Google Git
Sign in
android / toolchain / benchmark / cf0d0c0f34d9ee654c667b5701aad52f840f1bf9 / . / cximage / src / doc / doxy / html / group___encode.html
blob: 7b2cadc0203cef314fd8ed880c2beacea9264e2f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CxImage: Encode</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.8 -->
<div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
<h1>Encode</h1><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group___encode.html#ga5">CxImage::Encode</a> (BYTE *&amp;buffer, long &amp;size, DWORD imagetype)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group___encode.html#ga4">CxImage::Encode</a> (FILE *hFile, <a class="el" href="class_cx_image.html">CxImage</a> **pImages, int pagecount, DWORD imagetype)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group___encode.html#ga3">CxImage::Encode</a> (CxFile *hFile, <a class="el" href="class_cx_image.html">CxImage</a> **pImages, int pagecount, DWORD imagetype)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group___encode.html#ga2">CxImage::Encode</a> (CxFile *hFile, DWORD imagetype)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group___encode.html#ga1">CxImage::Encode</a> (FILE *hFile, DWORD imagetype)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group___encode.html#ga7">CxImage::Encode2RGBA</a> (BYTE *&amp;buffer, long &amp;size)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group___encode.html#ga6">CxImage::Encode2RGBA</a> (CxFile *hFile)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group___encode.html#ga0">CxImage::Save</a> (const TCHAR *filename, DWORD imagetype)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ga5" doxytag="CxImage::Encode" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool CxImage::Encode </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">BYTE *&amp;&nbsp;</td>
<td class="mdname" nowrap> <em>buffer</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>long &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>size</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>DWORD&nbsp;</td>
<td class="mdname" nowrap> <em>imagetype</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Saves to memory buffer the image in a specific format. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>buffer:</em>&nbsp;</td><td>output memory buffer pointer. Must be NULL, the function allocates and fill the memory, the application must free the buffer, see also <a class="el" href="group___initialization.html#ga7">FreeMemory()</a>. </td></tr>
<tr><td></td><td valign=top><em>size:</em>&nbsp;</td><td>output memory buffer size. </td></tr>
<tr><td></td><td valign=top><em>imagetype:</em>&nbsp;</td><td>file format, see ENUM_CXIMAGE_FORMATS </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if everything is ok </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga4" doxytag="CxImage::Encode" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool CxImage::Encode </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">FILE *&nbsp;</td>
<td class="mdname" nowrap> <em>hFile</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="class_cx_image.html">CxImage</a> **&nbsp;</td>
<td class="mdname" nowrap> <em>pImages</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>pagecount</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>DWORD&nbsp;</td>
<td class="mdname" nowrap> <em>imagetype</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Saves to disk or memory pagecount images, referenced by an array of CxImage pointers. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>hFile:</em>&nbsp;</td><td>file handle. </td></tr>
<tr><td></td><td valign=top><em>pImages:</em>&nbsp;</td><td>array of CxImage pointers. </td></tr>
<tr><td></td><td valign=top><em>pagecount:</em>&nbsp;</td><td>number of images. </td></tr>
<tr><td></td><td valign=top><em>imagetype:</em>&nbsp;</td><td>can be CXIMAGE_FORMAT_TIF or CXIMAGE_FORMAT_GIF. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if everything is ok </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga3" doxytag="CxImage::Encode" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool CxImage::Encode </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">CxFile *&nbsp;</td>
<td class="mdname" nowrap> <em>hFile</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="class_cx_image.html">CxImage</a> **&nbsp;</td>
<td class="mdname" nowrap> <em>pImages</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>pagecount</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>DWORD&nbsp;</td>
<td class="mdname" nowrap> <em>imagetype</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Saves to disk or memory pagecount images, referenced by an array of CxImage pointers. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>hFile:</em>&nbsp;</td><td>file handle (implemented using CxMemFile or CxIOFile). </td></tr>
<tr><td></td><td valign=top><em>pImages:</em>&nbsp;</td><td>array of CxImage pointers. </td></tr>
<tr><td></td><td valign=top><em>pagecount:</em>&nbsp;</td><td>number of images. </td></tr>
<tr><td></td><td valign=top><em>imagetype:</em>&nbsp;</td><td>can be CXIMAGE_FORMAT_TIF or CXIMAGE_FORMAT_GIF. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if everything is ok </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga2" doxytag="CxImage::Encode" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool CxImage::Encode </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">CxFile *&nbsp;</td>
<td class="mdname" nowrap> <em>hFile</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>DWORD&nbsp;</td>
<td class="mdname" nowrap> <em>imagetype</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Saves to disk the image in a specific format. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>hFile:</em>&nbsp;</td><td>file handle (implemented using CxMemFile or CxIOFile), open and enabled for writing. </td></tr>
<tr><td></td><td valign=top><em>imagetype:</em>&nbsp;</td><td>file format, see ENUM_CXIMAGE_FORMATS </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if everything is ok </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="ximage_8h.html#a18">ENUM_CXIMAGE_FORMATS</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga1" doxytag="CxImage::Encode" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool CxImage::Encode </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">FILE *&nbsp;</td>
<td class="mdname" nowrap> <em>hFile</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>DWORD&nbsp;</td>
<td class="mdname" nowrap> <em>imagetype</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Saves to disk the image in a specific format. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>hFile:</em>&nbsp;</td><td>file handle, open and enabled for writing. </td></tr>
<tr><td></td><td valign=top><em>imagetype:</em>&nbsp;</td><td>file format, see ENUM_CXIMAGE_FORMATS </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if everything is ok </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga7" doxytag="CxImage::Encode2RGBA" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool CxImage::Encode2RGBA </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">BYTE *&amp;&nbsp;</td>
<td class="mdname" nowrap> <em>buffer</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>long &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>size</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
exports the image into a RGBA buffer, Useful for OpenGL applications. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>buffer:</em>&nbsp;</td><td>output memory buffer pointer. Must be NULL, the function allocates and fill the memory, the application must free the buffer, see also <a class="el" href="group___initialization.html#ga7">FreeMemory()</a>. </td></tr>
<tr><td></td><td valign=top><em>size:</em>&nbsp;</td><td>output memory buffer size. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if everything is ok </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga6" doxytag="CxImage::Encode2RGBA" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool CxImage::Encode2RGBA </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">CxFile *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>hFile</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
exports the image into a RGBA buffer, Useful for OpenGL applications. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>hFile:</em>&nbsp;</td><td>file handle (implemented using CxMemFile or CxIOFile). </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if everything is ok </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga0" doxytag="CxImage::Save" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool CxImage::Save </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const TCHAR *&nbsp;</td>
<td class="mdname" nowrap> <em>filename</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>DWORD&nbsp;</td>
<td class="mdname" nowrap> <em>imagetype</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Saves to disk the image in a specific format. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>filename:</em>&nbsp;</td><td>file name </td></tr>
<tr><td></td><td valign=top><em>imagetype:</em>&nbsp;</td><td>file format, see ENUM_CXIMAGE_FORMATS </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if everything is ok </dd></dl>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Mon Oct 11 22:30:18 2004 for CxImage by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>