#include <OgreTextureManager.h>
Public Types | |
typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult |
typedef HashMap< String, ResourcePtr > | ResourceMap |
typedef std::map < ResourceHandle, ResourcePtr > | ResourceHandleMap |
typedef MapIterator < ResourceHandleMap > | ResourceMapIterator |
Public Member Functions | |
TextureManager (void) | |
virtual | ~TextureManager () |
virtual 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 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 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 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) |
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) |
Create a manual texture with a depth of 1 (not loaded from a file). | |
virtual void | setPreferredIntegerBitDepth (ushort bits, bool reloadTextures=true) |
Sets preferred bit depth for integer pixel format textures. | |
virtual ushort | getPreferredIntegerBitDepth (void) const |
gets preferred bit depth for integer pixel format textures. | |
virtual void | setPreferredFloatBitDepth (ushort bits, bool reloadTextures=true) |
Sets preferred bit depth for float pixel format textures. | |
virtual ushort | getPreferredFloatBitDepth (void) const |
gets preferred bit depth for float pixel format textures. | |
virtual void | setPreferredBitDepths (ushort integerBits, ushort floatBits, bool reloadTextures=true) |
Sets preferred bit depth for integer and float pixel format. | |
virtual bool | isFormatSupported (TextureType ttype, PixelFormat format, int usage) |
Returns whether this render system can natively support the precise texture format requested with the given usage options. | |
virtual bool | isEquivalentFormatSupported (TextureType ttype, PixelFormat format, int usage) |
Returns whether this render system can support the texture format requested with the given usage options, or another format with no quality reduction. | |
virtual PixelFormat | getNativeFormat (TextureType ttype, PixelFormat format, int usage)=0 |
Gets the format which will be natively used for a requested format given the constraints of the current device. | |
virtual bool | isHardwareFilteringSupported (TextureType ttype, PixelFormat format, int usage, bool preciseFormatOnly=false)=0 |
Returns whether this render system has hardware filtering supported for the texture format requested with the given usage options. | |
virtual void | setDefaultNumMipmaps (size_t num) |
Sets the default number of mipmaps to be used for loaded textures, for when textures are loaded automatically (e.g. | |
virtual size_t | getDefaultNumMipmaps () |
Gets the default number of mipmaps to be used for loaded textures. | |
virtual ResourcePtr | create (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0) |
Creates a new blank resource, but does not immediately load it. | |
virtual ResourceCreateOrRetrieveResult | createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0) |
Create a new resource, or retrieve an existing one with the same name if it already exists. | |
virtual void | setMemoryBudget (size_t bytes) |
Set a limit on the amount of memory this resource handler may use. | |
virtual size_t | getMemoryBudget (void) const |
Get the limit on the amount of memory this resource handler may use. | |
virtual size_t | getMemoryUsage (void) const |
Gets the current memory usage, in bytes. | |
virtual void | unload (const String &name) |
Unloads a single resource by name. | |
virtual void | unload (ResourceHandle handle) |
Unloads a single resource by handle. | |
virtual void | unloadAll (bool reloadableOnly=true) |
Unloads all resources. | |
virtual void | reloadAll (bool reloadableOnly=true) |
Caused all currently loaded resources to be reloaded. | |
virtual void | unloadUnreferencedResources (bool reloadableOnly=true) |
Unload all resources which are not referenced by any other object. | |
virtual void | reloadUnreferencedResources (bool reloadableOnly=true) |
Caused all currently loaded but not referenced by any other object resources to be reloaded. | |
virtual void | remove (ResourcePtr &r) |
Remove a single resource. | |
virtual void | remove (const String &name) |
Remove a single resource by name. | |
virtual void | remove (ResourceHandle handle) |
Remove a single resource by handle. | |
virtual void | removeAll (void) |
Removes all resources. | |
virtual ResourcePtr | getByName (const String &name) |
Retrieves a pointer to a resource by name, or null if the resource does not exist. | |
virtual ResourcePtr | getByHandle (ResourceHandle handle) |
Retrieves a pointer to a resource by handle, or null if the resource does not exist. | |
virtual bool | resourceExists (const String &name) |
Returns whether the named resource exists in this manager. | |
virtual bool | resourceExists (ResourceHandle handle) |
Returns whether a resource with the given handle exists in this manager. | |
virtual void | _notifyResourceTouched (Resource *res) |
Notify this manager that a resource which it manages has been 'touched', 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 ResourcePtr | prepare (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0) |
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 ResourcePtr | load (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0) |
Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters). | |
virtual const StringVector & | getScriptPatterns (void) const |
Gets the file patterns which should be used to find scripts for this ResourceManager. | |
virtual void | parseScript (DataStreamPtr &stream, const String &groupName) |
Parse the definition of a set of resources from a script file. | |
virtual Real | getLoadingOrder (void) const |
Gets the relative loading order of resources of this type. | |
const String & | getResourceType (void) const |
Gets a string identifying the type of resource this manager handles. | |
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. | |
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 Member Functions | |
ResourceHandle | getNextHandle (void) |
Allocates the next handle. | |
virtual Resource * | createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *createParams)=0 |
Create a new resource instance compatible with this manager (no custom parameters are populated at this point). | |
virtual void | addImpl (ResourcePtr &res) |
Add a newly created resource to the manager (note weak reference). | |
virtual void | removeImpl (ResourcePtr &res) |
Remove a resource from this manager; remove it from the lists. | |
virtual void | checkUsage (void) |
Checks memory usage and pages out if required. | |
Protected Attributes | |
ushort | mPreferredIntegerBitDepth |
ushort | mPreferredFloatBitDepth |
size_t | mDefaultNumMipmaps |
ResourceHandleMap | mResourcesByHandle |
ResourceMap | mResources |
ResourceHandle | mNextHandle |
size_t | mMemoryBudget |
size_t | mMemoryUsage |
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. | |
Static Protected Attributes | |
static T * | ms_Singleton |
Definition at line 55 of file OgreTextureManager.h.
typedef std::pair<ResourcePtr, bool> Ogre::ResourceManager::ResourceCreateOrRetrieveResult [inherited] |
Definition at line 98 of file OgreResourceManager.h.
typedef HashMap< String, ResourcePtr > Ogre::ResourceManager::ResourceMap [inherited] |
Definition at line 434 of file OgreResourceManager.h.
typedef std::map<ResourceHandle, ResourcePtr> Ogre::ResourceManager::ResourceHandleMap [inherited] |
Definition at line 435 of file OgreResourceManager.h.
typedef MapIterator<ResourceHandleMap> Ogre::ResourceManager::ResourceMapIterator [inherited] |
Definition at line 455 of file OgreResourceManager.h.
Ogre::TextureManager::TextureManager | ( | void | ) |
virtual Ogre::TextureManager::~TextureManager | ( | ) | [virtual] |
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] |
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. |
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] |
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. |
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] |
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. |
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] |
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 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] |
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. |
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 | |||
) | [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. |
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 | |||
) |
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 326 of file OgreTextureManager.h.
virtual void Ogre::TextureManager::setPreferredIntegerBitDepth | ( | ushort | bits, | |
bool | reloadTextures = true | |||
) | [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 ushort Ogre::TextureManager::getPreferredIntegerBitDepth | ( | void | ) | const [virtual] |
gets preferred bit depth for integer pixel format textures.
virtual void Ogre::TextureManager::setPreferredFloatBitDepth | ( | ushort | bits, | |
bool | reloadTextures = true | |||
) | [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 ushort Ogre::TextureManager::getPreferredFloatBitDepth | ( | void | ) | const [virtual] |
gets preferred bit depth for float pixel format textures.
virtual void Ogre::TextureManager::setPreferredBitDepths | ( | ushort | integerBits, | |
ushort | floatBits, | |||
bool | reloadTextures = true | |||
) | [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 bool Ogre::TextureManager::isFormatSupported | ( | TextureType | ttype, | |
PixelFormat | format, | |||
int | usage | |||
) | [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. |
virtual bool Ogre::TextureManager::isEquivalentFormatSupported | ( | TextureType | ttype, | |
PixelFormat | format, | |||
int | usage | |||
) | [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 PixelFormat Ogre::TextureManager::getNativeFormat | ( | TextureType | ttype, | |
PixelFormat | format, | |||
int | usage | |||
) | [pure virtual] |
Gets the format which will be natively used for a requested format given the constraints of the current device.
virtual bool Ogre::TextureManager::isHardwareFilteringSupported | ( | TextureType | ttype, | |
PixelFormat | format, | |||
int | usage, | |||
bool | preciseFormatOnly = false | |||
) | [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. |
virtual void Ogre::TextureManager::setDefaultNumMipmaps | ( | size_t | num | ) | [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.
virtual size_t Ogre::TextureManager::getDefaultNumMipmaps | ( | ) | [virtual] |
Gets the default number of mipmaps to be used for loaded textures.
Definition at line 455 of file OgreTextureManager.h.
static TextureManager& Ogre::TextureManager::getSingleton | ( | void | ) | [static] |
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< T >.
static TextureManager* Ogre::TextureManager::getSingletonPtr | ( | void | ) | [static] |
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< T >.
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.
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 |
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.
virtual void Ogre::ResourceManager::setMemoryBudget | ( | size_t | bytes | ) | [virtual, inherited] |
Set a limit on the amount of memory this resource handler may use.
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] |
virtual void Ogre::ResourceManager::unload | ( | const String & | name | ) | [virtual, inherited] |
Unloads a single resource by name.
virtual void Ogre::ResourceManager::unload | ( | ResourceHandle | handle | ) | [virtual, inherited] |
Unloads a single resource by handle.
virtual void Ogre::ResourceManager::unloadAll | ( | bool | reloadableOnly = true |
) | [virtual, inherited] |
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. |
virtual void Ogre::ResourceManager::reloadAll | ( | bool | reloadableOnly = true |
) | [virtual, inherited] |
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. |
virtual void Ogre::ResourceManager::unloadUnreferencedResources | ( | bool | reloadableOnly = true |
) | [virtual, inherited] |
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. |
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.
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.
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.
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.
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.
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 ResourcePtr Ogre::ResourceManager::getByName | ( | const String & | name | ) | [virtual, inherited] |
Retrieves a pointer to a resource by name, or null if the resource does not exist.
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 bool Ogre::ResourceManager::resourceExists | ( | const String & | name | ) | [virtual, inherited] |
Returns whether the named resource exists in this manager.
Definition at line 287 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 292 of file OgreResourceManager.h.
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::_notifyResourceLoaded | ( | Resource * | res | ) | [virtual, inherited] |
Notify this manager that a resource which it manages has been loaded.
virtual void Ogre::ResourceManager::_notifyResourceUnloaded | ( | Resource * | res | ) | [virtual, inherited] |
Notify this manager that a resource which it manages has been unloaded.
virtual ResourcePtr Ogre::ResourceManager::prepare | ( | const String & | name, | |
const String & | group, | |||
bool | isManual = false , |
|||
ManualResourceLoader * | loader = 0 , |
|||
const NameValuePairList * | loadParams = 0 | |||
) | [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).
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. |
virtual ResourcePtr Ogre::ResourceManager::load | ( | const String & | name, | |
const String & | group, | |||
bool | isManual = false , |
|||
ManualResourceLoader * | loader = 0 , |
|||
const NameValuePairList * | loadParams = 0 | |||
) | [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).
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. |
virtual const StringVector& Ogre::ResourceManager::getScriptPatterns | ( | void | ) | const [virtual, inherited] |
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader.
Definition at line 361 of file OgreResourceManager.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.
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::CompositorManager, Ogre::FontManager, and Ogre::MaterialManager.
Definition at line 376 of file OgreResourceManager.h.
virtual Real Ogre::ResourceManager::getLoadingOrder | ( | void | ) | const [virtual, inherited] |
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader.
Definition at line 384 of file OgreResourceManager.h.
const String& Ogre::ResourceManager::getResourceType | ( | void | ) | const [inherited] |
Gets a string identifying the type of resource this manager handles.
Definition at line 387 of file OgreResourceManager.h.
virtual void Ogre::ResourceManager::setVerbose | ( | bool | v | ) | [virtual, inherited] |
Sets whether this manager and its resources habitually produce log output.
Definition at line 390 of file OgreResourceManager.h.
virtual bool Ogre::ResourceManager::getVerbose | ( | void | ) | [virtual, inherited] |
Gets whether this manager and its resources habitually produce log output.
Definition at line 393 of file OgreResourceManager.h.
ResourceHandle Ogre::ResourceManager::getNextHandle | ( | void | ) | [protected, inherited] |
Allocates the next handle.
virtual Resource* Ogre::ResourceManager::createImpl | ( | const String & | name, | |
ResourceHandle | handle, | |||
const String & | group, | |||
bool | isManual, | |||
ManualResourceLoader * | loader, | |||
const NameValuePairList * | createParams | |||
) | [protected, pure virtual, inherited] |
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::CompositorManager, Ogre::FontManager, Ogre::HighLevelGpuProgramManager, Ogre::MaterialManager, Ogre::MeshManager, and Ogre::SkeletonManager.
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::removeImpl | ( | ResourcePtr & | res | ) | [protected, virtual, inherited] |
Remove a resource from this manager; remove it from the lists.
virtual void Ogre::ResourceManager::checkUsage | ( | void | ) | [protected, virtual, inherited] |
Checks memory usage and pages out if required.
ResourceMapIterator Ogre::ResourceManager::getResourceIterator | ( | void | ) | [inherited] |
Returns an iterator over all resources in this manager.
Definition at line 460 of file OgreResourceManager.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 67 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
void * | ptr | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 84 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 89 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
void * | ||||
) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 106 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
Definition at line 495 of file OgreTextureManager.h.
ushort Ogre::TextureManager::mPreferredFloatBitDepth [protected] |
Definition at line 496 of file OgreTextureManager.h.
size_t Ogre::TextureManager::mDefaultNumMipmaps [protected] |
Definition at line 497 of file OgreTextureManager.h.
ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle [protected, inherited] |
Definition at line 437 of file OgreResourceManager.h.
ResourceMap Ogre::ResourceManager::mResources [protected, inherited] |
Definition at line 438 of file OgreResourceManager.h.
ResourceHandle Ogre::ResourceManager::mNextHandle [protected, inherited] |
Definition at line 439 of file OgreResourceManager.h.
size_t Ogre::ResourceManager::mMemoryBudget [protected, inherited] |
Definition at line 440 of file OgreResourceManager.h.
size_t Ogre::ResourceManager::mMemoryUsage [protected, inherited] |
Definition at line 441 of file OgreResourceManager.h.
bool Ogre::ResourceManager::mVerbose [protected, inherited] |
Definition at line 443 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 448 of file OgreResourceManager.h.
Real Ogre::ResourceManager::mLoadOrder [protected, inherited] |
Loading order relative to other managers, higher is later.
Definition at line 450 of file OgreResourceManager.h.
String Ogre::ResourceManager::mResourceType [protected, inherited] |
String identifying the resource type this manager handles.
Definition at line 452 of file OgreResourceManager.h.
T* Ogre::Singleton< T >::ms_Singleton [static, protected, inherited] |
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:08:07 2009