Katana_mirror/katie
1
0
Fork 0
mirror of https://bitbucket.org/smil3y/katie.git synced 2025-02-24 10:52:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

QImage class documentation update

Browse source 
Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
This commit is contained in:
Ivailo Monev 2022-02-02 06:48:13 +02:00
parent 65a6e87920
commit 11695cf6dd
1 changed files with 13 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
src/gui/image/qimage.cpp
View file

@ -248,9 +248,8 @@ bool QImageData::checkForAlphaPixels() const
thread. thread.
The QImage class supports several image formats described by the The QImage class supports several image formats described by the
\l Format enum. These include monochrome, 8-bit, 32-bit and \l Format enum. These include monochrome, 32-bit and alpha-blended
alpha-blended images which are available in all versions of Qt images.
4.x.
QImage provides a collection of functions that can be used to QImage provides a collection of functions that can be used to
obtain a variety of information about the image. There are also obtain a variety of information about the image. There are also
@ -389,12 +388,12 @@ bool QImageData::checkForAlphaPixels() const
\snippet doc/src/snippets/code/src_gui_image_qimage.cpp 0 \snippet doc/src/snippets/code/src_gui_image_qimage.cpp 0
\endtable \endtable
In case of a 8-bit and monchrome images, the pixel value is only In case of monchrome images, the pixel value is only an index from
an index from the image's color table. So the setPixel() function the image's color table. So the setPixel() function can only be
can only be used to alter the color of the pixel at the given used to alter the color of the pixel at the given coordinates to a
coordinates to a predefined color from the image's color table, predefined color from the image's color table, i.e. it can only
i.e. it can only change the pixel's index value. To alter or add a change the pixel's index value. To alter or add a color to an
color to an image's color table, use the setColor() function. image's color table, use the setColor() function.
An entry in the color table is an ARGB quadruplet encoded as an An entry in the color table is an ARGB quadruplet encoded as an
QRgb value. Use the qRgb() and qRgba() functions to make a QRgb value. Use the qRgb() and qRgba() functions to make a
@ -2270,9 +2269,9 @@ QRgb QImage::pixel(int x, int y) const
Sets the pixel index or color at the given \a position to \a Sets the pixel index or color at the given \a position to \a
index_or_rgb. index_or_rgb.
If the image's format is either monochrome or 8-bit, the given \a If the image's format is monochrome, the given \a index_or_rgb
index_or_rgb value must be an index in the image's color table, value must be an index in the image's color table, otherwise the
otherwise the parameter must be a QRgb value. parameter must be a QRgb value.
If \a position is not a valid coordinate pair in the image, or if If \a position is not a valid coordinate pair in the image, or if
\a index_or_rgb >= 2 in the case of monochrome, the result is \a index_or_rgb >= 2 in the case of monochrome, the result is
@ -2380,11 +2379,8 @@ bool QImage::allGray() const
} }
/*! /*!
For 32-bit images, this function is equivalent to allGray(). For 32-bit images, this function is equivalent to allGray()
otherwise returns false.
For 8-bpp images, this function returns true if color(i) is
QRgb(i, i, i) for all indexes of the color table; otherwise
returns false.
\sa allGray(), {QImage#Image Formats}{Image Formats} \sa allGray(), {QImage#Image Formats}{Image Formats}
*/ */