<!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: csScreenShot 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>csScreenShot Class Reference<br>
<small>
[<a class="el" href="group__plugincommon.html">Common Plugin Classes</a>]</small>
</h1><!-- doxytag: class="csScreenShot" --><!-- doxytag: inherits="scfImplementationExt0< csScreenShot, csImageBase >" -->Simple <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> implementation for canvas screenshots.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="scrshot_8h-source.html">csplugincommon/canvas/scrshot.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csScreenShot:</div>
<div class="dynsection">
<p><center><img src="classcsScreenShot__inherit__graph.png" border="0" usemap="#csScreenShot__inherit__map" alt="Inheritance graph"></center>
<map name="csScreenShot__inherit__map">
<area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csScreenShot, csImageBase \>" alt="" coords="33,316,420,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="classcsScreenShot-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsScreenShot.html#ca5de54cd2dd6fc4e67c69ba36f7af35">csScreenShot</a> (<a class="el" href="structiGraphics2D.html">iGraphics2D</a> *G2D)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the screenshot object. <a href="#ca5de54cd2dd6fc4e67c69ba36f7af35"></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="classcsScreenShot.html#be90677cea0bd304532685904d0b92fb">GetFormat</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Qyery image format (see CS_IMGFMT_XXX above). <a href="#be90677cea0bd304532685904d0b92fb"></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="classcsScreenShot.html#0a2c8bac3fabb723c994324f77a4f29b">GetHeight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query image height. <a href="#0a2c8bac3fabb723c994324f77a4f29b"></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="classcsScreenShot.html#959957f53466a69a1ffd4e11c5957948">GetImageData</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to image data. <a href="#959957f53466a69a1ffd4e11c5957948"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br>
<a class="el" href="structcsRGBpixel.html">csRGBpixel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsScreenShot.html#92cda2de8889a6f5a3b378e872474251">GetPalette</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get image palette (or 0 if no palette). <a href="#92cda2de8889a6f5a3b378e872474251"></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="classcsScreenShot.html#68dd4d5cd5a7832689a9b99b79244753">GetWidth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query image width. <a href="#68dd4d5cd5a7832689a9b99b79244753"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsScreenShot.html#163d3019e2a9648ab2feb511f7e00464">~csScreenShot</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the screenshot object. <a href="#163d3019e2a9648ab2feb511f7e00464"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Simple <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> implementation for canvas screenshots.
<p>Definition at line <a class="el" href="scrshot_8h-source.html#l00038">38</a> of file <a class="el" href="scrshot_8h-source.html">scrshot.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ca5de54cd2dd6fc4e67c69ba36f7af35"></a><!-- doxytag: member="csScreenShot::csScreenShot" ref="ca5de54cd2dd6fc4e67c69ba36f7af35" args="(iGraphics2D *G2D)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csScreenShot::csScreenShot </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiGraphics2D.html">iGraphics2D</a> * </td>
<td class="paramname"> <em>G2D</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize the screenshot object.
<p>
</div>
</div><p>
<a class="anchor" name="163d3019e2a9648ab2feb511f7e00464"></a><!-- doxytag: member="csScreenShot::~csScreenShot" ref="163d3019e2a9648ab2feb511f7e00464" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual csScreenShot::~csScreenShot </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy the screenshot object.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="be90677cea0bd304532685904d0b92fb"></a><!-- doxytag: member="csScreenShot::GetFormat" ref="be90677cea0bd304532685904d0b92fb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csScreenShot::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="scrshot_8h-source.html#l00061">61</a> of file <a class="el" href="scrshot_8h-source.html">scrshot.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="0a2c8bac3fabb723c994324f77a4f29b"></a><!-- doxytag: member="csScreenShot::GetHeight" ref="0a2c8bac3fabb723c994324f77a4f29b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csScreenShot::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="scrshot_8h-source.html#l00058">58</a> of file <a class="el" href="scrshot_8h-source.html">scrshot.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="959957f53466a69a1ffd4e11c5957948"></a><!-- doxytag: member="csScreenShot::GetImageData" ref="959957f53466a69a1ffd4e11c5957948" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const void* csScreenShot::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 a pointer to image data.
<p>
<p>Implements <a class="el" href="structiImage.html#c6ef621537753b4409a003b126d3122c">iImage</a>.</p>
<p>Definition at line <a class="el" href="scrshot_8h-source.html#l00052">52</a> of file <a class="el" href="scrshot_8h-source.html">scrshot.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="92cda2de8889a6f5a3b378e872474251"></a><!-- doxytag: member="csScreenShot::GetPalette" ref="92cda2de8889a6f5a3b378e872474251" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a>* csScreenShot::GetPalette </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 palette (or 0 if no palette).
<p>
<p>Reimplemented from <a class="el" href="classcsImageBase.html#b5259fde6544f4ebf4fd6200a75c5efa">csImageBase</a>.</p>
<p>Definition at line <a class="el" href="scrshot_8h-source.html#l00064">64</a> of file <a class="el" href="scrshot_8h-source.html">scrshot.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="68dd4d5cd5a7832689a9b99b79244753"></a><!-- doxytag: member="csScreenShot::GetWidth" ref="68dd4d5cd5a7832689a9b99b79244753" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csScreenShot::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="scrshot_8h-source.html#l00055">55</a> of file <a class="el" href="scrshot_8h-source.html">scrshot.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csplugincommon/canvas/<a class="el" href="scrshot_8h-source.html">scrshot.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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
1001
