summaryrefslogtreecommitdiff
path: root/src/fl_read_image.cxx
diff options
context:
space:
mode:
Diffstat (limited to 'src/fl_read_image.cxx')
-rw-r--r--src/fl_read_image.cxx6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/fl_read_image.cxx b/src/fl_read_image.cxx
index d3d32877f..c3357b14d 100644
--- a/src/fl_read_image.cxx
+++ b/src/fl_read_image.cxx
@@ -24,15 +24,15 @@
Reads an RGB(A) image from the current window or off-screen buffer.
\param[in] p pixel buffer, or NULL to allocate one
\param[in] X,Y position of top-left of image to read
- \param[in] W,H width and height of image to read
+ \param[in] w,h width and height of image to read
\param[in] alpha alpha value for image (0 for none)
\returns pointer to pixel buffer, or NULL if allocation failed.
-
+
The \p p argument points to a buffer that can hold the image and must
be at least \p W*H*3 bytes when reading RGB images, or \p W*H*4 bytes
when reading RGBA images. If NULL, fl_read_image() will create an
array of the proper size which can be freed using <tt>delete[]</tt>.
-
+
The \p alpha parameter controls whether an alpha channel is created
and the value that is placed in the alpha channel. If 0, no alpha
channel is generated.