Rebel Fork Framework
Urho3D::IndexBuffer Class Reference

Hardware index buffer. More...

#include <Urho3D/Graphics/IndexBuffer.h>

Inheritance diagram for Urho3D::IndexBuffer:
Urho3D::Object Urho3D::GPUObject Urho3D::PipelineStateTracker Urho3D::RefCounted

Public Member Functions

 IndexBuffer (Context *context, bool forceHeadless=false)
 Construct. Optionally force headless (no GPU-side buffer) operation.
 
 ~IndexBuffer () 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 indexCount, bool largeIndices, bool dynamic=false)
 Set size and vertex elements and dynamic mode. 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 GetIndexCount () const
 
unsigned GetIndexSize () const
 
bool GetUsedVertexRange (unsigned start, unsigned count, unsigned &minVertex, unsigned &vertexCount)
 Return used vertex range from index range.
 
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.
 
ea::vector< unsigned > GetUnpackedData (unsigned start=0, unsigned count=M_MAX_UNSIGNED) const
 Return unpacked buffer data as plain array of indices.
 
void SetUnpackedData (const unsigned data[], unsigned start=0, unsigned count=M_MAX_UNSIGNED)
 Set data in the buffer from unpacked data. Data should contain at least count elements.
 
- 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 TypeInfoGetTypeInfo () 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.
 
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, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &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 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.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () 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.
 
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
 
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 void UnpackIndexData (const void *source, bool largeIndices, unsigned start, unsigned count, unsigned dest[])
 Unpack index data from index buffer into unsigned int array.
 
static void PackIndexData (const unsigned source[], void *dest, bool largeIndices, unsigned start, unsigned count)
 Pack index data from unsigned int array into index buffer.
 
static IndexBufferType GetIndexBufferType (IndexBuffer *indexBuffer)
 Return type of index buffer. Null is allowed.
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 

Private Member Functions

 URHO3D_OBJECT (IndexBuffer, Object)
 
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.
 
GraphicsGetGraphics () const
 Return the graphics subsystem associated with this GPU object.
 

Private Attributes

ea::shared_array< unsigned char > shadowData_
 Shadow data.
 
unsigned indexCount_
 Number of indices.
 
unsigned indexSize_
 Index size.
 
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 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< 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 index buffer.

Member Function Documentation

◆ GetIndexCount()

unsigned Urho3D::IndexBuffer::GetIndexCount ( ) const
inline

Return number of indices.

◆ GetIndexSize()

unsigned Urho3D::IndexBuffer::GetIndexSize ( ) const
inline

Return index size in bytes.

◆ IsDynamic()

bool Urho3D::IndexBuffer::IsDynamic ( ) const
inline

Return whether is dynamic.

◆ IsShadowed()

bool Urho3D::IndexBuffer::IsShadowed ( ) const
inline

Return whether CPU memory shadowing is enabled.

◆ SetShadowed()

void Urho3D::IndexBuffer::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: