deImage Class Reference

Image Resource. More...

#include <deImage.h>

Inheritance diagram for deImage:

List of all members.

Public Member Functions
Constructors and Destructors
	deImage (deImageManager *manager, const char *filename, int width, int height, int depth, int componentCount, int bitCount)
	Creates a new image object.
	deImage (deImageManager *manager, const char *filename, decXpmImage *image)
	Creates a new image object from an XPM image.
virtual	~deImage ()
	Cleans up the image.
Management
int	GetWidth () const
	Retrieves the width in pixels.
int	GetHeight () const
	Retrieves the height in pixels.
int	GetDepth () const
	Retrieves the depth in pixels.
int	GetComponentCount () const
	Retrieves the number of components.
int	GetBitCount () const
	Retrieves the bit count of each component.
sGrayscale8 *	GetDataGrayscale8 () const
	Retrieves the 8-bit Grayscale image data.
sGrayscale16 *	GetDataGrayscale16 () const
	Retrieves the 16-bit Grayscale image data.
sGrayscale32 *	GetDataGrayscale32 () const
	Retrieves the 32-bit Grayscale image data.
sGrayscaleAlpha8 *	GetDataGrayscaleAlpha8 () const
	Retrieves the 8-bit Grayscale-Alpha image data.
sGrayscaleAlpha16 *	GetDataGrayscaleAlpha16 () const
	Retrieves the 16-bit Grayscale-Alpha image data.
sGrayscaleAlpha32 *	GetDataGrayscaleAlpha32 () const
	Retrieves the 32-bit Grayscale-Alpha image data.
sRGB8 *	GetDataRGB8 () const
	Retrieves the 8-bit RGB image data.
sRGB16 *	GetDataRGB16 () const
	Retrieves the 16-bit RGB image data.
sRGB32 *	GetDataRGB32 () const
	Retrieves the 32-bit RGB image data.
sRGBA8 *	GetDataRGBA8 () const
	Retrieves the 8-bit RGBA image data.
sRGBA16 *	GetDataRGBA16 () const
	Retrieves the 16-bit RGBA image data.
sRGBA32 *	GetDataRGBA32 () const
	Retrieves the 32-bit RGBA image data.
void *	GetData () const
	Retrieves the image data pointer directly.
bool	GetHasCreatedTexture () const
	Determines if the texture of this image has already been created.
void	CreateTexture ()
	Create the texture for this image or update it.
void	DropAlpha ()
	Drops the alpha data.
System Peers
deBaseGraphicImage *	GetGraphicImage () const
	Retrieves the graphic system peer object.
void	SetGraphicImage (deBaseGraphicImage *image)
	Sets the graphic system peer object.

---

Detailed Description

Image Resource.

Stores images in variable bit depth and resolution. Does not provide any kind of conversation just storage.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Constructor & Destructor Documentation

deImage::deImage	(	deImageManager *	manager,
		const char *	filename,
		int	width,
		int	height,
		int	depth,
		int	componentCount,
		int	bitCount
	)

Creates a new image object.

Parameters:

resMgr	Resource manager to link to
filename	Filename of the image if present
width	Width of the image at least 1
height	Height of the image at least 1
components	Number of components ( 1 to 4 inclusive )
bitCount	Bit Count of each component ( 8, 16 or 32 )

deImage::deImage	(	deImageManager *	manager,
		const char *	filename,
		decXpmImage *	image
	)

Creates a new image object from an XPM image.

virtual deImage::~deImage

(

)

[virtual]

Cleans up the image.

---

Member Function Documentation

void deImage::CreateTexture

(

)

Create the texture for this image or update it.

void deImage::DropAlpha

(

)

Drops the alpha data.

int deImage::GetBitCount

(

)

const [inline]

Retrieves the bit count of each component.

int deImage::GetComponentCount

(

)

const [inline]

Retrieves the number of components.

void* deImage::GetData

(

)

const [inline]

Retrieves the image data pointer directly.

This is a very dangerous function. Use it only if you rellay know what you are doing.

sGrayscale16* deImage::GetDataGrayscale16

(

)

const

Retrieves the 16-bit Grayscale image data.

sGrayscale32* deImage::GetDataGrayscale32

(

)

const

Retrieves the 32-bit Grayscale image data.

sGrayscale8* deImage::GetDataGrayscale8

(

)

const

Retrieves the 8-bit Grayscale image data.

sGrayscaleAlpha16* deImage::GetDataGrayscaleAlpha16

(

)

const

Retrieves the 16-bit Grayscale-Alpha image data.

sGrayscaleAlpha32* deImage::GetDataGrayscaleAlpha32

(

)

const

Retrieves the 32-bit Grayscale-Alpha image data.

sGrayscaleAlpha8* deImage::GetDataGrayscaleAlpha8

(

)

const

Retrieves the 8-bit Grayscale-Alpha image data.

sRGB16* deImage::GetDataRGB16

(

)

const

Retrieves the 16-bit RGB image data.

sRGB32* deImage::GetDataRGB32

(

)

const

Retrieves the 32-bit RGB image data.

sRGB8* deImage::GetDataRGB8

(

)

const

Retrieves the 8-bit RGB image data.

sRGBA16* deImage::GetDataRGBA16

(

)

const

Retrieves the 16-bit RGBA image data.

sRGBA32* deImage::GetDataRGBA32

(

)

const

Retrieves the 32-bit RGBA image data.

sRGBA8* deImage::GetDataRGBA8

(

)

const

Retrieves the 8-bit RGBA image data.

int deImage::GetDepth

(

)

const [inline]

Retrieves the depth in pixels.

deBaseGraphicImage* deImage::GetGraphicImage

(

)

const [inline]

Retrieves the graphic system peer object.

bool deImage::GetHasCreatedTexture

(

)

const [inline]

Determines if the texture of this image has already been created.

int deImage::GetHeight

(

)

const [inline]

Retrieves the height in pixels.

int deImage::GetWidth

(

)

const [inline]

Retrieves the width in pixels.

void deImage::SetGraphicImage

(

deBaseGraphicImage *

image )

Sets the graphic system peer object.

---

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

• deImage.h