Base::IndexBufferBase Class Reference
#include <indexbufferbase.h>
Detailed Description
A resource which holds an array of indices into an array of vertices.(C) 2006 Radon Labs GmbH
Public Types | |
| enum | Usage |
| resource usage flags | |
| enum | State |
| resource states (DO NOT CHANGE ORDER!) | |
Public Member Functions | |
| IndexBufferBase () | |
| constructor | |
| virtual | ~IndexBufferBase () |
| destructor | |
| void * | Map (MapType mapType) |
| map index buffer for CPU access | |
| void | Unmap () |
| unmap the resource | |
| CoreGraphics::IndexType::Code | GetIndexType () const |
| get the index type (Index16 or Index32) | |
| SizeT | GetNumIndices () const |
| get number of indices | |
| Usage | GetUsage () const |
| get resource usage type | |
| Access | GetAccess () const |
| get cpu access type | |
| void | SetAsyncEnabled (bool b) |
| request synchronous/asynchronous resource loading | |
| bool | IsAsyncEnabled () const |
| return true if asynchronous resource loading is enabled | |
| void | SetResourceId (const ResourceId &id) |
| set the resource identifier | |
| const ResourceId & | GetResourceId () const |
| get the resource identifier | |
| void | SetLoader (const Ptr< ResourceLoader > &loader) |
| set optional resource loader | |
|
const Ptr < ResourceLoader > & | GetLoader () const |
| get optional resource loader | |
| void | SetSaver (const Ptr< ResourceSaver > &saver) |
| set optional resource saver | |
|
const Ptr < ResourceSaver > & | GetSaver () const |
| get optional resource saver | |
| SizeT | GetUseCount () const |
| get current use count | |
| virtual State | Load () |
| load the resource | |
| virtual void | Unload () |
| unload the resource, or cancel the pending load | |
| State | GetState () const |
| get current state | |
| bool | IsLoaded () const |
| return true if current state is Loaded | |
| bool | IsPending () const |
| return true if current state is Pending | |
| bool | LoadFailed () const |
| return true if current state is Failed | |
| virtual bool | Save () |
| save the resource | |
| 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::String & | GetClassName () 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 | SetIndexType (CoreGraphics::IndexType::Code type) |
| set the index type (Index16 or Index32) | |
| void | SetNumIndices (SizeT num) |
| set number of indices | |
| void | SetUsage (Usage usage) |
| set resource usage type | |
| void | SetAccess (Access access) |
| set resource cpu access type | |
| void | SetState (State s) |
| set current state | |
| void | IncrUseCount () |
| increment use count | |
| void | DecrUseCount () |
| decrement use count | |
Member Function Documentation
| void * Base::IndexBufferBase::Map | ( | MapType | mapType | ) |
map index buffer for CPU access
Make the index buffer content accessible by the CPU. The index buffer must have been initialized with the right Access and Usage flags (see parent class for details). There are several reasons why a mapping the resource may fail, this depends on the platform (for instance, the resource may currently be busy, or selected for rendering).
Reimplemented in CoreGraphics::CPUIndexBuffer, and Direct3D9::D3D9IndexBuffer.
| void Base::IndexBufferBase::Unmap | ( | ) |
unmap the resource
Give up CPU access on the index buffer content.
Reimplemented in CoreGraphics::CPUIndexBuffer, and Direct3D9::D3D9IndexBuffer.
| Resource::State Resources::Resource::Load | ( | ) | [virtual, inherited] |
load the resource
This loads the resource through the attached resource loader. Depending on the resource loader, the resource may happen synchronously or asynchronously. If the resource is loaded asynchronously, the IsPending() method will return true as long as the load is in progress, and IsLoaded() will become true when the loading process has finished. If the load has failed, IsPending() will switch to false and IsLoaded() will not be true.
| void Resources::Resource::Unload | ( | ) | [virtual, inherited] |
unload the resource, or cancel the pending load
This will unload the resource. Only call the method when IsLoaded() return true. To cancel a pending asynchronous loading process, call the CancelPendingLoad() method.
Reimplemented in Base::MeshBase, Base::VertexBufferBase, CoreGraphics::CPUIndexBuffer, CoreGraphics::CPUVertexBuffer, Direct3D9::D3D9IndexBuffer, Direct3D9::D3D9Shader, Direct3D9::D3D9Texture, Direct3D9::D3D9VertexBuffer, and Models::Model.
| bool Resources::Resource::Save | ( | ) | [virtual, inherited] |
save the resource
This will save the resource. A resource saver must be attached to the resource and the resource must be loaded for the method to succeed. Saving will always be performed synchronously.
| 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.