3227 lines
153 KiB
HTML
3227 lines
153 KiB
HTML
<HTML>
|
||
<HEAD>
|
||
<TITLE>FreeImagePlus</TITLE>
|
||
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
|
||
</HEAD>
|
||
<BODY BGCOLOR="#FFFFFF">
|
||
<!-- Generated by Doxygen 1.5.3 -->
|
||
<div class="tabs">
|
||
<ul>
|
||
<li><a href="main.html"><span>Main Page</span></a></li>
|
||
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
|
||
<li><a href="files.html"><span>Files</span></a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="tabs">
|
||
<ul>
|
||
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
|
||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||
</ul>
|
||
</div>
|
||
<h1>fipImage Class Reference</h1><!-- doxytag: class="fipImage" --><!-- doxytag: inherits="fipObject" --><code>#include <<a class="el" href="FreeImagePlus_8h-source.html">FreeImagePlus.h</a>></code>
|
||
<p>
|
||
<div class="dynheader">
|
||
Inheritance diagram for fipImage:</div>
|
||
<div class="dynsection">
|
||
|
||
<p><center><img src="classfipImage.png" usemap="#fipImage_map" border="0" alt=""></center>
|
||
<map name="fipImage_map">
|
||
<area href="classfipObject.html" alt="fipObject" shape="rect" coords="0,0,80,24">
|
||
<area href="classfipWinImage.html" alt="fipWinImage" shape="rect" coords="0,112,80,136">
|
||
</map>
|
||
</div>
|
||
|
||
<p>
|
||
<a href="classfipImage-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
||
A class used to manage all photo related images and all image types used by the library.
|
||
<p>
|
||
<a class="el" href="classfipImage.html" title="A class used to manage all photo related images and all image types used by the library...">fipImage</a> encapsulates the FIBITMAP format. It relies on the FreeImage library, especially for loading / saving images and for bit depth conversion. <dl class="version" compact><dt><b>Version:</b></dt><dd>FreeImage 3 </dd></dl>
|
||
<dl class="author" compact><dt><b>Author:</b></dt><dd>Herv<EFBFBD> Drolon </dd></dl>
|
||
<table border="0" cellpadding="0" cellspacing="0">
|
||
<tr><td></td></tr>
|
||
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
||
<tr><td colspan="2"><div class="groupHeader">Creation & Destruction</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#c46caee418be25c93640e3aa781d8d6b">fipImage</a> (FREE_IMAGE_TYPE image_type=FIT_BITMAP, unsigned width=0, unsigned height=0, unsigned bpp=0)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#c46caee418be25c93640e3aa781d8d6b"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#6d786d5096e9195f474895066f89099b">~fipImage</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#6d786d5096e9195f474895066f89099b"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#73236a46f1482187961d222e5d6b6550">setSize</a> (FREE_IMAGE_TYPE image_type, unsigned width, unsigned height, unsigned bpp, unsigned red_mask=0, unsigned green_mask=0, unsigned blue_mask=0)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image allocator. <a href="#73236a46f1482187961d222e5d6b6550"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#74db21a670ddadc7a6ccb79bd078d675">clear</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy image data. <a href="#74db21a670ddadc7a6ccb79bd078d675"></a><br></td></tr>
|
||
<tr><td colspan="2"><div class="groupHeader">Copying</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#06c739a746f4d80278c8ad0672d31198">fipImage</a> (const <a class="el" href="classfipImage.html">fipImage</a> &src)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#06c739a746f4d80278c8ad0672d31198"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classfipImage.html">fipImage</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#d44726ab5976e6da20c5f7ae44945ed5">operator=</a> (const <a class="el" href="classfipImage.html">fipImage</a> &src)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#d44726ab5976e6da20c5f7ae44945ed5"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classfipImage.html">fipImage</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#ba25f9c9bca89affa8f80109a33bcfab">operator=</a> (FIBITMAP *dib)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight"><b>Assignement operator</b><br>
|
||
Copy the input pointer and manage its destruction </b> <a href="#ba25f9c9bca89affa8f80109a33bcfab"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#055e4ebeeec99266eba409d792ffa91e">copySubImage</a> (<a class="el" href="classfipImage.html">fipImage</a> &dst, int left, int top, int right, int bottom) const </td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#4785ea37766142a94d66fd547238e4e9">pasteSubImage</a> (<a class="el" href="classfipImage.html">fipImage</a> &src, int left, int top, int alpha=256)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#60d3487e7f224f7bb123dbc41af5c1f1">crop</a> (int left, int top, int right, int bottom)</td></tr>
|
||
|
||
<tr><td colspan="2"><div class="groupHeader">Loading & Saving</div></td></tr>
|
||
<tr><td colspan="2"><div class="groupText">Loading and saving is handled by the FreeImage library. <br><br></div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#519c30171f6d32a4cbfb5ab614797765">load</a> (const char *lpszPathName, int flag=0)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#694af6397fab814063a362283cfee411">loadU</a> (const wchar_t *lpszPathName, int flag=0)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">UNICODE version of load (this function only works under WIN32 and does nothing on other OS). <a href="#694af6397fab814063a362283cfee411"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#be5b1b1745ade983be2b8d4c60c73849">loadFromHandle</a> (FreeImageIO *io, fi_handle handle, int flag=0)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#fe8332fdda9f97b4f4dd80c0ad8ad4b7">loadFromMemory</a> (<a class="el" href="classfipMemoryIO.html">fipMemoryIO</a> &memIO, int flag=0)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#73ca675cb2ec67982b3d2d27a5d7b522">save</a> (const char *lpszPathName, int flag=0) const </td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#1c2f28153bbf52cb34346196f6062231">saveU</a> (const wchar_t *lpszPathName, int flag=0) const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">UNICODE version of save (this function only works under WIN32 and does nothing on other OS). <a href="#1c2f28153bbf52cb34346196f6062231"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#8b2b910a57fbafac7f1c22644e6ef51a">saveToHandle</a> (FREE_IMAGE_FORMAT fif, FreeImageIO *io, fi_handle handle, int flag=0) const </td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#23a0bfde3edf6d7c4567672b39cf8f2a">saveToMemory</a> (FREE_IMAGE_FORMAT fif, <a class="el" href="classfipMemoryIO.html">fipMemoryIO</a> &memIO, int flag=0) const </td></tr>
|
||
|
||
<tr><td colspan="2"><div class="groupHeader">Information functions</div></td></tr>
|
||
<tr><td colspan="2"><div class="groupText">Accessors to the DIB BITMAPINFO structure. <br><br></div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">FREE_IMAGE_TYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#8c7bcd46ec28caae244b93f973bfc861">getImageType</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the data type of the image. <a href="#8c7bcd46ec28caae244b93f973bfc861"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#93b3aaeb08cee8a7b05b8508bd6be528">getWidth</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the image width in pixels. <a href="#93b3aaeb08cee8a7b05b8508bd6be528"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#98703c0973c03ed8661b6ba0f3fc2507">getHeight</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the image height in pixels. <a href="#98703c0973c03ed8661b6ba0f3fc2507"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#236159618249f3c67b595370a30c353c">getScanWidth</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the width of the bitmap in bytes rounded to the nearest DWORD. <a href="#236159618249f3c67b595370a30c353c"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#af840f67d36a464421ef3dd2b07f54f8">operator FIBITMAP *</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the FIBITMAP data. <a href="#af840f67d36a464421ef3dd2b07f54f8"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#5dc25fed45acce1c5ad543722a8eac17">isValid</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the image is allocated, FALSE otherwise. <a href="#5dc25fed45acce1c5ad543722a8eac17"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BITMAPINFO * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#09961c68a9f277bb85840ae8166d587c">getInfo</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the bitmap's BITMAPINFO header. <a href="#09961c68a9f277bb85840ae8166d587c"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BITMAPINFOHEADER * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#e7fe72c9c8396d0f13edf527cc1469e0">getInfoHeader</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the bitmap's BITMAPINFOHEADER. <a href="#e7fe72c9c8396d0f13edf527cc1469e0"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">LONG </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#e966071cb2d8495eb07f05d1b931b67b">getImageSize</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the bitmap in bytes. <a href="#e966071cb2d8495eb07f05d1b931b67b"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#ac6700c412f503113a206883de3bca34">getBitsPerPixel</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the bitdepth of the bitmap. <a href="#ac6700c412f503113a206883de3bca34"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#02368cdead403ed007c54d5b85693d28">getLine</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the width of the bitmap in bytes. <a href="#02368cdead403ed007c54d5b85693d28"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#de7fcbb7c638b433e9c82da7d45ee153">getHorizontalResolution</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the bitmap resolution along the X axis, in pixels / cm. <a href="#de7fcbb7c638b433e9c82da7d45ee153"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#9d4a0d8aff91ce53578d532fed8cb497">getVerticalResolution</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the bitmap resolution along the Y axis, in pixels / cm. <a href="#9d4a0d8aff91ce53578d532fed8cb497"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#5aa47d06567a9638604ebb7b57684ddf">setHorizontalResolution</a> (double value)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the bitmap resolution along the X axis, in pixels / cm <a href="#5aa47d06567a9638604ebb7b57684ddf"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#88b90333b4bac994bd9567409a692d98">setVerticalResolution</a> (double value)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the bitmap resolution along the Y axis, in pixels / cm <a href="#88b90333b4bac994bd9567409a692d98"></a><br></td></tr>
|
||
<tr><td colspan="2"><div class="groupHeader">Palette operations</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">RGBQUAD * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#5acaf6e3a3a264d8e9816886fbeedf0e">getPalette</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the bitmap's palette. <a href="#5acaf6e3a3a264d8e9816886fbeedf0e"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#0b5504a47d06ae2ab1fa4f652936a20c">getPaletteSize</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the palette size in <b>bytes</b>. <a href="#0b5504a47d06ae2ab1fa4f652936a20c"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#aaf5f6bd6f504e89c17adfef5afa9105">getColorsUsed</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of colours used in the bitmap. <a href="#aaf5f6bd6f504e89c17adfef5afa9105"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">FREE_IMAGE_COLOR_TYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#297b5ccccade7a643ab612db5a1937a0">getColorType</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Investigates the colour type of the bitmap. <a href="#297b5ccccade7a643ab612db5a1937a0"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#03c32ce273bd81da3ec204da59c75c5f">isGrayscale</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the bitmap is a 8-bit bitmap with a greyscale palette, FALSE otherwise. <a href="#03c32ce273bd81da3ec204da59c75c5f"></a><br></td></tr>
|
||
<tr><td colspan="2"><div class="groupHeader">Pixel access</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BYTE * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#58d1d2dc76ec59013e4b02e1e3d8ad37">accessPixels</a> () const </td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BYTE * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#46a3467e5b840d44eb3e3fa39eefdd00">getScanLine</a> (unsigned scanline) const </td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#d65014b4b5ecca3aed750c597914a745">getPixelIndex</a> (unsigned x, unsigned y, BYTE *value) const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the pixel index of a 1-, 4- or 8-bit palettized image at position (x, y), including range check (slow access). <a href="#d65014b4b5ecca3aed750c597914a745"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#a273feac48e48631e8e134479f315e53">getPixelColor</a> (unsigned x, unsigned y, RGBQUAD *value) const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the pixel color of a 16-, 24- or 32-bit image at position (x, y), including range check (slow access). <a href="#a273feac48e48631e8e134479f315e53"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#7b532080524de43040f471a217a06ed6">setPixelIndex</a> (unsigned x, unsigned y, BYTE *value)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the pixel index of a 1-, 4- or 8-bit palettized image at position (x, y), including range check (slow access). <a href="#7b532080524de43040f471a217a06ed6"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#5e71151858ae9a87a21b09b15780ce7f">setPixelColor</a> (unsigned x, unsigned y, RGBQUAD *value)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the pixel color of a 16-, 24- or 32-bit image at position (x, y), including range check (slow access). <a href="#5e71151858ae9a87a21b09b15780ce7f"></a><br></td></tr>
|
||
<tr><td colspan="2"><div class="groupHeader">Conversion routines</div></td></tr>
|
||
<tr><td colspan="2"><div class="groupText">Bitmaps are always loaded in their default bit depth.<p>
|
||
If you want the bitmap to be stored in another bit depth, the class provides several conversion functions. <br><br></div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#62bbc389868a6a3a28d4773d5d2b8f9a">convertToType</a> (FREE_IMAGE_TYPE image_type, BOOL scale_linear=TRUE)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts an image to a type supported by FreeImage. <a href="#62bbc389868a6a3a28d4773d5d2b8f9a"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#b8b6fac438acc05782f26e878a55ef88">threshold</a> (BYTE T)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the bitmap to 1 bit using a threshold T. <a href="#b8b6fac438acc05782f26e878a55ef88"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#1fc8717c637827be9ea1b5f8ab060385">dither</a> (FREE_IMAGE_DITHER algorithm)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts a 8-bit image to a monochrome 1-bit image using a dithering algorithm. <a href="#1fc8717c637827be9ea1b5f8ab060385"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#8ab0cfb98e77e506abc67249547becce">convertTo4Bits</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the bitmap to 4 bits. <a href="#8ab0cfb98e77e506abc67249547becce"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#546a967ed723560a54dbbe7b4a4b134a">convertTo8Bits</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the bitmap to 8 bits. <a href="#546a967ed723560a54dbbe7b4a4b134a"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#86737d525f7bc200e6c8d414cc526319">convertToGrayscale</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the bitmap to 8 bits. <a href="#86737d525f7bc200e6c8d414cc526319"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#55edbeef00af95a9b15c609da0d0feb5">colorQuantize</a> (FREE_IMAGE_QUANTIZE algorithm)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Quantizes a full colour 24-bit bitmap to a palletised 8-bit bitmap. <a href="#55edbeef00af95a9b15c609da0d0feb5"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#dab84c62d59496d87f02ef75798bd893">convertTo16Bits555</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the bitmap to 16 bits. <a href="#dab84c62d59496d87f02ef75798bd893"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#e5dcf5c389d8ada26edd5f88dc206dba">convertTo16Bits565</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the bitmap to 16 bits. <a href="#e5dcf5c389d8ada26edd5f88dc206dba"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#dee24d76235e62fc4c23bad8ccc45782">convertTo24Bits</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the bitmap to 24 bits. <a href="#dee24d76235e62fc4c23bad8ccc45782"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#2a2290b756032ae70943a18188443b56">convertTo32Bits</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the bitmap to 32 bits. <a href="#2a2290b756032ae70943a18188443b56"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#b82c87466747dd2b0264a235ce9beef1">convertToRGBF</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the bitmap to a 96-bit RGBF image. <a href="#b82c87466747dd2b0264a235ce9beef1"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#6219018eeeaae7c198d4c339019adf0e">toneMapping</a> (FREE_IMAGE_TMO tmo, double first_param=0, double second_param=0, double third_param=1, double fourth_param=0)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts a High Dynamic Range image (48-bit RGB or 96-bit RGB Float) to a 24-bit RGB image. <a href="#6219018eeeaae7c198d4c339019adf0e"></a><br></td></tr>
|
||
<tr><td colspan="2"><div class="groupHeader">Transparency support: background colour and alpha channel</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#cbc38aaa634419c2fa59f620bbd2926b">isTransparent</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if the image is transparent, returns FALSE otherwise. <a href="#cbc38aaa634419c2fa59f620bbd2926b"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#8b03ae388c462dbe2186e47d0079e6f1">getTransparencyCount</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">8-bit transparency : get the number of transparent colors. <a href="#8b03ae388c462dbe2186e47d0079e6f1"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BYTE * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#167d8b524fc0f0ca3629514d50cd85ff">getTransparencyTable</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">8-bit transparency : get the bitmap<61>s transparency table. <a href="#167d8b524fc0f0ca3629514d50cd85ff"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#732c381a90d4b9693e53881d6f630c3e">setTransparencyTable</a> (BYTE *table, int count)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">8-bit transparency : set the bitmap<61>s transparency table. <a href="#732c381a90d4b9693e53881d6f630c3e"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#9e1e8a6c15278a2c69b258dc4b68d92d">hasFileBkColor</a> () const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE when the image has a file background color, FALSE otherwise. <a href="#9e1e8a6c15278a2c69b258dc4b68d92d"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#1d8a3197711749722d3e2b12528345b4">getFileBkColor</a> (RGBQUAD *bkcolor) const </td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#11bb882fe1552cc4e448af62ca5320e6">setFileBkColor</a> (RGBQUAD *bkcolor)</td></tr>
|
||
|
||
<tr><td colspan="2"><div class="groupHeader">Channel processing support</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#15ac5ab44a12cb0b2eb66d43b0b3b16f">getChannel</a> (<a class="el" href="classfipImage.html">fipImage</a> &image, FREE_IMAGE_COLOR_CHANNEL channel) const </td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#ed2ecec85dbe1af0223da310aa37e2f2">setChannel</a> (<a class="el" href="classfipImage.html">fipImage</a> &image, FREE_IMAGE_COLOR_CHANNEL channel)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#1d6bb383a25ae46956bb5bf0ba301d12">splitChannels</a> (<a class="el" href="classfipImage.html">fipImage</a> &RedChannel, <a class="el" href="classfipImage.html">fipImage</a> &GreenChannel, <a class="el" href="classfipImage.html">fipImage</a> &BlueChannel)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#066e73d2f4a80924063459475202ee00">combineChannels</a> (<a class="el" href="classfipImage.html">fipImage</a> &red, <a class="el" href="classfipImage.html">fipImage</a> &green, <a class="el" href="classfipImage.html">fipImage</a> &blue)</td></tr>
|
||
|
||
<tr><td colspan="2"><div class="groupHeader">Rotation and flipping</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#d68f361586bccc7dc026833eeb12c7a0">rotateEx</a> (double angle, double x_shift, double y_shift, double x_origin, double y_origin, BOOL use_mask)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image translation and rotation using B-Splines. <a href="#d68f361586bccc7dc026833eeb12c7a0"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#b1a073b88d1869693088a80b043af97f">rotate</a> (double angle, const void *bkcolor=NULL)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Image rotation by means of three shears. <a href="#b1a073b88d1869693088a80b043af97f"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#9725ac6dba57a9030f18e515bf13ab43">flipHorizontal</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flip the image horizontally along the vertical axis. <a href="#9725ac6dba57a9030f18e515bf13ab43"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#6527d38e2404f74fce4126959ef67993">flipVertical</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flip the image vertically along the horizontal axis. <a href="#6527d38e2404f74fce4126959ef67993"></a><br></td></tr>
|
||
<tr><td colspan="2"><div class="groupHeader">Color manipulation routines</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#f1241c67380d3b5272be720b946162d0">invert</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inverts each pixel data. <a href="#f1241c67380d3b5272be720b946162d0"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#d288aae45d9aa00b9ebaf966735830f2">adjustCurve</a> (BYTE *LUT, FREE_IMAGE_COLOR_CHANNEL channel)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#85ce1f32e823426bbab4f70e7864d792">adjustGamma</a> (double gamma)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#d9284730c288ad864fff3bf7b2369405">adjustBrightness</a> (double percentage)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#dc5282f2f1a1e482df337ab41f2bc20e">adjustContrast</a> (double percentage)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#c21f36ed4ed0a4a2d22d115a9d3dcbe6">adjustBrightnessContrastGamma</a> (double brightness, double contrast, double gamma)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjusts an image's brightness, contrast and gamma within a single operation. <a href="#c21f36ed4ed0a4a2d22d115a9d3dcbe6"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#cf838e492f817278dab8273f498b180b">getHistogram</a> (DWORD *histo, FREE_IMAGE_COLOR_CHANNEL channel=FICC_BLACK) const </td></tr>
|
||
|
||
<tr><td colspan="2"><div class="groupHeader">Upsampling / downsampling</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#2caf6e417ee503b9c5ab9c777beb605a">rescale</a> (unsigned new_width, unsigned new_height, FREE_IMAGE_FILTER filter)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#0c387959b5f019c23efc665bf1c49777">makeThumbnail</a> (unsigned max_size, BOOL convert=TRUE)</td></tr>
|
||
|
||
<tr><td colspan="2"><div class="groupHeader">Image status</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#ba130e654d1ab1dd02a2542ef67d2b79">setModified</a> (BOOL bStatus=TRUE)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the image status as 'modified'. <a href="#ba130e654d1ab1dd02a2542ef67d2b79"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#da47c4deb2ac04f7db9a2d109cc3dc53">isModified</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the image status. <a href="#da47c4deb2ac04f7db9a2d109cc3dc53"></a><br></td></tr>
|
||
<tr><td colspan="2"><div class="groupHeader">Metadata</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#b526caf5381b2ad3ffcfd43b210b9f4e">getMetadataCount</a> (FREE_IMAGE_MDMODEL model) const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of tags contained in the <em>model</em> metadata model attached to the dib. <a href="#b526caf5381b2ad3ffcfd43b210b9f4e"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#ff07bb198d0a7ea06e9814e9d6a69060">getMetadata</a> (FREE_IMAGE_MDMODEL model, const char *key, <a class="el" href="classfipTag.html">fipTag</a> &tag) const </td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a metadata attached to the dib. <a href="#ff07bb198d0a7ea06e9814e9d6a69060"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#c650631fa36917569d3f939cf7b1f3f7">setMetadata</a> (FREE_IMAGE_MDMODEL model, const char *key, <a class="el" href="classfipTag.html">fipTag</a> &tag)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach a new FreeImage tag to the dib. <a href="#c650631fa36917569d3f939cf7b1f3f7"></a><br></td></tr>
|
||
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
|
||
<tr><td colspan="2"><div class="groupHeader">File type identification</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">static FREE_IMAGE_FORMAT </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#bb63a11e86d8237eebd6e17c8f4848ea">identifyFIF</a> (const char *lpszPathName)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">static FREE_IMAGE_FORMAT </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#3a36bdb96330e4fa344099e72ada8bb7">identifyFIFU</a> (const wchar_t *lpszPathName)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">UNICODE version of identifyFIF (this function only works under WIN32 and does nothing on other OS). <a href="#3a36bdb96330e4fa344099e72ada8bb7"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">static FREE_IMAGE_FORMAT </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#9c655138a320254a11ea85d58c4393fb">identifyFIFFromHandle</a> (FreeImageIO *io, fi_handle handle)</td></tr>
|
||
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">static FREE_IMAGE_FORMAT </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#780eceea73bd5c0ffb4b35c0423f3796">identifyFIFFromMemory</a> (FIMEMORY *hmem)</td></tr>
|
||
|
||
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
|
||
<tr><td colspan="2"><div class="groupHeader">Internal use</div></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="460626be0966aacdc6c75654988c1ca5"></a><!-- doxytag: member="fipImage::replace" ref="460626be0966aacdc6c75654988c1ca5" args="(FIBITMAP *new_dib)" -->
|
||
BOOL </td><td class="memItemRight" valign="bottom"><b>replace</b> (FIBITMAP *new_dib)</td></tr>
|
||
|
||
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">FIBITMAP * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#04850fb0a78de2c70a8e0aed65dd8972">_dib</a></td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">DIB data. <a href="#04850fb0a78de2c70a8e0aed65dd8972"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">FREE_IMAGE_FORMAT </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#c2a0b52b57c2d9675fbd804083800727">_fif</a></td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Original (or last saved) fif format if available, FIF_UNKNOWN otherwise. <a href="#c2a0b52b57c2d9675fbd804083800727"></a><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#a43ecddf8f66db4d9008c85e3c8df9f9">_bHasChanged</a></td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">TRUE whenever the display need to be refreshed. <a href="#a43ecddf8f66db4d9008c85e3c8df9f9"></a><br></td></tr>
|
||
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9239cd5aa24385a2cbd0e3ab1e662ac7"></a><!-- doxytag: member="fipImage::fipMultiPage" ref="9239cd5aa24385a2cbd0e3ab1e662ac7" args="" -->
|
||
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classfipImage.html#9239cd5aa24385a2cbd0e3ab1e662ac7">fipMultiPage</a></td></tr>
|
||
|
||
</table>
|
||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||
<a class="anchor" name="c46caee418be25c93640e3aa781d8d6b"></a><!-- doxytag: member="fipImage::fipImage" ref="c46caee418be25c93640e3aa781d8d6b" args="(FREE_IMAGE_TYPE image_type=FIT_BITMAP, unsigned width=0, unsigned height=0, unsigned bpp=0)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">fipImage::fipImage </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_TYPE </td>
|
||
<td class="paramname"> <em>image_type</em> = <code>FIT_BITMAP</code>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>width</em> = <code>0</code>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>height</em> = <code>0</code>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>bpp</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Constructor.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_AllocateT </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="6d786d5096e9195f474895066f89099b"></a><!-- doxytag: member="fipImage::~fipImage" ref="6d786d5096e9195f474895066f89099b" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">virtual fipImage::~fipImage </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"><code> [virtual]</code></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Destructor.
|
||
<p>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="06c739a746f4d80278c8ad0672d31198"></a><!-- doxytag: member="fipImage::fipImage" ref="06c739a746f4d80278c8ad0672d31198" args="(const fipImage &src)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">fipImage::fipImage </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const <a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>src</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Copy constructor.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Clone </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<hr><h2>Member Function Documentation</h2>
|
||
<a class="anchor" name="73236a46f1482187961d222e5d6b6550"></a><!-- doxytag: member="fipImage::setSize" ref="73236a46f1482187961d222e5d6b6550" args="(FREE_IMAGE_TYPE image_type, unsigned width, unsigned height, unsigned bpp, unsigned red_mask=0, unsigned green_mask=0, unsigned blue_mask=0)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::setSize </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_TYPE </td>
|
||
<td class="paramname"> <em>image_type</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>width</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>height</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>bpp</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>red_mask</em> = <code>0</code>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>green_mask</em> = <code>0</code>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>blue_mask</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Image allocator.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_AllocateT </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="74db21a670ddadc7a6ccb79bd078d675"></a><!-- doxytag: member="fipImage::clear" ref="74db21a670ddadc7a6ccb79bd078d675" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">virtual void fipImage::clear </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"><code> [virtual]</code></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Destroy image data.
|
||
<p>
|
||
|
||
<p>Reimplemented in <a class="el" href="classfipWinImage.html#122b7d871b5103736636b822837f7285">fipWinImage</a>.</p>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="d44726ab5976e6da20c5f7ae44945ed5"></a><!-- doxytag: member="fipImage::operator=" ref="d44726ab5976e6da20c5f7ae44945ed5" args="(const fipImage &src)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classfipImage.html">fipImage</a>& fipImage::operator= </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const <a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>src</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Copy constructor.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Clone </dd></dl>
|
||
|
||
<p>Reimplemented in <a class="el" href="classfipWinImage.html#1d095d07a35f38a40ef6d9c89561efe9">fipWinImage</a>.</p>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="ba25f9c9bca89affa8f80109a33bcfab"></a><!-- doxytag: member="fipImage::operator=" ref="ba25f9c9bca89affa8f80109a33bcfab" args="(FIBITMAP *dib)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="classfipImage.html">fipImage</a>& fipImage::operator= </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FIBITMAP * </td>
|
||
<td class="paramname"> <em>dib</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
<b>Assignement operator</b><br>
|
||
Copy the input pointer and manage its destruction </b>
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classfipImage.html#af840f67d36a464421ef3dd2b07f54f8" title="Returns a pointer to the FIBITMAP data.">operator FIBITMAP*()</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="055e4ebeeec99266eba409d792ffa91e"></a><!-- doxytag: member="fipImage::copySubImage" ref="055e4ebeeec99266eba409d792ffa91e" args="(fipImage &dst, int left, int top, int right, int bottom) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::copySubImage </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>dst</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>left</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>top</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>right</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>bottom</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Copy a sub part of the current image and returns it as a <a class="el" href="classfipImage.html" title="A class used to manage all photo related images and all image types used by the library...">fipImage</a> object.<p>
|
||
This method works with any bitmap type. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>dst</em> </td><td>Output subimage </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>left</em> </td><td>Specifies the left position of the cropped rectangle. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>top</em> </td><td>Specifies the top position of the cropped rectangle. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>right</em> </td><td>Specifies the right position of the cropped rectangle. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>bottom</em> </td><td>Specifies the bottom position of the cropped rectangle. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Copy </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="4785ea37766142a94d66fd547238e4e9"></a><!-- doxytag: member="fipImage::pasteSubImage" ref="4785ea37766142a94d66fd547238e4e9" args="(fipImage &src, int left, int top, int alpha=256)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::pasteSubImage </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>src</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>left</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>top</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>alpha</em> = <code>256</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Alpha blend or combine a sub part image with the current image.<p>
|
||
The bit depth of dst bitmap must be greater than or equal to the bit depth of src. Upper promotion of src is done internally. Supported bit depth equals to 4, 8, 16, 24 or 32. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>Source subimage </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>left</em> </td><td>Specifies the left position of the sub image. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>top</em> </td><td>Specifies the top position of the sub image. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>alpha</em> </td><td>Alpha blend factor. The source and destination images are alpha blended if alpha = 0..255. If alpha > 255, then the source image is combined to the destination image. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Paste </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="60d3487e7f224f7bb123dbc41af5c1f1"></a><!-- doxytag: member="fipImage::crop" ref="60d3487e7f224f7bb123dbc41af5c1f1" args="(int left, int top, int right, int bottom)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::crop </td>
|
||
<td>(</td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>left</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>top</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>right</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>bottom</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Crop a sub part of the current image and update it accordingly.<p>
|
||
This method works with any bitmap type. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>left</em> </td><td>Specifies the left position of the cropped rectangle. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>top</em> </td><td>Specifies the top position of the cropped rectangle. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>right</em> </td><td>Specifies the right position of the cropped rectangle. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>bottom</em> </td><td>Specifies the bottom position of the cropped rectangle. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="bb63a11e86d8237eebd6e17c8f4848ea"></a><!-- doxytag: member="fipImage::identifyFIF" ref="bb63a11e86d8237eebd6e17c8f4848ea" args="(const char *lpszPathName)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static FREE_IMAGE_FORMAT fipImage::identifyFIF </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const char * </td>
|
||
<td class="paramname"> <em>lpszPathName</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Identifies an image from disk, given its file name <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>lpszPathName</em> </td><td>Path and file name of the image to identify. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the found FreeImage format if successful, returns FIF_UNKNOWN otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetFileType, FreeImage_GetFIFFromFilename, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="3a36bdb96330e4fa344099e72ada8bb7"></a><!-- doxytag: member="fipImage::identifyFIFU" ref="3a36bdb96330e4fa344099e72ada8bb7" args="(const wchar_t *lpszPathName)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static FREE_IMAGE_FORMAT fipImage::identifyFIFU </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const wchar_t * </td>
|
||
<td class="paramname"> <em>lpszPathName</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
UNICODE version of identifyFIF (this function only works under WIN32 and does nothing on other OS).
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetFileTypeU, FreeImage_GetFIFFromFilenameU, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="9c655138a320254a11ea85d58c4393fb"></a><!-- doxytag: member="fipImage::identifyFIFFromHandle" ref="9c655138a320254a11ea85d58c4393fb" args="(FreeImageIO *io, fi_handle handle)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static FREE_IMAGE_FORMAT fipImage::identifyFIFFromHandle </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FreeImageIO * </td>
|
||
<td class="paramname"> <em>io</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">fi_handle </td>
|
||
<td class="paramname"> <em>handle</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Identifies an image using the specified FreeImageIO struct and fi_handle. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>io</em> </td><td>FreeImageIO structure </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>FreeImage fi_handle </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the found FreeImage format if successful, returns FIF_UNKNOWN otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetFileTypeFromHandle, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="780eceea73bd5c0ffb4b35c0423f3796"></a><!-- doxytag: member="fipImage::identifyFIFFromMemory" ref="780eceea73bd5c0ffb4b35c0423f3796" args="(FIMEMORY *hmem)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">static FREE_IMAGE_FORMAT fipImage::identifyFIFFromMemory </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FIMEMORY * </td>
|
||
<td class="paramname"> <em>hmem</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"><code> [static]</code></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Identifies an image using the specified memory stream. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>hmem</em> </td><td>FreeImage memory stream </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the found FreeImage format if successful, returns FIF_UNKNOWN otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetFileTypeFromMemory, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="519c30171f6d32a4cbfb5ab614797765"></a><!-- doxytag: member="fipImage::load" ref="519c30171f6d32a4cbfb5ab614797765" args="(const char *lpszPathName, int flag=0)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::load </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const char * </td>
|
||
<td class="paramname"> <em>lpszPathName</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>flag</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Loads an image from disk, given its file name and an optional flag. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>lpszPathName</em> </td><td>Path and file name of the image to load. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>The signification of this flag depends on the image to be read. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Load, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="694af6397fab814063a362283cfee411"></a><!-- doxytag: member="fipImage::loadU" ref="694af6397fab814063a362283cfee411" args="(const wchar_t *lpszPathName, int flag=0)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::loadU </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const wchar_t * </td>
|
||
<td class="paramname"> <em>lpszPathName</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>flag</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
UNICODE version of load (this function only works under WIN32 and does nothing on other OS).
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classfipImage.html#519c30171f6d32a4cbfb5ab614797765">load</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="be5b1b1745ade983be2b8d4c60c73849"></a><!-- doxytag: member="fipImage::loadFromHandle" ref="be5b1b1745ade983be2b8d4c60c73849" args="(FreeImageIO *io, fi_handle handle, int flag=0)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::loadFromHandle </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FreeImageIO * </td>
|
||
<td class="paramname"> <em>io</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">fi_handle </td>
|
||
<td class="paramname"> <em>handle</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>flag</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Loads an image using the specified FreeImageIO struct and fi_handle, and an optional flag. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>io</em> </td><td>FreeImageIO structure </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>FreeImage fi_handle </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>The signification of this flag depends on the image to be read. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_LoadFromHandle, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="fe8332fdda9f97b4f4dd80c0ad8ad4b7"></a><!-- doxytag: member="fipImage::loadFromMemory" ref="fe8332fdda9f97b4f4dd80c0ad8ad4b7" args="(fipMemoryIO &memIO, int flag=0)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::loadFromMemory </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classfipMemoryIO.html">fipMemoryIO</a> & </td>
|
||
<td class="paramname"> <em>memIO</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>flag</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Loads an image using the specified memory stream and an optional flag. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>memIO</em> </td><td>FreeImage memory stream </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>The signification of this flag depends on the image to be read. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_LoadFromMemory, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="73ca675cb2ec67982b3d2d27a5d7b522"></a><!-- doxytag: member="fipImage::save" ref="73ca675cb2ec67982b3d2d27a5d7b522" args="(const char *lpszPathName, int flag=0) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::save </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const char * </td>
|
||
<td class="paramname"> <em>lpszPathName</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>flag</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Saves an image to disk, given its file name and an optional flag. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>lpszPathName</em> </td><td>Path and file name of the image to save. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>The signification of this flag depends on the image to be saved. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Save, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="1c2f28153bbf52cb34346196f6062231"></a><!-- doxytag: member="fipImage::saveU" ref="1c2f28153bbf52cb34346196f6062231" args="(const wchar_t *lpszPathName, int flag=0) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::saveU </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const wchar_t * </td>
|
||
<td class="paramname"> <em>lpszPathName</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>flag</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
UNICODE version of save (this function only works under WIN32 and does nothing on other OS).
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classfipImage.html#73ca675cb2ec67982b3d2d27a5d7b522">save</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="8b2b910a57fbafac7f1c22644e6ef51a"></a><!-- doxytag: member="fipImage::saveToHandle" ref="8b2b910a57fbafac7f1c22644e6ef51a" args="(FREE_IMAGE_FORMAT fif, FreeImageIO *io, fi_handle handle, int flag=0) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::saveToHandle </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_FORMAT </td>
|
||
<td class="paramname"> <em>fif</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">FreeImageIO * </td>
|
||
<td class="paramname"> <em>io</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">fi_handle </td>
|
||
<td class="paramname"> <em>handle</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>flag</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Saves an image using the specified FreeImageIO struct and fi_handle, and an optional flag. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>fif</em> </td><td>Format identifier (FreeImage format) </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>io</em> </td><td>FreeImageIO structure </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>FreeImage fi_handle </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>The signification of this flag depends on the image to be saved. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_SaveToHandle, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="23a0bfde3edf6d7c4567672b39cf8f2a"></a><!-- doxytag: member="fipImage::saveToMemory" ref="23a0bfde3edf6d7c4567672b39cf8f2a" args="(FREE_IMAGE_FORMAT fif, fipMemoryIO &memIO, int flag=0) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::saveToMemory </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_FORMAT </td>
|
||
<td class="paramname"> <em>fif</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classfipMemoryIO.html">fipMemoryIO</a> & </td>
|
||
<td class="paramname"> <em>memIO</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>flag</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Saves an image using the specified memory stream and an optional flag. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>fif</em> </td><td>Format identifier (FreeImage format) </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>memIO</em> </td><td>FreeImage memory stream </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>The signification of this flag depends on the image to be saved. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_SaveToMemory, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="8c7bcd46ec28caae244b93f973bfc861"></a><!-- doxytag: member="fipImage::getImageType" ref="8c7bcd46ec28caae244b93f973bfc861" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">FREE_IMAGE_TYPE fipImage::getImageType </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the data type of the image.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetImageType </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="93b3aaeb08cee8a7b05b8508bd6be528"></a><!-- doxytag: member="fipImage::getWidth" ref="93b3aaeb08cee8a7b05b8508bd6be528" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">unsigned fipImage::getWidth </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the image width in pixels.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetWidth </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="98703c0973c03ed8661b6ba0f3fc2507"></a><!-- doxytag: member="fipImage::getHeight" ref="98703c0973c03ed8661b6ba0f3fc2507" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">unsigned fipImage::getHeight </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the image height in pixels.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetHeight </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="236159618249f3c67b595370a30c353c"></a><!-- doxytag: member="fipImage::getScanWidth" ref="236159618249f3c67b595370a30c353c" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">unsigned fipImage::getScanWidth </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the width of the bitmap in bytes rounded to the nearest DWORD.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetPitch </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="af840f67d36a464421ef3dd2b07f54f8"></a><!-- doxytag: member="fipImage::operator FIBITMAP *" ref="af840f67d36a464421ef3dd2b07f54f8" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">fipImage::operator FIBITMAP * </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"><code> [inline]</code></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns a pointer to the FIBITMAP data.
|
||
<p>
|
||
Used for direct access from FREEIMAGE functions or from your own low level C functions.<br>
|
||
<b>Sample use</b> : <br>
|
||
<pre>
|
||
<a class="el" href="classfipImage.html" title="A class used to manage all photo related images and all image types used by the library...">fipImage</a> src, dst;
|
||
src.load("test.png");
|
||
dst = FreeImage_ConvertTo8Bits(src);
|
||
FreeImage_Save(FIF_TIFF, dst, "test.tif", 0);
|
||
</pre> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classfipImage.html#ba25f9c9bca89affa8f80109a33bcfab" title="Assignement operator</b> Copy the input pointer and manage its destruction...">operator=(FIBITMAP *dib)</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="5dc25fed45acce1c5ad543722a8eac17"></a><!-- doxytag: member="fipImage::isValid" ref="5dc25fed45acce1c5ad543722a8eac17" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::isValid </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const<code> [virtual]</code></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns TRUE if the image is allocated, FALSE otherwise.
|
||
<p>
|
||
|
||
<p>Implements <a class="el" href="classfipObject.html#0fe8446f5665032bcf2089f08139b8cd">fipObject</a>.</p>
|
||
|
||
<p>Reimplemented in <a class="el" href="classfipWinImage.html#d8b7f7117e0c689503ceceec47ec3cee">fipWinImage</a>.</p>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="09961c68a9f277bb85840ae8166d587c"></a><!-- doxytag: member="fipImage::getInfo" ref="09961c68a9f277bb85840ae8166d587c" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BITMAPINFO* fipImage::getInfo </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns a pointer to the bitmap's BITMAPINFO header.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetInfo </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="e7fe72c9c8396d0f13edf527cc1469e0"></a><!-- doxytag: member="fipImage::getInfoHeader" ref="e7fe72c9c8396d0f13edf527cc1469e0" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BITMAPINFOHEADER* fipImage::getInfoHeader </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns a pointer to the bitmap's BITMAPINFOHEADER.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetInfoHeader </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="e966071cb2d8495eb07f05d1b931b67b"></a><!-- doxytag: member="fipImage::getImageSize" ref="e966071cb2d8495eb07f05d1b931b67b" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">LONG fipImage::getImageSize </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the size of the bitmap in bytes.
|
||
<p>
|
||
The size of the bitmap is the BITMAPINFOHEADER + the size of the palette + the size of the bitmap data. <dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetDIBSize </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="ac6700c412f503113a206883de3bca34"></a><!-- doxytag: member="fipImage::getBitsPerPixel" ref="ac6700c412f503113a206883de3bca34" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">unsigned fipImage::getBitsPerPixel </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the bitdepth of the bitmap.
|
||
<p>
|
||
<br>
|
||
When the image type is FIT_BITMAP, valid bitdepth can be 1, 4, 8, 16, 24 or 32. <dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetBPP, <a class="el" href="classfipImage.html#8c7bcd46ec28caae244b93f973bfc861" title="Returns the data type of the image.">getImageType</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="02368cdead403ed007c54d5b85693d28"></a><!-- doxytag: member="fipImage::getLine" ref="02368cdead403ed007c54d5b85693d28" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">unsigned fipImage::getLine </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the width of the bitmap in bytes.
|
||
<p>
|
||
<br>
|
||
<b>This is not the size of the scanline</b>. <dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetLine, <a class="el" href="classfipImage.html#236159618249f3c67b595370a30c353c" title="Returns the width of the bitmap in bytes rounded to the nearest DWORD.">getScanWidth</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="de7fcbb7c638b433e9c82da7d45ee153"></a><!-- doxytag: member="fipImage::getHorizontalResolution" ref="de7fcbb7c638b433e9c82da7d45ee153" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">double fipImage::getHorizontalResolution </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the bitmap resolution along the X axis, in pixels / cm.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetDotsPerMeterX </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="9d4a0d8aff91ce53578d532fed8cb497"></a><!-- doxytag: member="fipImage::getVerticalResolution" ref="9d4a0d8aff91ce53578d532fed8cb497" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">double fipImage::getVerticalResolution </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the bitmap resolution along the Y axis, in pixels / cm.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetDotsPerMeterY </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="5aa47d06567a9638604ebb7b57684ddf"></a><!-- doxytag: member="fipImage::setHorizontalResolution" ref="5aa47d06567a9638604ebb7b57684ddf" args="(double value)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void fipImage::setHorizontalResolution </td>
|
||
<td>(</td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>value</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
set the bitmap resolution along the X axis, in pixels / cm
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetInfoHeader </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="88b90333b4bac994bd9567409a692d98"></a><!-- doxytag: member="fipImage::setVerticalResolution" ref="88b90333b4bac994bd9567409a692d98" args="(double value)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void fipImage::setVerticalResolution </td>
|
||
<td>(</td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>value</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
set the bitmap resolution along the Y axis, in pixels / cm
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetInfoHeader </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="5acaf6e3a3a264d8e9816886fbeedf0e"></a><!-- doxytag: member="fipImage::getPalette" ref="5acaf6e3a3a264d8e9816886fbeedf0e" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">RGBQUAD* fipImage::getPalette </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns a pointer to the bitmap's palette.
|
||
<p>
|
||
If the bitmap doesn't have a palette, getPalette returns NULL. <dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetPalette </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="0b5504a47d06ae2ab1fa4f652936a20c"></a><!-- doxytag: member="fipImage::getPaletteSize" ref="0b5504a47d06ae2ab1fa4f652936a20c" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">unsigned fipImage::getPaletteSize </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the palette size in <b>bytes</b>.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetColorsUsed </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="aaf5f6bd6f504e89c17adfef5afa9105"></a><!-- doxytag: member="fipImage::getColorsUsed" ref="aaf5f6bd6f504e89c17adfef5afa9105" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">unsigned fipImage::getColorsUsed </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Retrieves the number of colours used in the bitmap.
|
||
<p>
|
||
If the bitmap is non-palletised, 0 is returned. <dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetColorsUsed </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="297b5ccccade7a643ab612db5a1937a0"></a><!-- doxytag: member="fipImage::getColorType" ref="297b5ccccade7a643ab612db5a1937a0" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">FREE_IMAGE_COLOR_TYPE fipImage::getColorType </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Investigates the colour type of the bitmap.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetColorType, FREE_IMAGE_COLOR_TYPE </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="03c32ce273bd81da3ec204da59c75c5f"></a><!-- doxytag: member="fipImage::isGrayscale" ref="03c32ce273bd81da3ec204da59c75c5f" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::isGrayscale </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns TRUE if the bitmap is a 8-bit bitmap with a greyscale palette, FALSE otherwise.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetBPP, FreeImage_GetColorType </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="58d1d2dc76ec59013e4b02e1e3d8ad37"></a><!-- doxytag: member="fipImage::accessPixels" ref="58d1d2dc76ec59013e4b02e1e3d8ad37" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BYTE* fipImage::accessPixels </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns a pointer to the bitmap bits.<p>
|
||
It is up to you to interpret these bytes correctly, according to the results of FreeImage_GetBPP and GetRedMask, FreeImage_GetGreenMask and FreeImage_GetBlueMask.<br>
|
||
Use this function with getScanWidth to iterates through the pixels. <dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetBits </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="46a3467e5b840d44eb3e3fa39eefdd00"></a><!-- doxytag: member="fipImage::getScanLine" ref="46a3467e5b840d44eb3e3fa39eefdd00" args="(unsigned scanline) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BYTE* fipImage::getScanLine </td>
|
||
<td>(</td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>scanline</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns a pointer to the start of the given scanline in the bitmap<61>s data-bits. This pointer can be cast according to the result returned by getImageType.<br>
|
||
Use this function with getScanWidth to iterates through the pixels. <dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetScanLine, FreeImage documentation </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="d65014b4b5ecca3aed750c597914a745"></a><!-- doxytag: member="fipImage::getPixelIndex" ref="d65014b4b5ecca3aed750c597914a745" args="(unsigned x, unsigned y, BYTE *value) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::getPixelIndex </td>
|
||
<td>(</td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>x</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>y</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">BYTE * </td>
|
||
<td class="paramname"> <em>value</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Get the pixel index of a 1-, 4- or 8-bit palettized image at position (x, y), including range check (slow access).
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>Pixel position in horizontal direction </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>Pixel position in vertical direction </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Pixel index (returned value) </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetPixelIndex </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="a273feac48e48631e8e134479f315e53"></a><!-- doxytag: member="fipImage::getPixelColor" ref="a273feac48e48631e8e134479f315e53" args="(unsigned x, unsigned y, RGBQUAD *value) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::getPixelColor </td>
|
||
<td>(</td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>x</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>y</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">RGBQUAD * </td>
|
||
<td class="paramname"> <em>value</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Get the pixel color of a 16-, 24- or 32-bit image at position (x, y), including range check (slow access).
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>Pixel position in horizontal direction </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>Pixel position in vertical direction </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Pixel color (returned value) </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetPixelColor </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="7b532080524de43040f471a217a06ed6"></a><!-- doxytag: member="fipImage::setPixelIndex" ref="7b532080524de43040f471a217a06ed6" args="(unsigned x, unsigned y, BYTE *value)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::setPixelIndex </td>
|
||
<td>(</td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>x</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>y</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">BYTE * </td>
|
||
<td class="paramname"> <em>value</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Set the pixel index of a 1-, 4- or 8-bit palettized image at position (x, y), including range check (slow access).
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>Pixel position in horizontal direction </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>Pixel position in vertical direction </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Pixel index </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_SetPixelIndex </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="5e71151858ae9a87a21b09b15780ce7f"></a><!-- doxytag: member="fipImage::setPixelColor" ref="5e71151858ae9a87a21b09b15780ce7f" args="(unsigned x, unsigned y, RGBQUAD *value)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::setPixelColor </td>
|
||
<td>(</td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>x</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>y</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">RGBQUAD * </td>
|
||
<td class="paramname"> <em>value</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Set the pixel color of a 16-, 24- or 32-bit image at position (x, y), including range check (slow access).
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>Pixel position in horizontal direction </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>Pixel position in vertical direction </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Pixel color </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_SetPixelColor </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="62bbc389868a6a3a28d4773d5d2b8f9a"></a><!-- doxytag: member="fipImage::convertToType" ref="62bbc389868a6a3a28d4773d5d2b8f9a" args="(FREE_IMAGE_TYPE image_type, BOOL scale_linear=TRUE)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::convertToType </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_TYPE </td>
|
||
<td class="paramname"> <em>image_type</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">BOOL </td>
|
||
<td class="paramname"> <em>scale_linear</em> = <code>TRUE</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts an image to a type supported by FreeImage.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>image_type</em> </td><td>New image type </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>scale_linear</em> </td><td>TRUE if image pixels must be scaled linearly when converting to a standard bitmap </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ConvertToType, FreeImage_ConvertToStandardType </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="b8b6fac438acc05782f26e878a55ef88"></a><!-- doxytag: member="fipImage::threshold" ref="b8b6fac438acc05782f26e878a55ef88" args="(BYTE T)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::threshold </td>
|
||
<td>(</td>
|
||
<td class="paramtype">BYTE </td>
|
||
<td class="paramname"> <em>T</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts the bitmap to 1 bit using a threshold T.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>T</em> </td><td>Threshold value in [0..255] </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Threshold </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="1fc8717c637827be9ea1b5f8ab060385"></a><!-- doxytag: member="fipImage::dither" ref="1fc8717c637827be9ea1b5f8ab060385" args="(FREE_IMAGE_DITHER algorithm)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::dither </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_DITHER </td>
|
||
<td class="paramname"> <em>algorithm</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts a 8-bit image to a monochrome 1-bit image using a dithering algorithm.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>algorithm</em> </td><td>Dithering algorithm to use. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Dither, FREE_IMAGE_DITHER </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="8ab0cfb98e77e506abc67249547becce"></a><!-- doxytag: member="fipImage::convertTo4Bits" ref="8ab0cfb98e77e506abc67249547becce" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::convertTo4Bits </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts the bitmap to 4 bits.
|
||
<p>
|
||
Unless the bitmap is a 1-bit palettized bitmap, colour values are converted to greyscale. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ConvertTo4Bits </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="546a967ed723560a54dbbe7b4a4b134a"></a><!-- doxytag: member="fipImage::convertTo8Bits" ref="546a967ed723560a54dbbe7b4a4b134a" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::convertTo8Bits </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts the bitmap to 8 bits.
|
||
<p>
|
||
If the bitmap is 24 or 32-bit RGB, the colour values are converted to greyscale. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ConvertTo8Bits </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="86737d525f7bc200e6c8d414cc526319"></a><!-- doxytag: member="fipImage::convertToGrayscale" ref="86737d525f7bc200e6c8d414cc526319" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::convertToGrayscale </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts the bitmap to 8 bits.
|
||
<p>
|
||
<br>
|
||
For palletized bitmaps, the color map is converted to a greyscale ramp. <dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ConvertToGreyscale </dd></dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="55edbeef00af95a9b15c609da0d0feb5"></a><!-- doxytag: member="fipImage::colorQuantize" ref="55edbeef00af95a9b15c609da0d0feb5" args="(FREE_IMAGE_QUANTIZE algorithm)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::colorQuantize </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_QUANTIZE </td>
|
||
<td class="paramname"> <em>algorithm</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Quantizes a full colour 24-bit bitmap to a palletised 8-bit bitmap.
|
||
<p>
|
||
<br>
|
||
The quantize parameter specifies which colour reduction algorithm should be used. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>algorithm</em> </td><td>Color quantization algorithm to use. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ColorQuantize, FREE_IMAGE_QUANTIZE </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="dab84c62d59496d87f02ef75798bd893"></a><!-- doxytag: member="fipImage::convertTo16Bits555" ref="dab84c62d59496d87f02ef75798bd893" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::convertTo16Bits555 </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts the bitmap to 16 bits.
|
||
<p>
|
||
The resulting bitmap has a layout of 5 bits red, 5 bits green, 5 bits blue and 1 unused bit. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ConvertTo16Bits555 </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="e5dcf5c389d8ada26edd5f88dc206dba"></a><!-- doxytag: member="fipImage::convertTo16Bits565" ref="e5dcf5c389d8ada26edd5f88dc206dba" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::convertTo16Bits565 </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts the bitmap to 16 bits.
|
||
<p>
|
||
The resulting bitmap has a layout of 5 bits red, 6 bits green and 5 bits blue. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ConvertTo16Bits565 </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="dee24d76235e62fc4c23bad8ccc45782"></a><!-- doxytag: member="fipImage::convertTo24Bits" ref="dee24d76235e62fc4c23bad8ccc45782" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::convertTo24Bits </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts the bitmap to 24 bits.
|
||
<p>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ConvertTo24Bits </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="2a2290b756032ae70943a18188443b56"></a><!-- doxytag: member="fipImage::convertTo32Bits" ref="2a2290b756032ae70943a18188443b56" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::convertTo32Bits </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts the bitmap to 32 bits.
|
||
<p>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ConvertTo32Bits </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="b82c87466747dd2b0264a235ce9beef1"></a><!-- doxytag: member="fipImage::convertToRGBF" ref="b82c87466747dd2b0264a235ce9beef1" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::convertToRGBF </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts the bitmap to a 96-bit RGBF image.
|
||
<p>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ConvertToRGBF </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="6219018eeeaae7c198d4c339019adf0e"></a><!-- doxytag: member="fipImage::toneMapping" ref="6219018eeeaae7c198d4c339019adf0e" args="(FREE_IMAGE_TMO tmo, double first_param=0, double second_param=0, double third_param=1, double fourth_param=0)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::toneMapping </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_TMO </td>
|
||
<td class="paramname"> <em>tmo</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>first_param</em> = <code>0</code>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>second_param</em> = <code>0</code>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>third_param</em> = <code>1</code>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>fourth_param</em> = <code>0</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Converts a High Dynamic Range image (48-bit RGB or 96-bit RGB Float) to a 24-bit RGB image.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>tmo</em> </td><td>Tone mapping operator </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>first_param</em> </td><td>First tone mapping algorithm parameter (algorithm dependant) </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>second_param</em> </td><td>Second tone mapping algorithm parameter (algorithm dependant) </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>third_param</em> </td><td>Third tone mapping algorithm parameter (algorithm dependant) </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>fourth_param</em> </td><td>Fourth tone mapping algorithm parameter (algorithm dependant) </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successfull, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_ToneMapping, FreeImage_TmoReinhard05Ex </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="cbc38aaa634419c2fa59f620bbd2926b"></a><!-- doxytag: member="fipImage::isTransparent" ref="cbc38aaa634419c2fa59f620bbd2926b" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::isTransparent </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns TRUE if the image is transparent, returns FALSE otherwise.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_IsTransparent </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="8b03ae388c462dbe2186e47d0079e6f1"></a><!-- doxytag: member="fipImage::getTransparencyCount" ref="8b03ae388c462dbe2186e47d0079e6f1" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">unsigned fipImage::getTransparencyCount </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
8-bit transparency : get the number of transparent colors.
|
||
<p>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the number of transparent colors in a palletised bitmap. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetTransparencyCount </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="167d8b524fc0f0ca3629514d50cd85ff"></a><!-- doxytag: member="fipImage::getTransparencyTable" ref="167d8b524fc0f0ca3629514d50cd85ff" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BYTE* fipImage::getTransparencyTable </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
8-bit transparency : get the bitmap<61>s transparency table.
|
||
<p>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns a pointer to the bitmap<61>s transparency table. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetTransparencyTable </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="732c381a90d4b9693e53881d6f630c3e"></a><!-- doxytag: member="fipImage::setTransparencyTable" ref="732c381a90d4b9693e53881d6f630c3e" args="(BYTE *table, int count)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void fipImage::setTransparencyTable </td>
|
||
<td>(</td>
|
||
<td class="paramtype">BYTE * </td>
|
||
<td class="paramname"> <em>table</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"> <em>count</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
8-bit transparency : set the bitmap<61>s transparency table.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_SetTransparencyTable </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="9e1e8a6c15278a2c69b258dc4b68d92d"></a><!-- doxytag: member="fipImage::hasFileBkColor" ref="9e1e8a6c15278a2c69b258dc4b68d92d" args="() const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::hasFileBkColor </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns TRUE when the image has a file background color, FALSE otherwise.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_HasBackgroundColor </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="1d8a3197711749722d3e2b12528345b4"></a><!-- doxytag: member="fipImage::getFileBkColor" ref="1d8a3197711749722d3e2b12528345b4" args="(RGBQUAD *bkcolor) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::getFileBkColor </td>
|
||
<td>(</td>
|
||
<td class="paramtype">RGBQUAD * </td>
|
||
<td class="paramname"> <em>bkcolor</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Retrieves the file background color of an image.<p>
|
||
For 8-bit images, the color index in the palette is returned in the rgbReserved member of the bkcolor parameter. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetBackgroundColor </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="11bb882fe1552cc4e448af62ca5320e6"></a><!-- doxytag: member="fipImage::setFileBkColor" ref="11bb882fe1552cc4e448af62ca5320e6" args="(RGBQUAD *bkcolor)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::setFileBkColor </td>
|
||
<td>(</td>
|
||
<td class="paramtype">RGBQUAD * </td>
|
||
<td class="paramname"> <em>bkcolor</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Set the file background color of an image.<p>
|
||
When saving an image to PNG, this background color is transparently saved to the PNG file. When the bkcolor parameter is NULL, the background color is removed from the image. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_SetBackgroundColor </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="15ac5ab44a12cb0b2eb66d43b0b3b16f"></a><!-- doxytag: member="fipImage::getChannel" ref="15ac5ab44a12cb0b2eb66d43b0b3b16f" args="(fipImage &image, FREE_IMAGE_COLOR_CHANNEL channel) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::getChannel </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>image</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">FREE_IMAGE_COLOR_CHANNEL </td>
|
||
<td class="paramname"> <em>channel</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Retrieves the red, green, blue or alpha channel of a 24- or 32-bit BGR[A] image. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>Output image to be extracted </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>Color channel to extract </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetChannel, FREE_IMAGE_COLOR_CHANNEL </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="ed2ecec85dbe1af0223da310aa37e2f2"></a><!-- doxytag: member="fipImage::setChannel" ref="ed2ecec85dbe1af0223da310aa37e2f2" args="(fipImage &image, FREE_IMAGE_COLOR_CHANNEL channel)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::setChannel </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>image</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">FREE_IMAGE_COLOR_CHANNEL </td>
|
||
<td class="paramname"> <em>channel</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Insert a 8-bit dib into a 24- or 32-bit image. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>image</em> </td><td>Input 8-bit image to insert </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>Color channel to replace </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_SetChannel, FREE_IMAGE_COLOR_CHANNEL </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="1d6bb383a25ae46956bb5bf0ba301d12"></a><!-- doxytag: member="fipImage::splitChannels" ref="1d6bb383a25ae46956bb5bf0ba301d12" args="(fipImage &RedChannel, fipImage &GreenChannel, fipImage &BlueChannel)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::splitChannels </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>RedChannel</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>GreenChannel</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>BlueChannel</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Split a 24-bit RGB image into 3 greyscale images corresponding to the red, green and blue channels. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>RedChannel</em> </td><td>Output red channel. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>GreenChannel</em> </td><td>Output green channel. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>BlueChannel</em> </td><td>Output blue channel. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns FALSE if the dib isn't a valid image, if it's not a 24-bit image or if one of the output channel can't be allocated. Returns TRUE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetChannel </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="066e73d2f4a80924063459475202ee00"></a><!-- doxytag: member="fipImage::combineChannels" ref="066e73d2f4a80924063459475202ee00" args="(fipImage &red, fipImage &green, fipImage &blue)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::combineChannels </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>red</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>green</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classfipImage.html">fipImage</a> & </td>
|
||
<td class="paramname"> <em>blue</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Builds a 24-bit RGB image given its red, green and blue channel. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>red</em> </td><td>Input red channel. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>green</em> </td><td>Input green channel. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>blue</em> </td><td>Input blue channel. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns FALSE if the dib can't be allocated, if the input channels are not 8-bit images. Returns TRUE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_SetChannel </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="d68f361586bccc7dc026833eeb12c7a0"></a><!-- doxytag: member="fipImage::rotateEx" ref="d68f361586bccc7dc026833eeb12c7a0" args="(double angle, double x_shift, double y_shift, double x_origin, double y_origin, BOOL use_mask)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::rotateEx </td>
|
||
<td>(</td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>angle</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>x_shift</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>y_shift</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>x_origin</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>y_origin</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">BOOL </td>
|
||
<td class="paramname"> <em>use_mask</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Image translation and rotation using B-Splines.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>angle</em> </td><td>Image rotation angle, in degree </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>x_shift</em> </td><td>Image horizontal shift </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>y_shift</em> </td><td>Image vertical shift </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>x_origin</em> </td><td>Origin of the x-axis </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>y_origin</em> </td><td>Origin of the y-axis </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>use_mask</em> </td><td>Whether or not to mask the image. Image mirroring is applied when use_mask is set to FALSE </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the translated & rotated dib if successful, returns NULL otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_RotateEx </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="b1a073b88d1869693088a80b043af97f"></a><!-- doxytag: member="fipImage::rotate" ref="b1a073b88d1869693088a80b043af97f" args="(double angle, const void *bkcolor=NULL)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::rotate </td>
|
||
<td>(</td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>angle</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">const void * </td>
|
||
<td class="paramname"> <em>bkcolor</em> = <code>NULL</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Image rotation by means of three shears.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>angle</em> </td><td>Image rotation angle, in degree </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>bkcolor</em> </td><td>Background color (image type dependent), default to black background </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns rotated dib if successful, returns NULL otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Rotate </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="9725ac6dba57a9030f18e515bf13ab43"></a><!-- doxytag: member="fipImage::flipHorizontal" ref="9725ac6dba57a9030f18e515bf13ab43" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::flipHorizontal </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Flip the image horizontally along the vertical axis.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_FlipHorizontal </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="6527d38e2404f74fce4126959ef67993"></a><!-- doxytag: member="fipImage::flipVertical" ref="6527d38e2404f74fce4126959ef67993" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::flipVertical </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Flip the image vertically along the horizontal axis.
|
||
<p>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_FlipVertical </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="f1241c67380d3b5272be720b946162d0"></a><!-- doxytag: member="fipImage::invert" ref="f1241c67380d3b5272be720b946162d0" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::invert </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Inverts each pixel data.
|
||
<p>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if successful, FALSE otherwise. </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Invert </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="d288aae45d9aa00b9ebaf966735830f2"></a><!-- doxytag: member="fipImage::adjustCurve" ref="d288aae45d9aa00b9ebaf966735830f2" args="(BYTE *LUT, FREE_IMAGE_COLOR_CHANNEL channel)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::adjustCurve </td>
|
||
<td>(</td>
|
||
<td class="paramtype">BYTE * </td>
|
||
<td class="paramname"> <em>LUT</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">FREE_IMAGE_COLOR_CHANNEL </td>
|
||
<td class="paramname"> <em>channel</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Perfoms an histogram transformation on a 8, 24 or 32-bit image according to the values of a lookup table (LUT).<p>
|
||
The transformation is done as follows.<br>
|
||
Image 8-bit : if the image has a color palette, the LUT is applied to this palette, otherwise, it is applied to the grey values.<br>
|
||
Image 24-bit & 32-bit : if channel == IPL_CC_RGB, the same LUT is applied to each color plane (R,G, and B). Otherwise, the LUT is applied to the specified channel only. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>LUT</em> </td><td>Lookup table. <b>The size of 'LUT' is assumed to be 256.</b> </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>The color channel to be processed (only used with 24 & 32-bit DIB). </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if the operation was successful, FALSE otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_AdjustCurve, FREE_IMAGE_COLOR_CHANNEL </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="85ce1f32e823426bbab4f70e7864d792"></a><!-- doxytag: member="fipImage::adjustGamma" ref="85ce1f32e823426bbab4f70e7864d792" args="(double gamma)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::adjustGamma </td>
|
||
<td>(</td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>gamma</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Performs gamma correction on a 8, 24 or 32-bit image. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>gamma</em> </td><td>Gamma value to use. A value of 1.0 leaves the image alone, less than one darkens it, and greater than one lightens it. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if the operation was successful, FALSE otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_AdjustGamma, <a class="el" href="classfipImage.html#d288aae45d9aa00b9ebaf966735830f2">adjustCurve</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="d9284730c288ad864fff3bf7b2369405"></a><!-- doxytag: member="fipImage::adjustBrightness" ref="d9284730c288ad864fff3bf7b2369405" args="(double percentage)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::adjustBrightness </td>
|
||
<td>(</td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>percentage</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Adjusts the brightness of a 8, 24 or 32-bit image by a certain amount. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>percentage</em> </td><td>Where -100 <= percentage <= 100<br>
|
||
A value 0 means no change, less than 0 will make the image darker and greater than 0 will make the image brighter. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if the operation was succesful, FALSE otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_AdjustBrightness, <a class="el" href="classfipImage.html#d288aae45d9aa00b9ebaf966735830f2">adjustCurve</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="dc5282f2f1a1e482df337ab41f2bc20e"></a><!-- doxytag: member="fipImage::adjustContrast" ref="dc5282f2f1a1e482df337ab41f2bc20e" args="(double percentage)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::adjustContrast </td>
|
||
<td>(</td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>percentage</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Adjusts the contrast of a 8, 24 or 32-bit image by a certain amount. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>percentage</em> </td><td>Where -100 <= percentage <= 100<br>
|
||
A value 0 means no change, less than 0 will decrease the contrast and greater than 0 will increase the contrast of the image. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if the operation was succesfull, FALSE otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_AdjustContrast, <a class="el" href="classfipImage.html#d288aae45d9aa00b9ebaf966735830f2">adjustCurve</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="c21f36ed4ed0a4a2d22d115a9d3dcbe6"></a><!-- doxytag: member="fipImage::adjustBrightnessContrastGamma" ref="c21f36ed4ed0a4a2d22d115a9d3dcbe6" args="(double brightness, double contrast, double gamma)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::adjustBrightnessContrastGamma </td>
|
||
<td>(</td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>brightness</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>contrast</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">double </td>
|
||
<td class="paramname"> <em>gamma</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Adjusts an image's brightness, contrast and gamma within a single operation.
|
||
<p>
|
||
If more than one of these image display properties need to be adjusted, using this function should be preferred over calling each adjustment function separately. That's particularly true for huge images or if performance is an issue. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classfipImage.html#d9284730c288ad864fff3bf7b2369405">adjustBrightness</a> <p>
|
||
<a class="el" href="classfipImage.html#dc5282f2f1a1e482df337ab41f2bc20e">adjustContrast</a> <p>
|
||
<a class="el" href="classfipImage.html#85ce1f32e823426bbab4f70e7864d792">adjustGamma</a> <p>
|
||
FreeImage_AdjustColors </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="cf838e492f817278dab8273f498b180b"></a><!-- doxytag: member="fipImage::getHistogram" ref="cf838e492f817278dab8273f498b180b" args="(DWORD *histo, FREE_IMAGE_COLOR_CHANNEL channel=FICC_BLACK) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::getHistogram </td>
|
||
<td>(</td>
|
||
<td class="paramtype">DWORD * </td>
|
||
<td class="paramname"> <em>histo</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">FREE_IMAGE_COLOR_CHANNEL </td>
|
||
<td class="paramname"> <em>channel</em> = <code>FICC_BLACK</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Computes image histogram For 24-bit and 32-bit images, histogram can be computed from red, green, blue and black channels. For 8-bit images, histogram is computed from the black channel. Other bit depth is not supported. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>histo</em> </td><td>pointer to an histogram array. <b>Size of this array is assumed to be 256</b>. </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>Color channel to use </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if the operation was succesfull, FALSE otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetHistogram </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="2caf6e417ee503b9c5ab9c777beb605a"></a><!-- doxytag: member="fipImage::rescale" ref="2caf6e417ee503b9c5ab9c777beb605a" args="(unsigned new_width, unsigned new_height, FREE_IMAGE_FILTER filter)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::rescale </td>
|
||
<td>(</td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>new_width</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>new_height</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">FREE_IMAGE_FILTER </td>
|
||
<td class="paramname"> <em>filter</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Rescale the image to a new width / height.<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>new_width</em> </td><td>New image width </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>new_height</em> </td><td>New image height </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>filter</em> </td><td>The filter parameter specifies which resampling filter should be used. </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if the operation was successful, FALSE otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_Rescale, FREE_IMAGE_FILTER </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="0c387959b5f019c23efc665bf1c49777"></a><!-- doxytag: member="fipImage::makeThumbnail" ref="0c387959b5f019c23efc665bf1c49777" args="(unsigned max_size, BOOL convert=TRUE)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::makeThumbnail </td>
|
||
<td>(</td>
|
||
<td class="paramtype">unsigned </td>
|
||
<td class="paramname"> <em>max_size</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">BOOL </td>
|
||
<td class="paramname"> <em>convert</em> = <code>TRUE</code></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Creates a thumbnail image keeping aspect ratio <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>max_size</em> </td><td>Maximum width or height in pixel units </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>convert</em> </td><td>When set to TRUE, converts the image to a standard type </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if the operation was successful, FALSE otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_MakeThumbnail </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="ba130e654d1ab1dd02a2542ef67d2b79"></a><!-- doxytag: member="fipImage::setModified" ref="ba130e654d1ab1dd02a2542ef67d2b79" args="(BOOL bStatus=TRUE)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void fipImage::setModified </td>
|
||
<td>(</td>
|
||
<td class="paramtype">BOOL </td>
|
||
<td class="paramname"> <em>bStatus</em> = <code>TRUE</code> </td>
|
||
<td> ) </td>
|
||
<td width="100%"><code> [inline]</code></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Set the image status as 'modified'.
|
||
<p>
|
||
<br>
|
||
When using the <a class="el" href="classfipWinImage.html" title="A class designed for MS Windows (TM) platforms.">fipWinImage</a> class, the image status is used to refresh the display. It is changed to FALSE whenever the display has just been refreshed. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>bStatus</em> </td><td>TRUE if the image should be marked as modified, FALSE otherwise </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classfipImage.html#da47c4deb2ac04f7db9a2d109cc3dc53" title="Get the image status.">isModified</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="da47c4deb2ac04f7db9a2d109cc3dc53"></a><!-- doxytag: member="fipImage::isModified" ref="da47c4deb2ac04f7db9a2d109cc3dc53" args="()" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::isModified </td>
|
||
<td>(</td>
|
||
<td class="paramname"> </td>
|
||
<td> ) </td>
|
||
<td width="100%"><code> [inline]</code></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Get the image status.
|
||
<p>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if the image is marked as modified, FALSE otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classfipImage.html#ba130e654d1ab1dd02a2542ef67d2b79" title="Set the image status as 'modified'.">setModified</a> </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="b526caf5381b2ad3ffcfd43b210b9f4e"></a><!-- doxytag: member="fipImage::getMetadataCount" ref="b526caf5381b2ad3ffcfd43b210b9f4e" args="(FREE_IMAGE_MDMODEL model) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">unsigned fipImage::getMetadataCount </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_MDMODEL </td>
|
||
<td class="paramname"> <em>model</em> </td>
|
||
<td> ) </td>
|
||
<td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Returns the number of tags contained in the <em>model</em> metadata model attached to the dib.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>model</em> </td><td>Metadata model to look for </td></tr>
|
||
</table>
|
||
</dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="ff07bb198d0a7ea06e9814e9d6a69060"></a><!-- doxytag: member="fipImage::getMetadata" ref="ff07bb198d0a7ea06e9814e9d6a69060" args="(FREE_IMAGE_MDMODEL model, const char *key, fipTag &tag) const " -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::getMetadata </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_MDMODEL </td>
|
||
<td class="paramname"> <em>model</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">const char * </td>
|
||
<td class="paramname"> <em>key</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classfipTag.html">fipTag</a> & </td>
|
||
<td class="paramname"> <em>tag</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"> const</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Retrieve a metadata attached to the dib.
|
||
<p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>model</em> </td><td>Metadata model to look for </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Metadata field name </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>tag</em> </td><td>Returned tag </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if the operation was succesfull, FALSE otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_GetMetadata </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="c650631fa36917569d3f939cf7b1f3f7"></a><!-- doxytag: member="fipImage::setMetadata" ref="c650631fa36917569d3f939cf7b1f3f7" args="(FREE_IMAGE_MDMODEL model, const char *key, fipTag &tag)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL fipImage::setMetadata </td>
|
||
<td>(</td>
|
||
<td class="paramtype">FREE_IMAGE_MDMODEL </td>
|
||
<td class="paramname"> <em>model</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">const char * </td>
|
||
<td class="paramname"> <em>key</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype"><a class="el" href="classfipTag.html">fipTag</a> & </td>
|
||
<td class="paramname"> <em>tag</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td width="100%"></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Attach a new FreeImage tag to the dib.
|
||
<p>
|
||
<br>
|
||
<b>Sample use</b> : <br>
|
||
<pre>
|
||
<a class="el" href="classfipImage.html" title="A class used to manage all photo related images and all image types used by the library...">fipImage</a> image;
|
||
...
|
||
<a class="el" href="classfipTag.html" title="FreeImage Tag.">fipTag</a> tag;
|
||
tag.setKeyValue("Caption/Abstract", "my caption");
|
||
image.setMetadata(FIMD_IPTC, tag.getKey(), tag);
|
||
tag.setKeyValue("Keywords", "FreeImage;Library;Images;Compression");
|
||
image.setMetadata(FIMD_IPTC, tag.getKey(), tag);
|
||
</pre><p>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>model</em> </td><td>Metadata model used to store the tag </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Tag field name </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>tag</em> </td><td>Tag to be attached </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns TRUE if the operation was succesfull, FALSE otherwise </dd></dl>
|
||
<dl class="see" compact><dt><b>See also:</b></dt><dd>FreeImage_SetMetadata </dd></dl>
|
||
|
||
</div>
|
||
</div><p>
|
||
<hr><h2>Member Data Documentation</h2>
|
||
<a class="anchor" name="04850fb0a78de2c70a8e0aed65dd8972"></a><!-- doxytag: member="fipImage::_dib" ref="04850fb0a78de2c70a8e0aed65dd8972" args="" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">FIBITMAP* <a class="el" href="classfipImage.html#04850fb0a78de2c70a8e0aed65dd8972">fipImage::_dib</a><code> [protected]</code> </td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
DIB data.
|
||
<p>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="c2a0b52b57c2d9675fbd804083800727"></a><!-- doxytag: member="fipImage::_fif" ref="c2a0b52b57c2d9675fbd804083800727" args="" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">FREE_IMAGE_FORMAT <a class="el" href="classfipImage.html#c2a0b52b57c2d9675fbd804083800727">fipImage::_fif</a><code> [protected]</code> </td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Original (or last saved) fif format if available, FIF_UNKNOWN otherwise.
|
||
<p>
|
||
|
||
</div>
|
||
</div><p>
|
||
<a class="anchor" name="a43ecddf8f66db4d9008c85e3c8df9f9"></a><!-- doxytag: member="fipImage::_bHasChanged" ref="a43ecddf8f66db4d9008c85e3c8df9f9" args="" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">BOOL <a class="el" href="classfipImage.html#a43ecddf8f66db4d9008c85e3c8df9f9">fipImage::_bHasChanged</a><code> [mutable, protected]</code> </td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
TRUE whenever the display need to be refreshed.
|
||
<p>
|
||
|
||
</div>
|
||
</div><p>
|
||
<hr>The documentation for this class was generated from the following file:<ul>
|
||
<li><a class="el" href="FreeImagePlus_8h-source.html">FreeImagePlus.h</a></ul>
|
||
<hr>
|
||
<p align="right">
|
||
<img src="freeimage.png"><br>
|
||
</p>
|
||
</BODY>
|
||
</HTML>
|
||
|