Hardware vertex buffer. More...

#include <Urho3D/Graphics/VertexBuffer.h>

Inheritance diagram for Urho3D::VertexBuffer:
[legend]
Collaboration diagram for Urho3D::VertexBuffer:
[legend]

Public Member Functions

 VertexBuffer (Context *context, bool forceHeadless=false)
 Construct. Optionally force headless (no GPU-side buffer) operation.
 
virtual ~VertexBuffer () override
 Destruct.
 
virtual void OnDeviceLost () override
 Mark the buffer destroyed on graphics context destruction. May be a no-op depending on the API.
 
virtual void OnDeviceReset () override
 Recreate the buffer and restore data if applicable. May be a no-op depending on the API.
 
virtual void Release () override
 Release buffer.
 
void SetShadowed (bool enable)
 Enable shadowing in CPU memory. Shadowing is forced on if the graphics subsystem does not exist.
 
bool SetSize (unsigned vertexCount, const PODVector< 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
 Return whether CPU memory shadowing is enabled.
 
bool IsDynamic () const
 Return whether is dynamic.
 
bool IsLocked () const
 Return whether is currently locked.
 
unsigned GetVertexCount () const
 Return number of vertices.
 
unsigned GetVertexSize () const
 Return vertex size in bytes.
 
const PODVector< VertexElement > & GetElements () const
 Return vertex elements.
 
const VertexElementGetElement (VertexElementSemantic semantic, unsigned char index=0) const
 Return vertex element, or null if does not exist.
 
const VertexElementGetElement (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.
 
unsigned GetElementMask () const
 Return legacy vertex element mask. Note that both semantic and type must match the legacy element for a mask bit to be set.
 
unsigned char * GetShadowData () const
 Return CPU memory shadow data.
 
SharedArrayPtr< 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.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
virtual ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash.
 
virtual const StringGetTypeName () const =0
 Return type name.
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
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 SubscribeToEvent (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
void SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 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 PODVector< StringHash > &exceptions, bool onlyUserData)
 Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
 
void SendEvent (StringHash eventType)
 Send event to all subscribers.
 
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
 
VariantMapGetEventDataMap () 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, Args...args)
 Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
 
const VariantMapGetGlobalVars () const
 Return all global variables.
 
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and value.
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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 StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
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.
 
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
 
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
 
int Refs () const
 Return reference count.
 
int WeakRefs () const
 Return weak reference count.
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 
- 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.
 
GraphicsGetGraphics () 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
 Return whether data is lost due to context loss.
 
bool HasPendingData () const
 Return whether has pending data assigned while graphics context was lost.
 

Static Public Member Functions

static const VertexElementGetElement (const PODVector< 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 PODVector< 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 PODVector< 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 PODVector< VertexElementGetElements (unsigned elementMask)
 Return a vertex element list from a legacy element bitmask.
 
static unsigned GetVertexSize (const PODVector< 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 (PODVector< VertexElement > &elements)
 Update offsets of vertex elements.
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 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.
 

Private Attributes

SharedArrayPtr< unsigned char > shadowData_
 Shadow data.
 
unsigned vertexCount_
 Number of vertices.
 
unsigned vertexSize_
 Vertex size.
 
PODVector< VertexElementelements_
 Vertex elements.
 
unsigned long long elementHash_
 Vertex element hash.
 
unsigned elementMask_
 Vertex element legacy bitmask.
 
LockState lockState_
 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 Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.
 
- Protected Attributes inherited from Urho3D::GPUObject
WeakPtr< Graphicsgraphics_
 Graphics subsystem.
 
GPUObjectHandle object_
 Object pointer or name.
 
bool dataLost_
 Data lost flag.
 
bool dataPending_
 Data pending flag.
 

Detailed Description

Hardware vertex buffer.


The documentation for this class was generated from the following files:
  • Source/Urho3D/Graphics/VertexBuffer.h
  • Source/Urho3D/Graphics/OpenGL/OGLVertexBuffer.cpp
  • Source/Urho3D/Graphics/VertexBuffer.cpp