Reference

CL_MouseCursor(3)

Mouse cursor management class.

NAME

CL_MouseCursor - Mouse cursor management class.

DESCRIPTION

Use this class to set the mouse cursor icon, or to toggle its visibility.

CLASS MEMBERS

static void set_cursor(
 CL_MouseCursorProvider *provider,
int frame=0)
static void show(
bool show_async=true)
static void hide()

MEMBERS WITH DESCRIPTIONS

static void set_cursor(
 CL_MouseCursorProvider *provider,
int frame=0)


Parameters:
provider - Mouse cursor to use.
frame - Subframe in the mouse cursor to use.


Description:

Set the system mouse cursor to 'provider'. If 'frame' is also specified, it will use that subframe in the cursor provider.

static void show(
bool show_async=true)


Parameters:
show_async - True if a secondary thread should be used for
mouse painting.


Description:

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.

static void hide()
Description:

Hides the mouse cursor.

SEE ALSO

All ClanLib API classes can be found in clanlib (3).

AUTHORS

Originally written by Magnus Norddahl <[email protected]> and Martin Starch <[email protected]>. ClanLib is now developed by the ClanLib Development team as an Open Source project.

The ClanLib man pages was created using the Perceps documentation system (another excellent piece of Open Source software, available at http://somewhere.in.the.world.org).

See clanlib (3) to find out how to get a full list of contributors and details on how to submit bug reports, comments etc.