Clarisse 4.0 SP5b SDK  4.0.0.0.5.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
ImageHelperBitmap Class Reference

Helper class to create 8-bit bitmaps. A bitmap is basically a 8-bit image. More...

Inheritance diagram for ImageHelperBitmap:
CoreBaseObject CoreBaseType

Public Member Functions

 ImageHelperBitmap ()
 Create a empty bitmap.
 
 ImageHelperBitmap (const ImageHelperBitmap &src)
 
 ImageHelperBitmap (const unsigned int &width, const unsigned int &height, const unsigned int &depth)
 Create a new bitmap with the specified resolution and depth.
 
unsigned char * get_buffer () const
 Return the internal buffer.
 
const unsigned int & get_width () const
 Return the width of the bitmap.
 
const unsigned int & get_height () const
 Return the height of the bitmap.
 
const unsigned int & get_depth () const
 Return the depth in bytes of the bitmap (3 for 24-bit, 4 for 32-bit)
 
void clear ()
 Clear (empty) the bitmap.
 
void create (const unsigned int &width, const unsigned int &height, const unsigned int &depth)
 Create a new bitmap with the specified resolution and depth.
 
bool is_empty ()
 Return true if the image is empty.
 
- Public Member Functions inherited from CoreBaseObject
bool is_kindof (const CoreBaseObject &object) const
 
virtual size_t get_memory_size () const
 
CoreString get_class_info_name () const
 
CoreString get_class_interface () const
 
const unsigned long & get_class_info_id () const
 
bool is_kindof (const CoreClassInfo &cinfo) const
 
virtual const CoreClassInfoget_class_info () const
 
bool operator== (const CoreBaseObject &obj) const
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 
bool operator== (const CoreBaseType &obj) const
 

Additional Inherited Members

- Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfoclass_info ()
 
static bool ___class_destructor__ (void *instance, const bool &is_array)
 
template<class T >
static T * cast (CoreBaseObject *object)
 
template<class T >
static const T * cast (const CoreBaseObject *object)
 

Detailed Description

Helper class to create 8-bit bitmaps. A bitmap is basically a 8-bit image.

Note
Currently it misses LUT support.

Constructor & Destructor Documentation

ImageHelperBitmap::ImageHelperBitmap ( const unsigned int &  width,
const unsigned int &  height,
const unsigned int &  depth 
)

Create a new bitmap with the specified resolution and depth.

Parameters
[in]widthwidth of the bitmap
[in]heightheight of the bitmap
[in]depthdepth in bytes of the bitmap

Member Function Documentation

void ImageHelperBitmap::create ( const unsigned int &  width,
const unsigned int &  height,
const unsigned int &  depth 
)

Create a new bitmap with the specified resolution and depth.

Parameters
[in]widthwidth of the bitmap
[in]heightheight of the bitmap
[in]depthdepth in bytes of the bitmap