Entire Class Index | Main Class Index | Cross Index | Global Index

# Class CL_MouseCursor

Mouse cursor management class.
Contained in: global
Derived from: none
Derived by: none
Group: Display (Display 2D)

#include <ClanLib/display.h>

### public function member index:

### Operations:

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

## Description:

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

## Function Member Descriptions:

CL_MouseCursor::hide - Hides the mouse cursor.
``static` `void`` `hide` `()`;

CL_MouseCursor::set_cursor - Set the system mouse cursor to 'provider'. If 'frame' is also specified, it will use that subframe in the cursor provider.
``static` `void`` `set_cursor` `(`CL_MouseCursorProvider`* `provider`, `int` `frame`=0)`;

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

CL_MouseCursor::show - 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`` `show` `(`bool` `show_async`=true)`;

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