<!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: csGLScreenShot 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>csGLScreenShot Class Reference<br> <small> [<a class="el" href="group__plugincommon.html">Common Plugin Classes</a>]</small> </h1><!-- doxytag: class="csGLScreenShot" --><!-- doxytag: inherits="scfImplementationExt0< csGLScreenShot, csImageBase >" -->OpenGL screen shot. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="glss_8h-source.html">csplugincommon/opengl/glss.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for csGLScreenShot:</div> <div class="dynsection"> <p><center><img src="classcsGLScreenShot__inherit__graph.png" border="0" usemap="#csGLScreenShot__inherit__map" alt="Inheritance graph"></center> <map name="csGLScreenShot__inherit__map"> <area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csGLScreenShot, csImageBase \>" alt="" coords="24,316,429,343"><area shape="rect" href="classcsImageBase.html" title="Base class for iImage implementations." alt="" coords="173,239,280,265"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csImageBase, iImage \>" alt="" coords="68,161,385,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csImageBase \>" alt="" coords="5,84,264,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="280,7,336,33"><area shape="rect" href="structiImage.html" title="The iImage interface is used to work with image objects." alt="" coords="288,84,352,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="24,7,245,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classcsGLScreenShot-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGLScreenShot.html#2c5acf7325aaa74f89ef9cd3f9af22e7">DecRef</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Decrement the reference count. <a href="#2c5acf7325aaa74f89ef9cd3f9af22e7"></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="classcsGLScreenShot.html#76965a2695b8855283dec646377771da">GetFormat</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Qyery image format (see CS_IMGFMT_XXX above). <a href="#76965a2695b8855283dec646377771da"></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="classcsGLScreenShot.html#524cbe56c8437ba44601faedf51881f9">GetHeight</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Query image height. <a href="#524cbe56c8437ba44601faedf51881f9"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGLScreenShot.html#45e05911e47d2c1b6bb3f60aefb41ac3">GetImageData</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get image data: returns either (<a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> *) or (unsigned char *) depending on format. <a href="#45e05911e47d2c1b6bb3f60aefb41ac3"></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="classcsGLScreenShot.html#21c1660dc928935c88246f576ad73755">GetWidth</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Query image width. <a href="#21c1660dc928935c88246f576ad73755"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGLScreenShot.html#d56814b513b2217658ab8143c203c3c2">IncRef</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Increment the number of references to this object. <a href="#d56814b513b2217658ab8143c203c3c2"></a><br></td></tr> <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="475a8bd78a1266da0faedb4fdf5c98dc"></a><!-- doxytag: member="csGLScreenShot::poolNext" ref="475a8bd78a1266da0faedb4fdf5c98dc" args="" --> <a class="el" href="classcsGLScreenShot.html">csGLScreenShot</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGLScreenShot.html#475a8bd78a1266da0faedb4fdf5c98dc">poolNext</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> OpenGL screen shot. <p>Definition at line <a class="el" href="glss_8h-source.html#l00039">39</a> of file <a class="el" href="glss_8h-source.html">glss.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="2c5acf7325aaa74f89ef9cd3f9af22e7"></a><!-- doxytag: member="csGLScreenShot::DecRef" ref="2c5acf7325aaa74f89ef9cd3f9af22e7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csGLScreenShot::DecRef </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Decrement the reference count. <p> <p>Reimplemented from <a class="el" href="classscfImplementation.html#9b996efbd8891c74a46f2c6705b56f89">scfImplementation< csImageBase ></a>.</p> </div> </div><p> <a class="anchor" name="76965a2695b8855283dec646377771da"></a><!-- doxytag: member="csGLScreenShot::GetFormat" ref="76965a2695b8855283dec646377771da" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int csGLScreenShot::GetFormat </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Qyery image format (see CS_IMGFMT_XXX above). <p> <p>Implements <a class="el" href="structiImage.html#dcfcf95222b2f49662efaf5aca8033c8">iImage</a>.</p> <p>Definition at line <a class="el" href="glss_8h-source.html#l00060">60</a> of file <a class="el" href="glss_8h-source.html">glss.h</a>.</p> </div> </div><p> <a class="anchor" name="524cbe56c8437ba44601faedf51881f9"></a><!-- doxytag: member="csGLScreenShot::GetHeight" ref="524cbe56c8437ba44601faedf51881f9" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int csGLScreenShot::GetHeight </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Query image height. <p> <p>Implements <a class="el" href="structiImage.html#31a45f12e47bbdca9754117200ce9658">iImage</a>.</p> <p>Definition at line <a class="el" href="glss_8h-source.html#l00058">58</a> of file <a class="el" href="glss_8h-source.html">glss.h</a>.</p> </div> </div><p> <a class="anchor" name="45e05911e47d2c1b6bb3f60aefb41ac3"></a><!-- doxytag: member="csGLScreenShot::GetImageData" ref="45e05911e47d2c1b6bb3f60aefb41ac3" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const void* csGLScreenShot::GetImageData </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get image data: returns either (<a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> *) or (unsigned char *) depending on format. <p> Note that for RGBA images the <a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> structure contains the alpha channel as well, so GetAlpha (see below) method will return 0 (because alpha is not stored separately, as for paletted images). <p>Implements <a class="el" href="structiImage.html#c6ef621537753b4409a003b126d3122c">iImage</a>.</p> <p>Definition at line <a class="el" href="glss_8h-source.html#l00054">54</a> of file <a class="el" href="glss_8h-source.html">glss.h</a>.</p> </div> </div><p> <a class="anchor" name="21c1660dc928935c88246f576ad73755"></a><!-- doxytag: member="csGLScreenShot::GetWidth" ref="21c1660dc928935c88246f576ad73755" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int csGLScreenShot::GetWidth </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Query image width. <p> <p>Implements <a class="el" href="structiImage.html#e46445da6aa7836ce65a1181b9125835">iImage</a>.</p> <p>Definition at line <a class="el" href="glss_8h-source.html#l00056">56</a> of file <a class="el" href="glss_8h-source.html">glss.h</a>.</p> </div> </div><p> <a class="anchor" name="d56814b513b2217658ab8143c203c3c2"></a><!-- doxytag: member="csGLScreenShot::IncRef" ref="d56814b513b2217658ab8143c203c3c2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csGLScreenShot::IncRef </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Increment the number of references to this object. <p> <p>Reimplemented from <a class="el" href="classscfImplementation.html#821518e0247da63ba7c6e60fc98dce19">scfImplementation< csImageBase ></a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>csplugincommon/opengl/<a class="el" href="glss_8h-source.html">glss.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>