Inheritance diagram for iIndexArray:

Detailed Description

Index array interface.

General
virtual eGraphicsPrimitiveType	GetPrimitiveType () const =0
	Get the primitive type of this index array. {Property}. More...

virtual tU32	GetNumIndices () const =0
	Get the number of indices in the given index array. {Property}. More...

virtual tU32	GetMaxVertexIndex () const =0
	Get the maximum vertex index that can be used in this index array. {Property}. More...

virtual eArrayUsage	GetUsage () const =0
	Get the usage of the given vertex array. {Property}. More...

Locking
virtual tPtr	Lock (tU32 ulFirstIndex, tU32 ulNumIndex, eLock aLock)=0
	Lock index array memory to enable writting and reading in it. More...

virtual tBool	Unlock ()=0
	Unlock vertex array memory. More...

virtual tBool	GetIsLocked () const =0
	Return true if the array is locked. {Property}. More...

Additional Inherited Members
Public Member Functions inherited from iDeviceResource
virtual iHString *	GetDeviceResourceName () const =0
	Get the resource's name. More...

virtual tBool	HasDeviceResourceBeenReset (tBool abClearFlag)=0
	Check whether the device resource has just been reset. More...

virtual tBool	ResetDeviceResource ()=0
	Reset the device resource. More...

virtual iDeviceResource *	Bind (iUnknown *apDevice)=0
	Called when the resource is going to be used by the device. 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 eGraphicsPrimitiveType GetPrimitiveType ( ) const

pure virtual

Get the primitive type of this index array. {Property}.

virtual tU32 GetNumIndices ( ) const

pure virtual

Get the number of indices in the given index array. {Property}.

virtual tU32 GetMaxVertexIndex ( ) const

pure virtual

Get the maximum vertex index that can be used in this index array. {Property}.

virtual eArrayUsage GetUsage ( ) const

pure virtual

Get the usage of the given vertex array. {Property}.

pure virtual

Lock index array memory to enable writting and reading in it.

Parameters

ulFirstIndex	is the offset in the index data to lock.
ulNumIndex	is the number of index to lock.
aLock	specify the locking mode.

Remarks: pass 0 for ulFirstIndex and ulNumIndex to lock the entire array.; This method should be considered as slow as it may perform some processing to adapt the indices data to the renderer's supported format.

virtual tBool Unlock ( )

pure virtual

Unlock vertex array memory.

Remarks: This method should be considered as slow as it may perform some processing to adapt the indices data to the renderer's supported format.

virtual tBool GetIsLocked ( ) const

pure virtual

Return true if the array is locked. {Property}.