---
name: "CL_PPMProvider"
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_PPMProvider"
---

# CL\_PPMProvider(3)

## NAME

CL\_PPMProvider

## CLASS MEMBERS

- static CL\_Surface \***create**(

  ```
   std::string handle,
  CL_InputSourceProvider *provider,
  bool transparent=false,
  unsigned char trans_red=0,
  unsigned char trans_green=0,
  unsigned char trans_blue=0)
  ```

- **CL\_PPMProvider**(

  ```
   std::string name,
  CL_InputSourceProvider *provider,
  bool transparent=false,
  unsigned char trans_red=0,
  unsigned char trans_green=0,
  unsigned char trans_blue=0)
  ```

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

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

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

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

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

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

  - 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 bool **is\_indexed**()

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

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

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

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

  - virtual void **lock**()

  - virtual void **unlock**()

  - unsigned int **save\_to\_file**(

  ```
   std::string output_name,
  int x_min,
  int y_min,
  int x_max,
  int y_max,
  unsigned char *src)
  ```

- int **my\_get\_value**(

  ```
  CL_InputSource *datafile)
  ```

## MEMBERS WITH DESCRIPTIONS

- static CL\_Surface \***create**(

  ```
   std::string handle,
  CL_InputSourceProvider *provider,
  bool transparent=false,
  unsigned char trans_red=0,
  unsigned char trans_green=0,
  unsigned char trans_blue=0)
  ```

  ```
  Description:
  ```

- **CL\_PPMProvider**(

  ```
   std::string name,
  CL_InputSourceProvider *provider,
  bool transparent=false,
  unsigned char trans_red=0,
  unsigned char trans_green=0,
  unsigned char trans_blue=0)
  ```

  ```
  Description:
  ```

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

  ```
  Description:
  ```

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

  ```
  Description:
  ```

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

  ```
  Description:
  ```

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

  ```
  Description:
  ```

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

  ```
  Description:
  ```

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

  ```
  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 bool **is\_indexed**()

  ```
  Description:
  ```

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

  ```
  Description:
  ```

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

  ```
  Description:
  ```

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

  ```
  Description:
  ```

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

  ```
  Description:
  ```

- virtual void **lock**()

  ```
  Description:
  ```

- virtual void **unlock**()

  ```
  Description:
  ```

- unsigned int **save\_to\_file**(

  ```
   std::string output_name,
  int x_min,
  int y_min,
  int x_max,
  int y_max,
  unsigned char *src)
  ```

  ```
  Description:
  ```

- int **my\_get\_value**(

  ```
  CL_InputSource *datafile)
  ```

  ```
  Description:
  ```

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