---
name: "CL_MagickProvider"
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_MagickProvider"
---

# CL\_MagickProvider(3)

Surface provider that can nearly load any graphics file format.

## NAME

CL\_MagickProvider - Surface provider that can nearly load any graphics file format.

## CLASS MEMBERS

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

  ```
   std::string name,
  CL_InputSourceProvider *provider,
  EPixelFormat pixelformat = RGBA8888,
  bool use_transcol=false,
  int transcol=0)
  ```

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

  ```
   std::string name,
  CL_InputSourceProvider *provider,
  int red_mask,
  int green_mask,
  int blue_mask,
  int alpha_mask,
  bool use_transcol=false,
  int transcol=0)
  ```

- **CL\_MagickProvider**(

  ```
   std::string name,
  CL_InputSourceProvider *provider,
  EPixelFormat pixelformat = RGBA8888,
  bool use_transcol=false,
  int transcol=0)
  ```

- **CL\_MagickProvider**(

  ```
   std::string name,
  CL_InputSourceProvider *provider,
  int red_mask,
  int green_mask,
  int blue_mask,
  int alpha_mask,
  bool use_transcol=false,
  int transcol=0)
  ```

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

  - 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\_red\_mask**()

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

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

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

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

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

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

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

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

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

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

  ## MEMBERS WITH DESCRIPTIONS

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

  ```
   std::string name,
  CL_InputSourceProvider *provider,
  EPixelFormat pixelformat = RGBA8888,
  bool use_transcol=false,
  int transcol=0)
  ```

  ```
  Description:
  ```

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

  ```
   std::string name,
  CL_InputSourceProvider *provider,
  int red_mask,
  int green_mask,
  int blue_mask,
  int alpha_mask,
  bool use_transcol=false,
  int transcol=0)
  ```

  ```
  Description:
  ```

- **CL\_MagickProvider**(

  ```
   std::string name,
  CL_InputSourceProvider *provider,
  EPixelFormat pixelformat = RGBA8888,
  bool use_transcol=false,
  int transcol=0)
  ```

  ```
  Description:
  ```

- **CL\_MagickProvider**(

  ```
   std::string name,
  CL_InputSourceProvider *provider,
  int red_mask,
  int green_mask,
  int blue_mask,
  int alpha_mask,
  bool use_transcol=false,
  int transcol=0)
  ```

  ```
  Description:
  ```

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

  ```
  Description:
  ```

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

  ```
  Description:
  ```

  Returns the pitch of the image (bytes per line).

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

  ```
  Description:
  ```

  Returns the width of the image.

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

  ```
  Description:
  ```

  Returns the height of the image.

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

  ```
  Description:
  ```

  Returns the number of subsprites in the image.

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

  ```
  Description:
  ```

  Returns the red mask.

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

  ```
  Description:
  ```

  Returns the blue mask.

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

  ```
  Description:
  ```

  Returns the green mask.

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

  ```
  Description:
  ```

  Returns the alpha mask.

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

  ```
  Description:
  ```

  Returns the palette used by the image. NULL if system palette.

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

  ```
  Description:
  ```

  Returns the transparency color used.

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

  ```
  Description:
  ```

  Returns whether src colorkeying is used.

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

  ```
  Description:
  ```

  Returns always false as the Magick Provider doesn't support PAL8 output

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

  ```
  Description:
  ```

  Returns the image data. Provider must be locked before pointer is valid.

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

  ```
  Description:
  ```

  Locks the surface provider.

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

  ```
  Description:
  ```

  Unlocks the surface provider.

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