Image Class Reference

Image to display either on an OpenGL- or plain SDL-Surface. More...

#include <image.h>

Public Member Functions
	Image (bool autoconvert=true)
	Constructor. Does some init. More...
	Image (const String &fname, bool autoconvert=true)
	~Image ()
void	clear ()
	Clears the Image and frees all resources. More...
void	load (const String &fname, bool autoconvert, uchar alpha=255)
	loads an Image into a SDL_Surface More...
void	load (const String &fname, uchar alpha=255)
void	convert ()
	converts an Image to Screenformat More...
bool	hasAlpha () const
	has alphachannel? More...
bool	hasColorKey () const
	has colorkey? RGB(255, 0, 255) More...
Uint16	width () const
Uint16	height () const
const Size &	size () const
void	setAutoConvert (bool autoconvert)
void	setAlpha (uchar alpha=255)
void	setColorKey (Color color)
Color	pixel (const Point &pos)
SDL_Surface *	surface ()
void *	pixels ()
GLuint	texNum () const
bool	hasTexture () const
GLuint	textureWidth () const
GLuint	textureHeight () const

Protected Member Functions
void	checkAlpha ()
	checks the surface for Alpha More...
void	checkColorKey ()
	checks the surface for ColorKey More...
void	genTexture ()
void	calcTexSize ()
void	clearTexture ()
void	clearSurface ()

Private Attributes
SDL_Surface *	mSurface
Color	mColorKey
bool	mHasAlpha
bool	mHasColorKey
bool	mIsConverted
bool	mAutoConvert
Size	mSize
GLuint	mTextureWidth
GLuint	mTextureHeight
GLuint	mTexNum

Detailed Description

Image to display either on an OpenGL- or plain SDL-Surface.

Constructor & Destructor Documentation

Image

(

bool

autoconvert = true

)

Constructor. Does some init.

References Image::clear(), Image::mAutoConvert, Image::mSurface, and Image::mTexNum.

Image	(	const String &	fname,
		bool	autoconvert = true
	)

References Image::clear(), Image::load(), Image::mAutoConvert, Image::mSurface, and Image::mTexNum.

~Image

(

)

References Image::clear().

Member Function Documentation

void calcTexSize ( )

protected

References EXCGL, Size::height(), Image::mSize, Image::mTextureHeight, Image::mTextureWidth, and Size::width().

Referenced by Image::convert(), and Image::textureHeight().

void checkAlpha ( )

protected

checks the surface for Alpha

References Color::a(), Size::height(), Image::mHasAlpha, Image::mSize, Image::mSurface, Size::width(), x, and y.

Referenced by Image::convert(), and Image::textureHeight().

void checkColorKey ( )

protected

checks the surface for ColorKey

References Color::b(), Color::g(), Size::height(), Image::mColorKey, Image::mHasColorKey, Image::mSize, Image::mSurface, Color::r(), Size::width(), x, and y.

Referenced by Image::convert(), and Image::textureHeight().

void clear

(

)

Clears the Image and frees all resources.

References Image::clearSurface(), Image::clearTexture(), Image::mColorKey, Image::mHasAlpha, Image::mHasColorKey, Image::mIsConverted, and Color::set().

Referenced by ImageFont::clear(), Image::Image(), and Image::~Image().

void clearSurface ( )

protected

References Image::mSurface.

Referenced by Image::clear(), Image::convert(), Image::genTexture(), and Image::textureHeight().

void clearTexture ( )

protected

References EXCSDL, Image::hasTexture(), Image::mSize, Image::mTexNum, Image::mTextureHeight, Image::mTextureWidth, and Size::set().

Referenced by Image::clear(), and Image::textureHeight().

void convert

(

)

converts an Image to Screenformat

References Image::calcTexSize(), Image::checkAlpha(), Image::checkColorKey(), Image::clearSurface(), EXCSDL, Image::genTexture(), Image::mHasAlpha, Image::mHasColorKey, Image::mIsConverted, Image::mSize, Image::mSurface, Size::set(), and Image::surface().

Referenced by Image::load(), and ImageFont::load().

void genTexture ( )

protected

References Color::b(), Image::clearSurface(), EXCSDL, Image::hasTexture(), Size::height(), Image::mHasAlpha, Image::mHasColorKey, Image::mSize, Image::mSurface, Image::mTexNum, Image::mTextureHeight, Image::mTextureWidth, Pixel::put(), Color::r(), Color::setA(), Size::width(), x, and y.

Referenced by Image::convert(), and Image::textureHeight().

bool hasAlpha ( ) const

inline

has alphachannel?

Returns

true if there is an alphachannel

References Image::mHasAlpha.

Referenced by CanvasGL::image().

bool hasColorKey ( ) const

inline

has colorkey? RGB(255, 0, 255)

Returns

true if there is a colorkey

References Image::mHasColorKey.

bool hasTexture ( ) const

inline

References Image::mTexNum.

Referenced by Image::clearTexture(), and Image::genTexture().

Uint16 height ( ) const

inline

Returns

the height

References Size::height(), and Image::mSize.

Referenced by ImageFont::ImageFont().

void load	(	const String &	fname,
		bool	autoconvert,
		uchar	alpha = 255
	)

loads an Image into a SDL_Surface

Parameters

fname

the filename to lo:ad

References Image::convert(), EXCSDL, Image::mAutoConvert, Image::mSize, Image::mSurface, and Size::set().

Referenced by Image::Image(), ImageFont::load(), and Image::load().

void load	(	const String &	fname,
		uchar	alpha = 255
	)

References Image::load(), and Image::mAutoConvert.

Color pixel ( const Point &  pos )

inline

References Image::mSurface, and Point::y.

Referenced by ImageFont::ImageFont().

void* pixels ( )

inline

References Image::mSurface.

void setAlpha ( uchar  alpha = 255 )

inline

References Image::mSurface.

void setAutoConvert ( bool  autoconvert )

inline

sets whether or not autoconvert to screenformat

Parameters

autoconvert

= should be converted automatically?

References Image::mAutoConvert.

void setColorKey ( Color  color )

inline

References Image::mColorKey.

const Size& size ( ) const

inline

Returns

the Size

References Image::mSize.

Referenced by Canvas::image(), and Label::setImage().

SDL_Surface* surface ( )

inline

References Image::mSurface.

Referenced by Image::convert(), and CanvasStd::image().

GLuint texNum ( ) const

inline

References Image::mTexNum.

Referenced by CanvasGL::image().

GLuint textureHeight ( ) const

inline

References Image::calcTexSize(), Image::checkAlpha(), Image::checkColorKey(), Image::clearSurface(), Image::clearTexture(), Image::genTexture(), and Image::mTextureHeight.

Referenced by CanvasGL::image().

GLuint textureWidth ( ) const

inline

References Image::mTextureWidth.

Referenced by CanvasGL::image().

Uint16 width ( ) const

inline

Returns

the width

References Image::mSize, and Size::width().

Referenced by ImageFont::ImageFont().

Member Data Documentation

bool mAutoConvert

private

Referenced by Image::Image(), Image::load(), and Image::setAutoConvert().

Color mColorKey

private

Referenced by Image::checkColorKey(), Image::clear(), and Image::setColorKey().

bool mHasAlpha

private

Referenced by Image::checkAlpha(), Image::clear(), Image::convert(), Image::genTexture(), and Image::hasAlpha().

bool mHasColorKey

private

Referenced by Image::checkColorKey(), Image::clear(), Image::convert(), Image::genTexture(), and Image::hasColorKey().

bool mIsConverted

private

Referenced by Image::clear(), and Image::convert().

Size mSize

private

Referenced by Image::calcTexSize(), Image::checkAlpha(), Image::checkColorKey(), Image::clearTexture(), Image::convert(), Image::genTexture(), Image::height(), Image::load(), Image::size(), and Image::width().

SDL_Surface* mSurface

private

Referenced by Image::checkAlpha(), Image::checkColorKey(), Image::clearSurface(), Image::convert(), Image::genTexture(), Image::Image(), Image::load(), Image::pixel(), Image::pixels(), Image::setAlpha(), and Image::surface().

GLuint mTexNum

private

Referenced by Image::clearTexture(), Image::genTexture(), Image::hasTexture(), Image::Image(), and Image::texNum().

GLuint mTextureHeight

private

Referenced by Image::calcTexSize(), Image::clearTexture(), Image::genTexture(), and Image::textureHeight().

GLuint mTextureWidth

private

Referenced by Image::calcTexSize(), Image::clearTexture(), Image::genTexture(), and Image::textureWidth().

---

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

• image.h
• image.cpp