<html> <head><title>ClanLib Reference: CL_MouseCursor</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_MouseCursor</h1><p> <b> Mouse cursor management class.</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>Operations:</h3></td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_MouseCursor.html#2452"><tt><font color=blue><b>set_cursor</b></font></tt></a></td><td><tt>(<a href="CL_MouseCursorProvider.html"><tt><font color=navy><b>CL_MouseCursorProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>frame</font></tt>=0)</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_MouseCursor.html#2453"><tt><font color=blue><b>show</b></font></tt></a></td><td><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>show_async</font></tt>=true)</tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_MouseCursor.html#2454"><tt><font color=blue><b>hide</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> Use this class to set the mouse cursor icon, or to toggle its visibility.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="2454"><font size=+1><b>CL_MouseCursor::hide</b></font></a> - Hides the mouse cursor.<br><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_MouseCursor.html#2454"><tt><font color=blue><b>hide</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2452"><font size=+1><b>CL_MouseCursor::set_cursor</b></font></a> - Set the system mouse cursor to 'provider'. If 'frame' is also specified, it will use that subframe in the cursor provider.<br><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_MouseCursor.html#2452"><tt><font color=blue><b>set_cursor</b></font></tt></a><tt>(<a href="CL_MouseCursorProvider.html"><tt><font color=navy><b>CL_MouseCursorProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>frame</font></tt>=0)</tt>;<br><blockquote> provider - Mouse cursor to use.<br> frame - Subframe in the mouse cursor to use.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2453"><font size=+1><b>CL_MouseCursor::show</b></font></a> - Makes the currently selected mouse cursor visible. If 'show_async' is true, it will use a secondary thread to draw the mouse. This ensures that the mouse cursor will keep running smooth despite of the framerate in the game.<br><tt><tt>static</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_MouseCursor.html#2453"><tt><font color=blue><b>show</b></font></tt></a><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>show_async</font></tt>=true)</tt>;<br><blockquote> show_async - True if a secondary thread should be used for<br> mouse painting.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> </body> </html>
