<html>
<head><title>ClanLib Reference: CL_Surface</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_Surface</h1><p>
<b> Image class in ClanLib.</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>Static_init:</h3></td>
<tr valign=top><td align=right><tt><tt>static</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Surface.html#2486"><tt><font color=blue><b>load</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>resource_id</font></tt>, <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>* <tt><font color=blue>manager</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>static</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Surface.html#2487"><tt><font color=blue><b>create</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>provider</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>delete_provider</font></tt>=false)</tt>;</td>
<tr valign=top><td align=right><tt><tt>static</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Surface.html#2488"><tt><font color=blue><b>create_dynamic</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>provider</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>delete_provider</font></tt>=false)</tt>;</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_Surface.html#2489"><tt><font color=blue><b>CL_Surface</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Surface.html#2490"><tt><font color=blue><b>CL_Surface</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>provider</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>delete_provider</font></tt> = false, <tt><font color=purple>bool</font></tt> <tt><font color=blue>dynamic</font></tt> = false)</tt>;</td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Surface.html#2491"><tt><font color=blue><b>CL_Surface</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>resource_id</font></tt>, <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>* <tt><font color=blue>manager</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Surface.html#2492"><tt><font color=blue><b>CL_Surface</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>dynamic</font></tt> = false)</tt>;</td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Surface.html#2493"><tt><font color=blue><b>CL_Surface</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>& <tt><font color=blue>surface</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_Surface.html#2494"><tt><font color=blue><b>~CL_Surface</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=left><h3>Operations:</h3></td>
<tr valign=top><td align=right><tt><tt><font color=navy>operator</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2495"><tt><font color=blue><b>bool</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>const</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>&</tt> </td><td align=right><a href="CL_Surface.html#2496"><tt><font color=black><b>operator</b></font></tt><tt> =</tt></a></td><td><tt>(<tt>const</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>& <tt><font color=blue>surf</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_Surface.html#2497"><tt><font color=blue><b>reload</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><a href="CL_SurfaceProvider.html"><tt><font color=navy><b>CL_SurfaceProvider</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Surface.html#2498"><tt><font color=blue><b>get_provider</b></font></tt></a></td><td><tt>() <tt>const</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_Surface.html#2499"><tt><font color=blue><b>put_screen</b></font></tt></a></td><td><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>spr_no</font></tt>=0, <a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>=NULL)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2500"><tt><font color=blue><b>put_screen</b></font></tt></a></td><td><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>float</font></tt> <tt><font color=blue>scale_x</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>scale_y</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>spr_no</font></tt>=0, <a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>=NULL)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2501"><tt><font color=blue><b>put_screen</b></font></tt></a></td><td><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>size_x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>size_y</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>spr_no</font></tt>=0, <a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>=NULL)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2502"><tt><font color=blue><b>put_target</b></font></tt></a></td><td><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>spr_no</font></tt>, <a href="CL_Target.html"><tt><font color=navy><b>CL_Target</b></font></tt></a>* <tt><font color=blue>target</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_Surface.html#2503"><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><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2504"><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><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2505"><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><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2506"><tt><font color=blue><b>is_video</b></font></tt></a></td><td><tt>(<a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt> = NULL) <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2507"><tt><font color=blue><b>is_loaded</b></font></tt></a></td><td><tt>(<a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt> = NULL) <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2508"><tt><font color=blue><b>convert_video</b></font></tt></a></td><td><tt>(<a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt> = NULL)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2509"><tt><font color=blue><b>convert_system</b></font></tt></a></td><td><tt>(<a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt> = NULL)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2510"><tt><font color=blue><b>flush</b></font></tt></a></td><td><tt>(<a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt> = NULL)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_Surface.html#2511"><tt><font color=blue><b>get_reference_count</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=left><h3>Implementation:</h3></td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a></td><td><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_Surface_Generic</font></tt>* <tt><font color=blue>impl</font></tt>)</tt>;</td>
<tr><td> </td></table>
<hr noshade>
<h2>Description:</h2>
This class is used to draw 2D images onto the backbuffer or to a <a href="CL_Target.html">CL_Target</a> renderer target.<br><br> In ClanLib, a surface is understood to be an image represented in a form, where it is most suitable for as fast rendering as possible. Unlike many other libraries, it is not possible to get direct access to the surface data.<br><br> A surface uses a <a href="CL_SurfaceProvider.html">CL_SurfaceProvider</a> surface provider to load its data. It is passed at creation time, and you can either roll your own provider, or use one already available in ClanLib.<br><br> It is also possible to create a surface from a resource source. This will allow you to load an image using a resource ID instead of directly specifying the image in your source code.<br><br> Dynamic surfaces<br><br> If you have an image which changes very frequently (eg. each frame), you want to use a dynamic surface instead. The difference is that the surface won't cache the image, and it won't convert it to another image format more suitable for the display target. Note that this is only faster if you change your image very frequently - otherwise a normal surface is the best solution.<br><br> When constructing your own images, you will most likely find the <a href="CL_Canvas.html">CL_Canvas</a> canvas surface provider interesting. This class will make it easier to create a custom drawing area where you can draw your image.<br><br> All surfaceproviders is a <a href="CL_Target.html">CL_Target</a> renderer target. However, most of the normal surface providers are "read only", meaning that their image data will only remain intact during a lock session. This is because the providers consume less memory when the image is only available, when someone needs it. Only the <a href="CL_Canvas.html">CL_Canvas</a> canvas provider will not destroy the image.<br><br> A surface can blit (draw itself) itself to the backbuffer, or to a renderer target. This means that you can use the surface to draw one surface provider to another.<br><p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="2489"><font size=+1><b>CL_Surface::CL_Surface</b></font></a> - Empty constructor, you need to assign a surface to the<br> <a href="CL_Surface.html">CL_Surface</a> object first before it becomes useable<br><tt></tt> <a href="CL_Surface.html#2489"><tt><font color=blue><b>CL_Surface</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2490"><font size=+1><b>CL_Surface::CL_Surface</b></font></a> - This function creates a <a href="CL_Surface.html">CL_Surface</a>.<br> If dynamic is true, the surface will be a dynamic blitter. If false, it will be a caching blitter.<br><tt></tt> <a href="CL_Surface.html#2490"><tt><font color=blue><b>CL_Surface</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>provider</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>delete_provider</font></tt> = false, <tt><font color=purple>bool</font></tt> <tt><font color=blue>dynamic</font></tt> = false)</tt>;<br><blockquote> provider - Image source.<br> delete_provider - If true, the surface will delete the provider when deleted itself.<br> dynamic - If true, a dynamic blitter will be chosen. If false, a caching blitter will be used.<br> Returns - The surface created.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2491"><font size=+1><b>CL_Surface::CL_Surface</b></font></a> - Loads a surface from a resource file.<br><tt></tt> <a href="CL_Surface.html#2491"><tt><font color=blue><b>CL_Surface</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>resource_id</font></tt>, <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>* <tt><font color=blue>manager</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2492"><font size=+1><b>CL_Surface::CL_Surface</b></font></a> - Loads a surface from an image file.<br><tt></tt> <a href="CL_Surface.html#2492"><tt><font color=blue><b>CL_Surface</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>dynamic</font></tt> = false)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2493"><font size=+1><b>CL_Surface::CL_Surface</b></font></a> - Make a copy of an other surface, but share the image data.<br><tt></tt> <a href="CL_Surface.html#2493"><tt><font color=blue><b>CL_Surface</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>& <tt><font color=blue>surface</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2512"><font size=+1><b>CL_Surface::CL_Surface</b></font></a> - Surface Constructor<br><tt></tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_Surface_Generic</font></tt>* <tt><font color=blue>impl</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2495"><font size=+1><b>CL_Surface::bool</b></font></a> - You can use this operator to check if the surface is<br> valid, to do that you write something like this: if (surf) {...}<br><tt><tt><font color=navy>operator</font></tt></tt> <a href="CL_Surface.html#2495"><tt><font color=blue><b>bool</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2509"><font size=+1><b>CL_Surface::convert_system</b></font></a> - convert surface to system memory - never fails! (or serious heap usage!)<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_Surface.html#2509"><tt><font color=blue><b>convert_system</b></font></tt></a><tt>(<a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2508"><font size=+1><b>CL_Surface::convert_video</b></font></a> - returns true if successfully loaded into videomemory, or already there<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_Surface.html#2508"><tt><font color=blue><b>convert_video</b></font></tt></a><tt>(<a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2487"><font size=+1><b>CL_Surface::create</b></font></a> - This function creates a <a href="CL_Surface.html">CL_Surface</a> instance being blitted by a caching blitter.<br><tt><tt>static</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>*</tt> <a href="CL_Surface.html#2487"><tt><font color=blue><b>create</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>provider</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>delete_provider</font></tt>=false)</tt>;<br><blockquote> provider - Image source.<br> delete_provider - If true, the surface will delete the provider when deleted itself.<br> Returns - The surface created.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2488"><font size=+1><b>CL_Surface::create_dynamic</b></font></a> - This function creates a <a href="CL_Surface.html">CL_Surface</a> instance being blitted by the dynamic (non caching) blitter.<br> You don't need to call reload with dynamic surfaces as they do that by themselves. <br><tt><tt>static</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>*</tt> <a href="CL_Surface.html#2488"><tt><font color=blue><b>create_dynamic</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>provider</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>delete_provider</font></tt>=false)</tt>;<br><blockquote> provider - Image source.<br> delete_provider - If true, the surface will delete the provider when deleted itself.<br> Returns - The surface created.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2510"><font size=+1><b>CL_Surface::flush</b></font></a> - completely flushes surface (removes from video/system-memory)<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Surface.html#2510"><tt><font color=blue><b>flush</b></font></tt></a><tt>(<a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2504"><font size=+1><b>CL_Surface::get_height</b></font></a> - Returns the height of the surface<br><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Surface.html#2504"><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="2505"><font size=+1><b>CL_Surface::get_num_frames</b></font></a> - Returns the number of frames/subsprites in the surface<br><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Surface.html#2505"><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="2498"><font size=+1><b>CL_Surface::get_provider</b></font></a> - Returns the surface provider used by this surface.<br><tt><a href="CL_SurfaceProvider.html"><tt><font color=navy><b>CL_SurfaceProvider</b></font></tt></a>*</tt> <a href="CL_Surface.html#2498"><tt><font color=blue><b>get_provider</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Surface provider used by this surface.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2511"><font size=+1><b>CL_Surface::get_reference_count</b></font></a> - Return the number of references to this surface<br><tt><tt><font color=purple>int</font></tt></tt> <a href="CL_Surface.html#2511"><tt><font color=blue><b>get_reference_count</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2503"><font size=+1><b>CL_Surface::get_width</b></font></a> - Returns the width of the surface<br><tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Surface.html#2503"><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="2507"><font size=+1><b>CL_Surface::is_loaded</b></font></a> - returns true if loaded in either video- or system-memory<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_Surface.html#2507"><tt><font color=blue><b>is_loaded</b></font></tt></a><tt>(<a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt> = NULL) <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2506"><font size=+1><b>CL_Surface::is_video</b></font></a> - returns true if in videomemory <br> on the specified card (null = current dispcard).<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_Surface.html#2506"><tt><font color=blue><b>is_video</b></font></tt></a><tt>(<a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt> = NULL) <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2486"><font size=+1><b>CL_Surface::load</b></font></a> - This function loads a surface from a resource file (usually a datafile).<br><tt><tt>static</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>*</tt> <a href="CL_Surface.html#2486"><tt><font color=blue><b>load</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>resource_id</font></tt>, <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>* <tt><font color=blue>manager</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2496"><font size=+1><b>CL_Surface::operator =</b></font></a> - Surface operator<br><tt><tt>const</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>&</tt> <a href="CL_Surface.html#2496"><tt><font color=black><b>operator</b></font></tt><tt> =</tt></a><tt>(<tt>const</tt> <a href="CL_Surface.html#2512"><tt><font color=blue><b>CL_Surface</b></font></tt></a>& <tt><font color=blue>surf</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2499"><font size=+1><b>CL_Surface::put_screen</b></font></a> - Draws the surface onto the backbuffer.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Surface.html#2499"><tt><font color=blue><b>put_screen</b></font></tt></a><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>spr_no</font></tt>=0, <a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>=NULL)</tt>;<br><blockquote> x - x coordinate to draw surface.<br> y - y coordinate to draw surface.<br> spr_no - subsprite number to use.<br> card - Display card to be drawn onto. If NULL it will use the currently selected video card by CL_Display.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2500"><font size=+1><b>CL_Surface::put_screen</b></font></a> - Draws the surface onto the backbuffer - scaling it to a specified size.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Surface.html#2500"><tt><font color=blue><b>put_screen</b></font></tt></a><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>float</font></tt> <tt><font color=blue>scale_x</font></tt>, <tt><font color=purple>float</font></tt> <tt><font color=blue>scale_y</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>spr_no</font></tt>=0, <a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>=NULL)</tt>;<br><blockquote> x - x coordinate to draw surface.<br> y - y coordinate to draw surface.<br> scale_x - scale x multiplyer.<br> scale_y - scale y multiplyer.<br> spr_no - subsprite number to use.<br> card - Display card to be drawn onto. If NULL it will use the currently selected video card by CL_Display.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2501"><font size=+1><b>CL_Surface::put_screen</b></font></a> - Draws the surface onto the backbuffer - scaling it to a specified size.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Surface.html#2501"><tt><font color=blue><b>put_screen</b></font></tt></a><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>size_x</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>size_y</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>spr_no</font></tt>=0, <a href="CL_DisplayCard.html"><tt><font color=navy><b>CL_DisplayCard</b></font></tt></a>* <tt><font color=blue>card</font></tt>=NULL)</tt>;<br><blockquote> x - x coordinate to draw surface.<br> y - y coordinate to draw surface.<br> size_x - width of the image when scaled.<br> size_y - height of the image when scaled.<br> spr_no - subsprite number to use.<br> card - Display card to be drawn onto. If NULL it will use the currently selected video card by CL_Display.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2502"><font size=+1><b>CL_Surface::put_target</b></font></a> - Draws the surface to a target.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Surface.html#2502"><tt><font color=blue><b>put_target</b></font></tt></a><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>spr_no</font></tt>, <a href="CL_Target.html"><tt><font color=navy><b>CL_Target</b></font></tt></a>* <tt><font color=blue>target</font></tt>)</tt>;<br><blockquote> x - x coordinate to draw surface.<br> y - y coordinate to draw surface.<br> spr_no - subsprite number to use.<br> target - target.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2497"><font size=+1><b>CL_Surface::reload</b></font></a> - Forces surface to reload surface data from provider.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Surface.html#2497"><tt><font color=blue><b>reload</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2494"><font size=+1><b>CL_Surface::~CL_Surface</b></font></a> - Surface Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_Surface.html#2494"><tt><font color=blue><b>~CL_Surface</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<hr noshade>
<h2>Variable Member Descriptions:</h2>
<a name="2513"><font size=+1><b>CL_Surface::impl</b></font></a> - Surface Implementation<br>
<tt><tt><font color=navy>CL_Surface_Generic</font></tt> *</tt> <tt><a href="CL_Surface.html#2513"><tt><font color=blue>impl</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br>
<a name="2514"><font size=+1><b>CL_Surface::resource</b></font></a> - Surface resource, if any.<br>
<tt><a href="CL_Resource.html"><tt><font color=navy><b>CL_Resource</b></font></tt></a> </tt> <tt><a href="CL_Surface.html#2514"><tt><font color=blue>resource</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br>
<hr noshade>
</body>
</html>
