FLTK 1.3.0
Fl_JPEG_Image Class Reference

The Fl_JPEG_Image class supports loading, caching, and drawing of Joint Photographic Experts Group (JPEG) File Interchange Format (JFIF) images. More...

#include <Fl_JPEG_Image.H>

Inheritance diagram for Fl_JPEG_Image:
Fl_RGB_Image Fl_Image

List of all members.

Public Member Functions

 Fl_JPEG_Image (const char *filename)
 The constructor loads the JPEG image from the given jpeg filename.
 Fl_JPEG_Image (const char *name, const unsigned char *data)
 The constructor loads the JPEG image from memory.
- Public Member Functions inherited from Fl_RGB_Image
virtual void color_average (Fl_Color c, float i)
 The color_average() method averages the colors in the image with the FLTK color value c.
virtual Fl_Imagecopy (int W, int H)
 The copy() method creates a copy of the specified image.
Fl_Imagecopy ()
 The copy() method creates a copy of the specified image.
virtual void desaturate ()
 The desaturate() method converts an image to grayscale.
virtual void draw (int X, int Y, int W, int H, int cx=0, int cy=0)
 Draws the image with a bounding box.
void draw (int X, int Y)
 Draws the image.
 Fl_RGB_Image (const uchar *bits, int W, int H, int D=3, int LD=0)
 The constructor creates a new image from the specified data.
virtual void label (Fl_Widget *w)
 The label() methods are an obsolete way to set the image attribute of a widget or menu item.
virtual void label (Fl_Menu_Item *m)
 The label() methods are an obsolete way to set the image attribute of a widget or menu item.
virtual void uncache ()
 If the image has been cached for display, delete the cache data.
virtual ~Fl_RGB_Image ()
 The destructor free all memory and server resources that are used by the image.
- Public Member Functions inherited from Fl_Image
int count () const
 The count() method returns the number of data values associated with the image.
int d () const
 Returns the current image depth.
const char *const * data () const
 Returns a pointer to the current image data array.
 Fl_Image (int W, int H, int D)
 The constructor creates an empty image with the specified width, height, and depth.
int h () const
 Returns the current image height in pixels.
void inactive ()
 The inactive() method calls color_average(FL_BACKGROUND_COLOR, 0.33f) to produce an image that appears grayed out.
int ld () const
 Returns the current line data size in bytes.
int w () const
 Returns the current image width in pixels.
virtual ~Fl_Image ()
 The destructor is a virtual method that frees all memory used by the image.

Additional Inherited Members

- Public Attributes inherited from Fl_RGB_Image
int alloc_array
const uchararray

Detailed Description

The Fl_JPEG_Image class supports loading, caching, and drawing of Joint Photographic Experts Group (JPEG) File Interchange Format (JFIF) images.

The class supports grayscale and color (RGB) JPEG image files.


Constructor & Destructor Documentation

Fl_JPEG_Image::Fl_JPEG_Image ( const char *  filename)

The constructor loads the JPEG image from the given jpeg filename.

The inherited destructor frees all memory and server resources that are used by the image.

There is no error function in this class. If the image has loaded correctly, w(), h(), and d() should return values greater zero.

Parameters:
[in]filenamea full path and name pointing to a valid jpeg file.
Fl_JPEG_Image::Fl_JPEG_Image ( const char *  name,
const unsigned char *  data 
)

The constructor loads the JPEG image from memory.

Construct an image from a block of memory inside the application. Fluid offers "binary Data" chunks as a great way to add image data into the C++ source code. name_png can be NULL. If a name is given, the image is added to the list of shared images (see: Fl_Shared_Image) and will be available by that name.

The inherited destructor frees all memory and server resources that are used by the image.

There is no error function in this class. If the image has loaded correctly, w(), h(), and d() should return values greater zero.

Parameters:
nameA unique name or NULL
dataA pointer to the memory location of the JPEG image

The documentation for this class was generated from the following files: