diff options
Diffstat (limited to 'doc/html/tqimage.html')
| -rw-r--r-- | doc/html/tqimage.html | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/doc/html/tqimage.html b/doc/html/tqimage.html index f435c83ec..cb8333ae7 100644 --- a/doc/html/tqimage.html +++ b/doc/html/tqimage.html @@ -81,7 +81,7 @@ representation with direct access to the pixel data. <li class=fn>bool <a href="#create-2"><b>create</b></a> ( const TQSize &, int depth, int numColors = 0, Endian bitOrder = IgnoreEndian )</li> <li class=fn>void <a href="#reset"><b>reset</b></a> ()</li> <li class=fn>void <a href="#fill"><b>fill</b></a> ( uint pixel )</li> -<li class=fn>void <a href="#invertPixels"><b>invertPixels</b></a> ( bool invertAlpha = TRUE )</li> +<li class=fn>void <a href="#invertPixels"><b>invertPixels</b></a> ( bool invertAlpha = true )</li> <li class=fn>TQImage <a href="#convertDepth-2"><b>convertDepth</b></a> ( int depth ) const</li> <li class=fn>TQImage <a href="#convertDepthWithPalette"><b>convertDepthWithPalette</b></a> ( int d, TQRgb * palette, int palette_count, int conversion_flags = 0 ) const</li> <li class=fn>TQImage <a href="#convertDepth"><b>convertDepth</b></a> ( int depth, int conversion_flags ) const</li> @@ -95,7 +95,7 @@ representation with direct access to the pixel data. <li class=fn>TQImage <a href="#scaleHeight"><b>scaleHeight</b></a> ( int h ) const</li> <li class=fn>TQImage <a href="#xForm"><b>xForm</b></a> ( const TQWMatrix & matrix ) const</li> <li class=fn>TQImage <a href="#createAlphaMask"><b>createAlphaMask</b></a> ( int conversion_flags = 0 ) const</li> -<li class=fn>TQImage <a href="#createHeuristicMask"><b>createHeuristicMask</b></a> ( bool clipTight = TRUE ) const</li> +<li class=fn>TQImage <a href="#createHeuristicMask"><b>createHeuristicMask</b></a> ( bool clipTight = true ) const</li> <li class=fn>TQImage <a href="#mirror"><b>mirror</b></a> () const</li> <li class=fn>TQImage <a href="#mirror-2"><b>mirror</b></a> ( bool horizontal, bool vertical ) const</li> <li class=fn>TQImage <a href="#swapRGB"><b>swapRGB</b></a> () const</li> @@ -330,9 +330,9 @@ Destroys the image and cleans up. <h3 class=fn>bool <a name="allGray"></a>TQImage::allGray () const </h3> -Returns TRUE if all the colors in the image are shades of gray +Returns true if all the colors in the image are shades of gray (i.e. their red, green and blue components are equal); otherwise -returns FALSE. +returns false. <p> This function is slow for large 32-bit images. <p> <p>See also <a href="#isGrayscale">isGrayscale</a>(). @@ -444,8 +444,8 @@ areas beyond this image pixels are filled with pixel 0. <h3 class=fn>bool <a name="create"></a>TQImage::create ( int width, int height, int depth, int numColors = 0, <a href="tqimage.html#Endian-enum">Endian</a> bitOrder = IgnoreEndian ) </h3> Sets the image <em>width</em>, <em>height</em>, <em>depth</em>, its number of colors -(in <em>numColors</em>), and bit order. Returns TRUE if successful, or -FALSE if the parameters are incorrect or if memory cannot be +(in <em>numColors</em>), and bit order. Returns true if successful, or +false if the parameters are incorrect or if memory cannot be allocated. <p> The <em>width</em> and <em>height</em> is limited to 32767. <em>depth</em> must be 1, 8, or 32. If <em>depth</em> is 1, <em>bitOrder</em> must be set to @@ -471,7 +471,7 @@ image. Returns a <a href="#isNull">null</a> image if <a href="#setAlphaBuffer">a convert to big-endianness using <a href="#convertBitOrder">convertBitOrder</a>(). <p> <p>See also <a href="#createHeuristicMask">createHeuristicMask</a>(), <a href="#hasAlphaBuffer">hasAlphaBuffer</a>(), and <a href="#setAlphaBuffer">setAlphaBuffer</a>(). -<h3 class=fn><a href="tqimage.html">TQImage</a> <a name="createHeuristicMask"></a>TQImage::createHeuristicMask ( bool clipTight = TRUE ) const +<h3 class=fn><a href="tqimage.html">TQImage</a> <a name="createHeuristicMask"></a>TQImage::createHeuristicMask ( bool clipTight = true ) const </h3> Creates and returns a 1-bpp heuristic mask for this image. It works by selecting a color from one of the corners, then chipping @@ -481,7 +481,7 @@ case of a draw (this generally means that this function is not applicable to the image), the result is arbitrary. <p> The returned image has little-endian bit order, which you can convert to big-endianness using <a href="#convertBitOrder">convertBitOrder</a>(). -<p> If <em>clipTight</em> is TRUE the mask is just large enough to cover the +<p> If <em>clipTight</em> is true the mask is just large enough to cover the pixels; otherwise, the mask is larger than the data pixels. <p> This function disregards the <a href="#hasAlphaBuffer">alpha buffer</a>. <p> <p>See also <a href="#createAlphaMask">createAlphaMask</a>(). @@ -548,8 +548,8 @@ to an image. <h3 class=fn>bool <a name="hasAlphaBuffer"></a>TQImage::hasAlphaBuffer () const </h3> -<p> Returns TRUE if alpha buffer mode is enabled; otherwise returns -FALSE. +<p> Returns true if alpha buffer mode is enabled; otherwise returns +false. <p> <p>See also <a href="#setAlphaBuffer">setAlphaBuffer</a>(). <h3 class=fn>int <a name="height"></a>TQImage::height () const @@ -592,10 +592,10 @@ Returns a list of image formats that are supported for image input. <p> <p>See also <a href="#outputFormats">outputFormats</a>(), <a href="#inputFormatList">inputFormatList</a>(), and <a href="tqimageio.html">TQImageIO</a>. -<h3 class=fn>void <a name="invertPixels"></a>TQImage::invertPixels ( bool invertAlpha = TRUE ) +<h3 class=fn>void <a name="invertPixels"></a>TQImage::invertPixels ( bool invertAlpha = true ) </h3> Inverts all pixel values in the image. -<p> If the depth is 32: if <em>invertAlpha</em> is TRUE, the alpha bits are +<p> If the depth is 32: if <em>invertAlpha</em> is true, the alpha bits are also inverted, otherwise they are left unchanged. <p> If the depth is not 32, the argument <em>invertAlpha</em> has no meaning. @@ -607,15 +607,15 @@ using color index <em>i</em> with a pixel using color index 255 minus <em>i</em> </h3> For 32-bit images, this function is equivalent to <a href="#allGray">allGray</a>(). -<p> For 8-bpp images, this function returns TRUE if <a href="#color">color</a>(i) is +<p> For 8-bpp images, this function returns true if <a href="#color">color</a>(i) is TQRgb(i,i,i) for all indices of the color table; otherwise returns -FALSE. +false. <p> <p>See also <a href="#allGray">allGray</a>() and <a href="#depth">depth</a>(). <h3 class=fn>bool <a name="isNull"></a>TQImage::isNull () const </h3> -<p> Returns TRUE if it is a null image; otherwise returns FALSE. +<p> Returns true if it is a null image; otherwise returns false. <p> A null image has all parameters set to zero and no allocated data. <p>Example: <a href="showimg-example.html#x1322">showimg/showimg.cpp</a>. @@ -628,8 +628,8 @@ FALSE. <h3 class=fn>bool <a name="load"></a>TQImage::load ( const <a href="tqstring.html">TQString</a> & fileName, const char * format = 0 ) </h3> -Loads an image from the file <em>fileName</em>. Returns TRUE if the -image was successfully loaded; otherwise returns FALSE. +Loads an image from the file <em>fileName</em>. Returns true if the +image was successfully loaded; otherwise returns false. <p> If <em>format</em> is specified, the loader attempts to read the image using the specified format. If <em>format</em> is not specified (which is the default), the loader reads a few bytes from the header to @@ -640,8 +640,8 @@ explains how to add extra formats. <h3 class=fn>bool <a name="loadFromData"></a>TQImage::loadFromData ( const uchar * buf, uint len, const char * format = 0 ) </h3> -Loads an image from the first <em>len</em> bytes of binary data in <em>buf</em>. Returns TRUE if the image was successfully loaded; otherwise -returns FALSE. +Loads an image from the first <em>len</em> bytes of binary data in <em>buf</em>. Returns true if the image was successfully loaded; otherwise +returns false. <p> If <em>format</em> is specified, the loader attempts to read the image using the specified format. If <em>format</em> is not specified (which is the default), the loader reads a few bytes from the header to @@ -664,7 +664,7 @@ image. The original TQImage is not changed. </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> Returns a mirror of the image, mirrored in the horizontal and/or -the vertical direction depending on whether <em>horizontal</em> and <em>vertical</em> are set to TRUE or FALSE. The original image is not +the vertical direction depending on whether <em>horizontal</em> and <em>vertical</em> are set to true or false. The original image is not changed. <p> <p>See also <a href="#smoothScale">smoothScale</a>(). @@ -692,8 +692,8 @@ offset by when positioning relative to other images. <h3 class=fn>bool <a name="operator!-eq"></a>TQImage::operator!= ( const <a href="tqimage.html">TQImage</a> & i ) const </h3> -Returns TRUE if this image and image <em>i</em> have different contents; -otherwise returns FALSE. The comparison can be slow, unless there +Returns true if this image and image <em>i</em> have different contents; +otherwise returns false. The comparison can be slow, unless there is some obvious difference, such as different widths, in which case the function will return quickly. <p> <p>See also <a href="#operator-eq">operator=</a>(). @@ -715,8 +715,8 @@ dereference the shared data. <h3 class=fn>bool <a name="operator-eq-eq"></a>TQImage::operator== ( const <a href="tqimage.html">TQImage</a> & i ) const </h3> -Returns TRUE if this image and image <em>i</em> have the same contents; -otherwise returns FALSE. The comparison can be slow, unless there +Returns true if this image and image <em>i</em> have the same contents; +otherwise returns false. The comparison can be slow, unless there is some obvious difference, such as different widths, in which case the function will return quickly. <p> <p>See also <a href="#operator-eq">operator=</a>(). @@ -779,8 +779,8 @@ format <em>format</em> and a quality factor of <em>quality</em>. <em>quality</em must be in the range 0..100 or -1. Specify 0 to obtain small compressed files, 100 for large uncompressed files, and -1 (the default) to use the default settings. -<p> Returns TRUE if the image was successfully saved; otherwise -returns FALSE. +<p> Returns true if the image was successfully saved; otherwise +returns false. <p> <p>See also <a href="#load">load</a>(), <a href="#loadFromData">loadFromData</a>(), <a href="#imageFormat">imageFormat</a>(), <a href="tqpixmap.html#save">TQPixmap::save</a>(), and <a href="tqimageio.html">TQImageIO</a>. <h3 class=fn>bool <a name="save-2"></a>TQImage::save ( <a href="tqiodevice.html">TQIODevice</a> * device, const char * format, int quality = -1 ) const @@ -858,7 +858,7 @@ the underlying platform. Hint: use <a href="tqcolor.html#qRed">tqRed()</a>, <p>Example: <a href="desktop-example.html#x1729">desktop/desktop.cpp</a>. <h3 class=fn>void <a name="setAlphaBuffer"></a>TQImage::setAlphaBuffer ( bool enable ) </h3> -Enables alpha buffer mode if <em>enable</em> is TRUE, otherwise disables +Enables alpha buffer mode if <em>enable</em> is true, otherwise disables it. The default setting is disabled. <p> An 8-bpp image has 8-bit pixels. A pixel is an index into the <a href="#color">color table</a>, which contains 32-bit color @@ -1033,8 +1033,8 @@ over a copy, e.g. <h3 class=fn>bool <a name="valid"></a>TQImage::valid ( int x, int y ) const </h3> -Returns TRUE if ( <em>x</em>, <em>y</em> ) is a valid coordinate in the image; -otherwise returns FALSE. +Returns true if ( <em>x</em>, <em>y</em> ) is a valid coordinate in the image; +otherwise returns false. <p> <p>See also <a href="#width">width</a>(), <a href="#height">height</a>(), and <a href="#pixelIndex">pixelIndex</a>(). <p>Examples: <a href="canvas-example.html#x2934">canvas/canvas.cpp</a> and <a href="qmag-example.html#x1777">qmag/qmag.cpp</a>. |