PLGraphics::ImagePart Class Reference

Image part. More...

#include <ImagePart.h>

List of all members.

Public Member Functions
	ImagePart ()
	Constructor.
PLGRAPHICS_API	ImagePart (const ImagePart &cSource)
	Copy constructor.
	~ImagePart ()
	Destructor.
PLGRAPHICS_API ImagePart &	operator= (const ImagePart &cSource)
	Assignment operator.
PLGRAPHICS_API void	Clear ()
	Clear data.
PLGRAPHICS_API void	ApplyEffect (const ImageEffect &cEffect)
	Apply image effect.
PLGRAPHICS_API ECheckConsistency	CheckConsistency () const
	Check image for possible problems.
PLCore::uint32	GetSemantics () const
	Get semantics.
void	SetSemantics (PLCore::uint32 nSemantics)
	Set semantics.
bool	HasMipmaps () const
	Check if the layer has mipmaps.
PLCore::uint32	GetNumOfMipmaps () const
	Get number of mipmaps.
ImageBuffer *	GetMipmap (PLCore::uint32 nIndex) const
	Get mipmap.
const PLCore::Container < ImageBuffer * > &	GetMipmaps () const
	Get mipmaps.
PLGRAPHICS_API bool	BuildMipmaps ()
	Build mipmaps.
PLGRAPHICS_API ImageBuffer *	CreateMipmap ()
	Create new mipmap.
PLGRAPHICS_API bool	DeleteMipmap (ImageBuffer &cImageBuffer)
	Delete mipmap.
PLGRAPHICS_API void	DeleteMipmaps ()
	Deletes all mipmaps besides the first one (the base map)

---

Detailed Description

Image part.

Note:

• An image part has usually at least one mipmap - the base map

---

Constructor & Destructor Documentation

PLGraphics::ImagePart::ImagePart

(

)

[inline]

Constructor.

PLGRAPHICS_API PLGraphics::ImagePart::ImagePart

(

const ImagePart &

cSource

)

Copy constructor.

Parameters:

[in]

cSource

Source to copy from

PLGraphics::ImagePart::~ImagePart

(

)

[inline]

Destructor.

---

Member Function Documentation

PLGRAPHICS_API ImagePart& PLGraphics::ImagePart::operator=

(

const ImagePart &

cSource

)

Assignment operator.

Parameters:

[in]

cSource

Source to copy from

Returns:

Reference to this object

PLGRAPHICS_API void PLGraphics::ImagePart::Clear

(

)

Clear data.

PLGRAPHICS_API void PLGraphics::ImagePart::ApplyEffect

(

const ImageEffect &

cEffect

)

Apply image effect.

Parameters:

[in]

cEffect

Image effect

PLGRAPHICS_API ECheckConsistency PLGraphics::ImagePart::CheckConsistency

(

)

const

Check image for possible problems.

Returns:

Error code describing any problem found, 'CheckOk' if everything is fine

PLCore::uint32 PLGraphics::ImagePart::GetSemantics

(

)

const [inline]

Get semantics.

Returns:

Semantics ID

void PLGraphics::ImagePart::SetSemantics

(

PLCore::uint32

nSemantics

)

[inline]

Set semantics.

Parameters:

[in]

nSemantics

Semantics ID

bool PLGraphics::ImagePart::HasMipmaps

(

)

const [inline]

Check if the layer has mipmaps.

Returns:

'true' if the frame contains more than one mipmap

PLCore::uint32 PLGraphics::ImagePart::GetNumOfMipmaps

(

)

const [inline]

Get number of mipmaps.

Returns:

Number of mipmaps

ImageBuffer * PLGraphics::ImagePart::GetMipmap

(

PLCore::uint32

nIndex

)

const [inline]

Get mipmap.

Parameters:

[in]

nIndex

Index of mipmap

Returns:

Image buffer, or a null pointer if it doesn't exist

const PLCore::Container< ImageBuffer * > & PLGraphics::ImagePart::GetMipmaps

(

)

const [inline]

Get mipmaps.

Returns:

List of mipmaps

PLGRAPHICS_API bool PLGraphics::ImagePart::BuildMipmaps

(

)

Build mipmaps.

Returns:

'true' on success, else 'false'

PLGRAPHICS_API ImageBuffer* PLGraphics::ImagePart::CreateMipmap

(

)

Create new mipmap.

Returns:

Image buffer of mipmap, or a null pointer on error

PLGRAPHICS_API bool PLGraphics::ImagePart::DeleteMipmap

(

ImageBuffer &

cImageBuffer

)

Delete mipmap.

Parameters:

[in]

cImageBuffer

Image buffer of mipmap

Returns:

'true' on success, ('cImageBuffer' is now no longer valid!) else 'false'

PLGRAPHICS_API void PLGraphics::ImagePart::DeleteMipmaps

(

)

Deletes all mipmaps besides the first one (the base map)

---

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

• ImagePart.h
• ImagePart.inl