<html> <head><title>ClanLib Reference: CL_PixelData</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_PixelData</h1><p> <b> Pixel Data Class</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Display (Display 2D) <p> #include <ClanLib/display.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_PixelData.html#1110"><tt><font color=blue><b>CL_PixelData</b></font></tt></a></td><td><tt>(<tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>red_mask</font></tt>, <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>green_mask</font></tt>, <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>blue_mask</font></tt>, <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>alpha_mask</font></tt>, <a href="CL_SurfaceProvider.html"><tt><font color=navy><b>CL_SurfaceProvider</b></font></tt></a>* <tt><font color=blue>src</font></tt>, <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>bytes_per_pixel</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_PixelData.html#1111"><tt><font color=blue><b>~CL_PixelData</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_PixelData.html#1112"><tt><font color=blue><b>get_width</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_PixelData.html#1113"><tt><font color=blue><b>get_height</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_PixelData.html#1114"><tt><font color=blue><b>get_bytes_per_pixel</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_PixelData.html#1115"><tt><font color=blue><b>get_bytes_per_line</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_PixelData.html#1116"><tt><font color=blue><b>get_line_pixel_to_dest</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>, <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>char</font></tt>* <tt><font color=blue>dest</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_PixelData.html#1117"><tt><font color=blue><b>dump_assert_info</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>line</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>char</font></tt>*</tt> </td><td align=right><a href="CL_PixelData.html#1118"><tt><font color=blue><b>get_line_pixel</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=navy>short</font></tt>*</tt> </td><td align=right><a href="CL_PixelData.html#1119"><tt><font color=blue><b>get_line_pixel16</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt>*</tt> </td><td align=right><a href="CL_PixelData.html#1120"><tt><font color=blue><b>get_line_pixel32</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1110"><font size=+1><b>CL_PixelData::CL_PixelData</b></font></a> - PixelData Constructor<br><tt></tt> <a href="CL_PixelData.html#1110"><tt><font color=blue><b>CL_PixelData</b></font></tt></a><tt>(<tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>red_mask</font></tt>, <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>green_mask</font></tt>, <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>blue_mask</font></tt>, <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>alpha_mask</font></tt>, <a href="CL_SurfaceProvider.html"><tt><font color=navy><b>CL_SurfaceProvider</b></font></tt></a>* <tt><font color=blue>src</font></tt>, <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>bytes_per_pixel</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1117"><font size=+1><b>CL_PixelData::dump_assert_info</b></font></a> - Dump assert info<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_PixelData.html#1117"><tt><font color=blue><b>dump_assert_info</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>line</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1115"><font size=+1><b>CL_PixelData::get_bytes_per_line</b></font></a> - Get bytes per line<br><tt><tt><font color=purple>int</font></tt></tt> <a href="CL_PixelData.html#1115"><tt><font color=blue><b>get_bytes_per_line</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1114"><font size=+1><b>CL_PixelData::get_bytes_per_pixel</b></font></a> - Get bytes per pixel<br><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_PixelData.html#1114"><tt><font color=blue><b>get_bytes_per_pixel</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1113"><font size=+1><b>CL_PixelData::get_height</b></font></a> - Get height<br><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_PixelData.html#1113"><tt><font color=blue><b>get_height</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1118"><font size=+1><b>CL_PixelData::get_line_pixel</b></font></a> - Get line pixel<br><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>char</font></tt>*</tt> <a href="CL_PixelData.html#1118"><tt><font color=blue><b>get_line_pixel</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1119"><font size=+1><b>CL_PixelData::get_line_pixel16</b></font></a> - Get line pixel16<br><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=navy>short</font></tt>*</tt> <a href="CL_PixelData.html#1119"><tt><font color=blue><b>get_line_pixel16</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1120"><font size=+1><b>CL_PixelData::get_line_pixel32</b></font></a> - Get line pixel32<br><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt>*</tt> <a href="CL_PixelData.html#1120"><tt><font color=blue><b>get_line_pixel32</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1116"><font size=+1><b>CL_PixelData::get_line_pixel_to_dest</b></font></a> - Get line pixel to dest<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_PixelData.html#1116"><tt><font color=blue><b>get_line_pixel_to_dest</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>, <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>char</font></tt>* <tt><font color=blue>dest</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1112"><font size=+1><b>CL_PixelData::get_width</b></font></a> - Get width<br><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_PixelData.html#1112"><tt><font color=blue><b>get_width</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1111"><font size=+1><b>CL_PixelData::~CL_PixelData</b></font></a> - PixelData Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_PixelData.html#1111"><tt><font color=blue><b>~CL_PixelData</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <hr noshade> </body> </html>
