Doxygen: more detailed descriptions of Fl_Image_Surface::offscreen() and Fl_Image_Surface::get_offscreen_before_delete().

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12142 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Manolo Gouy
2016-12-09 18:07:08 +00:00
parent 40f977ccce
commit c33df704ab
+6 -2
View File
@@ -63,7 +63,9 @@ void Fl_Image_Surface::untranslate() {
if (platform_surface) platform_surface->untranslate(); if (platform_surface) platform_surface->untranslate();
} }
/** Returns the Fl_Offscreen object associated to the image surface */ /** Returns the Fl_Offscreen object associated to the image surface.
The returned Fl_Offscreen object is deleted when the Fl_Image_Surface object is deleted.
*/
Fl_Offscreen Fl_Image_Surface::offscreen() { Fl_Offscreen Fl_Image_Surface::offscreen() {
return platform_surface ? platform_surface->offscreen : (Fl_Offscreen)0; return platform_surface ? platform_surface->offscreen : (Fl_Offscreen)0;
} }
@@ -93,7 +95,8 @@ Fl_Shared_Image* Fl_Image_Surface::highres_image()
return s_img; return s_img;
} }
/** Allows to delete the Fl_Image_Surface object while keeping its underlying Fl_Offscreen /** Allows to delete the Fl_Image_Surface object while keeping its underlying Fl_Offscreen.
This member function is intended for internal use by the FLTK library.
*/ */
Fl_Offscreen Fl_Image_Surface::get_offscreen_before_delete() { Fl_Offscreen Fl_Image_Surface::get_offscreen_before_delete() {
Fl_Offscreen keep = platform_surface->offscreen; Fl_Offscreen keep = platform_surface->offscreen;
@@ -135,6 +138,7 @@ Fl_Offscreen fl_create_offscreen(int w, int h) {
/** Deletion of an offscreen graphics buffer. /** Deletion of an offscreen graphics buffer.
\param ctx the buffer to be deleted. \param ctx the buffer to be deleted.
\note The \p ctx argument must have been created by fl_create_offscreen().
*/ */
void fl_delete_offscreen(Fl_Offscreen ctx) { void fl_delete_offscreen(Fl_Offscreen ctx) {
if (!ctx) return; if (!ctx) return;