<!-- clanlib header begin --> <HTML> <HEAD> <TITLE>CL_PixelFormat - ClanLib Game SDK</TITLE> <STYLE TYPE="text/css"><!-- HTML BODY { font-family: verdana, helvetica, sans-serif; font-size: 12px; } H1 { font-size: 22px; } H2 { font-size: 18px; } H3 { font-size: 16px; } H4 { font-size: 14px; } P { font-size: 12px; } LI { font-size: 12px; } --></STYLE> </HEAD> <body bgcolor=white text=black link=blue vlink=#800080> <center> <img src="http://clanlib.org/gfx/clanlib.png"> </center> <!-- clanlib header end --> <center> <p> <a href="http://clanlib.org/docs.html">Home</a> | <a href="classes.html">All Classes</a> | <a href="modules.html">Grouped Classes</a> | <a href="index.html">Index</a> | <a href="search.html">Search</a> </p> </center> <h1>Class CL_PixelFormat</h1> <p> Pixel data format description. <a href="#description">More...</a></p> <p>Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Display (Display 2D)</p> <p> #include <ClanLib/display.h> <p> <table border=0 width=100%> </table> <p><b>Construction:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_PixelFormat__CL_PixelFormat.html">CL_PixelFormat</a></p></td><td valign=top><p> Constructs a pixel format description.</p></td></tr></table> <p><b>Attributes:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_PixelFormat__operator ==.html">operator ==</a></p></td><td valign=top><p> Returns true if this pixel format is the same as the other one.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__operator !=.html">operator !=</a></p></td><td valign=top><p> Returns true if this pixel format is not the same as the other one.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__get_type.html">get_type</a></p></td><td valign=top><p> Returns the pixel format type (RGB or Indexed).</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__has_colorkey.html">has_colorkey</a></p></td><td valign=top><p> Returns true if format uses a source color key.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__get_depth.html">get_depth</a></p></td><td valign=top><p> Returns the depth of the pixel format.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__get_colorkey.html">get_colorkey</a></p></td><td valign=top><p> Returns the source color key.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__get_red_mask.html">get_red_mask</a></p></td><td valign=top><p> Returns the red component color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__get_green_mask.html">get_green_mask</a></p></td><td valign=top><p> Returns the green component color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__get_blue_mask.html">get_blue_mask</a></p></td><td valign=top><p> Returns the blue component color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__get_alpha_mask.html">get_alpha_mask</a></p></td><td valign=top><p> Returns the alpha component color mask.</p></td></tr></table> <p><b>Statics:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_PixelFormat__rgba8888.html">rgba8888</a> <i>static</i></p></td><td valign=top><p> Pixel format with 32 bit depth, 8 bits per color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__rgb888.html">rgb888</a> <i>static</i></p></td><td valign=top><p> Pixel format with 24 bit depth, 8 bits per color mask, no alpha.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__rgba4444.html">rgba4444</a> <i>static</i></p></td><td valign=top><p> Pixel format with 16 bit depth, 4 bits per color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__rgb555.html">rgb555</a> <i>static</i></p></td><td valign=top><p> Pixel format with 16 bit depth, 5 bits per color mask, one bit unused.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__rgb565.html">rgb565</a> <i>static</i></p></td><td valign=top><p> Pixel format with 16 bit depth, 5 bits for red and blue, 6 bits for green.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__abgr8888.html">abgr8888</a> <i>static</i></p></td><td valign=top><p> Pixel format with 32 bit depth, 8 bits per color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__bgr888.html">bgr888</a> <i>static</i></p></td><td valign=top><p> Pixel format with 24 bit depth, 8 bits per color mask, no alpha.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__abgr4444.html">abgr4444</a> <i>static</i></p></td><td valign=top><p> Pixel format with 16 bit depth, 4 bits per color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__bgr555.html">bgr555</a> <i>static</i></p></td><td valign=top><p> Pixel format with 16 bit depth, 5 bits per color mask, one bit unused.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__bgr565.html">bgr565</a> <i>static</i></p></td><td valign=top><p> Pixel format with 16 bit depth, 5 bits for red and blue, 6 bits for green.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__get_mask_shift.html">get_mask_shift</a></p></td><td valign=top><p> Returns the shift of a color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__get_mask_bits.html">get_mask_bits</a></p></td><td valign=top><p> Returns the bit count of a color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__get_bitmask.html">get_bitmask</a></p></td><td valign=top><p> Returns the color mask based on bit count and shift.</p></td></tr></table> <p><b>Operations:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_PixelFormat__set_type.html">set_type</a></p></td><td valign=top><p> Sets the pixel format type (RGB or Indexed).</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__enable_colorkey.html">enable_colorkey</a></p></td><td valign=top><p> Enable/disable color key.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__set_colorkey.html">set_colorkey</a></p></td><td valign=top><p> Sets the color key.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__set_depth.html">set_depth</a></p></td><td valign=top><p> Sets the depth of the pixel format.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__set_red_mask.html">set_red_mask</a></p></td><td valign=top><p> Sets the red component color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__set_green_mask.html">set_green_mask</a></p></td><td valign=top><p> Sets the green component color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__set_blue_mask.html">set_blue_mask</a></p></td><td valign=top><p> Sets the blue component color mask.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelFormat__set_alpha_mask.html">set_alpha_mask</a></p></td><td valign=top><p> Sets the alpha component color mask.</p></td></tr></table> <a name="#description"><p><b>Detailed description:</b></p> !group=Display/Display 2D! !header=display.h! <!-- clanlib footer begin --> <center><br><br><font color="#a0a0a0"> Questions or comments, write to the <a href="http://clanlib.org/contact.html">ClanLib mailing list</a>. </font></center> </body> </html> <!-- clanlib footer end -->