Mirrors_UI_SDK/fltk
1
0
Fork 0
mirror of https://github.com/fltk/fltk.git synced 2026-05-31 05:35:29 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Improve docs of Fl_Image and related classes (#431)

Browse Source 
Clarifications as discussed since April 15, 2022 07:00 UTC (see GitHub
issue #431).
This commit is contained in:
Albrecht Schlosser
2022-04-20 17:25:32 +02:00
parent c1d0783df9
commit 804c48515d
4 changed files with 32 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
FL/Fl_Image.H
+3 -3
View File
@@ -54,8 +54,8 @@ enum Fl_RGB_Scaling {
returned by w() and h(). These values are equal to data_w() and data_h() when
the image is created and can be changed by the scale() member function.
Since the Fl_Image class does not support image drawing by itself, calling
the draw() method results in a box with an X in it being drawn instead.
Since the Fl_Image class does not support image drawing by itself, calling the
Fl_Image::draw() method results in a box with an X in it being drawn instead.
*/
class FL_EXPORT Fl_Image {
friend class Fl_Graphics_Driver;
@@ -239,7 +239,7 @@ public:
/**
Creates a copy of the image in the same size.
The copied image should be released when you are done with it.
The new image should be released when you are done with it.
This does exactly the same as 'Fl_Image::copy(int W, int H) const' where
\p W and \p H are the width and height of the source image, respectively.
FL/Fl_Shared_Image.H
+1 -1
View File
@@ -176,7 +176,7 @@ public:
\note The internal image (pointer) is protected for good reasons, e.g.
to prevent access to the image so it can't be modified by user code.
\b DO \b NOT cast away the 'const' to modify the image.
\b DO \b NOT cast away the 'const' attribute to modify the image.
User code should rarely need this method. Use with caution.