---
name: "CL_Sprite2Provider"
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_Sprite2Provider"
---

# CL\_Sprite2Provider(3)

## NAME

CL\_Sprite2Provider

## CLASS MEMBERS

- **CL\_Sprite2Provider**(

  ```
  CL_InputSource *source)
  ```

- **CL\_Sprite2Provider**(

  ```
   CL_SurfaceProvider *src,
  int x,
  int y,
  int width,
  int height,
  int *tcols,
  int tcols_num)
  ```

- virtual **~CL\_Sprite2Provider**()

  - virtual unsigned int **get\_width**()

  - virtual unsigned int **get\_height**()

  - virtual unsigned int **get\_pitch**()

  - virtual unsigned int **get\_num\_frames**()

  - virtual CL\_Palette \***get\_palette**()

  - virtual bool **uses\_src\_colorkey**()

  - virtual unsigned int **get\_src\_colorkey**()

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

  - virtual unsigned int **get\_red\_mask**()

  - virtual unsigned int **get\_green\_mask**()

  - virtual unsigned int **get\_blue\_mask**()

  - virtual unsigned int **get\_alpha\_mask**()

  - virtual unsigned int **get\_depth**()

  - virtual void \***get\_data**()

  - virtual void **perform\_lock**()

  - virtual void **perform\_unlock**()

  ## MEMBERS WITH DESCRIPTIONS

- **CL\_Sprite2Provider**(

  ```
  CL_InputSource *source)
  ```

  ```
  Description:
  ```

- **CL\_Sprite2Provider**(

  ```
   CL_SurfaceProvider *src,
  int x,
  int y,
  int width,
  int height,
  int *tcols,
  int tcols_num)
  ```

  ```
  Description:
  ```

- virtual **~CL\_Sprite2Provider**()

  ```
  Description:
  ```

- virtual unsigned int **get\_width**()

  ```
  Description:
  ```

  Returns the width of the sprite2.

- virtual unsigned int **get\_height**()

  ```
  Description:
  ```

  Returns the height of the sprite2.

- virtual unsigned int **get\_pitch**()

  ```
  Description:
  ```

  Returns the pitch of the sprite2.

- virtual unsigned int **get\_num\_frames**()

  ```
  Description:
  ```

  Returns the number of subsprite2s in this sprite2.Returns the pixel format used by the sprite2.\
   	virtual EPixelFormat get\_pixel\_format() const;

- virtual CL\_Palette \***get\_palette**()

  ```
  Description:
  ```

  Returns the palette used by the surface. NULL if the system palette is used.

- virtual bool **uses\_src\_colorkey**()

  ```
  Description:
  ```

- virtual unsigned int **get\_src\_colorkey**()

  ```
  Description:
  ```

  Returns the transparency color used, or -1 if none.

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

  ```
  Description:
  ```

- virtual unsigned int **get\_red\_mask**()

  ```
  Description:
  ```

- virtual unsigned int **get\_green\_mask**()

  ```
  Description:
  ```

- virtual unsigned int **get\_blue\_mask**()

  ```
  Description:
  ```

- virtual unsigned int **get\_alpha\_mask**()

  ```
  Description:
  ```

- virtual unsigned int **get\_depth**()

  ```
  Description:
  ```

- virtual void \***get\_data**()

  ```
  Description:
  ```

  Returns a pointer to the sprite2s image data. Can only be called between lock() and unlock().

- virtual void **perform\_lock**()

  ```
  Description:
  ```

  Locks the surface provider. This causes the sprite2 to retrieve its surface data from the datafile.

- virtual void **perform\_unlock**()

  ```
  Description:
  ```

  Unlocks the surface provider. The sprite2 releases its surface data whenit is called.

## 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.