CL_MouseCursor3

Overview

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.