WoopsiGfx 1.4
Nintendo DS 2D Graphics Library
|
#include <libwoopsigfx/include/bitmapbase.h>
Public Member Functions | |
virtual | ~BitmapBase () |
virtual const u16 * | getData () const =0 |
virtual const u16 * | getData (s16 x, s16 y) const =0 |
virtual const u16 | getPixel (s16 x, s16 y) const =0 |
virtual void | copy (s16 x, s16 y, u32 size, u16 *dest) const =0 |
virtual const u16 | getWidth () const =0 |
virtual const u16 | getHeight () const =0 |
Abstract class defining the basic properties of a bitmap. Since the DS has 16-bit displays (1 alpha bit and 5 bits each for RGB), all bitmaps must expose their data in the same format.
However, since this class does not define how the data is stored, it is possible for a subclass to store the bitmap data in whatever format necessary (1, 2, 4, 8, 24 or 32-bits, or any format at all) as long as it translates back to the DS' native 16-bit format when accessed externally.
virtual WoopsiGfx::BitmapBase::~BitmapBase | ( | ) | [inline, virtual] |
Destructor.
virtual void WoopsiGfx::BitmapBase::copy | ( | s16 | x, |
s16 | y, | ||
u32 | size, | ||
u16 * | dest | ||
) | const [pure virtual] |
Copies data from the supplied co-ordinates sequentially into dest. If the amount to be copied exceeds the available width of the bitmap, copying will wrap around from the right-hand edge of the bitmap to the left-hand edge. The dest parameter must point to an area of memory large enough to contain the copied data.
x | The x co-ordinate to copy from. |
y | The y co-ordinate to copy from. |
size | The number of pixels to copy. |
dest | Pointer to the memory that will be copied into. |
Implemented in WoopsiGfx::Bitmap, WoopsiGfx::BitmapWrapper, WoopsiGfx::BufferedBitmap, and WoopsiGfx::FrameBuffer.
virtual const u16* WoopsiGfx::BitmapBase::getData | ( | ) | const [pure virtual] |
Get a pointer to the internal bitmap data.
Implemented in WoopsiGfx::Bitmap, WoopsiGfx::BitmapWrapper, WoopsiGfx::BufferedBitmap, and WoopsiGfx::FrameBuffer.
virtual const u16* WoopsiGfx::BitmapBase::getData | ( | s16 | x, |
s16 | y | ||
) | const [pure virtual] |
Get a pointer to the internal bitmap data at the specified co-ordinates.
x | The x co-ord of the data. |
y | The y co-ord of the data. |
Implemented in WoopsiGfx::Bitmap, WoopsiGfx::BitmapWrapper, WoopsiGfx::BufferedBitmap, and WoopsiGfx::FrameBuffer.
virtual const u16 WoopsiGfx::BitmapBase::getHeight | ( | ) | const [pure virtual] |
Get the bitmap's height.
Implemented in WoopsiGfx::Bitmap, WoopsiGfx::BitmapWrapper, WoopsiGfx::BufferedBitmap, and WoopsiGfx::FrameBuffer.
virtual const u16 WoopsiGfx::BitmapBase::getPixel | ( | s16 | x, |
s16 | y | ||
) | const [pure virtual] |
Get the colour of the pixel at the specified co-ordinates
x | The x co-ordinate of the pixel. |
y | The y co-ordinate of the pixel. |
Implemented in WoopsiGfx::Bitmap, WoopsiGfx::BitmapWrapper, WoopsiGfx::BufferedBitmap, and WoopsiGfx::FrameBuffer.
virtual const u16 WoopsiGfx::BitmapBase::getWidth | ( | ) | const [pure virtual] |
Get the bitmap's width.
Implemented in WoopsiGfx::Bitmap, WoopsiGfx::BitmapWrapper, WoopsiGfx::BufferedBitmap, and WoopsiGfx::FrameBuffer.