The SDL implementation of the Image base class. More...

#include <sdlimage.h>

Inheritance diagram for FIFE::SDLImage:

Collaboration diagram for FIFE::SDLImage:

Public Member Functions
	SDLImage (IResourceLoader *loader=0)

	SDLImage (const std::string &name, IResourceLoader *loader=0)

	SDLImage (SDL_Surface *surface)

	SDLImage (const std::string &name, SDL_Surface *surface)

	SDLImage (const uint8_t *data, uint32_t width, uint32_t height)

	SDLImage (const std::string &name, const uint8_t *data, uint32_t width, uint32_t height)

virtual	~SDLImage ()

virtual void	invalidate ()
	Invalidates the Image causing it to be reset or re-loaded. More...

virtual void	setSurface (SDL_Surface *surface)
	This frees the current suface and replaces it with the surface passed in the parameter (which can be NULL). More...

virtual void	render (const Rect &rect, uint8_t alpha=255, uint8_t const *rgb=0)
	Renders itself to the current render target (main screen or attached destination image) at the rectangle rect. More...

virtual size_t	getSize ()

virtual void	useSharedImage (const ImagePtr &shared, const Rect &region)
	After this call all image data will be taken from the given image and its subregion. More...

virtual void	forceLoadInternal ()
	Forces to load the image into internal memory of GPU. More...

virtual void	load ()

virtual void	free ()

Public Member Functions inherited from FIFE::Image
	Image (IResourceLoader *loader=0)
	Constructor. More...

	Image (const std::string &name, IResourceLoader *loader=0)

	Image (SDL_Surface *surface)
	Constructor. More...

	Image (const std::string &name, SDL_Surface *surface)

	Image (const uint8_t *data, uint32_t width, uint32_t height)
	Constructor. More...

	Image (const std::string &name, const uint8_t *data, uint32_t width, uint32_t height)

virtual	~Image ()
	Destructor. More...

virtual void	render (const Rect &rect, const ImagePtr &overlay, uint8_t alpha=255, uint8_t const *rgb=0)

virtual void	renderZ (const Rect &rect, float vertexZ, uint8_t alpha=255, uint8_t const *rgb=0)

virtual void	renderZ (const Rect &rect, float vertexZ, const ImagePtr &overlay, uint8_t alpha=255, uint8_t const *rgb=0)

virtual void	renderZ (const Rect &rect, float vertexZ, uint8_t alpha=255, bool forceNewBatch=false, uint8_t const *rgb=0)

SDL_Surface *	detachSurface ()
	Removes underlying SDL_Surface from the image (if exists) and returns this. More...

SDL_Surface *	getSurface ()

const SDL_Surface *	getSurface () const

void	saveImage (const std::string &filename)
	Saves the image using given filename. More...

uint32_t	getWidth () const

uint32_t	getHeight () const

const Rect &	getArea () const

void	setXShift (int32_t xshift)

int32_t	getXShift () const

void	setYShift (int32_t yshift)

int32_t	getYShift () const

void	getPixelRGBA (int32_t x, int32_t y, uint8_t r, uint8_t g, uint8_t b, uint8_t a)

bool	isSharedImage () const
	Returns true if this image shares data with another one. More...

const Rect &	getSubImageRect () const
	Returns area of the image it occupies in the shared image. More...

virtual void	copySubimage (uint32_t xoffset, uint32_t yoffset, const ImagePtr &img)
	Copies given image into this one with respect to given offsets. More...

Public Member Functions inherited from FIFE::IResource
	IResource (const std::string &name, IResourceLoader *loader=0)

virtual	~IResource ()

virtual const std::string &	getName ()

ResourceHandle	getHandle ()

virtual ResourceState	getState ()

virtual void	setState (const ResourceState &state)

Private Member Functions
void	finalize ()

SDL_Surface *	optimize (SDL_Surface *surface)
	SDL Alpha Optimizer This tries to convert an image with a fake alpha channel to an RGB image when the channel can be reasonably be replaced by a colorkey. More...

void	resetSdlimage ()

void	validateShared ()

Private Attributes
Uint8	m_last_alpha

bool	m_finalized

SDL_Color	m_colorkey

SDL_Surface *	m_zoom_surface

float	m_scale_x

float	m_scale_y

ImagePtr	m_atlas_img

std::string	m_atlas_name

Additional Inherited Members
Public Types inherited from FIFE::IResource
enum	ResourceState { RES_INVALID = 0, RES_NOT_LOADED, RES_LOADED }

Static Public Member Functions inherited from FIFE::Image
static void	saveAsPng (const std::string &filename, const SDL_Surface &surface)
	Saves the SDL_Surface to png format. More...

static bool	putPixel (SDL_Surface *surface, int32_t x, int32_t y, uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)

Protected Member Functions inherited from FIFE::Image
void	reset (SDL_Surface *surface)
	Resets the image to default values (including the x and y shift values), frees the current surface and sets the surface to the passed SDL_Surface (which can be NULL). More...

Protected Attributes inherited from FIFE::Image
SDL_Surface *	m_surface

int32_t	m_xshift

int32_t	m_yshift

bool	m_shared

Rect	m_subimagerect

Protected Attributes inherited from FIFE::IResource
std::string	m_name

IResourceLoader *	m_loader

ResourceState	m_state

Detailed Description

The SDL implementation of the Image base class.

Definition at line 40 of file sdlimage.h.

Constructor & Destructor Documentation

FIFE::SDLImage::SDLImage ( IResourceLoader * loader = 0 )

Definition at line 47 of file sdlimage.cpp.

References resetSdlimage().

FIFE::SDLImage::SDLImage	(	const std::string &	name,
		IResourceLoader *	loader = `0`
	)

Definition at line 52 of file sdlimage.cpp.

References resetSdlimage().

FIFE::SDLImage::SDLImage ( SDL_Surface * surface )

Definition at line 57 of file sdlimage.cpp.

References resetSdlimage().

FIFE::SDLImage::SDLImage	(	const std::string &	name,
		SDL_Surface *	surface
	)

Definition at line 62 of file sdlimage.cpp.

References resetSdlimage().

FIFE::SDLImage::SDLImage	(	const uint8_t *	data,
		uint32_t	width,
		uint32_t	height
	)

Definition at line 67 of file sdlimage.cpp.

References resetSdlimage().

FIFE::SDLImage::SDLImage	(	const std::string &	name,
		const uint8_t *	data,
		uint32_t	width,
		uint32_t	height
	)

Definition at line 72 of file sdlimage.cpp.

References resetSdlimage().

FIFE::SDLImage::~SDLImage ( )

virtual

Definition at line 86 of file sdlimage.cpp.

References m_zoom_surface.

Member Function Documentation

void FIFE::SDLImage::finalize ( )

private

Definition at line 412 of file sdlimage.cpp.

References FIFE::DynamicSingleton< RenderBackend >::instance(), FIFE::RenderBackend::isAlphaOptimizerEnabled(), load(), m_colorkey, m_finalized, FIFE::IResource::m_state, FIFE::Image::m_surface, optimize(), and FIFE::IResource::RES_NOT_LOADED.

Referenced by render().

Here is the caller graph for this function:

void FIFE::SDLImage::forceLoadInternal ( )

virtual

Forces to load the image into internal memory of GPU.

Implements FIFE::Image.

Definition at line 698 of file sdlimage.cpp.

References validateShared().

void FIFE::SDLImage::free ( )

virtual

Reimplemented from FIFE::Image.

Definition at line 727 of file sdlimage.cpp.

References FIFE::IResource::m_state, FIFE::IResource::RES_NOT_LOADED, and setSurface().

size_t FIFE::SDLImage::getSize ( )

virtual

Reimplemented from FIFE::Image.

Definition at line 660 of file sdlimage.cpp.

References FIFE::Image::m_surface, and m_zoom_surface.

virtual void FIFE::SDLImage::invalidate ( )

inlinevirtual

Invalidates the Image causing it to be reset or re-loaded.

Implements FIFE::Image.

Definition at line 50 of file sdlimage.h.

void FIFE::SDLImage::load ( )

virtual

Reimplemented from FIFE::Image.

Definition at line 713 of file sdlimage.cpp.

References FIFE::ImageManager::create(), FIFE::ImageManager::exists(), FIFE::DynamicSingleton< ImageManager >::instance(), FIFE::Image::load(), m_atlas_img, m_atlas_name, FIFE::Image::m_subimagerect, and useSharedImage().

Referenced by finalize(), and validateShared().

Here is the caller graph for this function:

SDL_Surface * FIFE::SDLImage::optimize ( SDL_Surface * surface )

private

SDL Alpha Optimizer This tries to convert an image with a fake alpha channel to an RGB image when the channel can be reasonably be replaced by a colorkey.

Definition at line 453 of file sdlimage.cpp.

References FIFE::_log, FL_DBG, FIFE::DynamicSingleton< RenderBackend >::instance(), and m_colorkey.

Referenced by finalize().

Here is the caller graph for this function: