Public Member Functions

sp::video::ImageBufferUByte Class Reference

#include <spImageBufferUByte.hpp>

Inheritance diagram for sp::video::ImageBufferUByte:
sp::video::ImageBufferContainer< u8, 255 > sp::video::ImageBuffer

List of all members.

Public Member Functions

 ImageBufferUByte ()
 ImageBufferUByte (const EPixelFormats Format, const dim::size2di &Size, u32 Depth=1, const u8 *InitBuffer=0)
 ImageBufferUByte (const ImageBufferUByte *Original)
 ~ImageBufferUByte ()
ImageBuffer * copy () const
void copy (const ImageBuffer *Other)
 Copies the image bufer data into this image buffer. This can also be used to convert from UByte to Float.
void setBuffer (const void *ImageBuffer, const dim::point2di &Pos, const dim::size2di &Size)
 Sets a new sub-buffer.
void getBuffer (void *ImageBuffer, const dim::point2di &Pos, const dim::size2di &Size) const
 Gets a sub-buffer.
void setColorKey (const video::color &Color, u8 Tolerance)

Constructor & Destructor Documentation

sp::video::ImageBufferUByte::ImageBufferUByte (  ) 
sp::video::ImageBufferUByte::ImageBufferUByte ( const EPixelFormats  Format,
const dim::size2di &  Size,
u32  Depth = 1,
const u8 *  InitBuffer = 0 
)
sp::video::ImageBufferUByte::ImageBufferUByte ( const ImageBufferUByte *  Original  ) 
sp::video::ImageBufferUByte::~ImageBufferUByte (  ) 

Member Function Documentation

ImageBuffer * sp::video::ImageBufferUByte::copy (  )  const [virtual]

Creates a copy of this image buffer and returns the resulting pointer.

Note:
Don't forget to delete this object!

Implements sp::video::ImageBuffer.

void sp::video::ImageBufferUByte::copy ( const ImageBuffer *  Other  )  [virtual]

Copies the image bufer data into this image buffer. This can also be used to convert from UByte to Float.

Implements sp::video::ImageBuffer.

void sp::video::ImageBufferUByte::getBuffer ( void *  ImageBuffer,
const dim::point2di &  Pos,
const dim::size2di &  Size 
) const [virtual]

Gets a sub-buffer.

Implements sp::video::ImageBuffer.

void sp::video::ImageBufferUByte::setBuffer ( const void *  ImageBuffer,
const dim::point2di &  Pos,
const dim::size2di &  Size 
) [virtual]

Sets a new sub-buffer.

Implements sp::video::ImageBuffer.

void sp::video::ImageBufferUByte::setColorKey ( const video::color &  Color,
u8  Tolerance 
) [virtual]

Sets the color key with the given tolerance.

Parameters:
Color,: Color which is to be blended out. The alpha channel specifies the transparency of this color. e.g. when you have a mesh-wire-fence the color between the mesh-wire (normally black {0|0|0} for green {0|255|0}) shall be blended out the color key has to be (0, 0, 0, 0) for black or (0, 255, 0, 0) or green.
Note:
The color key functions only work for the UBYTE image buffers (ImageBufferUByte).

Reimplemented from sp::video::ImageBuffer.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Apr 4 2013 23:22:58 for SoftPixel Engine by  doxygen 1.7.1