Hardware vertex buffer. More...

#include <Urho3D/Graphics/VertexBuffer.h>

Inheritance diagram for Urho3D::VertexBuffer:

Public Member Functions
	VertexBuffer (Context *context, bool forceHeadless=false)
	Construct. Optionally force headless (no GPU-side buffer) operation.

	~VertexBuffer () override
	Destruct.

void	OnDeviceLost () override
	Mark the buffer destroyed on graphics context destruction. May be a no-op depending on the API.

void	OnDeviceReset () override
	Recreate the buffer and restore data if applicable. May be a no-op depending on the API.

void	Release () override
	Release buffer.

void	SetShadowed (bool enable)

bool	SetSize (unsigned vertexCount, const ea::vector< VertexElement > &elements, bool dynamic=false)
	Set size, vertex elements and dynamic mode. Previous data will be lost.

bool	SetSize (unsigned vertexCount, unsigned elementMask, bool dynamic=false)
	Set size and vertex elements and dynamic mode using legacy element bitmask. Previous data will be lost.

bool	SetData (const void *data)
	Set all data in the buffer.

bool	SetDataRange (const void *data, unsigned start, unsigned count, bool discard=false)
	Set a data range in the buffer. Optionally discard data outside the range.

void *	Lock (unsigned start, unsigned count, bool discard=false)
	Lock the buffer for write-only editing. Return data pointer if successful. Optionally discard data outside the range.

void	Unlock ()
	Unlock the buffer and apply changes to the GPU buffer.

bool	IsShadowed () const

bool	IsDynamic () const

bool	IsLocked () const
	Return whether is currently locked.

unsigned	GetVertexCount () const

unsigned	GetVertexSize () const

const ea::vector< VertexElement > &	GetElements () const

const VertexElement *	GetElement (VertexElementSemantic semantic, unsigned char index=0) const
	Return vertex element, or null if does not exist.

const VertexElement *	GetElement (VertexElementType type, VertexElementSemantic semantic, unsigned char index=0) const
	Return vertex element with specific type, or null if does not exist.

bool	HasElement (VertexElementSemantic semantic, unsigned char index=0) const
	Return whether has a specified element semantic.

bool	HasElement (VertexElementType type, VertexElementSemantic semantic, unsigned char index=0) const
	Return whether has an element semantic with specific type.

unsigned	GetElementOffset (VertexElementSemantic semantic, unsigned char index=0) const
	Return offset of a element within vertex, or M_MAX_UNSIGNED if does not exist.

unsigned	GetElementOffset (VertexElementType type, VertexElementSemantic semantic, unsigned char index=0) const
	Return offset of a element with specific type within vertex, or M_MAX_UNSIGNED if element does not exist.

VertexMaskFlags	GetElementMask () const

unsigned char *	GetShadowData () const
	Return CPU memory shadow data.

ea::shared_array< unsigned char >	GetShadowDataShared () const
	Return shared array pointer to the CPU memory shadow data.

unsigned long long	GetBufferHash (unsigned streamIndex)
	Return buffer hash for building vertex declarations. Used internally.

ea::vector< Vector4 >	GetUnpackedData (unsigned start=0, unsigned count=M_MAX_UNSIGNED) const
	Return unpacked buffer data as `count * elements.size()` elements, grouped by vertices.

void	SetUnpackedData (const Vector4 data[], unsigned start=0, unsigned count=M_MAX_UNSIGNED)
	Set data in the buffer from unpacked data.

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.

bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Public Member Functions inherited from Urho3D::GPUObject
	GPUObject (Graphics *graphics)
	Construct with graphics subsystem pointer.

virtual	~GPUObject ()
	Destruct. Remove from the Graphics.

void	ClearDataLost ()
	Clear the data lost flag.

Graphics *	GetGraphics () const
	Return the graphics subsystem associated with this GPU object.

void *	GetGPUObject () const
	Return the object pointer. Applicable only on Direct3D.

unsigned	GetGPUObjectName () const
	Return the object name. Applicable only on OpenGL.

bool	IsDataLost () const

bool	HasPendingData () const
	Return whether has pending data assigned while graphics context was lost.

Public Member Functions inherited from Urho3D::PipelineStateTracker
unsigned	GetPipelineStateHash () const
	Return (partial) pipeline state hash. Save to call from multiple threads as long as the object is not changing.

void	MarkPipelineStateHashDirty ()
	Mark pipeline state hash as dirty.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object with the engine.

static const VertexElement *	GetElement (const ea::vector< VertexElement > &elements, VertexElementType type, VertexElementSemantic semantic, unsigned char index=0)
	Return element with specified type and semantic from a vertex element list, or null if does not exist.

static bool	HasElement (const ea::vector< VertexElement > &elements, VertexElementType type, VertexElementSemantic semantic, unsigned char index=0)
	Return whether element list has a specified element type and semantic.

static unsigned	GetElementOffset (const ea::vector< VertexElement > &elements, VertexElementType type, VertexElementSemantic semantic, unsigned char index=0)
	Return element offset for specified type and semantic from a vertex element list, or M_MAX_UNSIGNED if does not exist.

static ea::vector< VertexElement >	GetElements (unsigned elementMask)
	Return a vertex element list from a legacy element bitmask.

static unsigned	GetVertexSize (const ea::vector< VertexElement > &elements)
	Return vertex size from an element list.

static unsigned	GetVertexSize (unsigned elementMask)
	Return vertex size for a legacy vertex element bitmask.

static void	UpdateOffsets (ea::vector< VertexElement > &elements)
	Update offsets of vertex elements.

static void	UnpackVertexData (const void *source, unsigned sourceStride, const VertexElement &element, unsigned start, unsigned count, Vector4 dest[], unsigned destStride)
	Unpack given element data from vertex buffer into Vector4. Stride is measured in bytes.

static void	PackVertexData (const Vector4 source[], unsigned sourceStride, void *dest, unsigned destStride, const VertexElement &element, unsigned start, unsigned count)
	Pack given element data from Vector4 into vertex buffer. Stride is measured in bytes.

static void	ShuffleUnpackedVertexData (unsigned vertexCount, const Vector4 source[], const ea::vector< VertexElement > &sourceElements, Vector4 dest[], const ea::vector< VertexElement > &destElements, bool setMissingElementsToZero=true)
	Shuffle unpacked vertex data according to another vertex format. Element types are ignored. Source array should have `vertexCount * sourceElements.size()` elements. Destination array should have `vertexCount * destElements.size()` elements.

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (VertexBuffer, Object)

void	UpdateOffsets ()
	Update offsets of vertex elements.

bool	Create ()
	Create buffer.

bool	UpdateToGPU ()
	Update the shadow data to the GPU buffer.

void *	MapBuffer (unsigned start, unsigned count, bool discard)
	Map the GPU buffer into CPU memory. Not used on OpenGL.

void	UnmapBuffer ()
	Unmap the GPU buffer. Not used on OpenGL.

unsigned	RecalculatePipelineStateHash () const override
	Recalculate hash (must not be non zero). Shall be save to call from multiple threads as long as the object is not changing.

Graphics *	GetGraphics () const
	Return the graphics subsystem associated with this GPU object.

Private Attributes
ea::shared_array< unsigned char >	shadowData_
	Shadow data.

unsigned	vertexCount_ {}
	Number of vertices.

unsigned	vertexSize_ {}
	Vertex size.

ea::vector< VertexElement >	elements_
	Vertex elements.

unsigned long long	elementHash_ {}
	Vertex element hash.

VertexMaskFlags	elementMask_ {}
	Vertex element legacy bitmask.

LockState	lockState_ {LOCK_NONE}
	Buffer locking state.

unsigned	lockStart_ {}
	Lock start vertex.

unsigned	lockCount_ {}
	Lock number of vertices.

void *	lockScratchData_ {}
	Scratch buffer for fallback locking.

bool	dynamic_ {}
	Dynamic flag.

bool	shadowed_ {}
	Shadowed flag.

bool	discardLock_ {}
	Discard lock flag. Used by OpenGL only.

Additional Inherited Members
Protected Member Functions inherited from Urho3D::PipelineStateTracker
PipelineStateSubscription	CreateDependency (PipelineStateTracker *dependency)
	Create dependency onto another pipeline state.

void	AddSubscriberReference (PipelineStateTracker *subscriber)
	Add reference to subscriber pipeline state tracker.

void	RemoveSubscriberReference (PipelineStateTracker *subscriber)
	Remove reference to subscriber pipeline state tracker.

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Protected Attributes inherited from Urho3D::GPUObject
WeakPtr< Graphics >	graphics_
	Graphics subsystem.

GPUObjectHandle	object_ {}
	Object pointer or name.

bool	dataLost_ {}
	Data lost flag.

bool	dataPending_ {}
	Data pending flag.

Detailed Description

Hardware vertex buffer.

Member Function Documentation

◆ GetElementMask()

VertexMaskFlags Urho3D::VertexBuffer::GetElementMask ( ) const

inline

Return legacy vertex element mask. Note that both semantic and type must match the legacy element for a mask bit to be set.

◆ GetElements()

const ea::vector<VertexElement>& Urho3D::VertexBuffer::GetElements ( ) const

inline

Return vertex elements.

◆ GetVertexCount()

unsigned Urho3D::VertexBuffer::GetVertexCount ( ) const

inline

Return number of vertices.

◆ GetVertexSize()

unsigned Urho3D::VertexBuffer::GetVertexSize ( ) const

inline

Return vertex size in bytes.

◆ IsDynamic()

bool Urho3D::VertexBuffer::IsDynamic ( ) const

inline

Return whether is dynamic.

◆ IsShadowed()

bool Urho3D::VertexBuffer::IsShadowed ( ) const

inline

Return whether CPU memory shadowing is enabled.

◆ SetShadowed()

void Urho3D::VertexBuffer::SetShadowed ( bool enable )

Enable shadowing in CPU memory. Shadowing is forced on if the graphics subsystem does not exist.

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

Urho3D/Graphics/VertexBuffer.h
Urho3D/Graphics/VertexBuffer.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetElementMask()

◆ GetElements()

◆ GetVertexCount()

◆ GetVertexSize()

◆ IsDynamic()

◆ IsShadowed()

◆ SetShadowed()