<!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: csPixelFormat Struct 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>csPixelFormat Struct Reference<br>
<small>
[<a class="el" href="group__gfx2d.html">2D</a>]</small>
</h1><!-- doxytag: class="csPixelFormat" -->Structure describing the pixel format.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ivideo_2graph2d_8h-source.html">ivideo/graph2d.h</a>></code>
<p>
<p>
<a href="structcsPixelFormat-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="structcsPixelFormat.html#f8f67304c3819c3b4954ca6922281599">complete</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Little helper function to complete a <a class="el" href="structcsPixelFormat.html" title="Structure describing the pixel format.">csPixelFormat</a> structure given that the masks are correctly filled in. <a href="#f8f67304c3819c3b4954ca6922281599"></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="d83273bbb742ff808cfe067b649c62a9"></a><!-- doxytag: member="csPixelFormat::AlphaBits" ref="d83273bbb742ff808cfe067b649c62a9" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#d83273bbb742ff808cfe067b649c62a9">AlphaBits</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7bc610c1f073b232fe4ae22f6696baa2"></a><!-- doxytag: member="csPixelFormat::AlphaMask" ref="7bc610c1f073b232fe4ae22f6696baa2" args="" -->
<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#7bc610c1f073b232fe4ae22f6696baa2">AlphaMask</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8fe4f27d7f55ee71c0919658b3471899"></a><!-- doxytag: member="csPixelFormat::AlphaShift" ref="8fe4f27d7f55ee71c0919658b3471899" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#8fe4f27d7f55ee71c0919658b3471899">AlphaShift</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d1b414f4376180d379948fa4570e795"></a><!-- doxytag: member="csPixelFormat::BlueBits" ref="4d1b414f4376180d379948fa4570e795" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#4d1b414f4376180d379948fa4570e795">BlueBits</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="344c300262e89a13626c644d2ddb5865"></a><!-- doxytag: member="csPixelFormat::BlueMask" ref="344c300262e89a13626c644d2ddb5865" args="" -->
<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#344c300262e89a13626c644d2ddb5865">BlueMask</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="449980233ccf3a383530cc3d24cfb2b8"></a><!-- doxytag: member="csPixelFormat::BlueShift" ref="449980233ccf3a383530cc3d24cfb2b8" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#449980233ccf3a383530cc3d24cfb2b8">BlueShift</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4ac98dd68e5529a831a85e0af15f2202"></a><!-- doxytag: member="csPixelFormat::GreenBits" ref="4ac98dd68e5529a831a85e0af15f2202" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#4ac98dd68e5529a831a85e0af15f2202">GreenBits</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f15b67458e85bdf86cf2c2aa6a2c298c"></a><!-- doxytag: member="csPixelFormat::GreenMask" ref="f15b67458e85bdf86cf2c2aa6a2c298c" args="" -->
<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#f15b67458e85bdf86cf2c2aa6a2c298c">GreenMask</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38b92fd903f6010730e88a36fd60c0da"></a><!-- doxytag: member="csPixelFormat::GreenShift" ref="38b92fd903f6010730e88a36fd60c0da" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#38b92fd903f6010730e88a36fd60c0da">GreenShift</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#f02f2fb5a97de4077d7b9067743c1c55">PalEntries</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of palette entries. <a href="#f02f2fb5a97de4077d7b9067743c1c55"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#edc82fc868b361aa8a2f6a316fdd2258">PixelBytes</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of bytes for every pixel. <a href="#edc82fc868b361aa8a2f6a316fdd2258"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#ab76d988886d16b779a5610b2cceee1c">RedBits</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of significant bits for every color. <a href="#ab76d988886d16b779a5610b2cceee1c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#604edca9430a5d5b4e812baa49e7fbf1">RedMask</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The masks to extract the color information from a pixel (truecolor mode only). <a href="#604edca9430a5d5b4e812baa49e7fbf1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsPixelFormat.html#5b707202477e14246335d24e1e428fe8">RedShift</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The shifts to extract the color information from a pixel (truecolor mode only). <a href="#5b707202477e14246335d24e1e428fe8"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Structure describing the pixel format.
<p>Definition at line <a class="el" href="ivideo_2graph2d_8h-source.html#l00070">70</a> of file <a class="el" href="ivideo_2graph2d_8h-source.html">graph2d.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f8f67304c3819c3b4954ca6922281599"></a><!-- doxytag: member="csPixelFormat::complete" ref="f8f67304c3819c3b4954ca6922281599" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csPixelFormat::complete </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Little helper function to complete a <a class="el" href="structcsPixelFormat.html" title="Structure describing the pixel format.">csPixelFormat</a> structure given that the masks are correctly filled in.
<p>
<p>Definition at line <a class="el" href="ivideo_2graph2d_8h-source.html#l00107">107</a> of file <a class="el" href="ivideo_2graph2d_8h-source.html">graph2d.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f02f2fb5a97de4077d7b9067743c1c55"></a><!-- doxytag: member="csPixelFormat::PalEntries" ref="f02f2fb5a97de4077d7b9067743c1c55" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structcsPixelFormat.html#f02f2fb5a97de4077d7b9067743c1c55">csPixelFormat::PalEntries</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of palette entries.
<p>
0 for truecolor, else the number of palette entries (this number should be equal to 256 even if not all of these 256 colors can be modified (like is the case in Windows)). Currently only 0 and 256 are supported here.
<p>Definition at line <a class="el" href="ivideo_2graph2d_8h-source.html#l00092">92</a> of file <a class="el" href="ivideo_2graph2d_8h-source.html">graph2d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="edc82fc868b361aa8a2f6a316fdd2258"></a><!-- doxytag: member="csPixelFormat::PixelBytes" ref="edc82fc868b361aa8a2f6a316fdd2258" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structcsPixelFormat.html#edc82fc868b361aa8a2f6a316fdd2258">csPixelFormat::PixelBytes</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of bytes for every pixel.
<p>
The only supported values currently are:<p>
<ul>
<li>1: for palette mode (256 palette entries)</li><li>2: for truecolor 15/16-bit mode (no palette entries)</li><li>4: for truecolor 32-bit mode (no palette entries) </li></ul>
<p>Definition at line <a class="el" href="ivideo_2graph2d_8h-source.html#l00101">101</a> of file <a class="el" href="ivideo_2graph2d_8h-source.html">graph2d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="ab76d988886d16b779a5610b2cceee1c"></a><!-- doxytag: member="csPixelFormat::RedBits" ref="ab76d988886d16b779a5610b2cceee1c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structcsPixelFormat.html#ab76d988886d16b779a5610b2cceee1c">csPixelFormat::RedBits</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The number of significant bits for every color.
<p>
<p>Definition at line <a class="el" href="ivideo_2graph2d_8h-source.html#l00084">84</a> of file <a class="el" href="ivideo_2graph2d_8h-source.html">graph2d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="604edca9430a5d5b4e812baa49e7fbf1"></a><!-- doxytag: member="csPixelFormat::RedMask" ref="604edca9430a5d5b4e812baa49e7fbf1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> <a class="el" href="structcsPixelFormat.html#604edca9430a5d5b4e812baa49e7fbf1">csPixelFormat::RedMask</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The masks to extract the color information from a pixel (truecolor mode only).
<p>
Ignore the Mask and Shift fields of this structure if PalEntries != 0.
<p>Definition at line <a class="el" href="ivideo_2graph2d_8h-source.html#l00077">77</a> of file <a class="el" href="ivideo_2graph2d_8h-source.html">graph2d.h</a>.</p>
<p>Referenced by <a class="el" href="draw__common_8h-source.html#l00067">csPixMixerRGBA< Tpixel >::csPixMixerRGBA()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5b707202477e14246335d24e1e428fe8"></a><!-- doxytag: member="csPixelFormat::RedShift" ref="5b707202477e14246335d24e1e428fe8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structcsPixelFormat.html#5b707202477e14246335d24e1e428fe8">csPixelFormat::RedShift</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The shifts to extract the color information from a pixel (truecolor mode only).
<p>
<p>Definition at line <a class="el" href="ivideo_2graph2d_8h-source.html#l00082">82</a> of file <a class="el" href="ivideo_2graph2d_8h-source.html">graph2d.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivideo/<a class="el" href="ivideo_2graph2d_8h-source.html">graph2d.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
>
2664
