---
name: "CL_MouseCursorProvider"
section: "3"
platform: "linux"
package: "clanlib0-common-dev"
version: "0.4.4-8"
release: "Debian 3.0 (Woody)"
platforms: ["linux"]
url: "https://new.carta.tech/CL_MouseCursorProvider"
---

# CL\_MouseCursorProvider(3)

Mouse cursor image interface.

## NAME

CL\_MouseCursorProvider - Mouse cursor image interface.

## DESCRIPTION

The mouse cursor provider is an interface that describes how a mouse cursor should animate, and which images it should use. Use this class to create your cursor icon, and then use CL\_MouseCursor to make your cursor visible.

## CLASS MEMBERS

- virtual CL\_SurfaceProvider \***get\_surface\_provider**()

  - virtual bool **is\_animated**()

  - virtual int **get\_frame\_delay**(

  ```
  unsigned int frame_number)
  ```

## MEMBERS WITH DESCRIPTIONS

- virtual CL\_SurfaceProvider \***get\_surface\_provider**()

  ```
  Description:
  ```

  Returns the surface provider associated with the mouse cursor.

- virtual bool **is\_animated**()

  ```
  Description:
  ```

  Returns true if the cursor is animated.

- virtual int **get\_frame\_delay**(

  ```
  unsigned int frame_number)
  ```

  ```
  Description:
  ```

  Returns the millisec delay between 'frame\_number' and the next one.

## SEE ALSO

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

## AUTHORS

Originally written by Magnus Norddahl \<*mbn@dark.x.dtu.dk*\> and Martin Starch \<*starch@dark.x.dtu.dk*\>. 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.