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

# Class CL_JPGDProvider

JPGD Provider Class
Contained in: global
Derived from: CL_SurfaceProvider
Derived by: none
Group: JPEG (System)

#include <ClanLib/jpeg.h>

### public function member index:

### Construction:

`` | `CL_JPGDProvider` | `(`const` `std::string`& `filename`, `CL_InputSourceProvider`* `provider` = 0)`;
`` | `~CL_JPGDProvider` | `()`;

### Operations:

``virtual` `void`` | `lock` | `()`;
``virtual` `void`` | `unlock` | `()`;

### Attributes:

``virtual` `void`*` | `get_data` | `() `const``;
``virtual` `unsigned` `int`` | `get_num_frames` | `() `const``;
``virtual` `unsigned` `int`` | `get_width` | `() `const``;
``virtual` `unsigned` `int`` | `get_height` | `() `const``;
``virtual` `unsigned` `int`` | `get_pitch` | `() `const``;
``virtual` `unsigned` `int`` | `get_bytes_per_pixel` | `() `const``;
``virtual` `bool`` | `is_indexed` | `() `const``;
``virtual` `unsigned` `int`` | `get_red_mask` | `() `const``;
``virtual` `unsigned` `int`` | `get_green_mask` | `() `const``;
``virtual` `unsigned` `int`` | `get_blue_mask` | `() `const``;
``virtual` `unsigned` `int`` | `get_alpha_mask` | `() `const``;
``virtual` `CL_Palette`*` | `get_palette` | `() `const``;
``virtual` `bool`` | `uses_src_colorkey` | `() `const``;
``virtual` `unsigned` `int`` | `get_src_colorkey` | `() `const``;

## Description:

## Function Member Descriptions:

CL_JPGDProvider::CL_JPGDProvider - JPGD Provider Constructor
`` `CL_JPGDProvider` `(`const` `std::string`& `filename`, `CL_InputSourceProvider`* `provider` = 0)`;

CL_JPGDProvider::get_alpha_mask - Get alpha mask
``virtual` `unsigned` `int`` `get_alpha_mask` `() `const``;

CL_JPGDProvider::get_blue_mask - Get blue mask
``virtual` `unsigned` `int`` `get_blue_mask` `() `const``;

CL_JPGDProvider::get_bytes_per_pixel - Get bytes per pixel
``virtual` `unsigned` `int`` `get_bytes_per_pixel` `() `const``;

CL_JPGDProvider::get_data - Get data
``virtual` `void`*` `get_data` `() `const``;

CL_JPGDProvider::get_green_mask - Get green mask
``virtual` `unsigned` `int`` `get_green_mask` `() `const``;

CL_JPGDProvider::get_height - Get height
``virtual` `unsigned` `int`` `get_height` `() `const``;

CL_JPGDProvider::get_num_frames - Get num frames
``virtual` `unsigned` `int`` `get_num_frames` `() `const``;

CL_JPGDProvider::get_palette - Get palette
``virtual` `CL_Palette`*` `get_palette` `() `const``;

CL_JPGDProvider::get_pitch - Get pitch
``virtual` `unsigned` `int`` `get_pitch` `() `const``;

CL_JPGDProvider::get_red_mask - Get red mask
``virtual` `unsigned` `int`` `get_red_mask` `() `const``;

CL_JPGDProvider::get_src_colorkey - Get src colorkey
``virtual` `unsigned` `int`` `get_src_colorkey` `() `const``;

CL_JPGDProvider::get_width - Get width
``virtual` `unsigned` `int`` `get_width` `() `const``;

CL_JPGDProvider::is_indexed - Is indexed
``virtual` `bool`` `is_indexed` `() `const``;

CL_JPGDProvider::lock - Lock
``virtual` `void`` `lock` `()`;

CL_JPGDProvider::unlock - Unlock
``virtual` `void`` `unlock` `()`;

CL_JPGDProvider::uses_src_colorkey - Uses src colorkey
``virtual` `bool`` `uses_src_colorkey` `() `const``;

CL_JPGDProvider::~CL_JPGDProvider - JPGD Provider Destructor
`` `~CL_JPGDProvider` `()`;

## Variable Member Descriptions: