a5::Bitmap Class Reference [Bitmap]

Stores an image. More...

#include <Bitmap.hpp>

Inheritance diagram for a5::Bitmap:

List of all members.

Classes
class	Load_Failed
	Thrown when a bitmap fails to load. More...
class	Lock_Failed
	Thrown when an attempt to lock a bitmap fails. More...
Public Types
enum	LockType {   ReadWrite = 0,   Read = ALLEGRO_LOCK_READONLY,   Write = ALLEGRO_LOCK_WRITEONLY }
	Describes the type of Lock. More...
Public Member Functions
	Bitmap (unit width, unit height)
	Creates a bitmap with the specified width and height.
	Bitmap (const char *filename)
	Loads an image from a file in to a Bitmap object Requires A5SES_IMAGE_ADDON.
	Bitmap (const Bitmap &other)
	Clones an existing Bitmap.
	Bitmap (ALLEGRO_BITMAP *bitmap_, bool autofree=false)
	Wraps an existing ALLEGRO_BITMAP in a Bitmap object.
std::auto_ptr< Bitmap_Lock >	Lock (Pixel_Format format=Pixel_Format::Any, LockType type=ReadWrite)
	Locks an entire bitmap.
std::auto_ptr< Bitmap_Lock >	Lock (const Rectangle rect, Pixel_Format format=Pixel_Format::Any, LockType type=ReadWrite)
	Locks a region of a bitmap.
unit	Width () const
	Returns the width of the bitmap.
unit	Height () const
	Returns the height of the bitmap.
void	Clear (Color c=RGB(0, 0, 0))
	Clears the bitmap to the specified color.
void	Target ()
	Sets the global Allegro target bitmap to this Shouldn't need to be called if using pure A5SES.
std::auto_ptr< Bitmap >	Sub (Rectangle r)
	Creates a sub-bitmap object from the specified rectangle.
void	PutPixel (unit x, unit y, Color c)
	Sets a pixel to a color.
Color	GetPixel (unit x, unit y)
	Returns the color of a pixel.
void	Blit (Bitmap &src, unit x, unit y, int flags=0)
	Draws an entire Bitmap to this one.
void	Blit (Bitmap &src, unit x, unit y, Rectangle clip, int flags=0)
	Draws a partial Bitmap to this one.
void	BlitScaled (Bitmap &src, Rectangle r, int flags=0)
	Draws a bitmap scaled to r to this one.
void	BlitScaled (Bitmap &src, unit x, unit y, Rectangle r, Rectangle clip, int flags=0)
	Draws a bitmap scaled to r and clipped to clip to this one.
void	BlitTinted (Bitmap &src, Color tint, unit x, unit y, int flags=0)
	Draws an entire Bitmap to this one (tinted).
void	BlitTinted (Bitmap &src, Color tint, unit x, unit y, Rectangle clip, int flags=0)
	Draws a partial Bitmap to this one (tinted).
void	BlitTintedScaled (Bitmap &src, Color tint, unit x, unit y, Rectangle r, int flags=0)
	Draws a bitmap scaled to r to this one (tinted).
void	BlitTintedScaled (Bitmap &src, Color tint, unit x, unit y, Rectangle r, Rectangle clip, int flags=0)
	Draws a bitmap scaled to r and clipped to clip to this one (tinted).
Bitmap &	operator= (const Bitmap &other)
	Clones an existing Bitmap.
ALLEGRO_BITMAP *	Release ()
	Releases the held C structure so it is no longer automatically freed.
virtual	~Bitmap ()
	Destroys the bitmap if created is true.
	operator ALLEGRO_BITMAP * () const
	Returns a pointer to the Allegro bitmap structure.
Static Public Attributes
static const int	FlipHorizontal = ALLEGRO_FLIP_HORIZONTAL
	Flip the image on the x axis.
static const int	FlipVertical = ALLEGRO_FLIP_VERTICAL
	Flip the image on the y axis.
Friends
class	Display

---

Detailed Description

Stores an image.

---

Member Enumeration Documentation

enum a5::Bitmap::LockType

Describes the type of Lock.

---

Constructor & Destructor Documentation

a5::Bitmap::Bitmap	(	unit	width,
		unit	height
	)

Creates a bitmap with the specified width and height.

a5::Bitmap::Bitmap

(

const char *

filename

)

[explicit]

Loads an image from a file in to a Bitmap object Requires A5SES_IMAGE_ADDON.

Exceptions:

Bitmap::Load_Failed,Need_Addon

a5::Bitmap::Bitmap

(

const Bitmap &

other

)

Clones an existing Bitmap.

a5::Bitmap::Bitmap	(	ALLEGRO_BITMAP *	bitmap_,
		bool	autofree = false
	)

Wraps an existing ALLEGRO_BITMAP in a Bitmap object.

virtual a5::Bitmap::~Bitmap

(

)

[virtual]

Destroys the bitmap if created is true.

---

Member Function Documentation

std::auto_ptr<Bitmap_Lock> a5::Bitmap::Lock	(	Pixel_Format	format = Pixel_Format::Any,
		LockType	type = ReadWrite
	)

Locks an entire bitmap.

std::auto_ptr<Bitmap_Lock> a5::Bitmap::Lock	(	const Rectangle	rect,
		Pixel_Format	format = Pixel_Format::Any,
		LockType	type = ReadWrite
	)

Locks a region of a bitmap.

Exceptions:

Bitmap::Lock_Failed

unit a5::Bitmap::Width

(

)

const

Returns the width of the bitmap.

unit a5::Bitmap::Height

(

)

const

Returns the height of the bitmap.

void a5::Bitmap::Clear

(

Color

c = RGB(0, 0, 0)

)

Clears the bitmap to the specified color.

void a5::Bitmap::Target

(

)

Sets the global Allegro target bitmap to this Shouldn't need to be called if using pure A5SES.

std::auto_ptr<Bitmap> a5::Bitmap::Sub

(

Rectangle

r

)

Creates a sub-bitmap object from the specified rectangle.

void a5::Bitmap::PutPixel	(	unit	x,
		unit	y,
		Color	c
	)

Sets a pixel to a color.

Color a5::Bitmap::GetPixel	(	unit	x,
		unit	y
	)

Returns the color of a pixel.

void a5::Bitmap::Blit	(	Bitmap &	src,
		unit	x,
		unit	y,
		int	flags = 0
	)

Draws an entire Bitmap to this one.

void a5::Bitmap::Blit	(	Bitmap &	src,
		unit	x,
		unit	y,
		Rectangle	clip,
		int	flags = 0
	)

Draws a partial Bitmap to this one.

void a5::Bitmap::BlitScaled	(	Bitmap &	src,
		Rectangle	r,
		int	flags = 0
	)

Draws a bitmap scaled to r to this one.

void a5::Bitmap::BlitScaled	(	Bitmap &	src,
		unit	x,
		unit	y,
		Rectangle	r,
		Rectangle	clip,
		int	flags = 0
	)

Draws a bitmap scaled to r and clipped to clip to this one.

void a5::Bitmap::BlitTinted	(	Bitmap &	src,
		Color	tint,
		unit	x,
		unit	y,
		int	flags = 0
	)

Draws an entire Bitmap to this one (tinted).

void a5::Bitmap::BlitTinted	(	Bitmap &	src,
		Color	tint,
		unit	x,
		unit	y,
		Rectangle	clip,
		int	flags = 0
	)

Draws a partial Bitmap to this one (tinted).

void a5::Bitmap::BlitTintedScaled	(	Bitmap &	src,
		Color	tint,
		unit	x,
		unit	y,
		Rectangle	r,
		int	flags = 0
	)

Draws a bitmap scaled to r to this one (tinted).

void a5::Bitmap::BlitTintedScaled	(	Bitmap &	src,
		Color	tint,
		unit	x,
		unit	y,
		Rectangle	r,
		Rectangle	clip,
		int	flags = 0
	)

Draws a bitmap scaled to r and clipped to clip to this one (tinted).

Bitmap& a5::Bitmap::operator=

(

const Bitmap &

other

)

Clones an existing Bitmap.

ALLEGRO_BITMAP* a5::Bitmap::Release

(

)

Releases the held C structure so it is no longer automatically freed.

a5::Bitmap::operator ALLEGRO_BITMAP *

(

)

const

Returns a pointer to the Allegro bitmap structure.

---

Member Data Documentation

const int a5::Bitmap::FlipHorizontal = ALLEGRO_FLIP_HORIZONTAL [static]

Flip the image on the x axis.

const int a5::Bitmap::FlipVertical = ALLEGRO_FLIP_VERTICAL [static]

Flip the image on the y axis.