<!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>SDLmm::PixelFormat class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>SDLmm::PixelFormat Class Reference</h1><code>#include <<a class="el" href="sdlmm__pixelformat_8h-source.html">sdlmm_pixelformat.h</a>></code>
<p>
<a href="classSDLmm_1_1PixelFormat-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a0">PixelFormat</a> (SDL_PixelFormat *pixelformat)</td></tr>
<tr><td> </td><td><font size=-1><em>Constructor from an SDL_PixelFormat*.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a1">~PixelFormat</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>The destructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>Uint8 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a3">BitsPerPixel</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint8 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a4">BytesPerPixel</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint8 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a5">Rshift</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint8 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a6">Gshift</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint8 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a7">Bshift</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint8 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a8">Rloss</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint8 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a9">Gloss</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint8 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a10">Bloss</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint8 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a11">Aloss</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint32 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a12">Rmask</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint32 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a13">Gmask</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint32 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a14">Bmask</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint32 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a15">Amask</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespace__SDLmm.html#a0">Color</a> </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a16">colorkey</a> () const</td></tr>
<tr><td nowrap align=right valign=top>Uint8 </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a17">alpha</a> () const</td></tr>
<tr><td nowrap align=right valign=top>SDL_Palette* </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a18">palette</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespace__SDLmm.html#a0">Color</a> </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a19">MapRGB</a> (Uint8 r, Uint8 g, Uint8 b) const</td></tr>
<tr><td> </td><td><font size=-1><em>Map a RGB color value to a pixel format.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespace__SDLmm.html#a0">Color</a> </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a20">MapRGB</a> (const <a class="el" href="classSDLmm_1_1ColorRGB.html">ColorRGB</a> &colorrgb) const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespace__SDLmm.html#a0">Color</a> </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a21">MapRGBA</a> (Uint8 r, Uint8 g, Uint8 b, Uint8 a) const</td></tr>
<tr><td> </td><td><font size=-1><em>Map a RGBA color value to a pixel format.</em> <a href="#a21">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespace__SDLmm.html#a0">Color</a> </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a22">MapRGBA</a> (const <a class="el" href="classSDLmm_1_1ColorRGBA.html">ColorRGBA</a> &colorrgba) const</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a23">GetRGB</a> (<a class="el" href="namespace__SDLmm.html#a0">Color</a> pixel, Uint8 &r, Uint8 &g, Uint8 &b) const</td></tr>
<tr><td> </td><td><font size=-1><em>Get RGB values from a pixel in the pixel format of this <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a>.</em> <a href="#a23">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classSDLmm_1_1ColorRGB.html">ColorRGB</a> </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a24">GetRGB</a> (<a class="el" href="namespace__SDLmm.html#a0">Color</a> pixel) const</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a25">GetRGBA</a> (<a class="el" href="namespace__SDLmm.html#a0">Color</a> pixel, Uint8 &r, Uint8 &g, Uint8 &b, Uint8 &a) const</td></tr>
<tr><td> </td><td><font size=-1><em>Get RGBA values from a pixel in the pixel format of this <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a>.</em> <a href="#a25">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classSDLmm_1_1ColorRGBA.html">ColorRGBA</a> </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a26">GetRGBA</a> (<a class="el" href="namespace__SDLmm.html#a0">Color</a> pixel) const</td></tr>
<tr><td colspan="2"><div class="groupHeader">Informational methods</div></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#a2">valid</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns true if this <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a> is initialized, false otherwise.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>SDL_PixelFormat* </td><td valign=bottom><a class="el" href="classSDLmm_1_1PixelFormat.html#n0">me</a></td></tr>
<tr><td> </td><td><font size=-1><em>The actual SDL_PixelFormat for this <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a>.</em> <a href="#n0">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt>
<b>Author: </b><dd>
Adam Gates </dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="SDLmm::PixelFormat::PixelFormat"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
SDLmm::PixelFormat::PixelFormat (
</b></td>
<td valign="bottom"><b>
SDL_PixelFormat * <em>pixelformat</em> )<code> [inline, explicit]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor from an SDL_PixelFormat*.
<p>
This creates a new <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a> object from an existing SDL_PixelFormat. It's very important not to free the original pixel format since that will cause problems. Use with caution. </td>
</tr>
</table>
<a name="a1" doxytag="SDLmm::PixelFormat::~PixelFormat"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
SDLmm::PixelFormat::~PixelFormat (
</b></td>
<td valign="bottom"><b>
)<code> [inline, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a11" doxytag="SDLmm::PixelFormat::Aloss"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint8 SDLmm::PixelFormat::Aloss (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a15" doxytag="SDLmm::PixelFormat::Amask"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint32 SDLmm::PixelFormat::Amask (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="SDLmm::PixelFormat::BitsPerPixel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint8 SDLmm::PixelFormat::BitsPerPixel (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a10" doxytag="SDLmm::PixelFormat::Bloss"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint8 SDLmm::PixelFormat::Bloss (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a14" doxytag="SDLmm::PixelFormat::Bmask"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint32 SDLmm::PixelFormat::Bmask (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="SDLmm::PixelFormat::Bshift"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint8 SDLmm::PixelFormat::Bshift (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a4" doxytag="SDLmm::PixelFormat::BytesPerPixel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint8 SDLmm::PixelFormat::BytesPerPixel (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a24" doxytag="SDLmm::PixelFormat::GetRGB"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classSDLmm_1_1ColorRGB.html">ColorRGB</a> SDLmm::PixelFormat::GetRGB (
</b></td>
<td valign="bottom"><b>
<a class="el" href="namespace__SDLmm.html#a0">Color</a> <em>pixel</em> ) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a23" doxytag="SDLmm::PixelFormat::GetRGB"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void SDLmm::PixelFormat::GetRGB (
</b></td>
<td valign="bottom"><b>
<a class="el" href="namespace__SDLmm.html#a0">Color</a> <em>pixel</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 & <em>r</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 & <em>g</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 & <em>b</em> ) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get RGB values from a pixel in the pixel format of this <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a>.
<p>
This function uses the entire 8-bit [0..255] range when converting color components from pixel formats with less than 8-bits per RGB component (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pixel</em>
</td><td>
the pixel value </td></tr>
<tr><td valign=top><em>r, g, b</em>
</td><td>
references to integers where the RGB result will be stored.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="classSDLmm_1_1PixelFormat.html#a25">GetRGBA</a>, <a class="el" href="classSDLmm_1_1PixelFormat.html#a19">MapRGB</a>, <a class="el" href="classSDLmm_1_1PixelFormat.html#a21">MapRGBA</a> </dl> </td>
</tr>
</table>
<a name="a26" doxytag="SDLmm::PixelFormat::GetRGBA"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classSDLmm_1_1ColorRGBA.html">ColorRGBA</a> SDLmm::PixelFormat::GetRGBA (
</b></td>
<td valign="bottom"><b>
<a class="el" href="namespace__SDLmm.html#a0">Color</a> <em>pixel</em> ) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a25" doxytag="SDLmm::PixelFormat::GetRGBA"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void SDLmm::PixelFormat::GetRGBA (
</b></td>
<td valign="bottom"><b>
<a class="el" href="namespace__SDLmm.html#a0">Color</a> <em>pixel</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 & <em>r</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 & <em>g</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 & <em>b</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 & <em>a</em> ) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get RGBA values from a pixel in the pixel format of this <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a>.
<p>
This function uses the entire 8-bit [0..255] range when converting color components from pixel formats with less than 8-bits per RGB component (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).
<p>
<dl compact><dt>
<b>Note: </b><dd>
If the <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a> has no alpha component, the alpha will be returned as 0xff (100% opaque).</dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pixel</em>
</td><td>
the pixel value </td></tr>
<tr><td valign=top><em>r, g, b, a</em>
</td><td>
references to integers where the RGBA result will be stored. </td></tr>
</table>
</dl><dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="classSDLmm_1_1PixelFormat.html#a23">GetRGB</a>, <a class="el" href="classSDLmm_1_1PixelFormat.html#a19">MapRGB</a>, <a class="el" href="classSDLmm_1_1PixelFormat.html#a21">MapRGBA</a> </dl> </td>
</tr>
</table>
<a name="a9" doxytag="SDLmm::PixelFormat::Gloss"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint8 SDLmm::PixelFormat::Gloss (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a13" doxytag="SDLmm::PixelFormat::Gmask"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint32 SDLmm::PixelFormat::Gmask (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a6" doxytag="SDLmm::PixelFormat::Gshift"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint8 SDLmm::PixelFormat::Gshift (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a20" doxytag="SDLmm::PixelFormat::MapRGB"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="namespace__SDLmm.html#a0">Color</a> SDLmm::PixelFormat::MapRGB (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classSDLmm_1_1ColorRGB.html">ColorRGB</a> & <em>colorrgb</em> ) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a19" doxytag="SDLmm::PixelFormat::MapRGB"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="namespace__SDLmm.html#a0">Color</a> SDLmm::PixelFormat::MapRGB (
</b></td>
<td valign="bottom"><b>
Uint8 <em>r</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 <em>g</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 <em>b</em> ) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Map a RGB color value to a pixel format.
<p>
Maps the RGB color value to this <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a>'s pixel format and returns the pixel value as a 32-bit int.
<p>
If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned.
<p>
If the specified pixel format has an alpha component it will be returned as all 1 bits (fully opaque).
<p>
<dl compact><dt>
<b>Returns: </b><dd>
A pixel value best approximating the given RGB color value for a given pixel format. If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).</dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>r, g, b</em>
</td><td>
the RGB values. </td></tr>
</table>
</dl><dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="classSDLmm_1_1PixelFormat.html#a23">GetRGB</a>, <a class="el" href="classSDLmm_1_1PixelFormat.html#a25">GetRGBA</a>, <a class="el" href="classSDLmm_1_1PixelFormat.html#a21">MapRGBA</a> </dl> </td>
</tr>
</table>
<a name="a22" doxytag="SDLmm::PixelFormat::MapRGBA"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="namespace__SDLmm.html#a0">Color</a> SDLmm::PixelFormat::MapRGBA (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classSDLmm_1_1ColorRGBA.html">ColorRGBA</a> & <em>colorrgba</em> ) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a21" doxytag="SDLmm::PixelFormat::MapRGBA"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="namespace__SDLmm.html#a0">Color</a> SDLmm::PixelFormat::MapRGBA (
</b></td>
<td valign="bottom"><b>
Uint8 <em>r</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 <em>g</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 <em>b</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
Uint8 <em>a</em> ) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Map a RGBA color value to a pixel format.
<p>
Maps the RGBA color value to this <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a>'s pixel format and returns the pixel value as a 32-bit int.
<p>
If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned.
<p>
If the specified pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette).
<p>
<dl compact><dt>
<b>Returns: </b><dd>
A pixel value best approximating the given RGBA color value for a given pixel format. If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).</dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>r, g, b, a</em>
</td><td>
the RGBA values. </td></tr>
</table>
</dl><dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="classSDLmm_1_1PixelFormat.html#a23">GetRGB</a>, <a class="el" href="classSDLmm_1_1PixelFormat.html#a25">GetRGBA</a>, <a class="el" href="classSDLmm_1_1PixelFormat.html#a19">MapRGB</a> </dl> </td>
</tr>
</table>
<a name="a8" doxytag="SDLmm::PixelFormat::Rloss"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint8 SDLmm::PixelFormat::Rloss (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a12" doxytag="SDLmm::PixelFormat::Rmask"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint32 SDLmm::PixelFormat::Rmask (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="SDLmm::PixelFormat::Rshift"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint8 SDLmm::PixelFormat::Rshift (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a17" doxytag="SDLmm::PixelFormat::alpha"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Uint8 SDLmm::PixelFormat::alpha (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a16" doxytag="SDLmm::PixelFormat::colorkey"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="namespace__SDLmm.html#a0">Color</a> SDLmm::PixelFormat::colorkey (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a18" doxytag="SDLmm::PixelFormat::palette"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
SDL_Palette * SDLmm::PixelFormat::palette (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="SDLmm::PixelFormat::valid"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool SDLmm::PixelFormat::valid (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns true if this <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a> is initialized, false otherwise.
<p>
<dl compact><dt>
<b>Warning: </b><dd>
Using an uninitialzied <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a> can cause many problems. </dl> </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="n0" doxytag="SDLmm::PixelFormat::me"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
SDL_PixelFormat * SDLmm::PixelFormat::me<code> [protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The actual SDL_PixelFormat for this <a class="el" href="classSDLmm_1_1PixelFormat.html">PixelFormat</a>.
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="sdlmm__pixelformat_8h-source.html">sdlmm_pixelformat.h</a><li><a class="el" href="sdlmm__pixelformat_8cpp.html">sdlmm_pixelformat.cpp</a></ul>
<hr>
<table cellspacing=10 cellpadding=0 border=0 width=100%>
<tr valign=middle><td><font size=-1>Documentation automatically generated by <a
href="http://www.stack.nl/~dimitri/doxygen/"><img border=0 align=center src="doxygen.gif" alt="doxygen"></a> written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>.</font></td>
<td align=right><font size=-1>Project hosted at <br><a href="http://sourceforge.net"><img align=middle src="http://sourceforge.net/sflogo.php?group_id=25445&type=1" width="88" height="31" border="0" alt="Hosted by SourceForge"></a></font></td></tr></table>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
41c3b10f9ff9d7ae4da1b670fca4e90c
>
files
>
53
