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

Class CL_SpriteSubsectionProvider

The Sprite Sub Section 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(CL_SurfaceProvider* parent_provider, int start_x, int start_y, int width, int height);
CL_SpriteSubsectionProvider(CL_SurfaceProvider* parent_provider, int start_x, int start_y, int width, int height);
virtual ~CL_SpriteSubsectionProvider();

Attributes:

virtual unsigned int get_pitch() const;
virtual int get_translate_x() const;
virtual int get_translate_y() const;
virtual unsigned int get_width() const;
virtual unsigned int get_height() const;
virtual unsigned int get_num_frames() const;
virtual CL_Palette* get_palette() const;
virtual bool is_indexed() const;
virtual bool uses_src_colorkey() const;
virtual unsigned int get_src_colorkey() 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 unsigned int get_depth() const;
virtual void* get_data() const;

Operations:

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

Description:


Function Member Descriptions:

CL_SpriteSubsectionProvider::CL_SpriteSubsectionProvider - The Sprite Sub Section Provider Constructor
CL_SpriteSubsectionProvider(CL_SurfaceProvider* parent_provider, int start_x, int start_y, int width, int height);


CL_SpriteSubsectionProvider::create - Create
static CL_Surface* create(CL_SurfaceProvider* parent_provider, int start_x, int start_y, int width, int height);


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


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


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


CL_SpriteSubsectionProvider::get_depth - Get depth
virtual unsigned int get_depth() const;


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


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


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


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


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


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


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


CL_SpriteSubsectionProvider::get_translate_x - Get translate x
virtual int get_translate_x() const;


CL_SpriteSubsectionProvider::get_translate_y - Get translate y
virtual int get_translate_y() const;


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


CL_SpriteSubsectionProvider::is_indexed - Is indexed
virtual bool is_indexed() const;


CL_SpriteSubsectionProvider::perform_lock - Perform lock
virtual void perform_lock();


CL_SpriteSubsectionProvider::perform_unlock - Perform unlock
virtual void perform_unlock();


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


CL_SpriteSubsectionProvider::~CL_SpriteSubsectionProvider - The Sprite Sub Section Provider Destructor
virtual ~CL_SpriteSubsectionProvider();



Variable Member Descriptions: