Hardware index buffer. More...

#include <Urho3D/Graphics/IndexBuffer.h>

Inheritance diagram for Urho3D::IndexBuffer:

Collaboration diagram for Urho3D::IndexBuffer:

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.

SharedArrayPtr< unsigned char >	GetShadowDataShared () const
	Return shared array pointer to the CPU memory shadow 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 String &	GetTypeName () const =0

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 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.

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

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 String &	GetCategory () const

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

int	WeakRefs () const

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.

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.

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.

Private Attributes
SharedArrayPtr< 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
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

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 index buffer.

Member Function Documentation