#include <OgreTextureManager.h>
Inheritance diagram for Ogre::TextureManager:
Public Types | |
typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult |
typedef HashMap< String, ResourcePtr > | ResourceMap |
typedef std::map< ResourceHandle, ResourcePtr > | ResourceHandleMap |
typedef MapIterator< ResourceHandleMap > | ResourceMapIterator |
Public Member Functions | |
TextureManager (void) | |
virtual | ~TextureManager () |
virtual TexturePtr | load (const String &name, const String &group, TextureType texType=TEX_TYPE_2D, int numMipmaps=MIP_DEFAULT, Real gamma=1.0f, bool isAlpha=false, PixelFormat desiredFormat=PF_UNKNOWN) |
Loads a texture from a file. | |
virtual TexturePtr | loadImage (const String &name, const String &group, const Image &img, TextureType texType=TEX_TYPE_2D, int iNumMipmaps=MIP_DEFAULT, Real gamma=1.0f, bool isAlpha=false, PixelFormat desiredFormat=PF_UNKNOWN) |
Loads a texture from an Image object. | |
virtual TexturePtr | loadRawData (const String &name, const String &group, DataStreamPtr &stream, ushort uWidth, ushort uHeight, PixelFormat format, TextureType texType=TEX_TYPE_2D, int iNumMipmaps=MIP_DEFAULT, Real gamma=1.0f) |
Loads a texture from a raw data stream. | |
virtual TexturePtr | createManual (const String &name, const String &group, TextureType texType, uint width, uint height, uint depth, int num_mips, PixelFormat format, int usage=TU_DEFAULT, ManualResourceLoader *loader=0) |
Create a manual texture with specified width, height and depth (not loaded from a file). | |
TexturePtr | createManual (const String &name, const String &group, TextureType texType, uint width, uint height, int num_mips, PixelFormat format, int usage=TU_DEFAULT, ManualResourceLoader *loader=0) |
Create a manual texture with a depth of 1 (not loaded from a file). | |
virtual void | setPreferredIntegerBitDepth (ushort bits, bool reloadTextures=true) |
Sets preferred bit depth for integer pixel format textures. | |
virtual ushort | getPreferredIntegerBitDepth (void) const |
gets preferred bit depth for integer pixel format textures. | |
virtual void | setPreferredFloatBitDepth (ushort bits, bool reloadTextures=true) |
Sets preferred bit depth for float pixel format textures. | |
virtual ushort | getPreferredFloatBitDepth (void) const |
gets preferred bit depth for float pixel format textures. | |
virtual void | setPreferredBitDepths (ushort integerBits, ushort floatBits, bool reloadTextures=true) |
Sets preferred bit depth for integer and float pixel format. | |
virtual bool | isFormatSupported (TextureType ttype, PixelFormat format, int usage) |
Returns whether this render system can natively support the precise texture format requested with the given usage options. | |
virtual bool | isEquivalentFormatSupported (TextureType ttype, PixelFormat format, int usage) |
Returns whether this render system can support the texture format requested with the given usage options, or another format with no quality reduction. | |
virtual PixelFormat | getNativeFormat (TextureType ttype, PixelFormat format, int usage)=0 |
Gets the format which will be natively used for a requested format given the contraints of the current device. | |
virtual bool | isHardwareFilteringSupported (TextureType ttype, PixelFormat format, int usage, bool preciseFormatOnly=false)=0 |
Returns whether this render system has hardware filtering supported for the texture format requested with the given usage options. | |
virtual void | setDefaultNumMipmaps (size_t num) |
Sets the default number of mipmaps to be used for loaded textures, for when textures are loaded automatically (e.g. | |
virtual size_t | getDefaultNumMipmaps () |
Gets the default number of mipmaps to be used for loaded textures. | |
virtual ResourcePtr | create (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0) |
Creates a new blank resource, but does not immediately load it. | |
virtual ResourceCreateOrRetrieveResult | createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0) |
Create a new resource, or retrieve an existing one with the same name if it already exists. | |
virtual void | setMemoryBudget (size_t bytes) |
Set a limit on the amount of memory this resource handler may use. | |
virtual size_t | getMemoryBudget (void) const |
Get the limit on the amount of memory this resource handler may use. | |
virtual size_t | getMemoryUsage (void) const |
Gets the current memory usage, in bytes. | |
virtual void | unload (const String &name) |
Unloads a single resource by name. | |
virtual void | unload (ResourceHandle handle) |
Unloads a single resource by handle. | |
virtual void | unloadAll (bool reloadableOnly=true) |
Unloads all resources. | |
virtual void | reloadAll (bool reloadableOnly=true) |
Caused all currently loaded resources to be reloaded. | |
virtual void | unloadUnreferencedResources (bool reloadableOnly=true) |
Unload all resources which are not referenced by any other object. | |
virtual void | reloadUnreferencedResources (bool reloadableOnly=true) |
Caused all currently loaded but not referenced by any other object resources to be reloaded. | |
virtual void | remove (ResourcePtr &r) |
Remove a single resource. | |
virtual void | remove (const String &name) |
Remove a single resource by name. | |
virtual void | remove (ResourceHandle handle) |
Remove a single resource by handle. | |
virtual void | removeAll (void) |
Removes all resources. | |
virtual ResourcePtr | getByName (const String &name) |
Retrieves a pointer to a resource by name, or null if the resource does not exist. | |
virtual ResourcePtr | getByHandle (ResourceHandle handle) |
Retrieves a pointer to a resource by handle, or null if the resource does not exist. | |
virtual bool | resourceExists (const String &name) |
Returns whether the named resource exists in this manager. | |
virtual bool | resourceExists (ResourceHandle handle) |
Returns whether a resource with the given handle exists in this manager. | |
virtual void | _notifyResourceTouched (Resource *res) |
Notify this manager that a resource which it manages has been 'touched', ie used. | |
virtual void | _notifyResourceLoaded (Resource *res) |
Notify this manager that a resource which it manages has been loaded. | |
virtual void | _notifyResourceUnloaded (Resource *res) |
Notify this manager that a resource which it manages has been unloaded. | |
virtual ResourcePtr | load (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0) |
Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters). | |
virtual const StringVector & | getScriptPatterns (void) const |
Gets the file patterns which should be used to find scripts for this ResourceManager. | |
virtual void | parseScript (DataStreamPtr &stream, const String &groupName) |
Parse the definition of a set of resources from a script file. | |
virtual Real | getLoadingOrder (void) const |
Gets the relative loading order of resources of this type. | |
const String & | getResourceType (void) const |
Gets a string identifying the type of resource this manager handles. | |
ResourceMapIterator | getResourceIterator (void) |
Returns an iterator over all resources in this manager. | |
Static Public Member Functions | |
static TextureManager & | getSingleton (void) |
Override standard Singleton retrieval. | |
static TextureManager * | getSingletonPtr (void) |
Override standard Singleton retrieval. | |
Protected Member Functions | |
ResourceHandle | getNextHandle (void) |
Allocates the next handle. | |
virtual Resource * | createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *createParams)=0 |
Create a new resource instance compatible with this manager (no custom parameters are populated at this point). | |
virtual void | addImpl (ResourcePtr &res) |
Add a newly created resource to the manager (note weak reference). | |
virtual void | removeImpl (ResourcePtr &res) |
Remove a resource from this manager; remove it from the lists. | |
virtual void | checkUsage (void) |
Checks memory usage and pages out if required. | |
Protected Attributes | |
ushort | mPreferredIntegerBitDepth |
ushort | mPreferredFloatBitDepth |
size_t | mDefaultNumMipmaps |
ResourceHandleMap | mResourcesByHandle |
ResourceMap | mResources |
ResourceHandle | mNextHandle |
size_t | mMemoryBudget |
size_t | mMemoryUsage |
StringVector | mScriptPatterns |
Patterns to use to look for scripts if supported (e.g. *.overlay). | |
Real | mLoadOrder |
Loading order relative to other managers, higher is later. | |
String | mResourceType |
String identifying the resource type this manager handles. | |
Static Protected Attributes | |
static TextureManager * | ms_Singleton |
Definition at line 55 of file OgreTextureManager.h.
|
Definition at line 98 of file OgreResourceManager.h. |
|
Definition at line 412 of file OgreResourceManager.h. |
|
Definition at line 411 of file OgreResourceManager.h. |
|
Definition at line 430 of file OgreResourceManager.h. |
|
|
|
|
|
Notify this manager that a resource which it manages has been loaded.
|
|
Notify this manager that a resource which it manages has been 'touched', ie used.
|
|
Notify this manager that a resource which it manages has been unloaded.
|
|
Add a newly created resource to the manager (note weak reference).
|
|
Checks memory usage and pages out if required.
|
|
Creates a new blank resource, but does not immediately load it.
|
|
Create a new resource instance compatible with this manager (no custom parameters are populated at this point).
Implemented in Ogre::CompositorManager, Ogre::FontManager, Ogre::HighLevelGpuProgramManager, Ogre::MaterialManager, Ogre::MeshManager, and Ogre::SkeletonManager. |
|
Create a manual texture with a depth of 1 (not loaded from a file).
Definition at line 224 of file OgreTextureManager.h. |
|
Create a manual texture with specified width, height and depth (not loaded from a file).
|
|
Create a new resource, or retrieve an existing one with the same name if it already exists.
|
|
Retrieves a pointer to a resource by handle, or null if the resource does not exist.
|
|
Retrieves a pointer to a resource by name, or null if the resource does not exist.
|
|
Gets the default number of mipmaps to be used for loaded textures.
Definition at line 352 of file OgreTextureManager.h. |
|
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader. Definition at line 367 of file OgreResourceManager.h. |
|
Get the limit on the amount of memory this resource handler may use.
|
|
Gets the current memory usage, in bytes.
Definition at line 131 of file OgreResourceManager.h. |
|
Gets the format which will be natively used for a requested format given the contraints of the current device.
|
|
Allocates the next handle.
|
|
gets preferred bit depth for float pixel format textures.
|
|
gets preferred bit depth for integer pixel format textures.
|
|
Returns an iterator over all resources in this manager.
Definition at line 435 of file OgreResourceManager.h. |
|
Gets a string identifying the type of resource this manager handles.
Definition at line 370 of file OgreResourceManager.h. |
|
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader. Definition at line 344 of file OgreResourceManager.h. |
|
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< TextureManager >. |
|
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< TextureManager >. |
|
Returns whether this render system can support the texture format requested with the given usage options, or another format with no quality reduction.
|
|
Returns whether this render system can natively support the precise texture format requested with the given usage options.
|
|
Returns whether this render system has hardware filtering supported for the texture format requested with the given usage options.
|
|
Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters).
|
|
Loads a texture from a file.
|
|
Loads a texture from an Image object.
|
|
Loads a texture from a raw data stream.
|
|
Parse the definition of a set of resources from a script file.
Implements Ogre::ScriptLoader. Reimplemented in Ogre::CompositorManager, Ogre::FontManager, and Ogre::MaterialManager. Definition at line 359 of file OgreResourceManager.h. |
|
Caused all currently loaded resources to be reloaded.
|
|
Caused all currently loaded but not referenced by any other object resources to be reloaded.
|
|
Remove a single resource by handle.
|
|
Remove a single resource by name.
|
|
Remove a single resource.
|
|
Removes all resources.
Reimplemented in Ogre::CompositorManager. |
|
Remove a resource from this manager; remove it from the lists.
|
|
Returns whether a resource with the given handle exists in this manager.
Definition at line 292 of file OgreResourceManager.h. |
|
Returns whether the named resource exists in this manager.
Definition at line 287 of file OgreResourceManager.h. |
|
Sets the default number of mipmaps to be used for loaded textures, for when textures are loaded automatically (e.g. by Material class) or when 'load' is called with the default parameters by the application. If set to MIP_UNLIMITED mipmaps will be generated until the lowest possible level, 1x1x1.
|
|
Set a limit on the amount of memory this resource handler may use.
|
|
Sets preferred bit depth for integer and float pixel format.
|
|
Sets preferred bit depth for float pixel format textures.
|
|
Sets preferred bit depth for integer pixel format textures.
|
|
Unloads a single resource by handle.
|
|
Unloads a single resource by name.
|
|
Unloads all resources.
|
|
Unload all resources which are not referenced by any other object.
|
|
Definition at line 394 of file OgreTextureManager.h. |
|
Loading order relative to other managers, higher is later.
Definition at line 425 of file OgreResourceManager.h. |
|
Definition at line 417 of file OgreResourceManager.h. |
|
Definition at line 418 of file OgreResourceManager.h. |
|
Definition at line 416 of file OgreResourceManager.h. |
|
Definition at line 393 of file OgreTextureManager.h. |
|
Definition at line 392 of file OgreTextureManager.h. |
|
Definition at line 415 of file OgreResourceManager.h. |
|
Definition at line 414 of file OgreResourceManager.h. |
|
String identifying the resource type this manager handles.
Definition at line 427 of file OgreResourceManager.h. |
|
Definition at line 61 of file OgreSingleton.h. |
|
Patterns to use to look for scripts if supported (e.g. *.overlay).
Definition at line 423 of file OgreResourceManager.h. |
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Thu Dec 27 15:22:30 2007