PLGui::Image Class Reference

Image class. More...

#include <Image.h>

List of all members.

Public Member Functions
PLGUI_API	Image (Gui &cGui, const PLCore::String &sFilename="")
	Constructor.
PLGUI_API	Image (const Image &cImage)
	Copy constructor.
PLGUI_API	~Image ()
	Destructor.
PLGUI_API Image &	operator= (const Image &cImage)
	Assignment operator.
PLGUI_API Gui *	GetGui () const
	Get owner GUI.
PLGUI_API ImageImpl *	GetImpl () const
	Get implementation.
PLGUI_API bool	IsEmpty () const
	Check if image has been loaded.
PLGUI_API bool	Load (const PLCore::String &sFilename)
	Load image.
PLGUI_API bool	LoadWithColorKey (const PLCore::String &sFilename, const PLGraphics::Color3 &cColor)
	Load image and apply a color key.
PLGUI_API PLCore::String	GetFilename () const
	Get image filename.
PLGUI_API PLMath::Vector2i	GetSize () const
	Get image size.
PLGUI_API PLCore::uint32	GetColorDepth () const
	Get color depth.
Protected Attributes
Gui *	m_pGui
ImageImpl *	m_pImageImpl
PLCore::String	m_sFilename

---

Detailed Description

Image class.

Note:

• Implementation of the bridge design pattern, this class is the abstraction

---

Constructor & Destructor Documentation

PLGUI_API PLGui::Image::Image	(	Gui &	cGui,
		const PLCore::String &	sFilename = ""
	)

Constructor.

Parameters:

[in]	cGui	Owner GUI
[in]	sFilename	Image filename

PLGUI_API PLGui::Image::Image

(

const Image &

cImage

)

Copy constructor.

Parameters:

[in]

cImage

Image that is copied

PLGUI_API PLGui::Image::~Image

(

)

Destructor.

---

Member Function Documentation

PLGUI_API Image& PLGui::Image::operator=

(

const Image &

cImage

)

Assignment operator.

Parameters:

[in]

cImage

Image that is copied

PLGUI_API Gui* PLGui::Image::GetGui

(

)

const

Get owner GUI.

Returns:

Pointer to GUI object (never a null pointer)

PLGUI_API ImageImpl* PLGui::Image::GetImpl

(

)

const

Get implementation.

Returns:

Pointer to platform specific implementation

PLGUI_API bool PLGui::Image::IsEmpty

(

)

const

Check if image has been loaded.

Returns:

'true' if image is empty, else 'false'

PLGUI_API bool PLGui::Image::Load

(

const PLCore::String &

sFilename

)

Load image.

Parameters:

[in]

sFilename

Name of image file

Returns:

'true' if all went fine, else 'false'

PLGUI_API bool PLGui::Image::LoadWithColorKey	(	const PLCore::String &	sFilename,
		const PLGraphics::Color3 &	cColor
	)

Load image and apply a color key.

Parameters:

[in]	sFilename	Name of image file
[in]	cColor	Color that will be treated as transparent

Returns:

'true' if all went fine, else 'false'

PLGUI_API PLCore::String PLGui::Image::GetFilename

(

)

const

Get image filename.

Returns:

Filename of image

PLGUI_API PLMath::Vector2i PLGui::Image::GetSize

(

)

const

Get image size.

Returns:

Size of image

PLGUI_API PLCore::uint32 PLGui::Image::GetColorDepth

(

)

const

Get color depth.

Returns:

Color depth

---

Member Data Documentation

Gui* PLGui::Image::m_pGui [protected]

GUI instance

ImageImpl* PLGui::Image::m_pImageImpl [protected]

Image implementation object

PLCore::String PLGui::Image::m_sFilename [protected]

Image filename

---

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

• PLGui/include/PLGui/Gui/Resources/Image.h