ClanSoft logo
ClanSoft logo
Entire Class Index Main Class Index Cross Index Global Index

Class CL_DynamicProvider

Dynamic Provider Class
Contained in: global
Derived from: CL_SurfaceProvider_Generic
Derived by: none
Group: Display (Surface Providers)

#include <ClanLib/display.h>


public function member index:

Construction:

static CL_Surface* create(int width, int height, int no_sprs, EPixelFormat type = PAL8, int transcol = -1);
static CL_Surface* create(int width, int height, int no_sprs, int red_mask, int green_mask, int blue_mask, int alpha_mask, int transcol = -1);
CL_DynamicProvider(int width, int height, int no_sprs, EPixelFormat type = PAL8, int trans_col = -1);
CL_DynamicProvider(int width, int height, int no_sprs, int red_mask, int green_mask, int blue_mask, int alpha_mask, int transcol = -1);
virtual ~CL_DynamicProvider();

Attributes:

virtual int get_width() const;
virtual int get_height() const;
virtual int get_no_sprs() const;
virtual EPixelFormat get_pixel_format() const;
virtual CL_Palette* get_palette() const;
virtual int get_transcol() const;
virtual void* get_data() const;

Operations:

virtual void perform_lock();
virtual void perform_unlock();
 

Description:

Empty space dynamic surface provider header file


Function Member Descriptions:

CL_DynamicProvider::CL_DynamicProvider - Dynamic Provider Constructor
CL_DynamicProvider(int width, int height, int no_sprs, EPixelFormat type = PAL8, int trans_col = -1);


CL_DynamicProvider::CL_DynamicProvider - Dynamic Provider Constructor
CL_DynamicProvider(int width, int height, int no_sprs, int red_mask, int green_mask, int blue_mask, int alpha_mask, int transcol = -1);


CL_DynamicProvider::create - Create
static CL_Surface* create(int width, int height, int no_sprs, EPixelFormat type = PAL8, int transcol = -1);


CL_DynamicProvider::create - Create
static CL_Surface* create(int width, int height, int no_sprs, int red_mask, int green_mask, int blue_mask, int alpha_mask, int transcol = -1);


CL_DynamicProvider::get_data - Returns the pointer to the surface data, where you can copy your data to. It should be only called between lock() and unlock().
virtual void* get_data() const;


CL_DynamicProvider::get_height - Get height
virtual int get_height() const;


CL_DynamicProvider::get_no_sprs - Get no sprs
virtual int get_no_sprs() const;


CL_DynamicProvider::get_palette - Returns NULL, because PAL8 isn't supported
virtual CL_Palette* get_palette() const;


CL_DynamicProvider::get_pixel_format - Returns the pixelformat of the DynamicProvider as it was set in the constructor
virtual EPixelFormat get_pixel_format() const;


CL_DynamicProvider::get_transcol - Returns the transparent color, which was set in the constructor
virtual int get_transcol() const;


CL_DynamicProvider::get_width - Get width
virtual int get_width() const;


CL_DynamicProvider::perform_lock - Perform Lock
virtual void perform_lock();


CL_DynamicProvider::perform_unlock - Perform UnLock
virtual void perform_unlock();


CL_DynamicProvider::~CL_DynamicProvider - Deletes the DynamicProvider and deletes the data which was allocated in the constructor
virtual ~CL_DynamicProvider();



Variable Member Descriptions: