GUI::Image Class Reference

Class that represents a single Image of an Imageset. More...

List of all members.

Public Member Functions
Size	getSize ()
	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.
Point	getOffsets ()
	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.
string	getName ()
	Return the name of this Image object.
string	getImagesetName ()
	Return the name of the Imageset that contains this Image.
Rect	getSourceTextureArea ()
	Return Rect describing the source texture area used by this Image.

---

Detailed Description

Class that represents a single Image of an Imageset.

---

Member Function Documentation

Size GUI::Image::getSize

(

)

Return a Size object containing the dimensions of the Image.

Returns:

Size object holding the width and height of the Image.

float GUI::Image::getWidth

(

)

Return the pixel width of the image.

Returns:

Width of this Image in pixels.

float GUI::Image::getHeight

(

)

Return the pixel height of the image.

Returns:

Height of this Image in pixels

Point GUI::Image::getOffsets

(

)

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 GUI::Image::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 GUI::Image::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.

string GUI::Image::getName

(

)

Return the name of this Image object.

Returns:

String object containing the name of this Image

string GUI::Image::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.

Rect GUI::Image::getSourceTextureArea

(

)

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.