The Nebula Device 3: Base::VertexLayoutBase Class Reference

The Nebula Device 3

Base::VertexLayoutBase Class Reference

#include <vertexlayoutbase.h>

Inheritance diagram for Base::VertexLayoutBase:

Core::RefCounted Direct3D9::D3D9VertexLayout CoreGraphics::VertexLayout


Detailed Description

Base class for VertexLayout. A VertexLayout object describes what components a vertex has and offers some utility functions. Vertex layout objects are generally shared and created through the VertexLayoutServer (this is more efficient on some platforms).

(C) 2007 Radon Labs GmbH

Public Member Functions

 VertexLayoutBase ()
 constructor
virtual ~VertexLayoutBase ()
 destructor
void Setup (const Util::Array< CoreGraphics::VertexComponent > &c)
 setup the vertex layout
bool IsValid () const
 return true if valid has been setup
SizeT GetNumComponents () const
 get number of components
const
CoreGraphics::VertexComponent
GetComponentAt (IndexT i) const
 get vertex component at index
bool HasComponent (CoreGraphics::VertexComponent::SemanticName semName, IndexT semIndex) const
 return true if vertex component exists
IndexT FindComponent (CoreGraphics::VertexComponent::SemanticName semName, IndexT semIndex) const
 get index of vertex component by semantics
SizeT GetVertexByteSize () const
 get the vertex stride in number of bytes
IndexT GetComponentByteOffset (CoreGraphics::VertexComponent::SemanticName semName, IndexT semIndex) const
 get component offset from start of vertex
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Protected Member Functions

void Discard ()
 discard the vertex layout object

Static Protected Member Functions

static Util::String BuildSignature (const Util::Array< CoreGraphics::VertexComponent > &c)
 get sharing signature for a set of vertex components

Member Function Documentation

IndexT Base::VertexLayoutBase::GetComponentByteOffset ( CoreGraphics::VertexComponent::SemanticName  semName,
IndexT  semIndex 
) const

get component offset from start of vertex

Returns the component offset in bytes from the beginning of a vertex to the start of the given vertex components. Returns InvalidIndex if the vertex component doesn't exist!

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.