<!-- clanlib header begin --> <HTML> <HEAD> <TITLE>CL_PixelBuffer - 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_PixelBuffer</h1> <p> Pixel data access. <a href="#description">More...</a></p> <p>Derived from: <i>none</i> <br> Derived by: <a href="CL_BMPProvider.html">CL_BMPProvider</a> <a href="CL_DeviceContextBuffer.html">CL_DeviceContextBuffer</a> <a href="CL_JPEGProvider.html">CL_JPEGProvider</a> <a href="CL_PCXProvider.html">CL_PCXProvider</a> <a href="CL_PNGProvider.html">CL_PNGProvider</a> <a href="CL_TargaProvider.html">CL_TargaProvider</a> <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_PixelBuffer__CL_PixelBuffer.html">CL_PixelBuffer</a></p></td><td valign=top><p> Constructs a pixel buffer.</p></td></tr></table> <p><b>Attributes:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_PixelBuffer__get_format.html">get_format</a></p></td><td valign=top><p> Returns the pixel format of the pixel buffer.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__get_palette.html">get_palette</a></p></td><td valign=top><p> Returns the palette of the pixel buffer.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__get_width.html">get_width</a></p></td><td valign=top><p> Returns the buffer width.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__get_height.html">get_height</a></p></td><td valign=top><p> Returns the buffer height.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__get_pitch.html">get_pitch</a></p></td><td valign=top><p> Returns the pitch (bytes per scanline).</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__get_data.html">get_data</a></p></td><td valign=top><p> Returns a pointer to the beginning of the pixel buffer. Pointer is only valid inside a lock/unlock session.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__get_pixel.html">get_pixel</a></p></td><td valign=top><p> Returns the pixel at coordinates x and y. Only valid within a lock/unlock session.</p></td></tr></table> <p><b>Operations:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_PixelBuffer__operator =.html">operator =</a></p></td><td valign=top><p> Copy assignment operator.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__bool.html">bool</a></p></td><td valign=top><p> Return true if the CL_PixelBuffer is valid and useable</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__lock.html">lock</a></p></td><td valign=top><p> Locks the pixel buffer, making calls to get_data() valid.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__unlock.html">unlock</a></p></td><td valign=top><p> Unlocks the pixelbuffer.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__convert.html">convert</a></p></td><td valign=top><p> Convert pixel buffer to the pixel format of the target buffer, storing the result in the target buffer.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__convert_line.html">convert_line</a></p></td><td valign=top><p> Convert one line of pixel data to target buffer.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__to_format.html">to_format</a></p></td><td valign=top><p> Converts current buffer to a new pixel format and returns the result.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__set_colorkey.html">set_colorkey</a></p></td><td valign=top><p> Sets a new colorkey without converting the buffer.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_PixelBuffer__draw_pixel.html">draw_pixel</a></p></td><td valign=top><p> Draw a pixel at (x, y) using the specified color. Only valid within a lock/unlock session.</p></td></tr></table> <p><b>Implementation:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_PixelBuffer__impl.html">impl</a></p></td><td valign=top><p> Pixel data implementation.</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 -->