The IVertexBuffer video object interface. More...

#include "murl_video_i_vertex_buffer.h"

Inherited by Murl::Video::VertexBuffer.

Public Member Functions
virtual IObject *	GetObjectInterface ()=0
	Get the mutable Video::IObject interface. More...

virtual const IObject *	GetObjectInterface () const =0
	Get the constant Video::IObject interface. More...

virtual Bool	Set (IProgram *currentProgram, SInt32 id, UInt32 unit)=0
	Attach the vertex buffer to the current GPU program. More...

virtual Bool	SetDynamicBatchingAllowed (Bool allowed)=0
	Allow/disallow dynamic batching. More...

virtual Bool	IsDynamicBatchingAllowed () const =0
	Check if the buffer allows for dynamic batching. More...

virtual Bool	SetAccessMode (IEnums::BufferAccessMode mode)=0
	Set the access mode hint (read only or read/write). More...

virtual IEnums::BufferAccessMode	GetAccessMode () const =0
	Get the access mode hint. More...

virtual Bool	SetNumberOfBones (UInt32 numberOfBones)=0
	Set the number of bones affecting the vertex buffer. More...

virtual UInt32	GetNumberOfBones () const =0
	Get the number of bones affecting the vertex buffer. More...

virtual Bool	SetVertexData (void *vertices, UInt32 maxNumberOfVertices, UInt32 byteStride)=0
	Assign a mutable source data storage. More...

virtual Bool	SetVertexData (const void *vertices, UInt32 maxNumberOfVertices, UInt32 byteStride)=0
	Assign a constant source data storage. More...

virtual Bool	SetNumberOfVertices (UInt32 numberOfVertices)=0
	Set the actual number of vertices used. More...

virtual Bool	SetVerticesModified ()=0
	Mark the whole buffer as modified. More...

virtual Bool	SetVerticesModified (UInt32 firstVertex, UInt32 numberOfVertices)=0
	Mark a sub-region of the buffer as modified. More...

virtual void *	GetVertexData ()=0
	Get a pointer to the mutable source data, if available. More...

virtual const void *	GetVertexData () const =0
	Get a pointer to the constant source data. More...

virtual void *	GetVertexBufferData ()=0
	Get a pointer to the actual mutable buffer data. More...

virtual const void *	GetVertexBufferData () const =0
	Get a pointer to the actual constant buffer data. More...

virtual UInt32	GetMaxNumberOfVertices () const =0
	Get the maximum number of vertices the buffer can hold. More...

virtual UInt32	GetNumberOfVertices () const =0
	Get the actual number of vertices used. More...

virtual UInt32	GetByteStride () const =0
	Get the byte stride, i.e. More...

virtual Bool	AreVerticesModified () const =0
	Check if the buffer contents are modified. More...

virtual SInt32	AddAttribute (IEnums::AttributeItem item, IEnums::AttributeType type, UInt32 &byteOffset)=0
	Add a single predefined attribute variable. More...

virtual SInt32	AddAttribute (SInt32 id, IEnums::AttributeType type, UInt32 &byteOffset)=0
	Add a single custom attribute variable, by its unique integer ID in the renderer. More...

virtual SInt32	AddAttribute (const String &name, IEnums::AttributeType type, UInt32 &byteOffset)=0
	Add a single custom attribute variable, by its actual name. More...

virtual Bool	RemoveAllAttributes ()=0
	Remove all present attribute variables from the buffer. More...

virtual SInt32	GetAttributeIndex (IEnums::AttributeItem item) const =0
	Get the index of a predefined attribute variable in the buffer. More...

virtual SInt32	GetAttributeIndex (SInt32 id) const =0
	Get the index of a custom attribute variable in the buffer, by its unique integer ID. More...

virtual SInt32	GetAttributeIndex (const String &name) const =0
	Get the index of a custom attribute variable in the buffer, by its actual name. More...

virtual UInt32	GetNumberOfAttributes () const =0
	Get the total number of individual attribute variables present in the buffer. More...

virtual IEnums::AttributeType	GetAttributeType (UInt32 index) const =0
	Get the data type of an attribute variable at a given index. More...

virtual IEnums::AttributeItem	GetAttributeItem (UInt32 index) const =0
	Get the predefined attribute variable item at a given index. More...

virtual SInt32	GetAttributeId (UInt32 index) const =0
	Get the unique integer ID of an attribute variable at a given index. More...

virtual UInt32	GetAttributeByteOffset (UInt32 index) const =0
	Get the byte offset of an attribute variable relative to the buffer start. More...

virtual IAttribute *	GetAttribute (UInt32 index) const =0
	Get the generic attribute variable at a given index. More...

virtual IFloatAttribute *	GetFloatAttribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IFloatAttribute. More...

virtual IFloatVector2Attribute *	GetFloatVector2Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IFloatVector2Attribute. More...

virtual IFloatVector3Attribute *	GetFloatVector3Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IFloatVector3Attribute. More...

virtual IFloatVector4Attribute *	GetFloatVector4Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IFloatVector4Attribute. More...

virtual IUInt8Attribute *	GetUInt8Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IUInt8Attribute. More...

virtual IUInt8Vector2Attribute *	GetUInt8Vector2Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IUInt8Vector2Attribute. More...

virtual IUInt8Vector3Attribute *	GetUInt8Vector3Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IUInt8Vector3Attribute. More...

virtual IUInt8Vector4Attribute *	GetUInt8Vector4Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IUInt8Vector4Attribute. More...

virtual ISInt8Attribute *	GetSInt8Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an ISInt8Attribute. More...

virtual ISInt8Vector2Attribute *	GetSInt8Vector2Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an ISInt8Vector2Attribute. More...

virtual ISInt8Vector3Attribute *	GetSInt8Vector3Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an ISInt8Vector3Attribute. More...

virtual ISInt8Vector4Attribute *	GetSInt8Vector4Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an ISInt8Vector4Attribute. More...

virtual IUInt16Attribute *	GetUInt16Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IUInt16Attribute. More...

virtual IUInt16Vector2Attribute *	GetUInt16Vector2Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IUInt16Vector2Attribute. More...

virtual IUInt16Vector3Attribute *	GetUInt16Vector3Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IUInt16Vector3Attribute. More...

virtual IUInt16Vector4Attribute *	GetUInt16Vector4Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an IUInt16Vector4Attribute. More...

virtual ISInt16Attribute *	GetSInt16Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an ISInt16Attribute. More...

virtual ISInt16Vector2Attribute *	GetSInt16Vector2Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an ISInt16Vector2Attribute. More...

virtual ISInt16Vector3Attribute *	GetSInt16Vector3Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an ISInt16Vector3Attribute. More...

virtual ISInt16Vector4Attribute *	GetSInt16Vector4Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as an ISInt16Vector4Attribute. More...

virtual IUInt8Attribute *	GetNormalizedUInt8Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized IUInt8Attribute. More...

virtual IUInt8Vector2Attribute *	GetNormalizedUInt8Vector2Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized IUInt8Vector2Attribute. More...

virtual IUInt8Vector3Attribute *	GetNormalizedUInt8Vector3Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized IUInt8Vector3Attribute. More...

virtual IUInt8Vector4Attribute *	GetNormalizedUInt8Vector4Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized IUInt8Vector4Attribute. More...

virtual ISInt8Attribute *	GetNormalizedSInt8Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized ISInt8Attribute. More...

virtual ISInt8Vector2Attribute *	GetNormalizedSInt8Vector2Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized ISInt8Vector2Attribute. More...

virtual ISInt8Vector3Attribute *	GetNormalizedSInt8Vector3Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized ISInt8Vector3Attribute. More...

virtual ISInt8Vector4Attribute *	GetNormalizedSInt8Vector4Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized ISInt8Vector4Attribute. More...

virtual IUInt16Attribute *	GetNormalizedUInt16Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized IUInt16Attribute. More...

virtual IUInt16Vector2Attribute *	GetNormalizedUInt16Vector2Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized IUInt16Vector2Attribute. More...

virtual IUInt16Vector3Attribute *	GetNormalizedUInt16Vector3Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized IUInt16Vector3Attribute. More...

virtual IUInt16Vector4Attribute *	GetNormalizedUInt16Vector4Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized IUInt16Vector4Attribute. More...

virtual ISInt16Attribute *	GetNormalizedSInt16Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized ISInt16Attribute. More...

virtual ISInt16Vector2Attribute *	GetNormalizedSInt16Vector2Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized ISInt16Vector2Attribute. More...

virtual ISInt16Vector3Attribute *	GetNormalizedSInt16Vector3Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized ISInt16Vector3Attribute. More...

virtual ISInt16Vector4Attribute *	GetNormalizedSInt16Vector4Attribute (UInt32 index) const =0
	Get the attribute variable at a given index as a normalized ISInt16Vector4Attribute. More...

virtual Bool	IsInVideoMemory () const =0
	Check if the actual buffer resides in video memory. More...

virtual UInt32	GetSignature () const =0
	Get the signature, obtained via IRenderer::AcquireVertexBufferSignature(). More...

Detailed Description

The IVertexBuffer video object interface.

This interface represents a buffer containing geometry vertices.

Used internally by various geometry graph nodes, such as Graph::PlaneGeometry, Graph::ResourceMeshGeometry and others.

Member Function Documentation

◆ GetObjectInterface() [1/2]

virtual IObject* Murl::Video::IVertexBuffer::GetObjectInterface ( )

pure virtual

Get the mutable Video::IObject interface.

Returns: The IObject interface.

◆ GetObjectInterface() [2/2]

virtual const IObject* Murl::Video::IVertexBuffer::GetObjectInterface ( ) const

pure virtual

Get the constant Video::IObject interface.

Returns: The IObject interface.

◆ Set()

virtual Bool Murl::Video::IVertexBuffer::Set	(	IProgram *	currentProgram,
		SInt32	id,
		UInt32	unit
	)

pure virtual

Attach the vertex buffer to the current GPU program.

Parameters

currentProgram	The current GPU program.
id	The unique integer ID of the vertex buffer in the renderer.
unit	The vertex buffer unit.

Returns: true if successful.

◆ SetDynamicBatchingAllowed()

virtual Bool Murl::Video::IVertexBuffer::SetDynamicBatchingAllowed ( Bool allowed )

pure virtual

Allow/disallow dynamic batching.

Parameters

allowed If true, dynamic batching is allowed.

Returns: true if successful.

◆ IsDynamicBatchingAllowed()

virtual Bool Murl::Video::IVertexBuffer::IsDynamicBatchingAllowed ( ) const

pure virtual

Check if the buffer allows for dynamic batching.

Returns: true if dynamic batching is allowed.

◆ SetAccessMode()

virtual Bool Murl::Video::IVertexBuffer::SetAccessMode ( IEnums::BufferAccessMode mode )

pure virtual

Set the access mode hint (read only or read/write).

Parameters

mode	The access mode.

Returns: true if successful.

◆ GetAccessMode()

virtual IEnums::BufferAccessMode Murl::Video::IVertexBuffer::GetAccessMode ( ) const

pure virtual

Get the access mode hint.

Returns: The access mode.

◆ SetNumberOfBones()

virtual Bool Murl::Video::IVertexBuffer::SetNumberOfBones ( UInt32 numberOfBones )

pure virtual

Set the number of bones affecting the vertex buffer.

Parameters

numberOfBones The number of bones needed.

Returns: true if successful.

◆ GetNumberOfBones()

virtual UInt32 Murl::Video::IVertexBuffer::GetNumberOfBones ( ) const

pure virtual

Get the number of bones affecting the vertex buffer.

Returns: The number of bones needed.

◆ SetVertexData() [1/2]

virtual Bool Murl::Video::IVertexBuffer::SetVertexData	(	void *	vertices,
		UInt32	maxNumberOfVertices,
		UInt32	byteStride
	)

pure virtual

Assign a mutable source data storage.

Parameters

vertices	A pointer to the mutable buffer holding the source vertices.
maxNumberOfVertices	The maximum number of vertices the buffer can hold.
byteStride	The buffer stride, i.e. the size of a single vertex entry in bytes.

Returns: true if successful.

◆ SetVertexData() [2/2]

virtual Bool Murl::Video::IVertexBuffer::SetVertexData	(	const void *	vertices,
		UInt32	maxNumberOfVertices,
		UInt32	byteStride
	)

pure virtual

Assign a constant source data storage.

Parameters

vertices	A pointer to the constant buffer holding the source vertices.
maxNumberOfVertices	The maximum number of vertices the buffer can hold.
byteStride	The buffer stride, i.e. the size of a single vertex entry in bytes.

Returns: true if successful.

◆ SetNumberOfVertices()

virtual Bool Murl::Video::IVertexBuffer::SetNumberOfVertices ( UInt32 numberOfVertices )

pure virtual

Set the actual number of vertices used.

Parameters

numberOfVertices The actual number of vertices. Must be less or equal than the maximum number defined via SetVertexData().

Returns: true if successful.

◆ SetVerticesModified() [1/2]

virtual Bool Murl::Video::IVertexBuffer::SetVerticesModified ( )

pure virtual

Mark the whole buffer as modified.

Returns: true if successful.

◆ SetVerticesModified() [2/2]

virtual Bool Murl::Video::IVertexBuffer::SetVerticesModified	(	UInt32	firstVertex,
		UInt32	numberOfVertices
	)

pure virtual

Mark a sub-region of the buffer as modified.

Parameters

firstVertex	The first modified vertex in the buffer.
numberOfVertices	The number of modified vertices.

Returns: true if successful.

◆ GetVertexData() [1/2]

virtual void* Murl::Video::IVertexBuffer::GetVertexData ( )

pure virtual

Get a pointer to the mutable source data, if available.

If the source data storage was defined using a constant pointer, this method returns null.

Returns: A pointer to the mutable source data, or null if the source is immutable.

◆ GetVertexData() [2/2]

virtual const void* Murl::Video::IVertexBuffer::GetVertexData ( ) const

pure virtual

Get a pointer to the constant source data.

Returns: A pointer to the source data.

◆ GetVertexBufferData() [1/2]

virtual void* Murl::Video::IVertexBuffer::GetVertexBufferData ( )

pure virtual

Get a pointer to the actual mutable buffer data.

Returns: A pointer to the actual buffer data.

◆ GetVertexBufferData() [2/2]

virtual const void* Murl::Video::IVertexBuffer::GetVertexBufferData ( ) const

pure virtual

Get a pointer to the actual constant buffer data.

Returns: A pointer to the actual buffer data.

◆ GetMaxNumberOfVertices()

virtual UInt32 Murl::Video::IVertexBuffer::GetMaxNumberOfVertices ( ) const

pure virtual

Get the maximum number of vertices the buffer can hold.

Returns: The maximum number of vertices.

◆ GetNumberOfVertices()

virtual UInt32 Murl::Video::IVertexBuffer::GetNumberOfVertices ( ) const

pure virtual

Get the actual number of vertices used.

Returns: The actual number of vertices.

◆ GetByteStride()

virtual UInt32 Murl::Video::IVertexBuffer::GetByteStride ( ) const

pure virtual

Get the byte stride, i.e.

the size of a single vertex entry in bytes.

Returns: The byte stride.

◆ AreVerticesModified()

virtual Bool Murl::Video::IVertexBuffer::AreVerticesModified ( ) const

pure virtual

Check if the buffer contents are modified.

Returns: true if modified.

◆ AddAttribute() [1/3]

virtual SInt32 Murl::Video::IVertexBuffer::AddAttribute	(	IEnums::AttributeItem	item,
		IEnums::AttributeType	type,
		UInt32 &	byteOffset
	)

pure virtual

Add a single predefined attribute variable.

Parameters

item	The predefined item.
type	The attribute data type.
byteOffset	The offset in bytes of the attribute's location within the actual buffer data.

Returns: The zero-based index of the attribute in the buffer, or -1 if failed.

◆ AddAttribute() [2/3]

virtual SInt32 Murl::Video::IVertexBuffer::AddAttribute	(	SInt32	id,
		IEnums::AttributeType	type,
		UInt32 &	byteOffset
	)

pure virtual

Add a single custom attribute variable, by its unique integer ID in the renderer.

Parameters

id	The attribute's unique integer ID.
type	The attribute data type.
byteOffset	The offset in bytes of the attribute's location within the actual buffer data.

Returns: The zero-based index of the attribute in the buffer, or -1 if failed.

◆ AddAttribute() [3/3]

virtual SInt32 Murl::Video::IVertexBuffer::AddAttribute	(	const String &	name,
		IEnums::AttributeType	type,
		UInt32 &	byteOffset
	)

pure virtual

Add a single custom attribute variable, by its actual name.

Parameters

name	The attribute variable name.
type	The attribute data type.
byteOffset	The offset in bytes of the attribute's location within the actual buffer data.

Returns: The zero-based index of the attribute in the buffer, or -1 if failed.

◆ RemoveAllAttributes()

virtual Bool Murl::Video::IVertexBuffer::RemoveAllAttributes ( )

pure virtual

Remove all present attribute variables from the buffer.

Returns: true if successful.

◆ GetAttributeIndex() [1/3]

virtual SInt32 Murl::Video::IVertexBuffer::GetAttributeIndex ( IEnums::AttributeItem item ) const

pure virtual

Get the index of a predefined attribute variable in the buffer.

Parameters

item	The attribute item to query.

Returns: The zero-based index of the attribute, or -1 if not found.

◆ GetAttributeIndex() [2/3]

virtual SInt32 Murl::Video::IVertexBuffer::GetAttributeIndex ( SInt32 id ) const

pure virtual

Get the index of a custom attribute variable in the buffer, by its unique integer ID.

Parameters

id	The unique integer ID of the variable to query.

Returns: The zero-based index of the attribute, or -1 if not found.

◆ GetAttributeIndex() [3/3]

virtual SInt32 Murl::Video::IVertexBuffer::GetAttributeIndex ( const String & name ) const

pure virtual

Get the index of a custom attribute variable in the buffer, by its actual name.

Parameters

name	The attribute variable name to query.

Returns: The zero-based index of the attribute, or -1 if not found.

◆ GetNumberOfAttributes()

virtual UInt32 Murl::Video::IVertexBuffer::GetNumberOfAttributes ( ) const

pure virtual

Get the total number of individual attribute variables present in the buffer.

Returns: The number of attribute variables present.

◆ GetAttributeType()

virtual IEnums::AttributeType Murl::Video::IVertexBuffer::GetAttributeType ( UInt32 index ) const

pure virtual

Get the data type of an attribute variable at a given index.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable data type, or IEnums::ATTRIBUTE_TYPE_UNDEFINED if the index is out of range.

◆ GetAttributeItem()

virtual IEnums::AttributeItem Murl::Video::IVertexBuffer::GetAttributeItem ( UInt32 index ) const

pure virtual

Get the predefined attribute variable item at a given index.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The predefined variable item, or IEnums::ATTRIBUTE_ITEM_CUSTOM if the index is out of range.

◆ GetAttributeId()

virtual SInt32 Murl::Video::IVertexBuffer::GetAttributeId ( UInt32 index ) const

pure virtual

Get the unique integer ID of an attribute variable at a given index.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The unique ID, or -1 if the index is out of range.

◆ GetAttributeByteOffset()

virtual UInt32 Murl::Video::IVertexBuffer::GetAttributeByteOffset ( UInt32 index ) const

pure virtual

Get the byte offset of an attribute variable relative to the buffer start.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The byte offset, or 0 if the index is out of range.

◆ GetAttribute()

virtual IAttribute* Murl::Video::IVertexBuffer::GetAttribute ( UInt32 index ) const

pure virtual

Get the generic attribute variable at a given index.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range.

◆ GetFloatAttribute()

virtual IFloatAttribute* Murl::Video::IVertexBuffer::GetFloatAttribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IFloatAttribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetFloatVector2Attribute()

virtual IFloatVector2Attribute* Murl::Video::IVertexBuffer::GetFloatVector2Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IFloatVector2Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetFloatVector3Attribute()

virtual IFloatVector3Attribute* Murl::Video::IVertexBuffer::GetFloatVector3Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IFloatVector3Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetFloatVector4Attribute()

virtual IFloatVector4Attribute* Murl::Video::IVertexBuffer::GetFloatVector4Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IFloatVector4Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetUInt8Attribute()

virtual IUInt8Attribute* Murl::Video::IVertexBuffer::GetUInt8Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IUInt8Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetUInt8Vector2Attribute()

virtual IUInt8Vector2Attribute* Murl::Video::IVertexBuffer::GetUInt8Vector2Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IUInt8Vector2Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetUInt8Vector3Attribute()

virtual IUInt8Vector3Attribute* Murl::Video::IVertexBuffer::GetUInt8Vector3Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IUInt8Vector3Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetUInt8Vector4Attribute()

virtual IUInt8Vector4Attribute* Murl::Video::IVertexBuffer::GetUInt8Vector4Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IUInt8Vector4Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetSInt8Attribute()

virtual ISInt8Attribute* Murl::Video::IVertexBuffer::GetSInt8Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an ISInt8Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetSInt8Vector2Attribute()

virtual ISInt8Vector2Attribute* Murl::Video::IVertexBuffer::GetSInt8Vector2Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an ISInt8Vector2Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetSInt8Vector3Attribute()

virtual ISInt8Vector3Attribute* Murl::Video::IVertexBuffer::GetSInt8Vector3Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an ISInt8Vector3Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetSInt8Vector4Attribute()

virtual ISInt8Vector4Attribute* Murl::Video::IVertexBuffer::GetSInt8Vector4Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an ISInt8Vector4Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetUInt16Attribute()

virtual IUInt16Attribute* Murl::Video::IVertexBuffer::GetUInt16Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IUInt16Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetUInt16Vector2Attribute()

virtual IUInt16Vector2Attribute* Murl::Video::IVertexBuffer::GetUInt16Vector2Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IUInt16Vector2Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetUInt16Vector3Attribute()

virtual IUInt16Vector3Attribute* Murl::Video::IVertexBuffer::GetUInt16Vector3Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IUInt16Vector3Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetUInt16Vector4Attribute()

virtual IUInt16Vector4Attribute* Murl::Video::IVertexBuffer::GetUInt16Vector4Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an IUInt16Vector4Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetSInt16Attribute()

virtual ISInt16Attribute* Murl::Video::IVertexBuffer::GetSInt16Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an ISInt16Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetSInt16Vector2Attribute()

virtual ISInt16Vector2Attribute* Murl::Video::IVertexBuffer::GetSInt16Vector2Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an ISInt16Vector2Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetSInt16Vector3Attribute()

virtual ISInt16Vector3Attribute* Murl::Video::IVertexBuffer::GetSInt16Vector3Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an ISInt16Vector3Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetSInt16Vector4Attribute()

virtual ISInt16Vector4Attribute* Murl::Video::IVertexBuffer::GetSInt16Vector4Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as an ISInt16Vector4Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedUInt8Attribute()

virtual IUInt8Attribute* Murl::Video::IVertexBuffer::GetNormalizedUInt8Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized IUInt8Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedUInt8Vector2Attribute()

virtual IUInt8Vector2Attribute* Murl::Video::IVertexBuffer::GetNormalizedUInt8Vector2Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized IUInt8Vector2Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedUInt8Vector3Attribute()

virtual IUInt8Vector3Attribute* Murl::Video::IVertexBuffer::GetNormalizedUInt8Vector3Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized IUInt8Vector3Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedUInt8Vector4Attribute()

virtual IUInt8Vector4Attribute* Murl::Video::IVertexBuffer::GetNormalizedUInt8Vector4Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized IUInt8Vector4Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedSInt8Attribute()

virtual ISInt8Attribute* Murl::Video::IVertexBuffer::GetNormalizedSInt8Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized ISInt8Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedSInt8Vector2Attribute()

virtual ISInt8Vector2Attribute* Murl::Video::IVertexBuffer::GetNormalizedSInt8Vector2Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized ISInt8Vector2Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedSInt8Vector3Attribute()

virtual ISInt8Vector3Attribute* Murl::Video::IVertexBuffer::GetNormalizedSInt8Vector3Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized ISInt8Vector3Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedSInt8Vector4Attribute()

virtual ISInt8Vector4Attribute* Murl::Video::IVertexBuffer::GetNormalizedSInt8Vector4Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized ISInt8Vector4Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedUInt16Attribute()

virtual IUInt16Attribute* Murl::Video::IVertexBuffer::GetNormalizedUInt16Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized IUInt16Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedUInt16Vector2Attribute()

virtual IUInt16Vector2Attribute* Murl::Video::IVertexBuffer::GetNormalizedUInt16Vector2Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized IUInt16Vector2Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedUInt16Vector3Attribute()

virtual IUInt16Vector3Attribute* Murl::Video::IVertexBuffer::GetNormalizedUInt16Vector3Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized IUInt16Vector3Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedUInt16Vector4Attribute()

virtual IUInt16Vector4Attribute* Murl::Video::IVertexBuffer::GetNormalizedUInt16Vector4Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized IUInt16Vector4Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedSInt16Attribute()

virtual ISInt16Attribute* Murl::Video::IVertexBuffer::GetNormalizedSInt16Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized ISInt16Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedSInt16Vector2Attribute()

virtual ISInt16Vector2Attribute* Murl::Video::IVertexBuffer::GetNormalizedSInt16Vector2Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized ISInt16Vector2Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedSInt16Vector3Attribute()

virtual ISInt16Vector3Attribute* Murl::Video::IVertexBuffer::GetNormalizedSInt16Vector3Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized ISInt16Vector3Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ GetNormalizedSInt16Vector4Attribute()

virtual ISInt16Vector4Attribute* Murl::Video::IVertexBuffer::GetNormalizedSInt16Vector4Attribute ( UInt32 index ) const

pure virtual

Get the attribute variable at a given index as a normalized ISInt16Vector4Attribute.

Parameters

index The index of the variable to query, from 0 to GetNumberOfAttributes()-1.

Returns: The variable, or null if the index is out of range or the variable has a different data type.

◆ IsInVideoMemory()

virtual Bool Murl::Video::IVertexBuffer::IsInVideoMemory ( ) const

pure virtual

Check if the actual buffer resides in video memory.

Returns: true if in video memory.

◆ GetSignature()

virtual UInt32 Murl::Video::IVertexBuffer::GetSignature ( ) const

pure virtual

Get the signature, obtained via IRenderer::AcquireVertexBufferSignature().

Returns: The buffer signature.

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

murl_video_i_vertex_buffer.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetObjectInterface() [1/2]

◆ GetObjectInterface() [2/2]

◆ Set()

◆ SetDynamicBatchingAllowed()

◆ IsDynamicBatchingAllowed()

◆ SetAccessMode()

◆ GetAccessMode()

◆ SetNumberOfBones()

◆ GetNumberOfBones()

◆ SetVertexData() [1/2]

◆ SetVertexData() [2/2]

◆ SetNumberOfVertices()

◆ SetVerticesModified() [1/2]

◆ SetVerticesModified() [2/2]

◆ GetVertexData() [1/2]

◆ GetVertexData() [2/2]

◆ GetVertexBufferData() [1/2]

◆ GetVertexBufferData() [2/2]

◆ GetMaxNumberOfVertices()

◆ GetNumberOfVertices()

◆ GetByteStride()

◆ AreVerticesModified()

◆ AddAttribute() [1/3]

◆ AddAttribute() [2/3]

◆ AddAttribute() [3/3]

◆ RemoveAllAttributes()

◆ GetAttributeIndex() [1/3]

◆ GetAttributeIndex() [2/3]

◆ GetAttributeIndex() [3/3]

◆ GetNumberOfAttributes()

◆ GetAttributeType()

◆ GetAttributeItem()

◆ GetAttributeId()

◆ GetAttributeByteOffset()

◆ GetAttribute()

◆ GetFloatAttribute()

◆ GetFloatVector2Attribute()

◆ GetFloatVector3Attribute()

◆ GetFloatVector4Attribute()

◆ GetUInt8Attribute()

◆ GetUInt8Vector2Attribute()

◆ GetUInt8Vector3Attribute()

◆ GetUInt8Vector4Attribute()

◆ GetSInt8Attribute()

◆ GetSInt8Vector2Attribute()

◆ GetSInt8Vector3Attribute()

◆ GetSInt8Vector4Attribute()

◆ GetUInt16Attribute()

◆ GetUInt16Vector2Attribute()

◆ GetUInt16Vector3Attribute()

◆ GetUInt16Vector4Attribute()

◆ GetSInt16Attribute()

◆ GetSInt16Vector2Attribute()

◆ GetSInt16Vector3Attribute()

◆ GetSInt16Vector4Attribute()

◆ GetNormalizedUInt8Attribute()

◆ GetNormalizedUInt8Vector2Attribute()

◆ GetNormalizedUInt8Vector3Attribute()

◆ GetNormalizedUInt8Vector4Attribute()

◆ GetNormalizedSInt8Attribute()

◆ GetNormalizedSInt8Vector2Attribute()

◆ GetNormalizedSInt8Vector3Attribute()

◆ GetNormalizedSInt8Vector4Attribute()

◆ GetNormalizedUInt16Attribute()

◆ GetNormalizedUInt16Vector2Attribute()

◆ GetNormalizedUInt16Vector3Attribute()

◆ GetNormalizedUInt16Vector4Attribute()

◆ GetNormalizedSInt16Attribute()

◆ GetNormalizedSInt16Vector2Attribute()

◆ GetNormalizedSInt16Vector3Attribute()

◆ GetNormalizedSInt16Vector4Attribute()

◆ IsInVideoMemory()

◆ GetSignature()