OGRE
1.11.6
Object-Oriented Graphics Rendering Engine
|
Class for loading & managing textures. More...
#include <OgreTextureManager.h>
Public Types | |
typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult |
typedef std::map< ResourceHandle, ResourcePtr > | ResourceHandleMap |
typedef std::unordered_map< String, ResourcePtr > | ResourceMap |
typedef MapIterator< ResourceHandleMap > | ResourceMapIterator |
typedef std::unordered_map< String, ResourceMap > | ResourceWithGroupMap |
Public Member Functions | |
TextureManager (void) | |
virtual | ~TextureManager () |
const TexturePtr & | _getWarningTexture () |
Internal method to create a warning texture (bound when a texture unit is blank) More... | |
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... | |
TexturePtr | create (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0) |
Create a new texture. More... | |
virtual TexturePtr | createManual (const String &name, const String &group, TextureType texType, uint width, uint height, uint depth, int numMipmaps, PixelFormat format, int usage=TU_DEFAULT, ManualResourceLoader *loader=0, bool hwGammaCorrection=false, uint fsaa=0, const String &fsaaHint=BLANKSTRING) |
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 numMipmaps, PixelFormat format, int usage=TU_DEFAULT, ManualResourceLoader *loader=0, bool hwGammaCorrection=false, uint fsaa=0, const String &fsaaHint=BLANKSTRING) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... | |
ResourceCreateOrRetrieveResult | createOrRetrieve (const String &name, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *createParams, TextureType texType, int numMipmaps=MIP_DEFAULT, Real gamma=1.0f, bool isAlpha=false, PixelFormat desiredFormat=PF_UNKNOWN, bool hwGammaCorrection=false) |
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... | |
ResourcePtr | createResource (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... | |
SamplerPtr | createSampler (const String &name=BLANKSTRING) |
create a new sampler 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... | |
TexturePtr | getByName (const String &name, const String &groupName=RGN_DEFAULT) |
Retrieves a pointer to a resource by name, or null if the resource does not exist. More... | |
virtual uint32 | getDefaultNumMipmaps () |
Gets the default number of mipmaps to be used for loaded textures. More... | |
const SamplerPtr & | getDefaultSampler () |
get the default sampler More... | |
Real | getLoadingOrder (void) const |
Gets the relative loading order of resources of this type. More... | |
size_t | getMemoryBudget (void) const |
Get the limit on the amount of memory this resource handler may use. More... | |
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... | |
virtual ResourcePtr | getResourceByName (const String &name, const String &groupName=RGN_DEFAULT) |
Retrieves a pointer to a resource by name, or null if the resource does not exist. 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... | |
const SamplerPtr & | getSampler (const String &name) const |
retrieve an named sampler More... | |
const StringVector & | getScriptPatterns (void) const |
Gets the file patterns which should be used to find scripts for this ResourceManager. More... | |
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) |
Returns whether this render system has hardware filtering supported for the texture format requested with the given usage options. More... | |
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... | |
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 numMipmaps=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 width, ushort height, PixelFormat format, TextureType texType=TEX_TYPE_2D, int numMipmaps=MIP_DEFAULT, Real gamma=1.0f, bool hwGammaCorrection=false) |
Loads a texture from a raw data stream. More... | |
void | parseScript (DataStreamPtr &stream, const String &groupName) |
Parse the definition of a set of resources from a script file. More... | |
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... | |
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... | |
void | reloadAll (bool reloadableOnly=true) |
Caused all currently loaded resources to be reloaded. More... | |
virtual void | reloadAll (Resource::LoadingFlags flags) |
Caused all currently loaded resources to be reloaded. More... | |
void | reloadUnreferencedResources (bool reloadableOnly=true) |
Caused all currently loaded but not referenced by any other object resources to be reloaded. More... | |
void | remove (const ResourcePtr &r) |
Remove a single resource. More... | |
void | remove (const String &name, const String &group=RGN_DEFAULT) |
void | remove (ResourceHandle handle) |
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... | |
bool | resourceExists (const String &name, const String &group=RGN_DEFAULT) |
Returns whether the named resource exists in this manager. More... | |
bool | resourceExists (ResourceHandle handle) |
Returns whether a resource with the given handle exists in this manager. More... | |
virtual void | setDefaultNumMipmaps (uint32 num) |
Sets the default number of mipmaps to be used for loaded textures, for when textures are loaded automatically (e.g. More... | |
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... | |
void | setVerbose (bool v) |
Sets whether this manager and its resources habitually produce log output. More... | |
void | unload (const String &name, const String &group=RGN_DEFAULT) |
Unloads a single resource by name. More... | |
void | unload (ResourceHandle handle) |
Unloads a single resource by handle. More... | |
void | unloadAll (bool reloadableOnly=true) |
Unloads all resources. More... | |
virtual void | unloadAll (Resource::LoadingFlags flags) |
Unloads all resources. More... | |
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) |
Get the singleton instance. More... | |
static TextureManager * | getSingletonPtr (void) |
Get the singleton instance. More... | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
Class for loading & managing textures.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Ogre::TextureManager::TextureManager | ( | void | ) |
|
virtual |
|
inline |
create a new sampler
References OgreAssert.
|
inline |
retrieve an named sampler
References Ogre::BLANKSTRING, Ogre::ResourceManager::createOrRetrieve(), Ogre::MIP_DEFAULT, OGRE_RESOURCE_GROUP_INIT, Ogre::PF_UNKNOWN, Ogre::TEX_TYPE_2D, and Ogre::TU_DEFAULT.
TexturePtr Ogre::TextureManager::create | ( | const String & | name, |
const String & | group, | ||
bool | isManual = false , |
||
ManualResourceLoader * | loader = 0 , |
||
const NameValuePairList * | createParams = 0 |
||
) |
Create a new texture.
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 |
TexturePtr Ogre::TextureManager::getByName | ( | const String & | name, |
const String & | groupName = RGN_DEFAULT |
||
) |
Retrieves a pointer to a resource by name, or null if the resource does not exist.
Ogre::TextureManager::createOrRetrieve | ( | const String & | name, |
const String & | group, | ||
bool | isManual, | ||
ManualResourceLoader * | loader, | ||
const NameValuePairList * | createParams, | ||
TextureType | texType, | ||
int | numMipmaps = MIP_DEFAULT , |
||
Real | gamma = 1.0f , |
||
bool | isAlpha = false , |
||
PixelFormat | desiredFormat = PF_UNKNOWN , |
||
bool | hwGammaCorrection = false |
||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
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 |
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. |
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 |
||
) |
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; the manager reserves the right to create a different format for the texture if the original format is not available in this context. |
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. |
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 |
||
) |
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; the manager reserves the right to create a different format for the texture if the original format is not available in this context. |
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 an Image object.
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; the manager reserves the right to create a different format for the texture if the original format is not available in this context. |
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. |
img | The Image object which contains the data to load |
|
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 | The width of the texture |
height | The height 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. |
|
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 | The width of the texture |
height | The height of the texture |
depth | The depth 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. |
fsaaHint | specify "Quality" to enable CSAA on D3D |
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
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. |
|
virtual |
Gets preferred bit depth for integer pixel format 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 |
Gets preferred bit depth for float pixel format textures.
|
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 |
Returns whether this render system can natively support the precise texture format requested with the given usage options.
ttype | The type of texture |
format | The pixel format requested |
usage | The kind of usage this texture is intended for, a combination of the TextureUsage flags. |
|
virtual |
Returns whether this render system can support the texture format requested with the given usage options, or another format with no quality reduction.
|
pure virtual |
Gets the format which will be natively used for a requested format given the constraints of the current device.
Implemented in Ogre::GL3PlusTextureManager, Ogre::D3D11TextureManager, Ogre::D3D9TextureManager, Ogre::GLES2TextureManager, and Ogre::GLTextureManager.
|
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. |
Reimplemented in Ogre::D3D9TextureManager, Ogre::GLES2TextureManager, and Ogre::GLTextureManager.
|
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.
|
inlinevirtual |
Gets the default number of mipmaps to be used for loaded textures.
const TexturePtr& Ogre::TextureManager::_getWarningTexture | ( | ) |
Internal method to create a warning texture (bound when a texture unit is blank)
const SamplerPtr& Ogre::TextureManager::getDefaultSampler | ( | ) |
get the default sampler
|
static |
Get the singleton instance.
|
static |
Get the singleton instance.
|
inherited |
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 |
|
inherited |
Create a new resource, or retrieve an existing one with the same name if it already exists.
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 |
Referenced by getSampler().
|
inherited |
Set a limit on the amount of memory this resource handler may use.
|
inherited |
Get the limit on the amount of memory this resource handler may use.
|
inlineinherited |
Gets the current memory usage, in bytes.
References OGRE_RESOURCE_GROUP_INIT.
|
inherited |
Unloads a single resource by name.
|
inherited |
Unloads a single resource by handle.
|
inlineinherited |
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. |
References Ogre::Resource::LF_DEFAULT, and Ogre::Resource::LF_INCLUDE_NON_RELOADABLE.
|
virtualinherited |
Unloads all resources.
flags | Allow to restrict processing to only reloadable and/or unreferenced resources. |
|
inlineinherited |
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. |
References Ogre::Resource::LF_DEFAULT, and Ogre::Resource::LF_INCLUDE_NON_RELOADABLE.
|
virtualinherited |
Caused all currently loaded resources to be reloaded.
flags | Allow to restrict processing to only reloadable and/or unreferenced resources. Additionally, reloading could be done with preserving some selected resource states that could be used elsewhere. |
|
inlineinherited |
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. |
References Ogre::Resource::LF_ONLY_UNREFERENCED, and Ogre::Resource::LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE.
|
inlineinherited |
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. |
References Ogre::Resource::LF_ONLY_UNREFERENCED, Ogre::Resource::LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE, and OGRE_RESOURCE_GROUP_INIT.
|
inherited |
Remove a single resource.
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
virtualinherited |
Removes all resources.
Reimplemented in Ogre::CompositorManager.
|
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. |
|
virtualinherited |
Retrieves a pointer to a resource by name, or null if the resource does not exist.
Reimplemented in Ogre::GpuProgramManager.
|
virtualinherited |
Retrieves a pointer to a resource by handle, or null if the resource does not exist.
|
inlineinherited |
Returns whether the named resource exists in this manager.
|
inlineinherited |
Returns whether a resource with the given handle exists in this manager.
|
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 loaded.
|
virtualinherited |
Notify this manager that a resource which it manages has been unloaded.
|
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).
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 |
|
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).
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 |
|
inlinevirtualinherited |
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader.
|
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::FontManager.
|
inlinevirtualinherited |
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader.
|
inlineinherited |
Gets a string identifying the type of resource this manager handles.
|
inlineinherited |
Sets whether this manager and its resources habitually produce log output.
|
inlineinherited |
Gets whether this manager and its resources habitually produce log output.
|
inherited |
Create a resource pool, or reuse one that already exists.
|
inherited |
Destroy a resource pool.
|
inherited |
Destroy a resource pool.
|
inherited |
destroy all pools
|
inlineinherited |
Returns an iterator over all resources in this manager.
|
inherited |