<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: csSimplePixmap Class Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</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> <li><a href="pages.html"><span>Related Pages</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>csSimplePixmap Class Reference</h1><!-- doxytag: class="csSimplePixmap" --><!-- doxytag: inherits="csPixmap" -->This is the simple implementation of <a class="el" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a> that uses a single texture. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="cspixmap_8h-source.html">cstool/cspixmap.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for csSimplePixmap:</div> <div class="dynsection"> <p><center><img src="classcsSimplePixmap__inherit__graph.png" border="0" usemap="#csSimplePixmap__inherit__map" alt="Inheritance graph"></center> <map name="csSimplePixmap__inherit__map"> <area shape="rect" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple..." alt="" coords="28,7,111,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classcsSimplePixmap-members.html">List of all members.</a><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 class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#6eca6af461604c09a441649ab7bb8a18">Advance</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">advance in time <a href="#6eca6af461604c09a441649ab7bb8a18"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#46e187c986d9cc3feb66296bbc1d7964">csSimplePixmap</a> (<a class="el" href="structiTextureHandle.html">iTextureHandle</a> *hTexture, int x, int y, int w, int h)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the pixmap from a texture with given rectangle. <a href="#46e187c986d9cc3feb66296bbc1d7964"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#21c47d4f5c6be7cb574090277dd03fec">csSimplePixmap</a> (<a class="el" href="structiTextureHandle.html">iTextureHandle</a> *hTexture)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the pixmap from a texture. <a href="#21c47d4f5c6be7cb574090277dd03fec"></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="classcsSimplePixmap.html#3683a5f222d877ac3194088fad36d11d">DrawScaled</a> (<a class="el" href="structiGraphics3D.html">iGraphics3D</a> *g3d, int sx, int sy, int sw, int sh, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> Alpha=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Draw the pixmap given the screen position and new size. <a href="#3683a5f222d877ac3194088fad36d11d"></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="classcsSimplePixmap.html#5a9bc67122e2425c5c3ac0e7c4d8ad25">DrawTiled</a> (<a class="el" href="structiGraphics3D.html">iGraphics3D</a> *g3d, int sx, int sy, int sw, int sh, int orgx, int orgy, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> Alpha=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Draw the pixmap tiled over an area. <a href="#5a9bc67122e2425c5c3ac0e7c4d8ad25"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiTextureHandle.html">iTextureHandle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#d1b20207ac7a56631b7d21e10a93cfdc">GetTextureHandle</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return current texture handle <a href="#d1b20207ac7a56631b7d21e10a93cfdc"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#a4bde154381287a1b9f3d7d93f68affe">Height</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return current height of this pixmap <a href="#a4bde154381287a1b9f3d7d93f68affe"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#6130811387b782d0f04113aa2519c838">SetTextureHandle</a> (<a class="el" href="structiTextureHandle.html">iTextureHandle</a> *hTexture)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Change pixmap texture handle. <a href="#6130811387b782d0f04113aa2519c838"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#7cdeed3377b5a47c4203bcb120118611">SetTextureRectangle</a> (int x, int y, int w, int h)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set new location of pixmap image on texture. <a href="#7cdeed3377b5a47c4203bcb120118611"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#8ababd40e9fdf6cba7ecab8726f5842f">Width</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return current width of this pixmap <a href="#8ababd40e9fdf6cba7ecab8726f5842f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#6555cfe902f9e033481c1639b6fd5690">~csSimplePixmap</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Deinitialize the pixmap. <a href="#6555cfe902f9e033481c1639b6fd5690"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4aaaabb841125a5517b42f18f5f27ac9"></a><!-- doxytag: member="csSimplePixmap::hTex" ref="4aaaabb841125a5517b42f18f5f27ac9" args="" --> <a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiTextureHandle.html">iTextureHandle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#4aaaabb841125a5517b42f18f5f27ac9">hTex</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6245d3754555b800e5ef80be890f4857"></a><!-- doxytag: member="csSimplePixmap::th" ref="6245d3754555b800e5ef80be890f4857" args="" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#6245d3754555b800e5ef80be890f4857">th</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="64913b8bbfae931e57e0b6c39550ddeb"></a><!-- doxytag: member="csSimplePixmap::tw" ref="64913b8bbfae931e57e0b6c39550ddeb" args="" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#64913b8bbfae931e57e0b6c39550ddeb">tw</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6cd3d3c952ed408c859e8cc7ecc1ca29"></a><!-- doxytag: member="csSimplePixmap::tx" ref="6cd3d3c952ed408c859e8cc7ecc1ca29" args="" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#6cd3d3c952ed408c859e8cc7ecc1ca29">tx</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d655f3b3b6c928616afe8cb4d4492f75"></a><!-- doxytag: member="csSimplePixmap::ty" ref="d655f3b3b6c928616afe8cb4d4492f75" args="" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSimplePixmap.html#d655f3b3b6c928616afe8cb4d4492f75">ty</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> This is the simple implementation of <a class="el" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a> that uses a single texture. <p>Definition at line <a class="el" href="cspixmap_8h-source.html#l00086">86</a> of file <a class="el" href="cspixmap_8h-source.html">cspixmap.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="21c47d4f5c6be7cb574090277dd03fec"></a><!-- doxytag: member="csSimplePixmap::csSimplePixmap" ref="21c47d4f5c6be7cb574090277dd03fec" args="(iTextureHandle *hTexture)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csSimplePixmap::csSimplePixmap </td> <td>(</td> <td class="paramtype"><a class="el" href="structiTextureHandle.html">iTextureHandle</a> * </td> <td class="paramname"> <em>hTexture</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Initialize the pixmap from a texture. <p> </div> </div><p> <a class="anchor" name="46e187c986d9cc3feb66296bbc1d7964"></a><!-- doxytag: member="csSimplePixmap::csSimplePixmap" ref="46e187c986d9cc3feb66296bbc1d7964" args="(iTextureHandle *hTexture, int x, int y, int w, int h)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csSimplePixmap::csSimplePixmap </td> <td>(</td> <td class="paramtype"><a class="el" href="structiTextureHandle.html">iTextureHandle</a> * </td> <td class="paramname"> <em>hTexture</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>x</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>y</em>, </td> </tr> <tr> <td class="paramkey"></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 width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Initialize the pixmap from a texture with given rectangle. <p> </div> </div><p> <a class="anchor" name="6555cfe902f9e033481c1639b6fd5690"></a><!-- doxytag: member="csSimplePixmap::~csSimplePixmap" ref="6555cfe902f9e033481c1639b6fd5690" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual csSimplePixmap::~csSimplePixmap </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Deinitialize the pixmap. <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="6eca6af461604c09a441649ab7bb8a18"></a><!-- doxytag: member="csSimplePixmap::Advance" ref="6eca6af461604c09a441649ab7bb8a18" args="(csTicks)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void csSimplePixmap::Advance </td> <td>(</td> <td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td> <td class="paramname"> <em>ElapsedTime</em> </td> <td> ) </td> <td width="100%"><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> advance in time <p> <p>Implements <a class="el" href="classcsPixmap.html#4320d55b7a6541c2520a64511df3ce0e">csPixmap</a>.</p> <p>Definition at line <a class="el" href="cspixmap_8h-source.html#l00113">113</a> of file <a class="el" href="cspixmap_8h-source.html">cspixmap.h</a>.</p> </div> </div><p> <a class="anchor" name="3683a5f222d877ac3194088fad36d11d"></a><!-- doxytag: member="csSimplePixmap::DrawScaled" ref="3683a5f222d877ac3194088fad36d11d" args="(iGraphics3D *g3d, int sx, int sy, int sw, int sh, uint8 Alpha=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void csSimplePixmap::DrawScaled </td> <td>(</td> <td class="paramtype"><a class="el" href="structiGraphics3D.html">iGraphics3D</a> * </td> <td class="paramname"> <em>g3d</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>sx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>sy</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>sw</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>sh</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> </td> <td class="paramname"> <em>Alpha</em> = <code>0</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Draw the pixmap given the screen position and new size. <p> <p>Implements <a class="el" href="classcsPixmap.html#c51483cf186f7cb94700edbbcb8c77fe">csPixmap</a>.</p> </div> </div><p> <a class="anchor" name="5a9bc67122e2425c5c3ac0e7c4d8ad25"></a><!-- doxytag: member="csSimplePixmap::DrawTiled" ref="5a9bc67122e2425c5c3ac0e7c4d8ad25" args="(iGraphics3D *g3d, int sx, int sy, int sw, int sh, int orgx, int orgy, uint8 Alpha=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void csSimplePixmap::DrawTiled </td> <td>(</td> <td class="paramtype"><a class="el" href="structiGraphics3D.html">iGraphics3D</a> * </td> <td class="paramname"> <em>g3d</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>sx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>sy</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>sw</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>sh</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>orgx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>orgy</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> </td> <td class="paramname"> <em>Alpha</em> = <code>0</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Draw the pixmap tiled over an area. <p> multiple draw commands with the same texture and same origin values will align properly. The orgx and orgy point to a pixel (perhaps offscreen) where the (0,0) pixel of this pixmap would be drawn. <p>Implements <a class="el" href="classcsPixmap.html#18bafca32fff1ca7270db8da54d8dee0">csPixmap</a>.</p> </div> </div><p> <a class="anchor" name="d1b20207ac7a56631b7d21e10a93cfdc"></a><!-- doxytag: member="csSimplePixmap::GetTextureHandle" ref="d1b20207ac7a56631b7d21e10a93cfdc" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="structiTextureHandle.html">iTextureHandle</a>* csSimplePixmap::GetTextureHandle </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> return current texture handle <p> <p>Implements <a class="el" href="classcsPixmap.html#fb18943f75e61dda86a73b0b5b52ebf9">csPixmap</a>.</p> </div> </div><p> <a class="anchor" name="a4bde154381287a1b9f3d7d93f68affe"></a><!-- doxytag: member="csSimplePixmap::Height" ref="a4bde154381287a1b9f3d7d93f68affe" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int csSimplePixmap::Height </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> return current height of this pixmap <p> <p>Implements <a class="el" href="classcsPixmap.html#adf2b381eab0d686b80bf2576fd4d3fa">csPixmap</a>.</p> </div> </div><p> <a class="anchor" name="6130811387b782d0f04113aa2519c838"></a><!-- doxytag: member="csSimplePixmap::SetTextureHandle" ref="6130811387b782d0f04113aa2519c838" args="(iTextureHandle *hTexture)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csSimplePixmap::SetTextureHandle </td> <td>(</td> <td class="paramtype"><a class="el" href="structiTextureHandle.html">iTextureHandle</a> * </td> <td class="paramname"> <em>hTexture</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Change pixmap texture handle. <p> </div> </div><p> <a class="anchor" name="7cdeed3377b5a47c4203bcb120118611"></a><!-- doxytag: member="csSimplePixmap::SetTextureRectangle" ref="7cdeed3377b5a47c4203bcb120118611" args="(int x, int y, int w, int h)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csSimplePixmap::SetTextureRectangle </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>x</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>y</em>, </td> </tr> <tr> <td class="paramkey"></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 width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set new location of pixmap image on texture. <p> <p>Definition at line <a class="el" href="cspixmap_8h-source.html#l00103">103</a> of file <a class="el" href="cspixmap_8h-source.html">cspixmap.h</a>.</p> </div> </div><p> <a class="anchor" name="8ababd40e9fdf6cba7ecab8726f5842f"></a><!-- doxytag: member="csSimplePixmap::Width" ref="8ababd40e9fdf6cba7ecab8726f5842f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int csSimplePixmap::Width </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> return current width of this pixmap <p> <p>Implements <a class="el" href="classcsPixmap.html#eca74d9a08f365f7d0d91a7416413be6">csPixmap</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>cstool/<a class="el" href="cspixmap_8h-source.html">cspixmap.h</a></ul> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>