Inheritance diagram for iImage:

Detailed Description

Image interface.

Public Member Functions
virtual tBool	Copy (iImage *apImage)=0
	Copy the specified image. More...

virtual iImage *	Clone () const =0
	Clone this image. More...

virtual tBool	GetHasBitmap () const =0
	Get whether a bitmap is already initialized in the image. {Property}. More...

virtual iBitmap2D *	GrabBitmap (eImageUsage aLock, const sRecti &aDirtyRect)=0
	Grab the image as a bitmap to be used for some other operations. More...

virtual tBool	GetHasTexture () const =0
	Get whether a texture is already initialized in the image. {Property}. More...

virtual tBool	GetHasDepthStencil () const =0
	Get whether a depth stencil is already initialized in the image. {Property}. More...

virtual iTexture *	GrabTexture (eImageUsage aLock, const sRecti &aDirtyRect)=0
	Grab the image as a texture to be used for some other operations. More...

virtual tU32	GetWidth () const =0
	Get the image's width. {Property}. More...

virtual tU32	GetHeight () const =0
	Get the image's height. {Property}. More...

virtual sVec2f	GetSize () const =0
	Get the image's size in a vec2f. {Property}. More...

virtual tBool	Resize (tU32 anNewWidth, tU32 anNewHeight)=0
	Resize the image. More...

virtual void	RecomputeBitmapMipmapsBeforeCopyToTexture ()=0
	Indicate that the bitmap's mipmaps should be recomputed the next time the bitmap is copied to the texture. More...

Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual tBool Copy ( iImage * apImage )

pure virtual

Copy the specified image.

Remarks: Copy the bitmap's content.

virtual iImage* Clone ( ) const

pure virtual

Clone this image.

Remarks: Clone the bitmap's content.

virtual tBool GetHasBitmap ( ) const

pure virtual

Get whether a bitmap is already initialized in the image. {Property}.

virtual iBitmap2D* GrabBitmap	(	eImageUsage	aLock,
		const sRecti &	aDirtyRect
	)

pure virtual

Grab the image as a bitmap to be used for some other operations.

Remarks: This function only adds a dirty rectangles and manage the bitmap's update from the texture.; Pass a Null rectangle to identity the whole image size.

virtual tBool GetHasTexture ( ) const

pure virtual

Get whether a texture is already initialized in the image. {Property}.

virtual tBool GetHasDepthStencil ( ) const

pure virtual

Get whether a depth stencil is already initialized in the image. {Property}.

virtual iTexture* GrabTexture	(	eImageUsage	aLock,
		const sRecti &	aDirtyRect
	)

pure virtual

Grab the image as a texture to be used for some other operations.

Remarks: This function only adds a dirty rectangles and manage the texture's update from the bitmap.; Pass a Null rectangle to identity the whole image size.

virtual tU32 GetWidth ( ) const

pure virtual

Get the image's width. {Property}.

virtual tU32 GetHeight ( ) const

pure virtual

Get the image's height. {Property}.

virtual sVec2f GetSize ( ) const

pure virtual

Get the image's size in a vec2f. {Property}.

virtual tBool Resize	(	tU32	anNewWidth,
		tU32	anNewHeight
	)

pure virtual

Resize the image.

Remarks: This will clear the image's content.; Resize will fail if the size is smaller than one.; When resize fail the previous image's state is preserved.

virtual void RecomputeBitmapMipmapsBeforeCopyToTexture ( )

pure virtual

Indicate that the bitmap's mipmaps should be recomputed the next time the bitmap is copied to the texture.

Detailed Description

Public Member Functions

Member Function Documentation