<html> <head><title>ClanLib Reference: CL_MouseCursorProvider</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_MouseCursorProvider</h1><p> <b> Mouse cursor image interface.</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>static</tt> <a href="CL_MouseCursorProvider.html"><tt><font color=navy><b>CL_MouseCursorProvider</b></font></tt></a>*</tt> </td><td align=right><a href="CL_MouseCursorProvider.html#2432"><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>=true, <tt><font color=purple>bool</font></tt> <tt><font color=blue>animate</font></tt>=true, <tt>const</tt> <tt><font color=navy>std::vector</font></tt><<tt><font color=purple>int</font></tt>>* <tt><font color=blue>frame_delays</font></tt>=NULL)</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <a href="CL_MouseCursorProvider.html"><tt><font color=navy><b>CL_MouseCursorProvider</b></font></tt></a>*</tt> </td><td align=right><a href="CL_MouseCursorProvider.html#2433"><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>virtual</tt> </tt> </td><td align=right><a href="CL_MouseCursorProvider.html#2434"><tt><font color=blue><b>~CL_MouseCursorProvider</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> <a href="CL_SurfaceProvider.html"><tt><font color=navy><b>CL_SurfaceProvider</b></font></tt></a>*</tt> </td><td align=right><a href="CL_MouseCursorProvider.html#2435"><tt><font color=blue><b>get_surface_provider</b></font></tt></a></td><td><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_MouseCursorProvider.html#2436"><tt><font color=blue><b>is_animated</b></font></tt></a></td><td><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_MouseCursorProvider.html#2437"><tt><font color=blue><b>get_frame_delay</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>frame_number</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> The mouse cursor provider is an interface that describes how a mouse cursor should animate, and which images it should use.<br> Use this class to create your cursor icon, and then use <a href="CL_MouseCursor.html">CL_MouseCursor</a> to make your cursor visible.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="2432"><font size=+1><b>CL_MouseCursorProvider::create</b></font></a> - Creates a mouse cursor source, using a surface provider as the image source.<br> If the surface provider contain subframes, those will be available in the mouse cursor too. Furthermore, those frames can be used to animate the cursor, if a list of millisec delays are passed as well.<br><tt><tt>static</tt> <a href="CL_MouseCursorProvider.html"><tt><font color=navy><b>CL_MouseCursorProvider</b></font></tt></a>*</tt> <a href="CL_MouseCursorProvider.html#2432"><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>=true, <tt><font color=purple>bool</font></tt> <tt><font color=blue>animate</font></tt>=true, <tt>const</tt> <tt><font color=navy>std::vector</font></tt><<tt><font color=purple>int</font></tt>>* <tt><font color=blue>frame_delays</font></tt>=NULL)</tt>;<br><blockquote> provider - Image of the cursor.<br> delete_provider - If true, the surface provider will be<br> deleted together with the cursor provider.<br> animate - If true, the subframes in the surface provider will<br> be used to animate the cursor.<br> frame_delays - A list of millis to wait between each frame,<br> when animating the cursor.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2437"><font size=+1><b>CL_MouseCursorProvider::get_frame_delay</b></font></a> - Returns the millisec delay between 'frame_number' and the next one.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_MouseCursorProvider.html#2437"><tt><font color=blue><b>get_frame_delay</b></font></tt></a><tt>(<tt><font color=navy>unsigned</font></tt> <tt><font color=purple>int</font></tt> <tt><font color=blue>frame_number</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2435"><font size=+1><b>CL_MouseCursorProvider::get_surface_provider</b></font></a> - Returns the surface provider associated with the mouse cursor.<br><tt><tt>virtual</tt> <a href="CL_SurfaceProvider.html"><tt><font color=navy><b>CL_SurfaceProvider</b></font></tt></a>*</tt> <a href="CL_MouseCursorProvider.html#2435"><tt><font color=blue><b>get_surface_provider</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2436"><font size=+1><b>CL_MouseCursorProvider::is_animated</b></font></a> - Returns true if the cursor is animated.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_MouseCursorProvider.html#2436"><tt><font color=blue><b>is_animated</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2433"><font size=+1><b>CL_MouseCursorProvider::load</b></font></a> - Creates a mouse provider, loaded from resources.<br><tt><tt>static</tt> <a href="CL_MouseCursorProvider.html"><tt><font color=navy><b>CL_MouseCursorProvider</b></font></tt></a>*</tt> <a href="CL_MouseCursorProvider.html#2433"><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>;<br><blockquote> resource_id - Resource ID of the mouse cursor.<br> manager - Resource manager where the cursor is loaded from.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2434"><font size=+1><b>CL_MouseCursorProvider::~CL_MouseCursorProvider</b></font></a> - Mouse Cursor Provider destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_MouseCursorProvider.html#2434"><tt><font color=blue><b>~CL_MouseCursorProvider</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> </body> </html>
