<html> <head><title>ClanLib Reference: CL_BMPProvider</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_BMPProvider</h1><p> <b> Surface provider that can load BMP files.</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>static</tt> <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>*</tt> </td><td align=right><a href="CL_BMPProvider.html#2268"><tt><font color=blue><b>create</b></font></tt></a></td><td><tt>(<tt><font color=navy>std::string</font></tt> <tt><font color=blue>handle</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>transparent</font></tt>=false, <tt><font color=navy>short</font></tt> <tt><font color=blue>trans_col</font></tt>=-1)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_BMPProvider.html#2269"><tt><font color=blue><b>CL_BMPProvider</b></font></tt></a></td><td><tt>(<tt><font color=navy>std::string</font></tt> <tt><font color=blue>name</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>transparent</font></tt>=false, <tt><font color=navy>short</font></tt> <tt><font color=blue>trans_col</font></tt>=-1)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_BMPProvider.html#2270"><tt><font color=blue><b>~CL_BMPProvider</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_BMPProvider.html#2271"><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_BMPProvider.html#2272"><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_BMPProvider.html#2273"><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_BMPProvider.html#2274"><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> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_BMPProvider.html#2275"><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_BMPProvider.html#2276"><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_BMPProvider.html#2277"><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_BMPProvider.html#2278"><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_BMPProvider.html#2279"><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> <a href="CL_Palette.html"><tt><font color=navy><b>CL_Palette</b></font></tt></a>*</tt> </td><td align=right><a href="CL_BMPProvider.html#2280"><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_BMPProvider.html#2281"><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=purple>bool</font></tt></tt> </td><td align=right><a href="CL_BMPProvider.html#2282"><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_BMPProvider.html#2283"><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>void</font></tt>*</tt> </td><td align=right><a href="CL_BMPProvider.html#2284"><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_BMPProvider.html#2285"><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_BMPProvider.html#2286"><tt><font color=blue><b>perform_unlock</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> This code currently supports Win32 DIBs in uncompressed 8 and 24 bpp.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="2269"><font size=+1><b>CL_BMPProvider::CL_BMPProvider</b></font></a> - Constructs a surface provider that can read bmp files.<br><tt></tt> <a href="CL_BMPProvider.html#2269"><tt><font color=blue><b>CL_BMPProvider</b></font></tt></a><tt>(<tt><font color=navy>std::string</font></tt> <tt><font color=blue>name</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>transparent</font></tt>=false, <tt><font color=navy>short</font></tt> <tt><font color=blue>trans_col</font></tt>=-1)</tt>;<br><blockquote> name - Name of the bmp file to load.<br> provider - Input source provider that delivers the bmp file.<br> transparent - True if a color in image should be transparent.<br> trans_col - Transparency color used if 'transparent' is true. Defaults to color 0.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2268"><font size=+1><b>CL_BMPProvider::create</b></font></a> - Loads the bmp file 'handle' from the inputsource provider 'provider. <br> Creates a <a href="CL_Surface.html">CL_Surface</a> using the bmp image and returns it.<br><tt><tt>static</tt> <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>*</tt> <a href="CL_BMPProvider.html#2268"><tt><font color=blue><b>create</b></font></tt></a><tt>(<tt><font color=navy>std::string</font></tt> <tt><font color=blue>handle</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>transparent</font></tt>=false, <tt><font color=navy>short</font></tt> <tt><font color=blue>trans_col</font></tt>=-1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2278"><font size=+1><b>CL_BMPProvider::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_BMPProvider.html#2278"><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="2277"><font size=+1><b>CL_BMPProvider::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_BMPProvider.html#2277"><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="2284"><font size=+1><b>CL_BMPProvider::get_data</b></font></a> - Returns the image data. Provider must be locked before pointer is valid.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt>*</tt> <a href="CL_BMPProvider.html#2284"><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="2279"><font size=+1><b>CL_BMPProvider::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_BMPProvider.html#2279"><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="2276"><font size=+1><b>CL_BMPProvider::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_BMPProvider.html#2276"><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="2273"><font size=+1><b>CL_BMPProvider::get_height</b></font></a> - Returns the height of the image.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_BMPProvider.html#2273"><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="2274"><font size=+1><b>CL_BMPProvider::get_num_frames</b></font></a> - Returns the number of subsprites in the image.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_BMPProvider.html#2274"><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="2280"><font size=+1><b>CL_BMPProvider::get_palette</b></font></a> - Returns the palette used by the image. NULL if system palette.<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_BMPProvider.html#2280"><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="2271"><font size=+1><b>CL_BMPProvider::get_pitch</b></font></a> - Returns the pitch of the image (bytes per line).<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_BMPProvider.html#2271"><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="2275"><font size=+1><b>CL_BMPProvider::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_BMPProvider.html#2275"><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="2283"><font size=+1><b>CL_BMPProvider::get_src_colorkey</b></font></a> - Returns the transparency color used, -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_BMPProvider.html#2283"><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="2272"><font size=+1><b>CL_BMPProvider::get_width</b></font></a> - Returns the width of the image.<br><tt><tt>virtual</tt> <tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_BMPProvider.html#2272"><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="2281"><font size=+1><b>CL_BMPProvider::is_indexed</b></font></a> - Is Indexed<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_BMPProvider.html#2281"><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="2285"><font size=+1><b>CL_BMPProvider::perform_lock</b></font></a> - Locks the surface provider.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_BMPProvider.html#2285"><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="2286"><font size=+1><b>CL_BMPProvider::perform_unlock</b></font></a> - Unlocks the surface provider.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_BMPProvider.html#2286"><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="2282"><font size=+1><b>CL_BMPProvider::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_BMPProvider.html#2282"><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="2270"><font size=+1><b>CL_BMPProvider::~CL_BMPProvider</b></font></a> - BMP Provider Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_BMPProvider.html#2270"><tt><font color=blue><b>~CL_BMPProvider</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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
554fa56029a60daf7aab25253fdab3d8
>
files
>
34
