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:
Public Member Functions | |
| Fl_JPEG_Image (const char *filename) | |
| The constructor loads the JPEG image from the given jpeg filename. More... | |
| Fl_JPEG_Image (const char *name, const unsigned char *data, int data_length=-1) | |
| The constructor loads the JPEG image from memory. More... | |
 Public Member Functions inherited from Fl_RGB_Image | |
| virtual Fl_SVG_Image * | as_svg_image () |
| Returns whether an image is an Fl_SVG_Image or not. More... | |
| int | cache_h () |
| int | cache_w () |
| void | color_average (Fl_Color c, float i) FL_OVERRIDE |
| The color_average() method averages the colors in the image with the provided FLTK color value. More... | |
| Fl_Image * | copy () const |
| Fl_Image * | copy (int W, int H) const FL_OVERRIDE |
| Creates a resized copy of the image. More... | |
| void | desaturate () FL_OVERRIDE |
| The desaturate() method converts an image to grayscale. More... | |
| void | draw (int X, int Y) |
| void | draw (int X, int Y, int W, int H, int cx=0, int cy=0) FL_OVERRIDE |
| Draws the image to the current drawing surface with a bounding box. More... | |
| Fl_RGB_Image (const Fl_Pixmap *pxm, Fl_Color bg=FL_GRAY) | |
| The constructor creates a new RGBA image from the specified Fl_Pixmap. More... | |
| Fl_RGB_Image (const uchar *bits, int bits_length, int W, int H, int D, int LD) | |
| The constructor creates a new image from the specified data. More... | |
| 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. More... | |
| void | label (Fl_Menu_Item *m) FL_OVERRIDE |
| This method is an obsolete way to set the image attribute of a menu item. More... | |
| void | label (Fl_Widget *w) FL_OVERRIDE |
| This method is an obsolete way to set the image attribute of a widget or menu item. More... | |
| virtual void | normalize () |
| Makes sure the object is fully initialized. More... | |
| void | uncache () FL_OVERRIDE |
| If the image has been cached for display, delete the cache data. More... | |
| ~Fl_RGB_Image () FL_OVERRIDE | |
| The destructor frees all memory and server resources that are used by the image. | |
| Public Member Functions inherited from Fl_Image | |
| virtual class Fl_Shared_Image * | as_shared_image () |
| Returns whether an image is an Fl_Shared_Image or not. More... | |
| virtual void | color_average (Fl_Color c, float i) |
| The color_average() method averages the colors in the image with the provided FLTK color value. More... | |
| Fl_Image * | copy () const |
| Creates a copy of the image in the same size. More... | |
| virtual Fl_Image * | copy (int W, int H) const |
| Creates a resized copy of the image. More... | |
| int | count () const |
| Returns the number of data values associated with the image. More... | |
| int | d () const |
| Returns the image depth. More... | |
| const char *const * | data () const |
| Returns a pointer to the current image data array. More... | |
| int | data_h () const |
| Returns the height of the image data. | |
| int | data_w () const |
| Returns the width of the image data. | |
| virtual void | desaturate () |
| The desaturate() method converts an image to grayscale. More... | |
| void | draw (int X, int Y) |
| Draws the image to the current drawing surface. More... | |
| virtual void | draw (int X, int Y, int W, int H, int cx=0, int cy=0) |
| Draws the image to the current drawing surface with a bounding box. More... | |
| int | fail () const |
| Returns a value that is not 0 if there is currently no image available. More... | |
| Fl_Image (int W, int H, int D) | |
| The constructor creates an empty image with the specified width, height, and depth. More... | |
| int | h () const |
| Returns the current image drawing height in FLTK units. More... | |
| void | inactive () |
| The inactive() method calls color_average(FL_BACKGROUND_COLOR, 0.33f) to produce an image that appears grayed out. More... | |
| virtual void | label (Fl_Menu_Item *m) |
| This method is an obsolete way to set the image attribute of a menu item. More... | |
| virtual void | label (Fl_Widget *w) |
| This method is an obsolete way to set the image attribute of a widget or menu item. More... | |
| int | ld () const |
| Returns the current line data size in bytes. More... | |
| virtual void | release () |
Releases an Fl_Image - the same as 'delete this'. More... | |
| virtual void | scale (int width, int height, int proportional=1, int can_expand=0) |
| Sets the drawing size of the image. More... | |
| virtual void | uncache () |
| If the image has been cached for display, delete the cache data. More... | |
| int | w () const |
| Returns the current image drawing width in FLTK units. More... | |
| virtual | ~Fl_Image () |
| The destructor is a virtual method that frees all memory used by the image. | |
Protected Member Functions | |
| void | load_jpg_ (const char *filename, const char *sharename, const unsigned char *data, int data_length=-1) |
| Protected Member Functions inherited from Fl_Image | |
| void | d (int D) |
| Sets the current image depth. | |
| void | data (const char *const *p, int c) |
| Sets the current data pointer and count of pointers in the array. More... | |
| void | draw_empty (int X, int Y) |
| The protected method draw_empty() draws a box with an X in it. More... | |
| int | draw_scaled (int X, int Y, int W, int H) |
| Draw the image to the current drawing surface rescaled to a given width and height. More... | |
| void | h (int H) |
| Sets the height of the image data. More... | |
| void | ld (int LD) |
| Sets the current line data size in bytes. More... | |
| void | w (int W) |
| Sets the width of the image data. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Fl_RGB_Image | |
| static size_t | max_size () |
| Returns the maximum allowed image size in bytes when creating an Fl_RGB_Image object. More... | |
| static void | max_size (size_t size) |
| Sets the maximum allowed image size in bytes when creating an Fl_RGB_Image object. More... | |
| Static Public Member Functions inherited from Fl_Image | |
| static Fl_Labeltype | define_FL_IMAGE_LABEL () |
| static Fl_RGB_Scaling | RGB_scaling () |
| Returns the currently used RGB image scaling method. | |
| static void | RGB_scaling (Fl_RGB_Scaling) |
| Sets the RGB image scaling method used for copy(int, int). More... | |
| static Fl_RGB_Scaling | scaling_algorithm () |
| Gets what algorithm is used when resizing a source image to draw it. | |
| static void | scaling_algorithm (Fl_RGB_Scaling algorithm) |
| Sets what algorithm is used when resizing a source image to draw it. More... | |
| Public Attributes inherited from Fl_RGB_Image | |
| int | alloc_array |
| If non-zero, the object's data array is delete[]'d when deleting the object. | |
| const uchar * | array |
| Points to the start of the object's data array. More... | |
| Static Public Attributes inherited from Fl_Image | |
| static const int | ERR_FILE_ACCESS = -2 |
| static const int | ERR_FORMAT = -3 |
| static const int | ERR_MEMORY_ACCESS = -4 |
| static const int | ERR_NO_IMAGE = -1 |
| static bool | register_images_done = false |
| True after fl_register_images() was called, false before. | |
| Static Protected Member Functions inherited from Fl_Image | |
| static void | labeltype (const Fl_Label *lo, int lx, int ly, int lw, int lh, Fl_Align la) |
| static void | measure (const Fl_Label *lo, int &lw, int &lh) |
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() [1/2]
| 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.
Use Fl_Image::fail() to check if Fl_JPEG_Image failed to load. fail() returns ERR_FILE_ACCESS if the file could not be opened or read, ERR_FORMAT if the JPEG format could not be decoded, and ERR_NO_IMAGE if the image could not be loaded for another reason. If the image has loaded correctly, w(), h(), and d() should return values greater than zero.
- Parameters
-
[in] filename a full path and name pointing to a valid jpeg file.
- See also
- Fl_JPEG_Image::Fl_JPEG_Image(const char *imagename, const unsigned char *data)
◆ Fl_JPEG_Image() [2/2]
| Fl_JPEG_Image::Fl_JPEG_Image | ( | const char * | name, |
| const unsigned char * | data, | ||
| int | data_length = -1 |
||
| ) |
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.
Use Fl_Image::fail() to check if Fl_JPEG_Image failed to load. fail() returns ERR_FILE_ACCESS if the file could not be opened or read, ERR_FORMAT if the JPEG format could not be decoded, and ERR_NO_IMAGE if the image could not be loaded for another reason. If the image has loaded correctly, w(), h(), and d() should return values greater than zero.
- Parameters
-
name A unique name or NULL data A pointer to the memory location of the JPEG image data_length optional length of data. This will protect memory outside of thedataarray from illegal read operations
The documentation for this class was generated from the following files:
- Fl_JPEG_Image.H
- Fl_JPEG_Image.cxx
