Urho3D::VertexBuffer Class Reference

Hardware vertex buffer. More...

#include <OGLVertexBuffer.h>

Inheritance diagram for Urho3D::VertexBuffer:

Collaboration diagram for Urho3D::VertexBuffer:

Public Member Functions
	VertexBuffer (Context *context, bool forceHeadless=false)
	Construct.
virtual	~VertexBuffer ()
	Destruct.
virtual void	OnDeviceReset ()
	Recreate the GPU resource and restore data if applicable.
virtual void	Release ()
	Release the 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, unsigned elementMask, 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
	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.
unsigned	GetElementMask () const
	Return bitmask of vertex elements.
unsigned	GetElementOffset (VertexElement element) const
	Return offset of a specified element within a vertex.
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.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
	Return type hash.
virtual const String &	GetTypeName () const =0
	Return type name.
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.
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	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. More...
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
Context *	GetContext () const
	Return execution context.
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.
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.
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 context destruction.
void	ClearDataLost ()
	Clear the data lost flag.
Graphics *	GetGraphics () const
	Return the graphics subsystem.
unsigned	GetGPUObject () const
	Return the object's OpenGL handle.
bool	IsDataLost () const
	Return whether data is lost due to context loss.
bool	HasPendingData () const
	Return whether has pending data assigned while context was lost.

Static Public Member Functions
static unsigned	GetVertexSize (unsigned elementMask)
	Return vertex size corresponding to a vertex element mask.
static unsigned	GetElementOffset (unsigned elementMask, VertexElement element)
	Return element offset from an element mask.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
static bool	IsTypeOf (StringHash type)
	Check current type is type of specified type.
static bool	IsTypeOf (const TypeInfo *typeInfo)
	Check current type is type of specified type.
template<typename T >
static bool	IsTypeOf ()
	Check current type is type of specified class.

Static Public Attributes
static const unsigned	elementSize []
	Vertex element sizes in bytes. More...
static const unsigned	elementType []
	Vertex element OpenGL types. More...
static const unsigned	elementComponents []
	Vertex element OpenGL component counts. More...
static const unsigned	elementNormalize []
	Vertex element OpenGL normalization. More...

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.

Private Attributes
SharedArrayPtr< unsigned char >	shadowData_
	Shadow data.
unsigned	vertexCount_
	Number of vertices.
unsigned	vertexSize_
	Vertex size.
unsigned	elementMask_
	Vertex element bitmask.
unsigned	elementOffset_ [MAX_VERTEX_ELEMENTS]
	Vertex element offsets.
LockState	lockState_
	Buffer locking state.
unsigned	lockStart_
	Lock start vertex.
unsigned	lockCount_
	Lock number of vertices.
void *	lockScratchData_
	Scratch buffer for fallback locking.
bool	shadowed_
	Shadowed flag.
bool	dynamic_
	Dynamic flag.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.
Protected Attributes inherited from Urho3D::GPUObject
WeakPtr< Graphics >	graphics_
	Graphics subsystem.
unsigned	object_
	Object handle.
bool	dataLost_
	Data lost flag.
bool	dataPending_
	Data pending flag.

Detailed Description

Hardware vertex buffer.

Member Data Documentation

const unsigned Urho3D::VertexBuffer::elementComponents

static

Initial value:

=
{
    3, 
    3, 
    4, 
    2, 
    2, 
    3, 
    3, 
    4, 
    4, 
    4, 
    4, 
    4, 
    4 
}

Vertex element OpenGL component counts.

const unsigned Urho3D::VertexBuffer::elementNormalize

static

Initial value:

=
{
    GL_FALSE, 
    GL_FALSE, 
    GL_TRUE, 
    GL_FALSE, 
    GL_FALSE, 
    GL_FALSE, 
    GL_FALSE, 
    GL_FALSE, 
    GL_FALSE, 
    GL_FALSE, 
    GL_FALSE, 
    GL_FALSE, 
    GL_FALSE 
}

Vertex element OpenGL normalization.

const unsigned Urho3D::VertexBuffer::elementSize

static

Initial value:

=
{
    3 * sizeof(float), 
    3 * sizeof(float), 
    4 * sizeof(unsigned char), 
    2 * sizeof(float), 
    2 * sizeof(float), 
    3 * sizeof(float), 
    3 * sizeof(float), 
    4 * sizeof(float), 
    4 * sizeof(float), 
    4 * sizeof(unsigned char), 
    4 * sizeof(float), 
    4 * sizeof(float), 
    4 * sizeof(float) 
}

Vertex element sizes in bytes.

const unsigned Urho3D::VertexBuffer::elementType

static

Initial value:

=
{
    GL_FLOAT, 
    GL_FLOAT, 
    GL_UNSIGNED_BYTE, 
    GL_FLOAT, 
    GL_FLOAT, 
    GL_FLOAT, 
    GL_FLOAT, 
    GL_FLOAT, 
    GL_FLOAT, 
    GL_UNSIGNED_BYTE, 
    GL_FLOAT, 
    GL_FLOAT, 
    GL_FLOAT 
}

Vertex element OpenGL types.

---

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

• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/OpenGL/OGLVertexBuffer.h
• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/OpenGL/OGLVertexBuffer.cpp