FIFE  2008.0
FIFE::SDLImage Class Reference

#include <sdlimage.h>

Inheritance diagram for FIFE::SDLImage:
Inheritance graph
Collaboration diagram for FIFE::SDLImage:
Collaboration graph

Public Member Functions

virtual void invalidate ()
 
virtual void setSurface (SDL_Surface *surface)
 
virtual void render (const Rect &rect, uint8_t alpha=255, uint8_t const *rgb=0)
 
virtual void useSharedImage (const ImagePtr &shared, const Rect &region)
 
virtual void forceLoadInternal ()
 
- Public Member Functions inherited from FIFE::Image
 Image (IResourceLoader *loader=0)
 
 Image (SDL_Surface *surface)
 
 Image (const uint8_t *data, uint32_t width, uint32_t height)
 
virtual ~Image ()
 
SDL_Surface * detachSurface ()
 
void saveImage (const std::string &filename)
 
bool isSharedImage () const
 
const RectgetSubImageRect () const
 
virtual void copySubimage (uint32_t xoffset, uint32_t yoffset, const ImagePtr &img)
 

Additional Inherited Members

- Static Public Member Functions inherited from FIFE::Image
static void saveAsPng (const std::string &filename, const SDL_Surface &surface)
 
- Protected Member Functions inherited from FIFE::Image
void reset (SDL_Surface *surface)
 

Detailed Description

The SDL implementation of the Image base class.

Definition at line 40 of file sdlimage.h.

Member Function Documentation

void FIFE::SDLImage::forceLoadInternal ( )
virtual

Forces to load the image into internal memory of GPU

Implements FIFE::Image.

Definition at line 684 of file sdlimage.cpp.

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::render ( const Rect rect,
uint8_t  alpha = 255,
uint8_t const *  rgb = 0 
)
virtual

Renders itself to the current render target (main screen or attached destination image) at the rectangle rect. Convenience function

Parameters
rectThe position and clipping where to draw this image to.
alphaThe alpha value, with which to draw self.
rgbThe color value of overlay if any.

Implements FIFE::Image.

Definition at line 332 of file sdlimage.cpp.

References FIFE::RectType< T >::bottom(), FIFE::RectType< T >::h, FIFE::RectType< T >::right(), FIFE::RectType< T >::w, FIFE::RectType< T >::x, and FIFE::RectType< T >::y.

void FIFE::SDLImage::setSurface ( SDL_Surface *  surface)
virtual

This frees the current suface and replaces it with the surface passed in the parameter (which can be NULL).

See also
Image::reset(SDL_Surface* surface)
Parameters
surfacethe SDL_Surface to use for this image

Implements FIFE::Image.

Definition at line 89 of file sdlimage.cpp.

void FIFE::SDLImage::useSharedImage ( const ImagePtr shared,
const Rect region 
)
virtual

After this call all image data will be taken from the given image and its subregion

Implements FIFE::Image.

Definition at line 662 of file sdlimage.cpp.

References FIFE::RectType< T >::h, FIFE::RectType< T >::w, FIFE::RectType< T >::x, and FIFE::RectType< T >::y.


The documentation for this class was generated from the following files: