<html> <head><title>ClanLib Reference: CL_Sprite2Provider</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_Sprite2Provider</h1><p> <b> Sprite 2 Provider Class</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <a href="CL_SurfaceProvider_Generic.html">CL_SurfaceProvider_Generic</a> <br> Derived by: <i>none</i> <br>Group: Display (Surface Providers) <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_Sprite2Provider.html#1969"><tt><font color=blue><b>CL_Sprite2Provider</b></font></tt></a></td><td><tt>(<a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>* <tt><font color=blue>source</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1970"><tt><font color=blue><b>CL_Sprite2Provider</b></font></tt></a></td><td><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=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>width</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>height</font></tt>, <tt><font color=purple>int</font></tt>* <tt><font color=blue>tcols</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>tcols_num</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_Sprite2Provider.html#1971"><tt><font color=blue><b>~CL_Sprite2Provider</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>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1972"><tt><font color=blue><b>get_width</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1973"><tt><font color=blue><b>get_height</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1974"><tt><font color=blue><b>get_pitch</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1975"><tt><font color=blue><b>get_num_frames</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <a href="CL_Palette.html"><tt><font color=navy><b>CL_Palette</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Sprite2Provider.html#1976"><tt><font color=blue><b>get_palette</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1977"><tt><font color=blue><b>uses_src_colorkey</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1978"><tt><font color=blue><b>get_src_colorkey</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1979"><tt><font color=blue><b>is_indexed</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1980"><tt><font color=blue><b>get_red_mask</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1981"><tt><font color=blue><b>get_green_mask</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1982"><tt><font color=blue><b>get_blue_mask</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1983"><tt><font color=blue><b>get_alpha_mask</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1984"><tt><font color=blue><b>get_depth</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt>*</tt> </td><td align=right><a href="CL_Sprite2Provider.html#1985"><tt><font color=blue><b>get_data</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1986"><tt><font color=blue><b>perform_lock</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1987"><tt><font color=blue><b>perform_unlock</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td><tr><td colspan=3><h3>protected function member index:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Sprite2Provider.html#1968"><tt><font color=blue><b>load_data</b></font></tt></a></td><td><tt>(<a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>* <tt><font color=blue>datafile</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> Sprite surface provider especially designed for the font class. Most likely not very usable other places.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1969"><font size=+1><b>CL_Sprite2Provider::CL_Sprite2Provider</b></font></a> - Sprite 2 Provider Constructor<br><tt></tt> <a href="CL_Sprite2Provider.html#1969"><tt><font color=blue><b>CL_Sprite2Provider</b></font></tt></a><tt>(<a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>* <tt><font color=blue>source</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1970"><font size=+1><b>CL_Sprite2Provider::CL_Sprite2Provider</b></font></a> - Sprite 2 Provider Constructor<br><tt></tt> <a href="CL_Sprite2Provider.html#1970"><tt><font color=blue><b>CL_Sprite2Provider</b></font></tt></a><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=purple>int</font></tt> <tt><font color=blue>x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>y</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>width</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>height</font></tt>, <tt><font color=purple>int</font></tt>* <tt><font color=blue>tcols</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>tcols_num</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1983"><font size=+1><b>CL_Sprite2Provider::get_alpha_mask</b></font></a> - Get alpha mask<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sprite2Provider.html#1983"><tt><font color=blue><b>get_alpha_mask</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1982"><font size=+1><b>CL_Sprite2Provider::get_blue_mask</b></font></a> - Get blue mask<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sprite2Provider.html#1982"><tt><font color=blue><b>get_blue_mask</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1985"><font size=+1><b>CL_Sprite2Provider::get_data</b></font></a> - Returns a pointer to the sprite2s image data. Can only be called between lock() and unlock().<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt>*</tt> <a href="CL_Sprite2Provider.html#1985"><tt><font color=blue><b>get_data</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1984"><font size=+1><b>CL_Sprite2Provider::get_depth</b></font></a> - Get depth<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sprite2Provider.html#1984"><tt><font color=blue><b>get_depth</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1981"><font size=+1><b>CL_Sprite2Provider::get_green_mask</b></font></a> - Get green mask<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sprite2Provider.html#1981"><tt><font color=blue><b>get_green_mask</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1973"><font size=+1><b>CL_Sprite2Provider::get_height</b></font></a> - Returns the height of the sprite2.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sprite2Provider.html#1973"><tt><font color=blue><b>get_height</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1975"><font size=+1><b>CL_Sprite2Provider::get_num_frames</b></font></a> - Returns the number of subsprite2s in this sprite2.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sprite2Provider.html#1975"><tt><font color=blue><b>get_num_frames</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1976"><font size=+1><b>CL_Sprite2Provider::get_palette</b></font></a> - Returns the palette used by the surface. NULL if the system palette is used.<br><tt><tt>virtual</tt> <a href="CL_Palette.html"><tt><font color=navy><b>CL_Palette</b></font></tt></a>*</tt> <a href="CL_Sprite2Provider.html#1976"><tt><font color=blue><b>get_palette</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1974"><font size=+1><b>CL_Sprite2Provider::get_pitch</b></font></a> - Returns the pitch of the sprite2.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sprite2Provider.html#1974"><tt><font color=blue><b>get_pitch</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1980"><font size=+1><b>CL_Sprite2Provider::get_red_mask</b></font></a> - Get red mask<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sprite2Provider.html#1980"><tt><font color=blue><b>get_red_mask</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1978"><font size=+1><b>CL_Sprite2Provider::get_src_colorkey</b></font></a> - Returns the transparency color used, or -1 if none.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sprite2Provider.html#1978"><tt><font color=blue><b>get_src_colorkey</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1972"><font size=+1><b>CL_Sprite2Provider::get_width</b></font></a> - Returns the width of the sprite2.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sprite2Provider.html#1972"><tt><font color=blue><b>get_width</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1979"><font size=+1><b>CL_Sprite2Provider::is_indexed</b></font></a> - Is indexed<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_Sprite2Provider.html#1979"><tt><font color=blue><b>is_indexed</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1986"><font size=+1><b>CL_Sprite2Provider::perform_lock</b></font></a> - Locks the surface provider. This causes the sprite2 to retrieve its surface data from the datafile.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Sprite2Provider.html#1986"><tt><font color=blue><b>perform_lock</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1987"><font size=+1><b>CL_Sprite2Provider::perform_unlock</b></font></a> - Unlocks the surface provider. The sprite2 releases its surface data when it is called.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Sprite2Provider.html#1987"><tt><font color=blue><b>perform_unlock</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1977"><font size=+1><b>CL_Sprite2Provider::uses_src_colorkey</b></font></a> - Uses src colourkey<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_Sprite2Provider.html#1977"><tt><font color=blue><b>uses_src_colorkey</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1971"><font size=+1><b>CL_Sprite2Provider::~CL_Sprite2Provider</b></font></a> - Sprite 2 Provider Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_Sprite2Provider.html#1971"><tt><font color=blue><b>~CL_Sprite2Provider</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>
