<html> <head><title>ClanLib Reference: CL_DynamicProvider</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_DynamicProvider</h1><p> <b> Dynamic 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>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_DynamicProvider.html#1811"><tt><font color=blue><b>create</b></font></tt></a></td><td><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>no_sprs</font></tt>, <tt><font color=navy>EPixelFormat</font></tt> <tt><font color=blue>type</font></tt> = PAL8, <tt><font color=purple>int</font></tt> <tt><font color=blue>transcol</font></tt> = -1)</tt>;</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_DynamicProvider.html#1812"><tt><font color=blue><b>create</b></font></tt></a></td><td><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>no_sprs</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>red_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>green_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>blue_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>alpha_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>transcol</font></tt> = -1)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_DynamicProvider.html#1813"><tt><font color=blue><b>CL_DynamicProvider</b></font></tt></a></td><td><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>no_sprs</font></tt>, <tt><font color=navy>EPixelFormat</font></tt> <tt><font color=blue>type</font></tt> = PAL8, <tt><font color=purple>int</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_DynamicProvider.html#1814"><tt><font color=blue><b>CL_DynamicProvider</b></font></tt></a></td><td><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>no_sprs</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>red_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>green_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>blue_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>alpha_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>transcol</font></tt> = -1)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_DynamicProvider.html#1815"><tt><font color=blue><b>~CL_DynamicProvider</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=purple>int</font></tt></tt> </td><td align=right><a href="CL_DynamicProvider.html#1816"><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=purple>int</font></tt></tt> </td><td align=right><a href="CL_DynamicProvider.html#1817"><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=purple>int</font></tt></tt> </td><td align=right><a href="CL_DynamicProvider.html#1818"><tt><font color=blue><b>get_no_sprs</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>EPixelFormat</font></tt></tt> </td><td align=right><a href="CL_DynamicProvider.html#1819"><tt><font color=blue><b>get_pixel_format</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_DynamicProvider.html#1820"><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>int</font></tt></tt> </td><td align=right><a href="CL_DynamicProvider.html#1821"><tt><font color=blue><b>get_transcol</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_DynamicProvider.html#1822"><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_DynamicProvider.html#1823"><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_DynamicProvider.html#1824"><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> Empty space dynamic surface provider header file<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1813"><font size=+1><b>CL_DynamicProvider::CL_DynamicProvider</b></font></a> - Dynamic Provider Constructor<br><tt></tt> <a href="CL_DynamicProvider.html#1813"><tt><font color=blue><b>CL_DynamicProvider</b></font></tt></a><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>no_sprs</font></tt>, <tt><font color=navy>EPixelFormat</font></tt> <tt><font color=blue>type</font></tt> = PAL8, <tt><font color=purple>int</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="1814"><font size=+1><b>CL_DynamicProvider::CL_DynamicProvider</b></font></a> - Dynamic Provider Constructor<br><tt></tt> <a href="CL_DynamicProvider.html#1814"><tt><font color=blue><b>CL_DynamicProvider</b></font></tt></a><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>no_sprs</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>red_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>green_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>blue_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>alpha_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>transcol</font></tt> = -1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1811"><font size=+1><b>CL_DynamicProvider::create</b></font></a> - Create<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_DynamicProvider.html#1811"><tt><font color=blue><b>create</b></font></tt></a><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>no_sprs</font></tt>, <tt><font color=navy>EPixelFormat</font></tt> <tt><font color=blue>type</font></tt> = PAL8, <tt><font color=purple>int</font></tt> <tt><font color=blue>transcol</font></tt> = -1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1812"><font size=+1><b>CL_DynamicProvider::create</b></font></a> - Create<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_DynamicProvider.html#1812"><tt><font color=blue><b>create</b></font></tt></a><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>no_sprs</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>red_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>green_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>blue_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>alpha_mask</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>transcol</font></tt> = -1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1822"><font size=+1><b>CL_DynamicProvider::get_data</b></font></a> - Returns the pointer to the surface data, where you can copy your data to. It should be only called between lock() and unlock(). <br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt>*</tt> <a href="CL_DynamicProvider.html#1822"><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="1817"><font size=+1><b>CL_DynamicProvider::get_height</b></font></a> - Get height<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_DynamicProvider.html#1817"><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="1818"><font size=+1><b>CL_DynamicProvider::get_no_sprs</b></font></a> - Get no sprs<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_DynamicProvider.html#1818"><tt><font color=blue><b>get_no_sprs</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1820"><font size=+1><b>CL_DynamicProvider::get_palette</b></font></a> - Returns NULL, because PAL8 isn't supported<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_DynamicProvider.html#1820"><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="1819"><font size=+1><b>CL_DynamicProvider::get_pixel_format</b></font></a> - Returns the pixelformat of the DynamicProvider as it was set in the constructor<br><tt><tt>virtual</tt> <tt><font color=navy>EPixelFormat</font></tt></tt> <a href="CL_DynamicProvider.html#1819"><tt><font color=blue><b>get_pixel_format</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1821"><font size=+1><b>CL_DynamicProvider::get_transcol</b></font></a> - Returns the transparent color, which was set in the constructor<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_DynamicProvider.html#1821"><tt><font color=blue><b>get_transcol</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1816"><font size=+1><b>CL_DynamicProvider::get_width</b></font></a> - Get width<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_DynamicProvider.html#1816"><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="1823"><font size=+1><b>CL_DynamicProvider::perform_lock</b></font></a> - Perform Lock<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_DynamicProvider.html#1823"><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="1824"><font size=+1><b>CL_DynamicProvider::perform_unlock</b></font></a> - Perform UnLock<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_DynamicProvider.html#1824"><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="1815"><font size=+1><b>CL_DynamicProvider::~CL_DynamicProvider</b></font></a> - Deletes the DynamicProvider and deletes the data which was allocated in the constructor<br><tt><tt>virtual</tt> </tt> <a href="CL_DynamicProvider.html#1815"><tt><font color=blue><b>~CL_DynamicProvider</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>
