TalanSoft Toolkits  201707
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
List of all members
iVertexArray Struct Referenceabstract
Inheritance diagram for iVertexArray:
iDeviceResource iUnknown iD3D9VertexArray

Detailed Description

Vertex Array interface.

Remarks
Bindable

General

virtual tFVF GetFVF () const =0
 Get the FVF of the vertex array. {Property}. More...
 
virtual tU32 GetNumVertices () const =0
 Get the number of vertices in the vertex array. {Property}. More...
 
virtual eArrayUsage GetUsage () const =0
 Get the usage of the given vertex array. {Property}. More...
 

Locking

virtual tPtr Lock (tU32 ulFirstVertex, tU32 ulNumVertex, eLock aLock)=0
 Lock vertex 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 iHStringGetDeviceResourceName () 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 iDeviceResourceBind (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 iUnknownQueryInterface (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 tFVF GetFVF ( ) const
pure virtual

Get the FVF of the vertex array. {Property}.

virtual tU32 GetNumVertices ( ) const
pure virtual

Get the number of vertices in the vertex array. {Property}.

virtual eArrayUsage GetUsage ( ) const
pure virtual

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

virtual tPtr Lock ( tU32  ulFirstVertex,
tU32  ulNumVertex,
eLock  aLock 
)
pure virtual

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

Parameters
ulFirstVertexis the offset in the vertex data to lock.
ulNumVertexis the number of vertex to lock.
aLockspecify to locking mode.
Returns
a pointer to the vertex data.
Remarks
pass 0 for ulFirstVertex and ulNumVertex to lock the entire array.
virtual tBool Unlock ( )
pure virtual

Unlock vertex array memory.

virtual tBool GetIsLocked ( ) const
pure virtual

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