<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>FTGL: FTBuffer Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2-20100208 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div> <div class="contents"> <h1>FTBuffer Class Reference</h1><!-- doxytag: class="FTBuffer" --> <p><a class="el" href="classFTBuffer.html" title="FTBuffer is a helper class for pixel buffers.">FTBuffer</a> is a helper class for pixel buffers. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="FTBuffer_8h_source.html">FTBuffer.h</a>></code></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTBuffer.html#a424fd4161942b61338e72dbe5c4ff74a">FTBuffer</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a424fd4161942b61338e72dbe5c4ff74a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTBuffer.html#a26cbf457816ec8ea07cbc207c10281c6">~FTBuffer</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a26cbf457816ec8ea07cbc207c10281c6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classFTPoint.html">FTPoint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTBuffer.html#a5b5dedc85576f519bd804bb0e8a6b8a0">Pos</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the pen's position in the buffer. <a href="#a5b5dedc85576f519bd804bb0e8a6b8a0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTBuffer.html#a97ae51522466bfa08a719f439e0059a0">Pos</a> (<a class="el" href="classFTPoint.html">FTPoint</a> arg)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the pen's position in the buffer. <a href="#a97ae51522466bfa08a719f439e0059a0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTBuffer.html#a8b37679226ffbaa187236d7c371efcec">Size</a> (int w, int h)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the buffer's size. <a href="#a8b37679226ffbaa187236d7c371efcec"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTBuffer.html#a19cfff5527c3e04ec59f0cfa295d6abe">Width</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer's width. <a href="#a19cfff5527c3e04ec59f0cfa295d6abe"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTBuffer.html#a97c058c883b1b6d25242964a025faf0f">Height</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer's height. <a href="#a97c058c883b1b6d25242964a025faf0f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFTBuffer.html#a394321c98ce6bc4f016337cb1e9237fb">Pixels</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer's direct pixel buffer. <a href="#a394321c98ce6bc4f016337cb1e9237fb"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p><a class="el" href="classFTBuffer.html" title="FTBuffer is a helper class for pixel buffers.">FTBuffer</a> is a helper class for pixel buffers. </p> <p>It provides the interface between <a class="el" href="classFTBufferFont.html" title="FTBufferFont is a specialisation of the FTFont class for handling memory buffer fonts...">FTBufferFont</a> and <a class="el" href="classFTBufferGlyph.html" title="FTBufferGlyph is a specialisation of FTGlyph for memory buffer rendering.">FTBufferGlyph</a> to optimise rendering operations.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classFTBufferGlyph.html" title="FTBufferGlyph is a specialisation of FTGlyph for memory buffer rendering.">FTBufferGlyph</a> </dd> <dd> <a class="el" href="classFTBufferFont.html" title="FTBufferFont is a specialisation of the FTFont class for handling memory buffer fonts...">FTBufferFont</a> </dd></dl> <p>Definition at line <a class="el" href="FTBuffer_8h_source.html#l00045">45</a> of file <a class="el" href="FTBuffer_8h_source.html">FTBuffer.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a424fd4161942b61338e72dbe5c4ff74a"></a><!-- doxytag: member="FTBuffer::FTBuffer" ref="a424fd4161942b61338e72dbe5c4ff74a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">FTBuffer::FTBuffer </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Default constructor. </p> </div> </div> <a class="anchor" id="a26cbf457816ec8ea07cbc207c10281c6"></a><!-- doxytag: member="FTBuffer::~FTBuffer" ref="a26cbf457816ec8ea07cbc207c10281c6" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">FTBuffer::~FTBuffer </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Destructor. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a97c058c883b1b6d25242964a025faf0f"></a><!-- doxytag: member="FTBuffer::Height" ref="a97c058c883b1b6d25242964a025faf0f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int FTBuffer::Height </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the buffer's height. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The buffer's height, in pixels. </dd></dl> <p>Definition at line <a class="el" href="FTBuffer_8h_source.html#l00098">98</a> of file <a class="el" href="FTBuffer_8h_source.html">FTBuffer.h</a>.</p> </div> </div> <a class="anchor" id="a394321c98ce6bc4f016337cb1e9237fb"></a><!-- doxytag: member="FTBuffer::Pixels" ref="a394321c98ce6bc4f016337cb1e9237fb" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned char* FTBuffer::Pixels </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the buffer's direct pixel buffer. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A read-write pointer to the buffer's pixels. </dd></dl> <p>Definition at line <a class="el" href="FTBuffer_8h_source.html#l00105">105</a> of file <a class="el" href="FTBuffer_8h_source.html">FTBuffer.h</a>.</p> </div> </div> <a class="anchor" id="a97ae51522466bfa08a719f439e0059a0"></a><!-- doxytag: member="FTBuffer::Pos" ref="a97ae51522466bfa08a719f439e0059a0" args="(FTPoint arg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void FTBuffer::Pos </td> <td>(</td> <td class="paramtype"><a class="el" href="classFTPoint.html">FTPoint</a> </td> <td class="paramname"> <em>arg</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Set the pen's position in the buffer. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>arg</em> </td><td>An <a class="el" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a> object with the desired pen's position. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="FTBuffer_8h_source.html#l00073">73</a> of file <a class="el" href="FTBuffer_8h_source.html">FTBuffer.h</a>.</p> </div> </div> <a class="anchor" id="a5b5dedc85576f519bd804bb0e8a6b8a0"></a><!-- doxytag: member="FTBuffer::Pos" ref="a5b5dedc85576f519bd804bb0e8a6b8a0" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classFTPoint.html">FTPoint</a> FTBuffer::Pos </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the pen's position in the buffer. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The pen's position as an <a class="el" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a> object. </dd></dl> <p>Definition at line <a class="el" href="FTBuffer_8h_source.html#l00063">63</a> of file <a class="el" href="FTBuffer_8h_source.html">FTBuffer.h</a>.</p> </div> </div> <a class="anchor" id="a8b37679226ffbaa187236d7c371efcec"></a><!-- doxytag: member="FTBuffer::Size" ref="a8b37679226ffbaa187236d7c371efcec" args="(int w, int h)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void FTBuffer::Size </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>w</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>h</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Set the buffer's size. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>w</em> </td><td>The buffer's desired width, in pixels. </td></tr> <tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>The buffer's desired height, in pixels. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a19cfff5527c3e04ec59f0cfa295d6abe"></a><!-- doxytag: member="FTBuffer::Width" ref="a19cfff5527c3e04ec59f0cfa295d6abe" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int FTBuffer::Width </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the buffer's width. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The buffer's width, in pixels. </dd></dl> <p>Definition at line <a class="el" href="FTBuffer_8h_source.html#l00091">91</a> of file <a class="el" href="FTBuffer_8h_source.html">FTBuffer.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="FTBuffer_8h_source.html">FTBuffer.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address> </body> </html>