Hardware vertex buffer. More...
#include </home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/GraphicsAPI/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. More... | |
| void | OnDeviceReset () override |
| Recreate the buffer and restore data if applicable. May be a no-op depending on the API. More... | |
| void | Release () override |
| Release buffer. More... | |
| void | SetShadowed (bool enable) |
| Enable shadowing in CPU memory. Shadowing is forced on if the graphics subsystem does not exist. | |
| bool | SetSize (i32 vertexCount, const Vector< VertexElement > &elements, bool dynamic=false) |
| Set size, vertex elements and dynamic mode. Previous data will be lost. | |
| bool | SetSize (i32 vertexCount, VertexElements 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, i32 start, i32 count, bool discard=false) |
| Set a data range in the buffer. Optionally discard data outside the range. | |
| void * | Lock (i32 start, i32 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. | |
| i32 | GetVertexCount () const |
| Return number of vertices. | |
| i32 | GetVertexSize () const |
| Return vertex size in bytes. | |
| const Vector< VertexElement > & | GetElements () const |
| Return vertex elements. | |
| const VertexElement * | GetElement (VertexElementSemantic semantic, i8 index=0) const |
| Return vertex element, or null if does not exist. | |
| const VertexElement * | GetElement (VertexElementType type, VertexElementSemantic semantic, i8 index=0) const |
| Return vertex element with specific type, or null if does not exist. | |
| bool | HasElement (VertexElementSemantic semantic, i8 index=0) const |
| Return whether has a specified element semantic. | |
| bool | HasElement (VertexElementType type, VertexElementSemantic semantic, i8 index=0) const |
| Return whether has an element semantic with specific type. | |
| i32 | GetElementOffset (VertexElementSemantic semantic, i8 index=0) const |
| Return offset of a element within vertex, or NINDEX if does not exist. | |
| i32 | GetElementOffset (VertexElementType type, VertexElementSemantic semantic, i8 index=0) const |
| Return offset of a element with specific type within vertex, or NINDEX if element does not exist. | |
| VertexElements | 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. | |
| byte * | GetShadowData () const |
| Return CPU memory shadow data. | |
| SharedArrayPtr< byte > | GetShadowDataShared () const |
| Return shared array pointer to the CPU memory shadow data. | |
| hash64 | GetBufferHash (i32 streamIndex) |
| Return buffer hash for building vertex declarations. Used internally. | |
 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 |
| Return type hash. More... | |
| virtual const String & | GetTypeName () const =0 |
| Return type name. More... | |
| virtual const TypeInfo * | GetTypeInfo () 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 Vector< 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. | |
| 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, 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. | |
| Context * | GetContext () const |
| Return execution context. | |
| const Variant & | GetGlobalVar (StringHash key) const |
| Return global variable based on key. | |
| const VariantMap & | GetGlobalVars () const |
| Return all global variables. | |
| void | SetGlobalVar (StringHash key, const Variant &value) |
| Set global variable with the respective key and 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 String & | GetCategory () 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. | |
| RefCounted (const RefCounted &rhs)=delete | |
| Prevent copy construction. | |
| RefCounted & | operator= (const RefCounted &rhs)=delete |
| Prevent assignment. | |
| 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. | |
| RefCount * | RefCountPtr () |
| 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. | |
| virtual void | OnDeviceLost () |
| Mark the GPU resource destroyed on graphics context destruction. More... | |
| virtual void | OnDeviceReset () |
| Recreate the GPU resource and restore data if applicable. More... | |
| virtual void | Release () |
| Unconditionally release the GPU resource. More... | |
| 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. | |
| u32 | 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 VertexElement * | GetElement (const Vector< VertexElement > &elements, VertexElementType type, VertexElementSemantic semantic, i8 index=0) |
| Return element with specified type and semantic from a vertex element list, or null if does not exist. | |
| static bool | HasElement (const Vector< VertexElement > &elements, VertexElementType type, VertexElementSemantic semantic, i8 index=0) |
| Return whether element list has a specified element type and semantic. | |
| static i32 | GetElementOffset (const Vector< VertexElement > &elements, VertexElementType type, VertexElementSemantic semantic, i8 index=0) |
| Return element offset for specified type and semantic from a vertex element list, or NINDEX if does not exist. | |
| static Vector< VertexElement > | GetElements (VertexElements elementMask) |
| Return a vertex element list from a legacy element bitmask. | |
| static i32 | GetVertexSize (const Vector< VertexElement > &elements) |
| Return vertex size from an element list. | |
| static i32 | GetVertexSize (VertexElements elementMask) |
| Return vertex size for a legacy vertex element bitmask. | |
| static void | UpdateOffsets (Vector< VertexElement > &elements) |
| Update offsets of vertex 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 (i32 start, i32 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< byte > | shadowData_ |
| Shadow data. | |
| i32 | vertexCount_ {} |
| Number of vertices. | |
| i32 | vertexSize_ {} |
| Vertex size. | |
| Vector< VertexElement > | elements_ |
| Vertex elements. | |
| hash64 | elementHash_ {} |
| Vertex element hash. | |
| VertexElements | elementMask_ {} |
| Vertex element legacy bitmask. | |
| LockState | lockState_ {LOCK_NONE} |
| Buffer locking state. | |
| i32 | lockStart_ {} |
| Lock start vertex. | |
| i32 | 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 | |
| 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
◆ OnDeviceLost()
|
overridevirtual |
Mark the buffer destroyed on graphics context destruction. May be a no-op depending on the API.
Reimplemented from Urho3D::GPUObject.
◆ OnDeviceReset()
|
overridevirtual |
Recreate the buffer and restore data if applicable. May be a no-op depending on the API.
Reimplemented from Urho3D::GPUObject.
◆ Release()
|
overridevirtual |
Release buffer.
Reimplemented from Urho3D::GPUObject.
The documentation for this class was generated from the following files:
- /home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/GraphicsAPI/VertexBuffer.h
- /home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/GraphicsAPI/VertexBuffer.cpp
