From 7ddd3b8c50d365d860235e4e50b0db06c6acb2d1 Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Sun, 14 Sep 2008 18:19:41 +0000 Subject: Doxygen Documentation WP5 Done, WP6 half finished so that all Fl_Image class hierarchy is up-to-date. Also completed the documentation of the useful Fl_Shared_Image. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6241 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Shared_Image.H | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'FL/Fl_Shared_Image.H') diff --git a/FL/Fl_Shared_Image.H b/FL/Fl_Shared_Image.H index 0dd6f3cd8..6f766ece8 100644 --- a/FL/Fl_Shared_Image.H +++ b/FL/Fl_Shared_Image.H @@ -36,6 +36,13 @@ typedef Fl_Image *(*Fl_Shared_Handler)(const char *name, uchar *header, int headerlen); // Shared images class. +/** + This class supports caching, loading, + and drawing of image files. Most applications will also want to + link against the fltk_images library and call the + fl_register_images() + function to support standard image formats such as BMP, GIF, JPEG, and PNG. +*/ class FL_EXPORT Fl_Shared_Image : public Fl_Image { protected: @@ -62,8 +69,9 @@ class FL_EXPORT Fl_Shared_Image : public Fl_Image { void update(); public: - + /** Returns the filename of the shared image */ const char *name() { return name_; } + /** Returns the number of references of this shared image. When reference is below 1, the image is deleted. */ int refcount() { return refcount_; } void release(); void reload(); -- cgit v1.2.3