DigitalSpaces::DICEGUIImage Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>


Public Member Functions
void	getSize (out_Pairf *size)
	Return a Size object containing the dimensions of the Image.
float	getWidth ()
	Return the pixel width of the image.
float	getHeight ()
	Return the pixel height of the image.
void	getOffsets (out_Pairf *offsets)
	Return a Point object that contains the offset applied when rendering this Image.
float	getOffsetX ()
	Return the X rendering offset.
float	getOffsetY ()
	Return the Y rendering offset.
const char *	getName ()
	Return the name of this Image object.
const char *	getImagesetName ()
	Return the name of the Imageset that contains this Image.
DICEGUIImageset *	getImageset ()
	Return the parent Imageset object that contains this Image.
void	getSourceTextureArea (out_Vector4f *area)
	Return Rect describing the source texture area used by this Image.

Member Function Documentation

void DigitalSpaces::DICEGUIImage::getSize ( out_Pairf * size )

Return a Size object containing the dimensions of the Image.

float DigitalSpaces::DICEGUIImage::getWidth ( )

Return the pixel width of the image.

float DigitalSpaces::DICEGUIImage::getHeight ( )

Return the pixel height of the image.

void DigitalSpaces::DICEGUIImage::getOffsets ( out_Pairf * offsets )

Return a Point object that contains the offset applied when rendering this Image.

Returns:: Point object containing the offsets applied when rendering this Image

float DigitalSpaces::DICEGUIImage::getOffsetX ( )

Return the X rendering offset.

Returns:: X rendering offset. This is the number of pixels that the image is offset by when rendering at any given location.

float DigitalSpaces::DICEGUIImage::getOffsetY ( )

Return the Y rendering offset.

Returns:: Y rendering offset. This is the number of pixels that the image is offset by when rendering at any given location.

const char* DigitalSpaces::DICEGUIImage::getName ( )

Return the name of this Image object.

const char* DigitalSpaces::DICEGUIImage::getImagesetName ( )

Return the name of the Imageset that contains this Image.

Returns:: String object containing the name of the Imageset which this Image is a part of.

DICEGUIImageset* DigitalSpaces::DICEGUIImage::getImageset ( )

Return the parent Imageset object that contains this Image.

void DigitalSpaces::DICEGUIImage::getSourceTextureArea ( out_Vector4f * area )

Return Rect describing the source texture area used by this Image.

Returns:: Rect object that describes, in pixels, the area upon the source texture which is used when rendering this Image.

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