Base::TextureBase Class Reference
#include <texturebase.h>
Detailed Description
The base class for texture objects.(C) 2007 Radon Labs GmbH
Public Types | |
| enum | Type |
| texture types | |
| enum | CubeFace |
| cube map face | |
| enum | Usage |
| resource usage flags | |
| enum | State |
| resource states (DO NOT CHANGE ORDER!) | |
Public Member Functions | |
| TextureBase () | |
| constructor | |
| virtual | ~TextureBase () |
| destructor | |
| Type | GetType () const |
| get texture type | |
| SizeT | GetWidth () const |
| get width of texture | |
| SizeT | GetHeight () const |
| get height of texture (if 2d or 3d texture) | |
| SizeT | GetDepth () const |
| get depth of texture (if 3d texture) | |
| SizeT | GetNumMipLevels () const |
| get number of mip levels | |
| CoreGraphics::PixelFormat::Code | GetPixelFormat () const |
| get pixel format of the texture | |
| bool | Map (IndexT mipLevel, Access accessMode, MapInfo &outMapInfo) |
| map the a texture mip level for CPU access | |
| void | Unmap (IndexT mipLevel) |
| unmap texture after CPU access | |
| bool | MapCubeFace (CubeFace face, IndexT mipLevel, Access accessMode, MapInfo &outMapInfo) |
| map a cube map face for CPU access | |
| void | UnmapCubeFace (CubeFace face, IndexT mipLevel) |
| unmap cube map face after CPU access | |
| 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 | SetType (Type t) |
| set texture type | |
| void | SetWidth (SizeT w) |
| set texture width | |
| void | SetHeight (SizeT h) |
| set texture height | |
| void | SetDepth (SizeT d) |
| set texture depth | |
| void | SetNumMipLevels (SizeT n) |
| set number of mip levels | |
| void | SetPixelFormat (CoreGraphics::PixelFormat::Code f) |
| set pixel format | |
| 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 | |
Data Structures | |
| class | MapInfo |
| access info filled by Map methods More... | |
Member Function Documentation
| 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.