<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iCursor Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iCursor Struct Reference</h1><!-- doxytag: class="iCursor" --><!-- doxytag: inherits="iBase" -->This interface is used to access the custom cursor plugin, which handles processing for displaying pixmaps as cursors.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="custcursor_8h-source.html">ivideo/custcursor.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iCursor:</div>
<div class="dynsection">
<p><center><img src="structiCursor__inherit__graph.png" border="0" usemap="#iCursor__inherit__map" alt="Inheritance graph"></center>
<map name="iCursor__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="11,7,67,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiCursor-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#281942a563a0d060cde2670dd8f56dd0">GetBGColor</a> (const char *name) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the background color of the cursor. <a href="#281942a563a0d060cde2670dd8f56dd0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiImage.html">iImage</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#b93ce20426b07eeeef7e20a19ccbe75d">GetCursorImage</a> (const char *name) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get cursor image of the specified cursor. <a href="#b93ce20426b07eeeef7e20a19ccbe75d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#1ffaaea912f8182832349b9c90cc6cf1">GetFGColor</a> (const char *name) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the foreground color of the cursor. <a href="#1ffaaea912f8182832349b9c90cc6cf1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsVector2.html">csVector2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#403a969caee78ea3fd7283588f3da8a4">GetHotSpot</a> (const char *name) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the hotspot (center) of the specified cursor on the pixmap. <a href="#403a969caee78ea3fd7283588f3da8a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br>
<a class="el" href="structcsRGBcolor.html">csRGBcolor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#690ea68462ea68901a03b9dce8f98488">GetKeyColor</a> (const char *name) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get key colour of the specified cursor. <a href="#690ea68462ea68901a03b9dce8f98488"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#e0b0575dac2ac89957eaeaf33e432287">GetTransparency</a> (const char *name) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the transparency of the specified cursor. <a href="#e0b0575dac2ac89957eaeaf33e432287"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#949bf7e4dc835544ab14689c6ec34858">ParseConfigFile</a> (<a class="el" href="structiConfigFile.html">iConfigFile</a> *)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load cursor settings from a configuration file. <a href="#949bf7e4dc835544ab14689c6ec34858"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#eb243efe50e32012ab0058b9c1e7eb8a">RemoveAllCursors</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all cursors. <a href="#eb243efe50e32012ab0058b9c1e7eb8a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#a0a77374c2d63cc5167937db889a98a2">RemoveCursor</a> (const char *name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Completely remove a cursor. <a href="#a0a77374c2d63cc5167937db889a98a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#309b45fd1b56cf88f796e8d765d97353">SetColor</a> (const char *name, <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> fg, <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> bg)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the foreground and background colors of the cursor. <a href="#309b45fd1b56cf88f796e8d765d97353"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#48344b2df7dac77684b67acc096ca866">SetCursor</a> (const char *name, <a class="el" href="structiImage.html">iImage</a> *image, <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> *keycolor=0, <a class="el" href="classcsVector2.html">csVector2</a> hotspot=<a class="el" href="classcsVector2.html">csVector2</a>(0, 0), <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> transparency=0, <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> fg=<a class="el" href="structcsRGBcolor.html">csRGBcolor</a>(255, 255, 255), <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> bg=<a class="el" href="structcsRGBcolor.html">csRGBcolor</a>(0, 0, 0))=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds or replaces a cursor called name. <a href="#48344b2df7dac77684b67acc096ca866"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#691c68d49f982a0e7e76f258fe2da69c">SetHotSpot</a> (const char *name, <a class="el" href="classcsVector2.html">csVector2</a> hotspot)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the hotspot (center) of the specified cursor on the pixmap. <a href="#691c68d49f982a0e7e76f258fe2da69c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#60c74d1eb63637fa834355126bd5fb14">SetKeyColor</a> (const char *name, <a class="el" href="structcsRGBcolor.html">csRGBcolor</a>)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set key colour of the specified cursor. <a href="#60c74d1eb63637fa834355126bd5fb14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#4ccf9bcceff754fcca33fd7a2acf2528">SetTransparency</a> (const char *name, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> transparancy)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the transparency of the specified cursor. <a href="#4ccf9bcceff754fcca33fd7a2acf2528"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#13690fa9bef1a2d34ffa87001ad30ab7">Setup</a> (<a class="el" href="structiGraphics3D.html">iGraphics3D</a> *, bool ForceEmulation=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Must be called before custom cursors will be displayed. <a href="#13690fa9bef1a2d34ffa87001ad30ab7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiCursor.html#761485f78c6b03f2da959bb8c9ad1553">SwitchCursor</a> (const char *name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Switches the current cursor displayed to the specified cursor. <a href="#761485f78c6b03f2da959bb8c9ad1553"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This interface is used to access the custom cursor plugin, which handles processing for displaying pixmaps as cursors.
<p>
Any number of cursors can be set, indexed by key strings, along with hotspots, and transparency. Supports any static <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a>. <p>
A default implementation of the <a class="el" href="structiCursor.html" title="This interface is used to access the custom cursor plugin, which handles processing...">iCursor</a> interface is provided by the 'crystalspace.graphic.cursor' plugin.
<p>Definition at line <a class="el" href="custcursor_8h-source.html#l00050">50</a> of file <a class="el" href="custcursor_8h-source.html">custcursor.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="281942a563a0d060cde2670dd8f56dd0"></a><!-- doxytag: member="iCursor::GetBGColor" ref="281942a563a0d060cde2670dd8f56dd0" args="(const char *name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> iCursor::GetBGColor </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the background color of the cursor.
<p>
These will only be used for graphics drivers which support only monochrome cursors. Returns default 0,0,0 if there is no cursor with this name.
</div>
</div><p>
<a class="anchor" name="b93ce20426b07eeeef7e20a19ccbe75d"></a><!-- doxytag: member="iCursor::GetCursorImage" ref="b93ce20426b07eeeef7e20a19ccbe75d" args="(const char *name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiImage.html">iImage</a>> iCursor::GetCursorImage </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get cursor image of the specified cursor.
<p>
The returned reference is invalid -- check with <a class="el" href="classcsRef.html#620198af96e2f744bab6207d9c546ed8" title="Smart pointer validity check.">csRef<>::IsValid()</a> -- if the cursor is not registered. This getter safely can be used to check if a cursor is defined or not without switching cursors.
</div>
</div><p>
<a class="anchor" name="1ffaaea912f8182832349b9c90cc6cf1"></a><!-- doxytag: member="iCursor::GetFGColor" ref="1ffaaea912f8182832349b9c90cc6cf1" args="(const char *name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structcsRGBcolor.html">csRGBcolor</a> iCursor::GetFGColor </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the foreground color of the cursor.
<p>
These will only be used for graphics drivers which support only monochrome cursors. Returns default 255,255,255 if there is no cursor with this name.
</div>
</div><p>
<a class="anchor" name="403a969caee78ea3fd7283588f3da8a4"></a><!-- doxytag: member="iCursor::GetHotSpot" ref="403a969caee78ea3fd7283588f3da8a4" args="(const char *name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsVector2.html">csVector2</a> iCursor::GetHotSpot </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the hotspot (center) of the specified cursor on the pixmap.
<p>
Returns default 0,0 if there is no cursor with this name
</div>
</div><p>
<a class="anchor" name="690ea68462ea68901a03b9dce8f98488"></a><!-- doxytag: member="iCursor::GetKeyColor" ref="690ea68462ea68901a03b9dce8f98488" args="(const char *name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="structcsRGBcolor.html">csRGBcolor</a>* iCursor::GetKeyColor </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get key colour of the specified cursor.
<p>
Returns default 0 if the cursor has no keycolor set or there is no cursor with this name
</div>
</div><p>
<a class="anchor" name="e0b0575dac2ac89957eaeaf33e432287"></a><!-- doxytag: member="iCursor::GetTransparency" ref="e0b0575dac2ac89957eaeaf33e432287" args="(const char *name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> iCursor::GetTransparency </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the transparency of the specified cursor.
<p>
Transparency can range from 0 (completely opaque) to 255 (completely transparent). Returns default 0 if there is no cursor with this name.
</div>
</div><p>
<a class="anchor" name="949bf7e4dc835544ab14689c6ec34858"></a><!-- doxytag: member="iCursor::ParseConfigFile" ref="949bf7e4dc835544ab14689c6ec34858" args="(iConfigFile *)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iCursor::ParseConfigFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiConfigFile.html">iConfigFile</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load cursor settings from a configuration file.
<p>
</div>
</div><p>
<a class="anchor" name="eb243efe50e32012ab0058b9c1e7eb8a"></a><!-- doxytag: member="iCursor::RemoveAllCursors" ref="eb243efe50e32012ab0058b9c1e7eb8a" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iCursor::RemoveAllCursors </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove all cursors.
<p>
</div>
</div><p>
<a class="anchor" name="a0a77374c2d63cc5167937db889a98a2"></a><!-- doxytag: member="iCursor::RemoveCursor" ref="a0a77374c2d63cc5167937db889a98a2" args="(const char *name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iCursor::RemoveCursor </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Completely remove a cursor.
<p>
</div>
</div><p>
<a class="anchor" name="309b45fd1b56cf88f796e8d765d97353"></a><!-- doxytag: member="iCursor::SetColor" ref="309b45fd1b56cf88f796e8d765d97353" args="(const char *name, csRGBcolor fg, csRGBcolor bg)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iCursor::SetColor </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcsRGBcolor.html">csRGBcolor</a> </td>
<td class="paramname"> <em>fg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcsRGBcolor.html">csRGBcolor</a> </td>
<td class="paramname"> <em>bg</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the foreground and background colors of the cursor.
<p>
These will only be used for graphics drivers which support only monochrome cursors.
</div>
</div><p>
<a class="anchor" name="48344b2df7dac77684b67acc096ca866"></a><!-- doxytag: member="iCursor::SetCursor" ref="48344b2df7dac77684b67acc096ca866" args="(const char *name, iImage *image, csRGBcolor *keycolor=0, csVector2 hotspot=csVector2(0, 0), uint8 transparency=0, csRGBcolor fg=csRGBcolor(255, 255, 255), csRGBcolor bg=csRGBcolor(0, 0, 0))=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iCursor::SetCursor </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiImage.html">iImage</a> * </td>
<td class="paramname"> <em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcsRGBcolor.html">csRGBcolor</a> * </td>
<td class="paramname"> <em>keycolor</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsVector2.html">csVector2</a> </td>
<td class="paramname"> <em>hotspot</em> = <code><a class="el" href="classcsVector2.html">csVector2</a>(0, 0)</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> </td>
<td class="paramname"> <em>transparency</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcsRGBcolor.html">csRGBcolor</a> </td>
<td class="paramname"> <em>fg</em> = <code><a class="el" href="structcsRGBcolor.html">csRGBcolor</a>(255, 255, 255)</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcsRGBcolor.html">csRGBcolor</a> </td>
<td class="paramname"> <em>bg</em> = <code><a class="el" href="structcsRGBcolor.html">csRGBcolor</a>(0, 0, 0)</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds or replaces a cursor called name.
<p>
Currently you can only register an <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> - a simple pixmap will then be created for use in emulation mode. The 'transparency' can range from 0 (completely opaque) to 255 (completely transparent).
</div>
</div><p>
<a class="anchor" name="691c68d49f982a0e7e76f258fe2da69c"></a><!-- doxytag: member="iCursor::SetHotSpot" ref="691c68d49f982a0e7e76f258fe2da69c" args="(const char *name, csVector2 hotspot)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iCursor::SetHotSpot </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsVector2.html">csVector2</a> </td>
<td class="paramname"> <em>hotspot</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the hotspot (center) of the specified cursor on the pixmap.
<p>
</div>
</div><p>
<a class="anchor" name="60c74d1eb63637fa834355126bd5fb14"></a><!-- doxytag: member="iCursor::SetKeyColor" ref="60c74d1eb63637fa834355126bd5fb14" args="(const char *name, csRGBcolor)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iCursor::SetKeyColor </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcsRGBcolor.html">csRGBcolor</a> </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set key colour of the specified cursor.
<p>
</div>
</div><p>
<a class="anchor" name="4ccf9bcceff754fcca33fd7a2acf2528"></a><!-- doxytag: member="iCursor::SetTransparency" ref="4ccf9bcceff754fcca33fd7a2acf2528" args="(const char *name, uint8 transparancy)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iCursor::SetTransparency </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> </td>
<td class="paramname"> <em>transparancy</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the transparency of the specified cursor.
<p>
The 'transparency' can range from 0 (completely opaque) to 255 (completely transparent) This will only work if the video driver supports transparency for cursors, or the cursor is being emulated.
</div>
</div><p>
<a class="anchor" name="13690fa9bef1a2d34ffa87001ad30ab7"></a><!-- doxytag: member="iCursor::Setup" ref="13690fa9bef1a2d34ffa87001ad30ab7" args="(iGraphics3D *, bool ForceEmulation=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iCursor::Setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiGraphics3D.html">iGraphics3D</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ForceEmulation</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Must be called before custom cursors will be displayed.
<p>
If you want to use software emulation mode on all platforms, set the ForceEmulation argument to true.
</div>
</div><p>
<a class="anchor" name="761485f78c6b03f2da959bb8c9ad1553"></a><!-- doxytag: member="iCursor::SwitchCursor" ref="761485f78c6b03f2da959bb8c9ad1553" args="(const char *name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iCursor::SwitchCursor </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Switches the current cursor displayed to the specified cursor.
<p>
Disables automatic switching of cursors on mouse events;<p>
The system defaults to CSCURSOR_Default. In this mode, it will also automatically switch to CSCURSOR_MouseDown when the mouse is pressed
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivideo/<a class="el" href="custcursor_8h-source.html">custcursor.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2869
