Ogre::D3D9TextureManager Class Reference

`#include <OgreD3D9TextureManager.h>`

Inheritance diagram for Ogre::D3D9TextureManager:
[legend]

List of all members.

## Public Types

typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult
typedef HashMap< String, ResourcePtr > | ResourceMap
typedef HashMap< String, ResourceMap > | ResourceWithGroupMap
typedef map< ResourceHandle, ResourcePtr >::type | ResourceHandleMap
typedef MapIterator < ResourceHandleMap > | ResourceMapIterator

## Public Member Functions

| D3D9TextureManager ()
| ~D3D9TextureManager ()
PixelFormat | getNativeFormat (TextureType ttype, PixelFormat format, int usage)
bool | isHardwareFilteringSupported (TextureType ttype, PixelFormat format, int usage, bool preciseFormatOnly=false)
virtual ResourceCreateOrRetrieveResult | createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0, TextureType texType=TEX_TYPE_2D, int numMipmaps=MIP_DEFAULT, Real gamma=1.0f, bool isAlpha=false, PixelFormat desiredFormat=PF_UNKNOWN, bool hwGammaCorrection=false)
| Create a new texture, or retrieve an existing one with the same name if it already exists.
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 TexturePtr | prepare (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, bool hwGammaCorrection=false)
| Prepares to loads a texture from a file.
virtual ResourcePtr | prepare (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false)
| Generic prepare method, used to create a Resource specific to this ResourceManager without using one of the specialised 'prepare' methods (containing per-Resource-type parameters).
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, bool hwGammaCorrection=false)
| Loads a texture from a file.
virtual ResourcePtr | load (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false)
| 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 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, bool hwGammaCorrection=false)
| 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, bool hwGammaCorrection=false)
| 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, bool hwGammaCorrection=false, uint fsaa=0, const String &fsaaHint=StringUtil::BLANK)
| 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, bool hwGammaCorrection=false, uint fsaa=0, const String &fsaaHint=StringUtil::BLANK)
| 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 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 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 void | removeUnreferencedResources (bool reloadableOnly=true)
| Remove all resources which are not referenced by any other object.
virtual ResourcePtr | getByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_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', i.e.
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 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.
virtual void | setVerbose (bool v)
| Sets whether this manager and its resources habitually produce log output.
virtual bool | getVerbose (void)
| Gets whether this manager and its resources habitually produce log output.
ResourcePool * | getResourcePool (const String &name)
| Create a resource pool, or reuse one that already exists.
void | destroyResourcePool (ResourcePool *pool)
| Destroy a resource pool.
void | destroyResourcePool (const String &name)
| Destroy a resource pool.
void | destroyAllResourcePools ()
| destroy all pools
ResourceMapIterator | getResourceIterator (void)
| Returns an iterator over all resources in this manager.
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info
void * | operator new[] (size_t sz)
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)

## Static Public Member Functions

static TextureManager & | getSingleton (void)
| Override standard Singleton retrieval.
static TextureManager * | getSingletonPtr (void)
| Override standard Singleton retrieval.

## Protected Types

typedef map< String, ResourcePool * >::type | ResourcePoolMap

## Protected Member Functions

Resource * | createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *createParams)
ResourceHandle | getNextHandle (void)
| Allocates the next handle.
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
ResourceWithGroupMap | mResourcesWithGroup
ResourceHandle | mNextHandle
size_t | mMemoryBudget
AtomicScalar< size_t > | mMemoryUsage
bool | mVerbose
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.
ResourcePoolMap | mResourcePoolMap

## Static Protected Attributes

static TextureManager * | msSingleton

## Detailed Description

Definition at line 36 of file OgreD3D9TextureManager.h.

## Member Typedef Documentation

typedef std::pair<ResourcePtr, bool> Ogre::ResourceManager::ResourceCreateOrRetrieveResult`[inherited]`

Definition at line 103 of file OgreResourceManager.h.

typedef map<ResourceHandle, ResourcePtr>::type Ogre::ResourceManager::ResourceHandleMap`[inherited]`

Definition at line 494 of file OgreResourceManager.h.

typedef HashMap< String, ResourcePtr > Ogre::ResourceManager::ResourceMap`[inherited]`

Definition at line 492 of file OgreResourceManager.h.

typedef MapIterator<ResourceHandleMap> Ogre::ResourceManager::ResourceMapIterator`[inherited]`

Definition at line 515 of file OgreResourceManager.h.

typedef map<String, ResourcePool*>::type Ogre::ResourceManager::ResourcePoolMap`[protected, inherited]`

Definition at line 526 of file OgreResourceManager.h.

typedef HashMap< String, ResourceMap > Ogre::ResourceManager::ResourceWithGroupMap`[inherited]`

Definition at line 493 of file OgreResourceManager.h.

## Constructor & Destructor Documentation

Ogre::D3D9TextureManager::D3D9TextureManager | ( |  | ) |

Ogre::D3D9TextureManager::~D3D9TextureManager | ( |  | ) |

## Member Function Documentation

virtual void Ogre::ResourceManager::_notifyResourceLoaded | ( | Resource * | res | ) | `[virtual, inherited]`

Notify this manager that a resource which it manages has been loaded.

virtual void Ogre::ResourceManager::_notifyResourceTouched | ( | Resource * | res | ) | `[virtual, inherited]`

Notify this manager that a resource which it manages has been 'touched', i.e.

used.

virtual void Ogre::ResourceManager::_notifyResourceUnloaded | ( | Resource * | res | ) | `[virtual, inherited]`

Notify this manager that a resource which it manages has been unloaded.

virtual void Ogre::ResourceManager::addImpl | ( | ResourcePtr & | res | ) | `[protected, virtual, inherited]`

Add a newly created resource to the manager (note weak reference)

virtual void Ogre::ResourceManager::checkUsage | ( | void |  | ) | `[protected, virtual, inherited]`

Checks memory usage and pages out if required.

virtual ResourcePtr Ogre::ResourceManager::create | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | createParams = `0`
| ) |  | `[virtual, inherited]`

Creates a new blank resource, but does not immediately load it.

Remarks:
  Resource managers handle disparate types of resources, so if you want to get at the detailed interface of this resource, you'll have to cast the result to the subclass you know you're creating.

Parameters:

  name | The unique name of the resource
  group | The name of the resource group to attach this new resource to
  isManual | Is this resource manually loaded? If so, you should really populate the loader parameter in order that the load process can call the loader back when loading is required.
  loader | Pointer to a ManualLoader implementation which will be called when the Resource wishes to load (should be supplied if you set isManual to true). You can in fact leave this parameter null if you wish, but the Resource will never be able to reload if anything ever causes it to unload. Therefore provision of a proper ManualLoader instance is strongly recommended.
  createParams | If any parameters are required to create an instance, they should be supplied here as name / value pairs

Resource* Ogre::D3D9TextureManager::createImpl | ( | const String & | name,
|  | ResourceHandle | handle,
|  | const String & | group,
|  | bool | isManual,
|  | ManualResourceLoader * | loader,
|  | const NameValuePairList * | createParams
| ) |  | `[protected, virtual]`

Create a new resource instance compatible with this manager (no custom parameters are populated at this point).

Remarks:
  Subclasses must override this method and create a subclass of Resource.

Parameters:

  name | The unique name of the resource
  group | The name of the resource group to attach this new resource to
  isManual | Is this resource manually loaded? If so, you should really populate the loader parameter in order that the load process can call the loader back when loading is required.
  loader | Pointer to a ManualLoader implementation which will be called when the Resource wishes to load (should be supplied if you set isManual to true). You can in fact leave this parameter null if you wish, but the Resource will never be able to reload if anything ever causes it to unload. Therefore provision of a proper ManualLoader instance is strongly recommended.
  createParams | If any parameters are required to create an instance, they should be supplied here as name / value pairs. These do not need to be set on the instance (handled elsewhere), just used if required to differentiate which concrete class is created.

Implements Ogre::ResourceManager.

virtual TexturePtr Ogre::TextureManager::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`,
|  | bool | hwGammaCorrection = `false`,
|  | uint | fsaa = `0`,
|  | const String & | fsaaHint = `StringUtil::BLANK`
| ) |  | `[virtual, inherited]`

Create a manual texture with specified width, height and depth (not loaded from a file).

Parameters:

  name | The name to give the resulting texture
  group | The name of the resource group to assign the texture to
  texType | The type of texture to load/create, defaults to normal 2D textures
  width,height,depth | The dimensions of the texture
  numMipmaps | The number of pre-filtered mipmaps to generate. If left to MIP_DEFAULT then the TextureManager's default number of mipmaps will be used (see setDefaultNumMipmaps()) If set to MIP_UNLIMITED mipmaps will be generated until the lowest possible level, 1x1x1.
  format | The internal format you wish to request; the manager reserves the right to create a different format if the one you select is not available in this context.
  usage | The kind of usage this texture is intended for. It is a combination of TU_STATIC, TU_DYNAMIC, TU_WRITE_ONLY, TU_AUTOMIPMAP and TU_RENDERTARGET (see TextureUsage enum). You are strongly advised to use HBU_STATIC_WRITE_ONLY wherever possible, if you need to update regularly, consider HBU_DYNAMIC_WRITE_ONLY.

  loader

  If you intend the contents of the manual texture to be regularly updated, to the extent that you don't need to recover the contents if the texture content is lost somehow, you can leave this parameter as 0. However, if you intend to populate the texture only once, then you should implement ManualResourceLoader and pass a pointer to it in this parameter; this means that if the manual texture ever needs to be reloaded, the ManualResourceLoader will be called to do it.

  hwGammaCorrection | Pass 'true' to enable hardware gamma correction (sRGB) on this texture. The hardware will convert from gamma space to linear space when reading from this texture. Only applicable for 8-bits per channel textures, will be ignored for other types. Has the advantage over pre-applied gamma that the texture precision is maintained.
  fsaa | The level of multisampling to use if this is a render target. Ignored if usage does not include TU_RENDERTARGET or if the device does not support it.

TexturePtr Ogre::TextureManager::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`,
|  | bool | hwGammaCorrection = `false`,
|  | uint | fsaa = `0`,
|  | const String & | fsaaHint = `StringUtil::BLANK`
| ) |  | `[inherited]`

Create a manual texture with a depth of 1 (not loaded from a file).

Parameters:

  name | The name to give the resulting texture
  group | The name of the resource group to assign the texture to
  texType | The type of texture to load/create, defaults to normal 2D textures
  width,height | The dimensions of the texture
  numMipmaps | The number of pre-filtered mipmaps to generate. If left to MIP_DEFAULT then the TextureManager's default number of mipmaps will be used (see setDefaultNumMipmaps()). If set to MIP_UNLIMITED mipmaps will be generated until the lowest possible level, 1x1x1.
  format | The internal format you wish to request; the manager reserves the right to create a different format if the one you select is not available in this context.
  usage | The kind of usage this texture is intended for. It is a combination of TU_STATIC, TU_DYNAMIC, TU_WRITE_ONLY, TU_AUTOMIPMAP and TU_RENDERTARGET (see TextureUsage enum). You are strongly advised to use HBU_STATIC_WRITE_ONLY wherever possible, if you need to update regularly, consider HBU_DYNAMIC_WRITE_ONLY.

  loader

  If you intend the contents of the manual texture to be regularly updated, to the extent that you don't need to recover the contents if the texture content is lost somehow, you can leave this parameter as 0. However, if you intend to populate the texture only once, then you should implement ManualResourceLoader and pass a pointer to it in this parameter; this means that if the manual texture ever needs to be reloaded, the ManualResourceLoader will be called to do it.

  hwGammaCorrection | Pass 'true' to enable hardware gamma correction (sRGB) on this texture. The hardware will convert from gamma space to linear space when reading from this texture. Only applicable for 8-bits per channel textures, will be ignored for other types. Has the advantage over pre-applied gamma that the texture precision is maintained.
  fsaa | The level of multisampling to use if this is a render target. Ignored if usage does not include TU_RENDERTARGET or if the device does not support it.

Definition at line 331 of file OgreTextureManager.h.

virtual ResourceCreateOrRetrieveResult Ogre::TextureManager::createOrRetrieve | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | createParams = `0`,
|  | TextureType | texType = `TEX_TYPE_2D`,
|  | int | numMipmaps = `MIP_DEFAULT`,
|  | Real | gamma = `1.0f`,
|  | bool | isAlpha = `false`,
|  | PixelFormat | desiredFormat = `PF_UNKNOWN`,
|  | bool | hwGammaCorrection = `false`
| ) |  | `[virtual, inherited]`

Create a new texture, or retrieve an existing one with the same name if it already exists.

Parameters:

  texType | The type of texture to load/create, defaults to normal 2D textures
  numMipmaps | The number of pre-filtered mipmaps to generate. If left to MIP_DEFAULT then the TextureManager's default number of mipmaps will be used (see setDefaultNumMipmaps()) If set to MIP_UNLIMITED mipmaps will be generated until the lowest possible level, 1x1x1.
  gamma | The gamma adjustment factor to apply to this texture (brightening/darkening)
  isAlpha | Only applicable to greyscale images. If true, specifies that the image should be loaded into an alpha texture rather than a single channel colour texture - useful for fixed-function systems.
  desiredFormat | The format you would like to have used instead of the format being based on the contents of the texture
  hwGammaCorrection | Pass 'true' to enable hardware gamma correction (sRGB) on this texture. The hardware will convert from gamma space to linear space when reading from this texture. Only applicable for 8-bits per channel textures, will be ignored for other types. Has the advantage over pre-applied gamma that the texture precision is maintained.

See also:
  ResourceManager::createOrRetrieve

virtual ResourceCreateOrRetrieveResult Ogre::ResourceManager::createOrRetrieve | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | createParams = `0`
| ) |  | `[virtual, inherited]`

Create a new resource, or retrieve an existing one with the same name if it already exists.

Remarks:
  This method performs the same task as calling getByName() followed by create() if that returns null. The advantage is that it does it in one call so there are no race conditions if using multiple threads that could cause getByName() to return null, but create() to fail because another thread created a resource in between.

See also:
  ResourceManager::create
  ResourceManager::getByName

Returns:
  A pair, the first element being the pointer, and the second being an indicator specifying whether the resource was newly created.

void Ogre::ResourceManager::destroyAllResourcePools | ( |  | ) | `[inherited]`

destroy all pools

void Ogre::ResourceManager::destroyResourcePool | ( | ResourcePool * | pool | ) | `[inherited]`

Destroy a resource pool.

void Ogre::ResourceManager::destroyResourcePool | ( | const String & | name | ) | `[inherited]`

Destroy a resource pool.

virtual ResourcePtr Ogre::ResourceManager::getByHandle | ( | ResourceHandle | handle | ) | `[virtual, inherited]`

Retrieves a pointer to a resource by handle, or null if the resource does not exist.

virtual ResourcePtr Ogre::ResourceManager::getByName | ( | const String & | name,
|  | const String & | groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME`
| ) |  | `[virtual, inherited]`

Retrieves a pointer to a resource by name, or null if the resource does not exist.

virtual size_t Ogre::TextureManager::getDefaultNumMipmaps | ( |  | ) | `[virtual, inherited]`

Gets the default number of mipmaps to be used for loaded textures.

Definition at line 460 of file OgreTextureManager.h.

virtual Real Ogre::ResourceManager::getLoadingOrder | ( | void |  | ) | const`[virtual, inherited]`

Gets the relative loading order of resources of this type.

Remarks:
  There are dependencies between some kinds of resource in terms of loading order, and this value enumerates that. Higher values load later during bulk loading tasks.

Implements Ogre::ScriptLoader.

Definition at line 412 of file OgreResourceManager.h.

virtual size_t Ogre::ResourceManager::getMemoryBudget | ( | void |  | ) | const`[virtual, inherited]`

Get the limit on the amount of memory this resource handler may use.

virtual size_t Ogre::ResourceManager::getMemoryUsage | ( | void |  | ) | const`[virtual, inherited]`

Gets the current memory usage, in bytes.

Definition at line 136 of file OgreResourceManager.h.

PixelFormat Ogre::D3D9TextureManager::getNativeFormat | ( | TextureType | ttype,
|  | PixelFormat | format,
|  | int | usage
| ) |  | `[virtual]`

Gets the format which will be natively used for a requested format given the constraints of the current device.

Implements Ogre::TextureManager.

ResourceHandle Ogre::ResourceManager::getNextHandle | ( | void |  | ) | `[protected, inherited]`

Allocates the next handle.

virtual ushort Ogre::TextureManager::getPreferredFloatBitDepth | ( | void |  | ) | const`[virtual, inherited]`

gets preferred bit depth for float pixel format textures.

virtual ushort Ogre::TextureManager::getPreferredIntegerBitDepth | ( | void |  | ) | const`[virtual, inherited]`

gets preferred bit depth for integer pixel format textures.

ResourceMapIterator Ogre::ResourceManager::getResourceIterator | ( | void |  | ) | `[inherited]`

Returns an iterator over all resources in this manager.

Note:
  Use of this iterator is NOT thread safe!

Definition at line 520 of file OgreResourceManager.h.

ResourcePool* Ogre::ResourceManager::getResourcePool | ( | const String & | name | ) | `[inherited]`

Create a resource pool, or reuse one that already exists.

const String& Ogre::ResourceManager::getResourceType | ( | void |  | ) | const`[inherited]`

Gets a string identifying the type of resource this manager handles.

Definition at line 415 of file OgreResourceManager.h.

virtual const StringVector& Ogre::ResourceManager::getScriptPatterns | ( | void |  | ) | const`[virtual, inherited]`

Gets the file patterns which should be used to find scripts for this ResourceManager.

Remarks:
  Some resource managers can read script files in order to define resources ahead of time. These resources are added to the available list inside the manager, but none are loaded initially. This allows you to load the items that are used on demand, or to load them all as a group if you wish (through ResourceGroupManager).

  This method lets you determine the file pattern which will be used to identify scripts intended for this manager.

Returns:
  A list of file patterns, in the order they should be searched in.

See also:
  isScriptingSupported, parseScript

Implements Ogre::ScriptLoader.

Definition at line 388 of file OgreResourceManager.h.

static TextureManager& Ogre::TextureManager::getSingleton | ( | void |  | ) | `[static, inherited]`

Override standard Singleton retrieval.

Remarks:
  Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

  This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< TextureManager >.

static TextureManager* Ogre::TextureManager::getSingletonPtr | ( | void |  | ) | `[static, inherited]`

Override standard Singleton retrieval.

Remarks:
  Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

  This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< TextureManager >.

virtual bool Ogre::ResourceManager::getVerbose | ( | void |  | ) | `[virtual, inherited]`

Gets whether this manager and its resources habitually produce log output.

Definition at line 421 of file OgreResourceManager.h.

virtual bool Ogre::TextureManager::isEquivalentFormatSupported | ( | TextureType | ttype,
|  | PixelFormat | format,
|  | int | usage
| ) |  | `[virtual, inherited]`

Returns whether this render system can support the texture format requested with the given usage options, or another format with no quality reduction.

virtual bool Ogre::TextureManager::isFormatSupported | ( | TextureType | ttype,
|  | PixelFormat | format,
|  | int | usage
| ) |  | `[virtual, inherited]`

Returns whether this render system can natively support the precise texture format requested with the given usage options.

Remarks:
  You can still create textures with this format even if this method returns false; the texture format will just be altered to one which the device does support.

Note:
  Sometimes the device may just slightly change the format, such as reordering the channels or packing the channels differently, without it making and qualitative differences to the texture. If you want to just detect whether the quality of a given texture will be reduced, use isEquivalentFormatSupport instead.

Parameters:

  format | The pixel format requested
  usage | The kind of usage this texture is intended for, a combination of the TextureUsage flags.

Returns:
  true if the format is natively supported, false if a fallback would be used.

bool Ogre::D3D9TextureManager::isHardwareFilteringSupported | ( | TextureType | ttype,
|  | PixelFormat | format,
|  | int | usage,
|  | bool | preciseFormatOnly = `false`
| ) |  | `[virtual]`

Returns whether this render system has hardware filtering supported for the texture format requested with the given usage options.

Remarks:
  Not all texture format are supports filtering by the hardware, i.e. some cards support floating point format, but it doesn't supports filtering on the floating point texture at all, or only a subset floating point formats have flitering supported.

  In the case you want to write shader to work with floating point texture, and you want to produce better visual quality, it's necessary to flitering the texture manually in shader (potential requires four or more texture fetch instructions, plus several arithmetic instructions) if filtering doesn't supported by hardware. But in case on the hardware that supports floating point filtering natively, it had better to adopt this capability for performance (because only one texture fetch instruction are required) and doesn't loss visual quality.

  This method allow you queries hardware texture filtering capability to deciding which verion of the shader to be used. Note it's up to you to write multi-version shaders for support various hardware, internal engine can't do that for you automatically.

Note:
  Under GL, texture filtering are always supported by driver, but if it's not supported by hardware natively, software simulation will be used, and you will end up with very slow speed (less than 0.1 fps for example). To slove this performance problem, you must disable filtering manually (by use filtering none in the material script's texture_unit section, or call TextureUnitState::setTextureFiltering with TFO_NONE if populate material in code).

Parameters:

  ttype | The texture type requested
  format | The pixel format requested
  usage | The kind of usage this texture is intended for, a combination of the TextureUsage flags.
  preciseFormatOnly | Whether precise or fallback format mode is used to detecting. In case the pixel format doesn't supported by device, false will be returned if in precise mode, and natively used pixel format will be actually use to check if in fallback mode.

Returns:
  true if the texture filtering is supported.

Implements Ogre::TextureManager.

virtual TexturePtr Ogre::TextureManager::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`,
|  | bool | hwGammaCorrection = `false`
| ) |  | `[virtual, inherited]`

Loads a texture from a file.

Parameters:

  name | The file to load, or a String identifier in some cases
  group | The name of the resource group to assign the texture to
  texType | The type of texture to load/create, defaults to normal 2D textures
  numMipmaps | The number of pre-filtered mipmaps to generate. If left to MIP_DEFAULT then the TextureManager's default number of mipmaps will be used (see setDefaultNumMipmaps()) If set to MIP_UNLIMITED mipmaps will be generated until the lowest possible level, 1x1x1.
  gamma | The gamma adjustment factor to apply to this texture (brightening/darkening) during loading
  isAlpha | Only applicable to greyscale images. If true, specifies that the image should be loaded into an alpha texture rather than a single channel colour texture - useful for fixed-function systems.
  desiredFormat | The format you would like to have used instead of the format being based on the contents of the texture. Pass PF_UNKNOWN to default.
  hwGammaCorrection | Pass 'true' to enable hardware gamma correction (sRGB) on this texture. The hardware will convert from gamma space to linear space when reading from this texture. Only applicable for 8-bits per channel textures, will be ignored for other types. Has the advantage over pre-applied gamma that the texture precision is maintained.

virtual ResourcePtr Ogre::ResourceManager::load | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | loadParams = `0`,
|  | bool | backgroundThread = `false`
| ) |  | `[virtual, inherited]`

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).

Parameters:

  name | The name of the Resource
  group | The resource group to which this resource will belong
  isManual | Is the resource to be manually loaded? If so, you should provide a value for the loader parameter
  loader | The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter
  loadParams | Optional pointer to a list of name/value pairs containing loading parameters for this type of resource.
  backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread

virtual TexturePtr Ogre::TextureManager::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`,
|  | bool | hwGammaCorrection = `false`
| ) |  | `[virtual, inherited]`

Loads a texture from an Image object.

Note:
  The texture will create as manual texture without loader.

Parameters:

  name | The name to give the resulting texture
  group | The name of the resource group to assign the texture to
  img | The Image object which contains the data to load
  texType | The type of texture to load/create, defaults to normal 2D textures
  numMipmaps | The number of pre-filtered mipmaps to generate. If left to MIP_DEFAULT then the TextureManager's default number of mipmaps will be used (see setDefaultNumMipmaps()) If set to MIP_UNLIMITED mipmaps will be generated until the lowest possible level, 1x1x1.
  gamma | The gamma adjustment factor to apply to this texture (brightening/darkening)
  isAlpha | Only applicable to greyscale images. If true, specifies that the image should be loaded into an alpha texture rather than a single channel colour texture - useful for fixed-function systems.
  desiredFormat | The format you would like to have used instead of the format being based on the contents of the texture
  hwGammaCorrection | Pass 'true' to enable hardware gamma correction (sRGB) on this texture. The hardware will convert from gamma space to linear space when reading from this texture. Only applicable for 8-bits per channel textures, will be ignored for other types. Has the advantage over pre-applied gamma that the texture precision is maintained.

virtual TexturePtr Ogre::TextureManager::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`,
|  | bool | hwGammaCorrection = `false`
| ) |  | `[virtual, inherited]`

Loads a texture from a raw data stream.

Note:
  The texture will create as manual texture without loader.

Parameters:

  name | The name to give the resulting texture
  group | The name of the resource group to assign the texture to
  stream | Incoming data stream
  width,height | The dimensions of the texture
  format | The format of the data being passed in; the manager reserves the right to create a different format for the texture if the original format is not available in this context.
  texType | The type of texture to load/create, defaults to normal 2D textures
  numMipmaps | The number of pre-filtered mipmaps to generate. If left to MIP_DEFAULT then the TextureManager's default number of mipmaps will be used (see setDefaultNumMipmaps()) If set to MIP_UNLIMITED mipmaps will be generated until the lowest possible level, 1x1x1.
  gamma | The gamma adjustment factor to apply to this texture (brightening/darkening) while loading
  hwGammaCorrection | Pass 'true' to enable hardware gamma correction (sRGB) on this texture. The hardware will convert from gamma space to linear space when reading from this texture. Only applicable for 8-bits per channel textures, will be ignored for other types. Has the advantage over pre-applied gamma that the texture precision is maintained.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | `[inherited]`

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  | `[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  | `[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | `[inherited]`

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  | `[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  | `[inherited]`

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | `[inherited]`

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  | `[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  | `[inherited]`

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | `[inherited]`

Definition at line 90 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::ResourceManager::parseScript | ( | DataStreamPtr & | stream,
|  | const String & | groupName
| ) |  | `[virtual, inherited]`

Parse the definition of a set of resources from a script file.

Remarks:
  Some resource managers can read script files in order to define resources ahead of time. These resources are added to the available list inside the manager, but none are loaded initially. This allows you to load the items that are used on demand, or to load them all as a group if you wish (through ResourceGroupManager).

Parameters:

  stream | Weak reference to a data stream which is the source of the script
  groupName | The name of the resource group that resources which are parsed are to become a member of. If this group is loaded or unloaded, then the resources discovered in this script will be loaded / unloaded with it.

Implements Ogre::ScriptLoader.

Reimplemented in Ogre::MaterialManager, Ogre::CompositorManager, and Ogre::FontManager.

Definition at line 403 of file OgreResourceManager.h.

virtual TexturePtr Ogre::TextureManager::prepare | ( | 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`,
|  | bool | hwGammaCorrection = `false`
| ) |  | `[virtual, inherited]`

Prepares to loads a texture from a file.

Parameters:

  name | The file to load, or a String identifier in some cases
  group | The name of the resource group to assign the texture to
  texType | The type of texture to load/create, defaults to normal 2D textures
  numMipmaps | The number of pre-filtered mipmaps to generate. If left to MIP_DEFAULT then the TextureManager's default number of mipmaps will be used (see setDefaultNumMipmaps()) If set to MIP_UNLIMITED mipmaps will be generated until the lowest possible level, 1x1x1.
  gamma | The gamma adjustment factor to apply to this texture (brightening/darkening)
  isAlpha | Only applicable to greyscale images. If true, specifies that the image should be loaded into an alpha texture rather than a single channel colour texture - useful for fixed-function systems.
  desiredFormat | The format you would like to have used instead of the format being based on the contents of the texture
  hwGammaCorrection | Pass 'true' to enable hardware gamma correction (sRGB) on this texture. The hardware will convert from gamma space to linear space when reading from this texture. Only applicable for 8-bits per channel textures, will be ignored for other types. Has the advantage over pre-applied gamma that the texture precision is maintained.

virtual ResourcePtr Ogre::ResourceManager::prepare | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | loadParams = `0`,
|  | bool | backgroundThread = `false`
| ) |  | `[virtual, inherited]`

Generic prepare method, used to create a Resource specific to this ResourceManager without using one of the specialised 'prepare' methods (containing per-Resource-type parameters).

Parameters:

  name | The name of the Resource
  group | The resource group to which this resource will belong
  isManual | Is the resource to be manually loaded? If so, you should provide a value for the loader parameter
  loader | The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter
  loadParams | Optional pointer to a list of name/value pairs containing loading parameters for this type of resource.
  backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread

virtual void Ogre::ResourceManager::reloadAll | ( | bool | reloadableOnly = `true` | ) | `[virtual, inherited]`

Caused all currently loaded resources to be reloaded.

Remarks:
  All resources currently being held in this manager which are also marked as currently loaded will be unloaded, then loaded again.

Parameters:

  reloadableOnly | If true (the default), only reload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't loaded again. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.

See also:
  Resource::isReloadable for resource is reloadable.

virtual void Ogre::ResourceManager::reloadUnreferencedResources | ( | bool | reloadableOnly = `true` | ) | `[virtual, inherited]`

Caused all currently loaded but not referenced by any other object resources to be reloaded.

Remarks:
  This method behaves like reloadAll, except that it only reloads resources which are not in use, i.e. not referenced by other objects.

  Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, unload or reload that resource will cause dangerous pointer access. Use this function instead of reloadAll allows you avoid fail in those situations.

Parameters:

  reloadableOnly | If true (the default), only reloads resources which can be subsequently automatically reloaded.

virtual void Ogre::ResourceManager::remove | ( | ResourcePtr & | r | ) | `[virtual, inherited]`

Remove a single resource.

Remarks:
  Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note:
  The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

virtual void Ogre::ResourceManager::remove | ( | const String & | name | ) | `[virtual, inherited]`

Remove a single resource by name.

Remarks:
  Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note:
  The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

virtual void Ogre::ResourceManager::remove | ( | ResourceHandle | handle | ) | `[virtual, inherited]`

Remove a single resource by handle.

Remarks:
  Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note:
  The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

virtual void Ogre::ResourceManager::removeAll | ( | void |  | ) | `[virtual, inherited]`

Removes all resources.

Note:
  The word 'Destroy' is not used here, since if any other pointers are referring to these resources, they will persist until they have been finished with; however to all intents and purposes the resources no longer exist and will get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

Reimplemented in Ogre::CompositorManager.

virtual void Ogre::ResourceManager::removeImpl | ( | ResourcePtr & | res | ) | `[protected, virtual, inherited]`

Remove a resource from this manager; remove it from the lists.

virtual void Ogre::ResourceManager::removeUnreferencedResources | ( | bool | reloadableOnly = `true` | ) | `[virtual, inherited]`

Remove all resources which are not referenced by any other object.

Remarks:
  This method behaves like removeAll, except that it only removes resources which are not in use, ie not referenced by other objects. This allows you to free up some memory selectively whilst still keeping the group around (and the resources present, just not using much memory).

  Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, remove or reload that resource will cause dangerous pointer access. Use this function instead of removeAll allows you avoid fail in those situations.

Parameters:

  reloadableOnly | If true (the default), only removes resources which can be subsequently automatically reloaded.

virtual bool Ogre::ResourceManager::resourceExists | ( | const String & | name | ) | `[virtual, inherited]`

Returns whether the named resource exists in this manager.

Definition at line 308 of file OgreResourceManager.h.

virtual bool Ogre::ResourceManager::resourceExists | ( | ResourceHandle | handle | ) | `[virtual, inherited]`

Returns whether a resource with the given handle exists in this manager.

Definition at line 313 of file OgreResourceManager.h.

virtual void Ogre::TextureManager::setDefaultNumMipmaps | ( | size_t | num | ) | `[virtual, inherited]`

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.

Note:
  The default value is 0.

virtual void Ogre::ResourceManager::setMemoryBudget | ( | size_t | bytes | ) | `[virtual, inherited]`

Set a limit on the amount of memory this resource handler may use.

Remarks:
  If, when asked to load a new resource, the manager believes it will exceed this memory budget, it will temporarily unload a resource to make room for the new one. This unloading is not permanent and the Resource is not destroyed; it simply needs to be reloaded when next used.

virtual void Ogre::TextureManager::setPreferredBitDepths | ( | ushort | integerBits,
|  | ushort | floatBits,
|  | bool | reloadTextures = `true`
| ) |  | `[virtual, inherited]`

Sets preferred bit depth for integer and float pixel format.

Parameters:

  integerBits | Number of bits. Available values: 0, 16 and 32, where 0 (the default) means keep original format as it is. This value is number of bits for the pixel.
  floatBits | Number of bits. Available values: 0, 16 and 32, where 0 (the default) means keep original format as it is. This value is number of bits for a channel of the pixel.
  reloadTextures | If true (the default), will reloading all reloadable textures.

virtual void Ogre::TextureManager::setPreferredFloatBitDepth | ( | ushort | bits,
|  | bool | reloadTextures = `true`
| ) |  | `[virtual, inherited]`

Sets preferred bit depth for float pixel format textures.

Parameters:

  bits | Number of bits. Available values: 0, 16 and 32, where 0 (the default) means keep original format as it is. This value is number of bits for a channel of the pixel.
  reloadTextures | If true (the default), will reloading all reloadable textures.

virtual void Ogre::TextureManager::setPreferredIntegerBitDepth | ( | ushort | bits,
|  | bool | reloadTextures = `true`
| ) |  | `[virtual, inherited]`

Sets preferred bit depth for integer pixel format textures.

Parameters:

  bits | Number of bits. Available values: 0, 16 and 32, where 0 (the default) means keep original format as it is. This value is number of bits for the pixel.
  reloadTextures | If true (the default), will reloading all reloadable textures.

virtual void Ogre::ResourceManager::setVerbose | ( | bool | v | ) | `[virtual, inherited]`

Sets whether this manager and its resources habitually produce log output.

Definition at line 418 of file OgreResourceManager.h.

virtual void Ogre::ResourceManager::unload | ( | const String & | name | ) | `[virtual, inherited]`

Unloads a single resource by name.

Remarks:
  Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also:
  ResourceGroupManager for unloading of resource groups.

virtual void Ogre::ResourceManager::unload | ( | ResourceHandle | handle | ) | `[virtual, inherited]`

Unloads a single resource by handle.

Remarks:
  Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also:
  ResourceGroupManager for unloading of resource groups.

virtual void Ogre::ResourceManager::unloadAll | ( | bool | reloadableOnly = `true` | ) | `[virtual, inherited]`

Unloads all resources.

Remarks:
  Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also:
  ResourceGroupManager for unloading of resource groups.

Parameters:

  reloadableOnly | If true (the default), only unload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't load them later. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.

See also:
  Resource::isReloadable for resource is reloadable.

virtual void Ogre::ResourceManager::unloadUnreferencedResources | ( | bool | reloadableOnly = `true` | ) | `[virtual, inherited]`

Unload all resources which are not referenced by any other object.

Remarks:
  This method behaves like unloadAll, except that it only unloads resources which are not in use, ie not referenced by other objects. This allows you to free up some memory selectively whilst still keeping the group around (and the resources present, just not using much memory).

  Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, unload or reload that resource will cause dangerous pointer access. Use this function instead of unloadAll allows you avoid fail in those situations.

Parameters:

  reloadableOnly | If true (the default), only unloads resources which can be subsequently automatically reloaded.

## Member Data Documentation

size_t Ogre::TextureManager::mDefaultNumMipmaps`[protected, inherited]`

Definition at line 502 of file OgreTextureManager.h.

Real Ogre::ResourceManager::mLoadOrder`[protected, inherited]`

Loading order relative to other managers, higher is later.

Definition at line 510 of file OgreResourceManager.h.

size_t Ogre::ResourceManager::mMemoryBudget`[protected, inherited]`

Definition at line 500 of file OgreResourceManager.h.

AtomicScalar<size_t> Ogre::ResourceManager::mMemoryUsage`[protected, inherited]`

Definition at line 501 of file OgreResourceManager.h.

ResourceHandle Ogre::ResourceManager::mNextHandle`[protected, inherited]`

Definition at line 499 of file OgreResourceManager.h.

ushort Ogre::TextureManager::mPreferredFloatBitDepth`[protected, inherited]`

Definition at line 501 of file OgreTextureManager.h.

ushort Ogre::TextureManager::mPreferredIntegerBitDepth`[protected, inherited]`

Definition at line 500 of file OgreTextureManager.h.

ResourcePoolMap Ogre::ResourceManager::mResourcePoolMap`[protected, inherited]`

Definition at line 527 of file OgreResourceManager.h.

ResourceMap Ogre::ResourceManager::mResources`[protected, inherited]`

Definition at line 497 of file OgreResourceManager.h.

ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle`[protected, inherited]`

Definition at line 496 of file OgreResourceManager.h.

ResourceWithGroupMap Ogre::ResourceManager::mResourcesWithGroup`[protected, inherited]`

Definition at line 498 of file OgreResourceManager.h.

String Ogre::ResourceManager::mResourceType`[protected, inherited]`

String identifying the resource type this manager handles.

Definition at line 512 of file OgreResourceManager.h.

StringVector Ogre::ResourceManager::mScriptPatterns`[protected, inherited]`

Patterns to use to look for scripts if supported (e.g. *.overlay)

Definition at line 508 of file OgreResourceManager.h.

TextureManager * Ogre::Singleton< TextureManager >::msSingleton`[static, protected, inherited]`

Definition at line 75 of file OgreSingleton.h.

bool Ogre::ResourceManager::mVerbose`[protected, inherited]`

Definition at line 503 of file OgreResourceManager.h.

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

- OgreD3D9TextureManager.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:50