Class for loading & managing textures. More...
#include <OgreTextureManager.h>
Public Types | |
typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult |
typedef map< ResourceHandle, ResourcePtr >::type | ResourceHandleMap |
typedef HashMap< String, ResourcePtr > | ResourceMap |
typedef MapIterator < ResourceHandleMap > | ResourceMapIterator |
typedef HashMap< String, ResourceMap > | ResourceWithGroupMap |
Public Member Functions | |
TextureManager (void) | |
virtual | ~TextureManager () |
virtual void | _notifyResourceLoaded (Resource *res) |
Notify this manager that a resource which it manages has been loaded. More... | |
virtual void | _notifyResourceTouched (Resource *res) |
Notify this manager that a resource which it manages has been 'touched', i.e. More... | |
virtual void | _notifyResourceUnloaded (Resource *res) |
Notify this manager that a resource which it manages has been unloaded. More... | |
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. More... | |
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). More... | |
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). More... | |
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. More... | |
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. More... | |
void | destroyAllResourcePools () |
destroy all pools More... | |
void | destroyResourcePool (ResourcePool *pool) |
Destroy a resource pool. More... | |
void | destroyResourcePool (const String &name) |
Destroy a resource pool. More... | |
virtual ResourcePtr | getByHandle (ResourceHandle handle) |
Retrieves a pointer to a resource by handle, or null if the resource does not exist. More... | |
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. More... | |
virtual size_t | getDefaultNumMipmaps () |
Gets the default number of mipmaps to be used for loaded textures. More... | |
virtual Real | getLoadingOrder (void) const |
Gets the relative loading order of resources of this type. More... | |
virtual size_t | getMemoryBudget (void) const |
Get the limit on the amount of memory this resource handler may use. More... | |
virtual size_t | getMemoryUsage (void) const |
Gets the current memory usage, in bytes. More... | |
virtual PixelFormat | getNativeFormat (TextureType ttype, PixelFormat format, int usage)=0 |
Gets the format which will be natively used for a requested format given the constraints of the current device. More... | |
virtual ushort | getPreferredFloatBitDepth (void) const |
gets preferred bit depth for float pixel format textures. More... | |
virtual ushort | getPreferredIntegerBitDepth (void) const |
gets preferred bit depth for integer pixel format textures. More... | |
ResourceMapIterator | getResourceIterator (void) |
Returns an iterator over all resources in this manager. More... | |
ResourcePool * | getResourcePool (const String &name) |
Create a resource pool, or reuse one that already exists. More... | |
const String & | getResourceType (void) const |
Gets a string identifying the type of resource this manager handles. More... | |
virtual const StringVector & | getScriptPatterns (void) const |
Gets the file patterns which should be used to find scripts for this ResourceManager. More... | |
virtual bool | getVerbose (void) |
Gets whether this manager and its resources habitually produce log output. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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). More... | |
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. More... | |
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. More... | |
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 *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
virtual void | parseScript (DataStreamPtr &stream, const String &groupName) |
Parse the definition of a set of resources from a script file. More... | |
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. More... | |
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). More... | |
virtual void | reloadAll (bool reloadableOnly=true) |
Caused all currently loaded resources to be reloaded. More... | |
virtual void | reloadUnreferencedResources (bool reloadableOnly=true) |
Caused all currently loaded but not referenced by any other object resources to be reloaded. More... | |
virtual void | remove (ResourcePtr &r) |
Remove a single resource. More... | |
virtual void | remove (const String &name) |
Remove a single resource by name. More... | |
virtual void | remove (ResourceHandle handle) |
Remove a single resource by handle. More... | |
virtual void | removeAll (void) |
Removes all resources. More... | |
virtual void | removeUnreferencedResources (bool reloadableOnly=true) |
Remove all resources which are not referenced by any other object. More... | |
virtual bool | resourceExists (const String &name) |
Returns whether the named resource exists in this manager. More... | |
virtual bool | resourceExists (ResourceHandle handle) |
Returns whether a resource with the given handle exists in this manager. More... | |
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. More... | |
virtual void | setMemoryBudget (size_t bytes) |
Set a limit on the amount of memory this resource handler may use. More... | |
virtual void | setPreferredBitDepths (ushort integerBits, ushort floatBits, bool reloadTextures=true) |
Sets preferred bit depth for integer and float pixel format. More... | |
virtual void | setPreferredFloatBitDepth (ushort bits, bool reloadTextures=true) |
Sets preferred bit depth for float pixel format textures. More... | |
virtual void | setPreferredIntegerBitDepth (ushort bits, bool reloadTextures=true) |
Sets preferred bit depth for integer pixel format textures. More... | |
virtual void | setVerbose (bool v) |
Sets whether this manager and its resources habitually produce log output. More... | |
virtual void | unload (const String &name) |
Unloads a single resource by name. More... | |
virtual void | unload (ResourceHandle handle) |
Unloads a single resource by handle. More... | |
virtual void | unloadAll (bool reloadableOnly=true) |
Unloads all resources. More... | |
virtual void | unloadUnreferencedResources (bool reloadableOnly=true) |
Unload all resources which are not referenced by any other object. More... | |
Static Public Member Functions | |
static TextureManager & | getSingleton (void) |
Override standard Singleton retrieval. More... | |
static TextureManager * | getSingletonPtr (void) |
Override standard Singleton retrieval. More... | |
Protected Types | |
typedef map< String, ResourcePool * >::type | ResourcePoolMap |
Protected Member Functions | |
virtual void | addImpl (ResourcePtr &res) |
Add a newly created resource to the manager (note weak reference) More... | |
virtual void | checkUsage (void) |
Checks memory usage and pages out if required. More... | |
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). More... | |
ResourceHandle | getNextHandle (void) |
Allocates the next handle. More... | |
virtual void | removeImpl (ResourcePtr &res) |
Remove a resource from this manager; remove it from the lists. More... | |
Protected Attributes | |
size_t | mDefaultNumMipmaps |
Real | mLoadOrder |
Loading order relative to other managers, higher is later. More... | |
size_t | mMemoryBudget |
size_t | mMemoryUsage |
ResourceHandle | mNextHandle |
ushort | mPreferredFloatBitDepth |
ushort | mPreferredIntegerBitDepth |
ResourcePoolMap | mResourcePoolMap |
ResourceMap | mResources |
ResourceHandleMap | mResourcesByHandle |
ResourceWithGroupMap | mResourcesWithGroup |
String | mResourceType |
String identifying the resource type this manager handles. More... | |
StringVector | mScriptPatterns |
Patterns to use to look for scripts if supported (e.g. *.overlay) More... | |
bool | mVerbose |
Static Protected Attributes | |
static TextureManager * | ms_Singleton |
Class for loading & managing textures.
Definition at line 60 of file OgreTextureManager.h.
|
inherited |
Definition at line 103 of file OgreResourceManager.h.
|
inherited |
Definition at line 494 of file OgreResourceManager.h.
|
inherited |
Definition at line 492 of file OgreResourceManager.h.
|
inherited |
Definition at line 515 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 526 of file OgreResourceManager.h.
|
inherited |
Definition at line 493 of file OgreResourceManager.h.
Ogre::TextureManager::TextureManager | ( | void | ) |
|
virtual |
|
virtualinherited |
Notify this manager that a resource which it manages has been loaded.
|
virtualinherited |
Notify this manager that a resource which it manages has been 'touched', i.e.
used.
|
virtualinherited |
Notify this manager that a resource which it manages has been unloaded.
|
protectedvirtualinherited |
Add a newly created resource to the manager (note weak reference)
|
protectedvirtualinherited |
Checks memory usage and pages out if required.
|
virtualinherited |
Creates a new blank resource, but does not immediately load it.
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 |
|
protectedpure virtualinherited |
Create a new resource instance compatible with this manager (no custom parameters are populated at this point).
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. |
Implemented in Ogre::MeshManager, Ogre::MaterialManager, Ogre::BspResourceManager, Ogre::SkeletonManager, Ogre::FontManager, Ogre::HighLevelGpuProgramManager, Ogre::CompositorManager, Ogre::GLTextureManager, Ogre::GLESTextureManager, Ogre::GLGpuProgramManager, Ogre::GLESGpuProgramManager, Ogre::D3D10GpuProgramManager, Ogre::D3D11GpuProgramManager, Ogre::D3D10TextureManager, Ogre::D3D11TextureManager, Ogre::D3D9GpuProgramManager, and Ogre::D3D9TextureManager.
|
virtual |
Create a manual texture with specified width, height and depth (not loaded from a file).
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. |
|
inline |
Create a manual texture with a depth of 1 (not loaded from a file).
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 |
Create a new texture, or retrieve an existing one with the same name if it already exists.
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. |
|
virtualinherited |
Create a new resource, or retrieve an existing one with the same name if it already exists.
|
inherited |
destroy all pools
|
inherited |
Destroy a resource pool.
|
inherited |
Destroy a resource pool.
|
virtualinherited |
Retrieves a pointer to a resource by handle, or null if the resource does not exist.
|
virtualinherited |
Retrieves a pointer to a resource by name, or null if the resource does not exist.
|
inlinevirtual |
Gets the default number of mipmaps to be used for loaded textures.
Definition at line 460 of file OgreTextureManager.h.
|
inlinevirtualinherited |
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader.
Definition at line 412 of file OgreResourceManager.h.
|
virtualinherited |
Get the limit on the amount of memory this resource handler may use.
|
inlinevirtualinherited |
Gets the current memory usage, in bytes.
Definition at line 136 of file OgreResourceManager.h.
|
pure virtual |
Gets the format which will be natively used for a requested format given the constraints of the current device.
Implemented in Ogre::D3D10TextureManager, Ogre::D3D11TextureManager, Ogre::D3D9TextureManager, Ogre::GLESTextureManager, and Ogre::GLTextureManager.
|
protectedinherited |
Allocates the next handle.
|
virtual |
gets preferred bit depth for float pixel format textures.
|
virtual |
gets preferred bit depth for integer pixel format textures.
|
inlineinherited |
Returns an iterator over all resources in this manager.
Definition at line 520 of file OgreResourceManager.h.
|
inherited |
Create a resource pool, or reuse one that already exists.
|
inlineinherited |
Gets a string identifying the type of resource this manager handles.
Definition at line 415 of file OgreResourceManager.h.
|
inlinevirtualinherited |
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader.
Definition at line 388 of file OgreResourceManager.h.
|
static |
Override standard Singleton retrieval.
|
static |
Override standard Singleton retrieval.
|
inlinevirtualinherited |
Gets whether this manager and its resources habitually produce log output.
Definition at line 421 of file OgreResourceManager.h.
|
virtual |
Returns whether this render system can support the texture format requested with the given usage options, or another format with no quality reduction.
|
virtual |
Returns whether this render system can natively support the precise texture format requested with the given usage options.
format | The pixel format requested |
usage | The kind of usage this texture is intended for, a combination of the TextureUsage flags. |
|
pure virtual |
Returns whether this render system has hardware filtering supported for the texture format requested with the given usage options.
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. |
Implemented in Ogre::D3D10TextureManager, Ogre::D3D11TextureManager, Ogre::D3D9TextureManager, Ogre::GLESTextureManager, and Ogre::GLTextureManager.
|
virtual |
Loads a texture from a file.
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. |
|
virtualinherited |
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).
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 |
Loads a texture from an Image object.
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 |
Loads a texture from a raw data stream.
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. |
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
|
inlinevirtualinherited |
Parse the definition of a set of resources from a script file.
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 |
Prepares to loads a texture from a file.
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. |
|
virtualinherited |
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).
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 |
|
virtualinherited |
Caused all currently loaded resources to be reloaded.
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. |
|
virtualinherited |
Caused all currently loaded but not referenced by any other object resources to be reloaded.
reloadableOnly | If true (the default), only reloads resources which can be subsequently automatically reloaded. |
|
virtualinherited |
Remove a single resource.
|
virtualinherited |
Remove a single resource by name.
|
virtualinherited |
Remove a single resource by handle.
|
virtualinherited |
Removes all resources.
Reimplemented in Ogre::CompositorManager.
|
protectedvirtualinherited |
Remove a resource from this manager; remove it from the lists.
|
virtualinherited |
Remove all resources which are not referenced by any other object.
reloadableOnly | If true (the default), only removes resources which can be subsequently automatically reloaded. |
|
inlinevirtualinherited |
Returns whether the named resource exists in this manager.
Definition at line 308 of file OgreResourceManager.h.
|
inlinevirtualinherited |
Returns whether a resource with the given handle exists in this manager.
Definition at line 313 of file OgreResourceManager.h.
|
virtual |
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.
|
virtualinherited |
Set a limit on the amount of memory this resource handler may use.
|
virtual |
Sets preferred bit depth for integer and float pixel format.
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 |
Sets preferred bit depth for float pixel format textures.
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 |
Sets preferred bit depth for integer pixel format textures.
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. |
|
inlinevirtualinherited |
Sets whether this manager and its resources habitually produce log output.
Definition at line 418 of file OgreResourceManager.h.
|
virtualinherited |
Unloads a single resource by name.
|
virtualinherited |
Unloads a single resource by handle.
|
virtualinherited |
Unloads all resources.
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. |
|
virtualinherited |
Unload all resources which are not referenced by any other object.
reloadableOnly | If true (the default), only unloads resources which can be subsequently automatically reloaded. |
|
protected |
Definition at line 502 of file OgreTextureManager.h.
|
protectedinherited |
Loading order relative to other managers, higher is later.
Definition at line 510 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 500 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 501 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 499 of file OgreResourceManager.h.
|
protected |
Definition at line 501 of file OgreTextureManager.h.
|
protected |
Definition at line 500 of file OgreTextureManager.h.
|
protectedinherited |
Definition at line 527 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 497 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 496 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 498 of file OgreResourceManager.h.
|
protectedinherited |
String identifying the resource type this manager handles.
Definition at line 512 of file OgreResourceManager.h.
|
staticprotectedinherited |
Definition at line 75 of file OgreSingleton.h.
|
protectedinherited |
Patterns to use to look for scripts if supported (e.g. *.overlay)
Definition at line 508 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 503 of file OgreResourceManager.h.