OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::TextureManager Class Referenceabstract

Class for loading & managing textures. More...

#include <OgreTextureManager.h>

+ Inheritance diagram for Ogre::TextureManager:

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...
 
TexturePtr create (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
 Create a new texture. 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...
 
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...
 
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...
 
SamplerPtr createSampler (const String &name=BLANKSTRING)
 create a new sampler 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 SamplerPtrgetDefaultSampler ()
 get the default sampler 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...
 
const SamplerPtrgetSampler (const String &name) const
 retrieve an named sampler 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, int numMipmaps, Real gamma, bool isAlpha, PixelFormat desiredFormat=PF_UNKNOWN, bool hwGammaCorrection=false)
 
TexturePtr load (const String &name, const String &group, TextureType texType=TEX_TYPE_2D, int numMipmaps=MIP_DEFAULT, Real gamma=1.0f, PixelFormat desiredFormat=PF_UNKNOWN, bool hwGammaCorrection=false)
 Loads a texture from a file. 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...
 
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 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...
 
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...
 
- Public Member Functions inherited from Ogre::ResourceManager
 ResourceManager ()
 
virtual ~ResourceManager ()
 
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...
 
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...
 
void destroyAllResourcePools ()
 destroy all pools More...
 
void destroyResourcePool (const String &name)
 Destroy a resource pool. More...
 
void destroyResourcePool (ResourcePool *pool)
 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...
 
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 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...
 
ResourcePoolgetResourcePool (const String &name)
 Create a resource pool, or reuse one that already exists. More...
 
const StringgetResourceType (void) const
 Gets a string identifying the type of resource this manager handles. More...
 
const StringVectorgetScriptPatterns (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...
 
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...
 
void parseScript (DataStreamPtr &stream, const String &groupName)
 Parse the definition of a set of resources from a script 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)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void remove (ResourceHandle handle)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. 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...
 
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...
 
void setMemoryBudget (size_t bytes)
 Set a limit on the amount of memory this resource handler may use. 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...
 
- Public Member Functions inherited from Ogre::ScriptLoader
virtual ~ScriptLoader ()
 
- Public Member Functions inherited from Ogre::Singleton< TextureManager >
 Singleton (void)
 
 ~Singleton (void)
 

Static Public Member Functions

static TextureManagergetSingleton (void)
 Get the singleton instance. More...
 
static TextureManagergetSingletonPtr (void)
 Get the singleton instance. More...
 
- Static Public Member Functions inherited from Ogre::Singleton< TextureManager >
static TextureManagergetSingleton (void)
 Get the singleton instance. More...
 
static TextureManagergetSingletonPtr (void)
 Get the singleton instance. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::ResourceManager
typedef std::pair< ResourcePtr, bool > ResourceCreateOrRetrieveResult
 
typedef std::map< ResourceHandle, ResourcePtrResourceHandleMap
 
typedef std::unordered_map< String, ResourcePtrResourceMap
 
typedef MapIterator< ResourceHandleMapResourceMapIterator
 
typedef std::unordered_map< String, ResourceMapResourceWithGroupMap
 

Detailed Description

Class for loading & managing textures.

Remarks
Note that this class is abstract - the particular RenderSystem that is in use at the time will create a concrete subclass of this. Note that the concrete class will be available via the abstract singleton obtained from TextureManager::getSingleton(), but you should not assume that it is available until you have a) initialised Ogre (after selecting a RenderSystem and calling initialise from the Root object), and b) created at least one window - this may be done at the same time as part a if you allow Ogre to autocreate one.

Constructor & Destructor Documentation

◆ TextureManager()

Ogre::TextureManager::TextureManager ( void  )

◆ ~TextureManager()

virtual Ogre::TextureManager::~TextureManager ( )
virtual

Member Function Documentation

◆ createSampler()

SamplerPtr Ogre::TextureManager::createSampler ( const String name = BLANKSTRING)

create a new sampler

◆ getSampler()

const SamplerPtr& Ogre::TextureManager::getSampler ( const String name) const

retrieve an named sampler

◆ create()

TexturePtr Ogre::TextureManager::create ( const String name,
const String group,
bool  isManual = false,
ManualResourceLoader loader = 0,
const NameValuePairList createParams = 0 
)

Create a new texture.

Parameters
nameThe unique name of the Resource
groupThe name of the resource group to attach this new resource to
isManualIs 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.
loaderPointer 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.
createParamsIf any parameters are required to create an instance, they should be supplied here as name / value pairs

◆ getByName()

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.

◆ createOrRetrieve() [1/2]

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.

Parameters
nameThe unique name of the Resource
groupThe name of the resource group to attach this new resource to
isManualIs 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.
loaderPointer 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.
createParamsIf any parameters are required to create an instance, they should be supplied here as name / value pairs
texTypeThe type of texture to load/create, defaults to normal 2D textures
numMipmapsThe 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.
gammaThe gamma adjustment factor to apply to this texture (brightening/darkening)
isAlphadeprecated: same as specifying PF_A8 for desiredFormat
desiredFormatThe format you would like to have used instead of the format being based on the contents of the texture
hwGammaCorrectionPass '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.

◆ prepare()

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.

Parameters
nameThe file to load, or a String identifier in some cases
groupThe name of the resource group to assign the texture to
texTypeThe type of texture to load/create, defaults to normal 2D textures
numMipmapsThe 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.
gammaThe gamma adjustment factor to apply to this texture (brightening/darkening)
desiredFormatThe 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.
hwGammaCorrectionpass '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.
isAlphadeprecated: same as specifying PF_A8 for desiredFormat

◆ load() [1/2]

TexturePtr Ogre::TextureManager::load ( const String name,
const String group,
TextureType  texType = TEX_TYPE_2D,
int  numMipmaps = MIP_DEFAULT,
Real  gamma = 1.0f,
PixelFormat  desiredFormat = PF_UNKNOWN,
bool  hwGammaCorrection = false 
)

Loads a texture from a file.

Parameters
nameThe file to load, or a String identifier in some cases
groupThe name of the resource group to assign the texture to
texTypeThe type of texture to load/create, defaults to normal 2D textures
numMipmapsThe 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.
gammaThe gamma adjustment factor to apply to this texture (brightening/darkening)
desiredFormatThe 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.
hwGammaCorrectionpass '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.

◆ load() [2/2]

TexturePtr Ogre::TextureManager::load ( const String name,
const String group,
TextureType  texType,
int  numMipmaps,
Real  gamma,
bool  isAlpha,
PixelFormat  desiredFormat = PF_UNKNOWN,
bool  hwGammaCorrection = false 
)

◆ loadImage()

virtual TexturePtr Ogre::TextureManager::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 
)
virtual

Loads a texture from an Image object.

Note
The texture will create as manual texture without loader.
Parameters
nameThe file to load, or a String identifier in some cases
groupThe name of the resource group to assign the texture to
texTypeThe type of texture to load/create, defaults to normal 2D textures
numMipmapsThe 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.
gammaThe gamma adjustment factor to apply to this texture (brightening/darkening)
desiredFormatThe 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.
hwGammaCorrectionpass '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.
isAlphadeprecated: same as specifying PF_A8 for desiredFormat
imgThe Image object which contains the data to load

◆ loadRawData()

virtual TexturePtr Ogre::TextureManager::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 
)
virtual

Loads a texture from a raw data stream.

Note
The texture will create as manual texture without loader.
Parameters
nameThe name to give the resulting texture
groupThe name of the resource group to assign the texture to
streamIncoming data stream
widthThe width of the texture
heightThe height of the texture
formatThe 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.
texTypeThe type of texture to load/create, defaults to normal 2D textures
numMipmapsThe 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.
gammaThe gamma adjustment factor to apply to this texture (brightening/darkening) while loading
hwGammaCorrectionPass '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.

◆ createManual() [1/2]

virtual TexturePtr Ogre::TextureManager::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 
)
virtual

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

Parameters
nameThe name to give the resulting texture
groupThe name of the resource group to assign the texture to
texTypeThe type of texture to load/create, defaults to normal 2D textures
widthThe width of the texture
heightThe height of the texture
depthThe depth of the texture
numMipmapsThe 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.
formatThe 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.
usageThe 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_GPU_ONLY wherever possible, if you need to update regularly, consider HBU_CPU_TO_GPU.
loaderIf 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.
hwGammaCorrectionpass '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.
fsaaThe 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.
fsaaHintspecify "Quality" to enable CSAA on D3D

◆ createManual() [2/2]

TexturePtr Ogre::TextureManager::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 
)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ setPreferredIntegerBitDepth()

virtual void Ogre::TextureManager::setPreferredIntegerBitDepth ( ushort  bits,
bool  reloadTextures = true 
)
virtual

Sets preferred bit depth for integer pixel format textures.

Parameters
bitsNumber 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.
reloadTexturesIf true (the default), will reloading all reloadable textures.

◆ getPreferredIntegerBitDepth()

virtual ushort Ogre::TextureManager::getPreferredIntegerBitDepth ( void  ) const
virtual

Gets preferred bit depth for integer pixel format textures.

◆ setPreferredFloatBitDepth()

virtual void Ogre::TextureManager::setPreferredFloatBitDepth ( ushort  bits,
bool  reloadTextures = true 
)
virtual

Sets preferred bit depth for float pixel format textures.

Parameters
bitsNumber 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.
reloadTexturesIf true (the default), will reloading all reloadable textures.

◆ getPreferredFloatBitDepth()

virtual ushort Ogre::TextureManager::getPreferredFloatBitDepth ( void  ) const
virtual

Gets preferred bit depth for float pixel format textures.

◆ setPreferredBitDepths()

virtual void Ogre::TextureManager::setPreferredBitDepths ( ushort  integerBits,
ushort  floatBits,
bool  reloadTextures = true 
)
virtual

Sets preferred bit depth for integer and float pixel format.

Parameters
integerBitsNumber 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.
floatBitsNumber 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.
reloadTexturesIf true (the default), will reloading all reloadable textures.

◆ isFormatSupported()

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.

Remarks
You can still create textures with this format even if this method returns false; the texture format will just be altered to one which the device does support.
Note
Sometimes the device may just slightly change the format, such as reordering the channels or packing the channels differently, without it making and qualitative differences to the texture. If you want to just detect whether the quality of a given texture will be reduced, use isEquivalentFormatSupport instead.
Parameters
ttypeThe type of texture
formatThe pixel format requested
usageThe kind of usage this texture is intended for, a combination of the TextureUsage flags.
Returns
true if the format is natively supported, false if a fallback would be used.

◆ isEquivalentFormatSupported()

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.

◆ getNativeFormat()

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.

Implemented in Ogre::DefaultTextureManager, Ogre::MetalTextureManager, Ogre::D3D11TextureManager, Ogre::GL3PlusTextureManager, Ogre::D3D9TextureManager, Ogre::GLES2TextureManager, Ogre::GLTextureManager, and Ogre::GLTextureManagerCommon.

◆ isHardwareFilteringSupported()

virtual bool Ogre::TextureManager::isHardwareFilteringSupported ( TextureType  ttype,
PixelFormat  format,
int  usage,
bool  preciseFormatOnly = false 
)
virtual

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

Remarks
Not all texture format are supports filtering by the hardware, i.e. some cards support floating point format, but it doesn't supports filtering on the floating point texture at all, or only a subset floating point formats have flitering supported.
In the case you want to write shader to work with floating point texture, and you want to produce better visual quality, it's necessary to flitering the texture manually in shader (potential requires four or more texture fetch instructions, plus several arithmetic instructions) if filtering doesn't supported by hardware. But in case on the hardware that supports floating point filtering natively, it had better to adopt this capability for performance (because only one texture fetch instruction are required) and doesn't loss visual quality.
This method allow you queries hardware texture filtering capability to deciding which verion of the shader to be used. Note it's up to you to write multi-version shaders for support various hardware, internal engine can't do that for you automatically.
Note
Under GL, texture filtering are always supported by driver, but if it's not supported by hardware natively, software simulation will be used, and you will end up with very slow speed (less than 0.1 fps for example). To slove this performance problem, you must disable filtering manually (by use filtering none in the material script's texture_unit section, or call TextureUnitState::setTextureFiltering with TFO_NONE if populate material in code).
Parameters
ttypeThe texture type requested
formatThe pixel format requested
usageThe kind of usage this texture is intended for, a combination of the TextureUsage flags.
preciseFormatOnlyWhether precise or fallback format mode is used to detecting. In case the pixel format doesn't supported by device, false will be returned if in precise mode, and natively used pixel format will be actually use to check if in fallback mode.
Returns
true if the texture filtering is supported.

Reimplemented in Ogre::DefaultTextureManager, Ogre::D3D9TextureManager, Ogre::GLES2TextureManager, and Ogre::GLTextureManager.

◆ setDefaultNumMipmaps()

virtual void Ogre::TextureManager::setDefaultNumMipmaps ( uint32  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.

Note
The default value is 0.

◆ getDefaultNumMipmaps()

virtual uint32 Ogre::TextureManager::getDefaultNumMipmaps ( )
inlinevirtual

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

◆ _getWarningTexture()

const TexturePtr& Ogre::TextureManager::_getWarningTexture ( )

Internal method to create a warning texture (bound when a texture unit is blank)

◆ getDefaultSampler()

const SamplerPtr& Ogre::TextureManager::getDefaultSampler ( )

get the default sampler

◆ getSingleton()

static TextureManager& Ogre::TextureManager::getSingleton ( void  )
static

Get the singleton instance.

◆ getSingletonPtr()

static TextureManager* Ogre::TextureManager::getSingletonPtr ( void  )
static

Get the singleton instance.

◆ createOrRetrieve() [2/2]

ResourceCreateOrRetrieveResult Ogre::ResourceManager::createOrRetrieve

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

Remarks
This method performs the same task as calling getByName() followed by create() if that returns null. The advantage is that it does it in one call so there are no race conditions if using multiple threads that could cause getByName() to return null, but create() to fail because another thread created a resource in between.
Parameters
nameThe unique name of the Resource
groupThe name of the resource group to attach this new resource to
isManualIs 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.
loaderPointer 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.
createParamsIf any parameters are required to create an instance, they should be supplied here as name / value pairs
Returns
A pair, the first element being the pointer, and the second being an indicator specifying whether the resource was newly created.

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