Fl_Shared_Image.H

Go to the documentation of this file.

//
// Shared image header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2024 by Bill Spitzak and others.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file.  If this
// file is missing or damaged, see the license at:
//
//     https://www.fltk.org/COPYING.php
//
// Please see the following page on how to report bugs and issues:
//
//     https://www.fltk.org/bugs.php
//

 
#ifndef Fl_Shared_Image_H
#  define Fl_Shared_Image_H
 
#  include "Fl_Image.H"
 
#undef SHIM_DEBUG

typedef Fl_Image *(*Fl_Shared_Handler)(const char *name,
                                       uchar *header,
                                       int headerlen);

class FL_EXPORT Fl_Shared_Image : public Fl_Image {
 
  friend class Fl_JPEG_Image;
  friend class Fl_PNG_Image;
  friend class Fl_SVG_Image;
  friend class Fl_Graphics_Driver;
 
protected:
 
  static Fl_Shared_Image **images_;     // Shared images
  static int    num_images_;            // Number of shared images
  static int    alloc_images_;          // Allocated shared images
  static Fl_Shared_Handler *handlers_;  // Additional format handlers
  static int    num_handlers_;          // Number of format handlers
  static int    alloc_handlers_;        // Allocated format handlers
 
  const char    *name_;                 // Name of image file
  int           original_;              // Original image?
  int           refcount_;              // Number of times this image has been used
  Fl_Image      *image_;                // The image that is shared
  int           alloc_image_;           // Was the image allocated?
 
  static int    compare(Fl_Shared_Image **i0, Fl_Shared_Image **i1);
 
  // Use get() and release() to load/delete images in memory...
  Fl_Shared_Image();
  Fl_Shared_Image(const char *n, Fl_Image *img = 0);
  virtual ~Fl_Shared_Image();
  void add();
  void update();
  Fl_Shared_Image *copy_(int W, int H) const;
 
public:
#ifdef SHIM_DEBUG
  static void print_pool();
#endif

  const char    *name() { return name_; }

  int           refcount() { return refcount_; }

  int original() { return original_; }
 
  void  release() FL_OVERRIDE;
  virtual void  reload();
 
  Fl_Shared_Image *as_shared_image() FL_OVERRIDE {
    return this;
  }
 
  Fl_Image *copy(int W, int H) const FL_OVERRIDE;
  Fl_Image *copy() const;
  Fl_Image *copy();
 
  void color_average(Fl_Color c, float i) FL_OVERRIDE;
  void desaturate() FL_OVERRIDE;
  void draw(int X, int Y, int W, int H, int cx = 0, int cy = 0) FL_OVERRIDE;
  void draw(int X, int Y) { draw(X, Y, w(), h(), 0, 0); }
  void uncache() FL_OVERRIDE;
 
  static Fl_Shared_Image *find(const char *name, int W = 0, int H = 0);
  static Fl_Shared_Image *get(const char *name, int W = 0, int H = 0);
  static Fl_Shared_Image *get(Fl_RGB_Image *rgb, int own_it = 1);
  static Fl_Shared_Image **images();
  static int            num_images();
  static void           add_handler(Fl_Shared_Handler f);
  static void           remove_handler(Fl_Shared_Handler f);

  const Fl_Image *image() const { return image_; }
 
}; // class Fl_Shared_Image
 
//
// The following function is provided in the fltk_images library and
// registers all of the "extra" image file formats that are not part
// of the core FLTK library...
//
 
FL_EXPORT extern void fl_register_images();
 
#endif // !Fl_Shared_Image_H