<!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: Graphics (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><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>
<h1>Graphics</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCS.html">CS</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Main namespace for CrystalSpace. <br></td></tr>
<p>
<tr><td colspan="2"><br><h2>Modules</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gfx2d.html">2D</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gfx3d.html">3D</a></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBakeKeyColor.html">csBakeKeyColor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Functions to bake keycolor into the alpha channel of images. <a href="classcsBakeKeyColor.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsColorQuantizer.html">csColorQuantizer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Color quantizer. <a href="classcsColorQuantizer.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsComparator_3_01csRGBcolor_01_5_00_01csRGBcolor_01_5_01_4.html">csComparator< csRGBcolor *, csRGBcolor * ></a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">csComparator<> specialization for csColor*. <a href="classcsComparator_3_01csRGBcolor_01_5_00_01csRGBcolor_01_5_01_4.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsComparator_3_01csRGBcolor_00_01csRGBcolor_01_4.html">csComparator< csRGBcolor, csRGBcolor ></a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">csComparator<> specialization for <a class="el" href="structcsRGBcolor.html" title="An RGB color.">csRGBcolor</a>. <a href="classcsComparator_3_01csRGBcolor_00_01csRGBcolor_01_4.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageBase.html">csImageBase</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base class for <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> implementations. <a href="classcsImageBase.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageCubeMapMaker.html">csImageCubeMapMaker</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper class to create a cube map from a number of 2D images as the cube faces. <a href="classcsImageCubeMapMaker.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageManipulate.html">csImageManipulate</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Helper class to manipulate <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> objects. <a href="classcsImageManipulate.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageMemory.html">csImageMemory</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Memory image. <a href="classcsImageMemory.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageTools.html">csImageTools</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Some helper functions to deal with <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> objects. <a href="classcsImageTools.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageVolumeMaker.html">csImageVolumeMaker</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper class to create a volume aka 3D texture from a number of 2D images as the volume slices. <a href="classcsImageVolumeMaker.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsInterleavedSubBufferOptions.html">csInterleavedSubBufferOptions</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure describing the properties of the individual buffers to be interleaved. <a href="structcsInterleavedSubBufferOptions.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNormalMappingTools.html">csNormalMappingTools</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Some helpers for stuff related to normal maps. <a href="classcsNormalMappingTools.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPackRGB.html">csPackRGB</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">RGB data packing. <a href="structcsPackRGB.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPackRGBA.html">csPackRGBA</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">RGBA data packing. <a href="structcsPackRGBA.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRenderBuffer.html">csRenderBuffer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Render buffer - basic container for mesh geometry data. <a href="classcsRenderBuffer.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsRGBcolor.html">csRGBcolor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An RGB color. <a href="structcsRGBcolor.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An RGB pixel. <a href="structcsRGBpixel.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsShaderExpressionAccessor.html">csShaderExpressionAccessor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shader variable accessor that evaluates a shader expression when the SV value is queried. <a href="classcsShaderExpressionAccessor.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1RenderBufferPersistent.html">CS::RenderBufferPersistent</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Render buffer wrapper with additional persistence information. <a href="classCS_1_1RenderBufferPersistent.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Eye sensivity to different color components</h2></td></tr>
<tr><td colspan="2">Eye sensivity to different color components, from NTSC grayscale equation.<p>
The coefficients are multiplied by 100 and rounded towards nearest integer, to facilitate integer math. The squared coefficients are also multiplied by 100 and rounded to nearest integer (thus 173 == 1.73, 242 == 2.42 etc). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gfx.html#gdb10058e64166c47bae8a5a2fe530d79">B_COEF</a> 107</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Blue component sensivity. <a href="#gdb10058e64166c47bae8a5a2fe530d79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gfx.html#g054e602cf24056da9a48adc676358e37">G_COEF</a> 242</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Green component sensivity. <a href="#g054e602cf24056da9a48adc676358e37"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gfx.html#g7586b393cb9e1dfc0006f4b8ec945239">R_COEF</a> 173</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Red component sensivity. <a href="#g7586b393cb9e1dfc0006f4b8ec945239"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Eye sensivity to different color components, squared</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gfx.html#g908a17fc1f44ec18e06974a1013d2a5f">B_COEF_SQ</a> 114</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Blue component sensivity, squared. <a href="#g908a17fc1f44ec18e06974a1013d2a5f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gfx.html#g04d98bf1813193e592d83eba1712a52e">G_COEF_SQ</a> 587</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Green component sensivity, squared. <a href="#g04d98bf1813193e592d83eba1712a52e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gfx.html#g3e6bcc20975b271236d5f6f9f9e44d86">R_COEF_SQ</a> 299</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Red component sensivity, squared. <a href="#g3e6bcc20975b271236d5f6f9f9e44d86"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsPtr.html">csPtr</a>< <a class="el" href="structiImage.html">iImage</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gfx.html#gf7a643095c2b02895e1ab94acd0a5b4e">csCreateXORPatternImage</a> (int width, int height, int recdepth, float red=1.0f, float green=1.0f, float blue=1.0f)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> with a nice XOR pattern with 2^<code>recdepth</code> shades of from white to black. <a href="#gf7a643095c2b02895e1ab94acd0a5b4e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiImage.html">iImage</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gfx.html#gc6acfe6b38256d69a02bb13fc7f8ac2d">csBakeKeyColor::Image</a> (<a class="el" href="structiImage.html">iImage</a> *source, const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> &transpColor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set alpha of all pixels to 0 that match <em>transpColor</em>. <a href="#gc6acfe6b38256d69a02bb13fc7f8ac2d"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="gdb10058e64166c47bae8a5a2fe530d79"></a><!-- doxytag: member="rgbpixel.h::B_COEF" ref="gdb10058e64166c47bae8a5a2fe530d79" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define B_COEF 107 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Blue component sensivity.
<p>
<p>Definition at line <a class="el" href="rgbpixel_8h-source.html#l00254">254</a> of file <a class="el" href="rgbpixel_8h-source.html">rgbpixel.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="g908a17fc1f44ec18e06974a1013d2a5f"></a><!-- doxytag: member="rgbpixel.h::B_COEF_SQ" ref="g908a17fc1f44ec18e06974a1013d2a5f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define B_COEF_SQ 114 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Blue component sensivity, squared.
<p>
<p>Definition at line <a class="el" href="rgbpixel_8h-source.html#l00263">263</a> of file <a class="el" href="rgbpixel_8h-source.html">rgbpixel.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="g054e602cf24056da9a48adc676358e37"></a><!-- doxytag: member="rgbpixel.h::G_COEF" ref="g054e602cf24056da9a48adc676358e37" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define G_COEF 242 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Green component sensivity.
<p>
<p>Definition at line <a class="el" href="rgbpixel_8h-source.html#l00252">252</a> of file <a class="el" href="rgbpixel_8h-source.html">rgbpixel.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="g04d98bf1813193e592d83eba1712a52e"></a><!-- doxytag: member="rgbpixel.h::G_COEF_SQ" ref="g04d98bf1813193e592d83eba1712a52e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define G_COEF_SQ 587 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Green component sensivity, squared.
<p>
<p>Definition at line <a class="el" href="rgbpixel_8h-source.html#l00261">261</a> of file <a class="el" href="rgbpixel_8h-source.html">rgbpixel.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="g7586b393cb9e1dfc0006f4b8ec945239"></a><!-- doxytag: member="rgbpixel.h::R_COEF" ref="g7586b393cb9e1dfc0006f4b8ec945239" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define R_COEF 173 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Red component sensivity.
<p>
<p>Definition at line <a class="el" href="rgbpixel_8h-source.html#l00250">250</a> of file <a class="el" href="rgbpixel_8h-source.html">rgbpixel.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="g3e6bcc20975b271236d5f6f9f9e44d86"></a><!-- doxytag: member="rgbpixel.h::R_COEF_SQ" ref="g3e6bcc20975b271236d5f6f9f9e44d86" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define R_COEF_SQ 299 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Red component sensivity, squared.
<p>
<p>Definition at line <a class="el" href="rgbpixel_8h-source.html#l00259">259</a> of file <a class="el" href="rgbpixel_8h-source.html">rgbpixel.h</a>.</p>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gf7a643095c2b02895e1ab94acd0a5b4e"></a><!-- doxytag: member="xorpat.h::csCreateXORPatternImage" ref="gf7a643095c2b02895e1ab94acd0a5b4e" args="(int width, int height, int recdepth, float red=1.0f, float green=1.0f, float blue=1.0f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiImage.html">iImage</a>> csCreateXORPatternImage </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>recdepth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>red</em> = <code>1.0f</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>green</em> = <code>1.0f</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>blue</em> = <code>1.0f</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> with a nice XOR pattern with 2^<code>recdepth</code> shades of from white to black.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>Width of the image to create </td></tr>
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>Height of the image to create </td></tr>
<tr><td valign="top"></td><td valign="top"><em>recdepth</em> </td><td>"recursion depth", clamped to range 1-8. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>red</em> </td><td>Maximum value of red component </td></tr>
<tr><td valign="top"></td><td valign="top"><em>green</em> </td><td>Maximum value of green component </td></tr>
<tr><td valign="top"></td><td valign="top"><em>blue</em> </td><td>Maximum value of blue component </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gc6acfe6b38256d69a02bb13fc7f8ac2d"></a><!-- doxytag: member="csBakeKeyColor::Image" ref="gc6acfe6b38256d69a02bb13fc7f8ac2d" args="(iImage *source, const csRGBpixel &transpColor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiImage.html">iImage</a>> csBakeKeyColor::Image </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiImage.html">iImage</a> * </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> & </td>
<td class="paramname"> <em>transpColor</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set alpha of all pixels to 0 that match <em>transpColor</em>.
<p>
The color of pixels made transparent is changed such that it has the average color of some near non-transparent pixels to prevent halos. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Intermediately uses a truecolor images, i.e. paletted images are not handled with maximum efficiency. </dd></dl>
</div>
</div><p>
<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
>
1792
