Abstract class representing a Texture resource. More...

#include <OgreTexture.h>

Inheritance diagram for Ogre::Texture:

Public Member Functions
	Texture (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)

virtual	~Texture ()

void	_loadImages (const ConstImagePtrList &images)
	Internal method to load the texture from a set of images. More...

void	convertToImage (Image &destImage, bool includeMipMaps=false)
	Populate an Image with the contents of this texture. More...

virtual void	copyToTexture (TexturePtr &target)
	Copies (and maybe scales to fit) the contents of this texture to another texture. More...

void	createInternalResources (void)
	Creates the internal texture resources for this texture. More...

virtual void	createShaderAccessPoint (uint bindPoint, TextureAccess access=TA_READ_WRITE, int mipmapLevel=0, int textureArrayIndex=0, PixelFormat format=PF_UNKNOWN)
	Enable read and/or write privileges to the texture from shaders. More...

void	freeInternalResources (void)

virtual const HardwarePixelBufferSharedPtr &	getBuffer (size_t face=0, size_t mipmap=0)
	Return hardware pixel buffer for a surface. More...

uint	getCustomAttribute (const String &name)
	simplified API for bindings More...

virtual void	getCustomAttribute (const String &name, void *pData)
	Retrieve a platform or API-specific piece of information from this texture. More...

uint32	getDepth (void) const
	Returns the depth of the texture (only applicable for 3D textures). More...

ushort	getDesiredFloatBitDepth (void) const
	gets desired bit depth for float pixel format textures. More...

PixelFormat	getDesiredFormat (void) const
	Returns the desired pixel format for the texture surface. More...

ushort	getDesiredIntegerBitDepth (void) const
	gets desired bit depth for integer pixel format textures. More...

PixelFormat	getFormat () const
	Returns the pixel format for the texture surface. More...

uint	getFSAA () const
	Get the level of multisample AA to be used if this texture is a rendertarget. More...

const String &	getFSAAHint () const
	Get the multisample AA hint if this texture is a rendertarget. More...

float	getGamma (void) const
	Returns the gamma adjustment factor applied to this texture on loading. More...

uint32	getHeight (void) const
	Returns the height of the texture. More...

bool	getMipmapsHardwareGenerated (void) const
	Are mipmaps hardware generated? More...

uint32	getNumFaces () const
	Return the number of faces this texture has. More...

uint32	getNumMipmaps (void) const
	Gets the number of mipmaps to be used for this texture. More...

uint32	getSrcDepth (void) const
	Returns the original depth of the input texture (only applicable for 3D textures). More...

PixelFormat	getSrcFormat (void) const
	Returns the pixel format of the original input texture (may differ due to hardware requirements and pixel format conversion). More...

uint32	getSrcHeight (void) const
	Returns the height of the original input texture (may differ due to hardware requirements). More...

uint32	getSrcWidth (void) const
	Returns the width of the original input texture (may differ due to hardware requirements). More...

TextureType	getTextureType (void) const
	Gets the type of texture. More...

int	getUsage () const
	Returns the TextureUsage identifier for this Texture. More...

uint32	getWidth (void) const
	Returns the width of the texture. More...

bool	hasAlpha (void) const
	Returns true if the texture has an alpha layer. More...

bool	isHardwareGammaEnabled () const
	Gets whether this texture will be set up so that on sampling it, hardware gamma correction is applied. More...

void	loadImage (const Image &img)
	Loads the data from an image. More...

void	loadRawData (DataStreamPtr &stream, ushort uWidth, ushort uHeight, PixelFormat eFormat)
	Loads the data from a raw stream. More...

void	setDepth (uint32 d)
	Set the depth of the texture (only applicable for 3D textures); can only do this before load();. More...

void	setDesiredBitDepths (ushort integerBits, ushort floatBits)
	Sets desired bit depth for integer and float pixel format. More...

void	setDesiredFloatBitDepth (ushort bits)
	Sets desired bit depth for float pixel format textures. More...

void	setDesiredIntegerBitDepth (ushort bits)
	Sets desired bit depth for integer pixel format textures. More...

void	setFormat (PixelFormat pf)
	Sets the desired pixel format for the texture surface; can only be set before load(). More...

void	setFSAA (uint fsaa, const String &fsaaHint)
	Set the level of multisample AA to be used if this texture is a rendertarget. More...

void	setGamma (float g)
	Sets the gamma adjustment factor applied to this texture on loading the data. More...

void	setHardwareGammaEnabled (bool enabled)
	Sets whether this texture will be set up so that on sampling it, hardware gamma correction is applied. More...

void	setHeight (uint32 h)
	Set the height of the texture; can only do this before load();. More...

void	setLayerNames (const std::vector< String > &names)
	Set image names to be loaded as layers (3d & texture array) or cubemap faces. More...

void	setNumMipmaps (uint32 num)
	Sets the number of mipmaps to be used for this texture. More...

void	setTextureType (TextureType ttype)
	Sets the type of texture; can only be changed before load() More...

void	setTreatLuminanceAsAlpha (bool asAlpha)

void	setUsage (int u)
	Sets the TextureUsage identifier for this Texture; only useful before load() More...

void	setWidth (uint32 w)
	Set the width of the texture; can only do this before load();. More...

Public Member Functions inherited from Ogre::Resource
	Resource (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)
	Standard constructor. More...

virtual	~Resource ()
	Virtual destructor. More...

virtual void	_dirtyState ()
	Manually mark the state of this resource as having been changed. More...

void	_fireLoadingComplete (bool unused=false)
	Firing of loading complete event. More...

void	_firePreparingComplete (bool unused=false)
	Firing of preparing complete event. More...

void	_fireUnloadingComplete (void)
	Firing of unloading complete event. More...

void	_notifyOrigin (const String &origin)
	Notify this resource of it's origin. More...

virtual void	addListener (Listener *lis)
	Register a listener on this resource. More...

virtual void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource. More...

virtual void	escalateLoading ()
	Escalates the loading of a background loaded resource. More...

ResourceManager *	getCreator (void)
	Gets the manager which created this resource. More...

const String &	getGroup (void) const
	Gets the group which this resource is a member of. More...

ResourceHandle	getHandle (void) const

LoadingState	getLoadingState () const
	Returns the current loading state. More...

const String &	getName (void) const
	Gets resource name. More...

const String &	getOrigin (void) const
	Get the origin of this resource, e.g. More...

size_t	getSize (void) const
	Retrieves info about the size of the resource. More...

virtual size_t	getStateCount () const
	Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More...

bool	isBackgroundLoaded (void) const
	Returns whether this Resource has been earmarked for background loading. More...

bool	isLoaded (void) const
	Returns true if the Resource has been loaded, false otherwise. More...

bool	isLoading () const
	Returns whether the resource is currently in the process of background loading. More...

bool	isManuallyLoaded (void) const
	Is this resource manually loaded? More...

bool	isPrepared (void) const
	Returns true if the Resource has been prepared, false otherwise. More...

bool	isReloadable (void) const
	Returns true if the Resource is reloadable, false otherwise. More...

virtual void	load (bool backgroundThread=false)
	Loads the resource, if it is not already. More...

virtual void	prepare (bool backgroundThread=false)
	Prepares the resource for load, if it is not already. More...

virtual void	reload (LoadingFlags flags=LF_DEFAULT)
	Reloads the resource, if it is already loaded. More...

virtual void	removeListener (Listener *lis)
	Remove a listener on this resource. More...

void	setBackgroundLoaded (bool bl)
	Tells the resource whether it is background loaded or not. More...

virtual void	touch (void)
	'Touches' the resource to indicate it has been used. More...

virtual void	unload (void)
	Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...

Public Member Functions inherited from Ogre::StringInterface
	StringInterface ()

virtual	~StringInterface ()
	Virtual destructor, see Effective C++. More...

void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object. More...

ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class. More...

const ParamDictionary *	getParamDictionary (void) const

String	getParameter (const String &name) const
	Generic parameter retrieval method. More...

const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object. More...

bool	setParameter (const String &name, const String &value)
	Generic parameter setting method. More...

void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method. More...

Additional Inherited Members
Public Types inherited from Ogre::Resource
enum	LoadingFlags { LF_DEFAULT = 0 , LF_INCLUDE_NON_RELOADABLE = 1 , LF_ONLY_UNREFERENCED = 2 , LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3 , LF_PRESERVE_STATE = 4 }
	Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More...

enum	LoadingState { LOADSTATE_UNLOADED , LOADSTATE_LOADING , LOADSTATE_LOADED , LOADSTATE_UNLOADING , LOADSTATE_PREPARED , LOADSTATE_PREPARING }
	Enum identifying the loading state of the resource. More...

Static Public Member Functions inherited from Ogre::StringInterface
static void	cleanupDictionary ()
	Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...

Detailed Description

Abstract class representing a Texture resource.

The actual concrete subclass which will exist for a texture
is dependent on the rendering system in use (Direct3D, OpenGL etc).
This class represents the commonalities, and is the one 'used'
by programmers even though the real implementation could be
different in reality. Texture objects are created through
the 'create' method of the TextureManager concrete subclass.

Constructor & Destructor Documentation

◆ Texture()

Ogre::Texture::Texture	(	ResourceManager *	creator,
		const String &	name,
		ResourceHandle	handle,
		const String &	group,
		bool	isManual = `false`,
		ManualResourceLoader *	loader = `0`
	)

◆ ~Texture()

virtual Ogre::Texture::~Texture ( )

inlinevirtual

Member Function Documentation

◆ setTextureType()

void Ogre::Texture::setTextureType ( TextureType ttype )

inline

Sets the type of texture; can only be changed before load()

◆ getTextureType()

TextureType Ogre::Texture::getTextureType ( void ) const

inline

Gets the type of texture.

◆ getNumMipmaps()

uint32 Ogre::Texture::getNumMipmaps ( void ) const

inline

Gets the number of mipmaps to be used for this texture.

◆ setNumMipmaps()

void Ogre::Texture::setNumMipmaps ( uint32 num )

inline

Sets the number of mipmaps to be used for this texture.

Note: Must be set before calling any 'load' method.

References Ogre::TU_AUTOMIPMAP.

◆ getMipmapsHardwareGenerated()

bool Ogre::Texture::getMipmapsHardwareGenerated ( void ) const

inline

Are mipmaps hardware generated?

Will only be accurate after texture load, or createInternalResources

◆ getGamma()

float Ogre::Texture::getGamma ( void ) const

inline

Returns the gamma adjustment factor applied to this texture on loading.

◆ setGamma()

void Ogre::Texture::setGamma ( float g )

inline

Sets the gamma adjustment factor applied to this texture on loading the data.

Note: Must be called before any 'load' method. This gamma factor will be premultiplied in and may reduce the precision of your textures. You can use setHardwareGamma if supported to apply gamma on sampling the texture instead.

◆ setHardwareGammaEnabled()

void Ogre::Texture::setHardwareGammaEnabled ( bool enabled )

inline

Sets whether this texture will be set up so that on sampling it, hardware gamma correction is applied.

24-bit textures are often saved in gamma colour space; this preserves precision in the 'darks'. However, if you're performing blending on the sampled colours, you really want to be doing it in linear space. One way is to apply a gamma correction value on loading (see setGamma), but this means you lose precision in those dark colours. An alternative is to get the hardware to do the gamma correction when reading the texture and converting it to a floating point value for the rest of the pipeline. This option allows you to do that; it's only supported in relatively recent hardware (others will ignore it) but can improve the quality of colour reproduction.

Note: Must be called before any 'load' method since it may affect the construction of the underlying hardware resources. Also note this only useful on textures using 8-bit colour channels.

◆ isHardwareGammaEnabled()

bool Ogre::Texture::isHardwareGammaEnabled ( ) const

inline

Gets whether this texture will be set up so that on sampling it, hardware gamma correction is applied.

◆ setFSAA()

void Ogre::Texture::setFSAA	(	uint	fsaa,
		const String &	fsaaHint
	)

inline

Set the level of multisample AA to be used if this texture is a rendertarget.

Note: This option will be ignored if TU_RENDERTARGET is not part of the usage options on this texture, or if the hardware does not support it.

Parameters

fsaa	The number of samples
fsaaHint	Any hinting text (see Root::createRenderWindow)

◆ getFSAA()

uint Ogre::Texture::getFSAA ( ) const

inline

Get the level of multisample AA to be used if this texture is a rendertarget.

◆ getFSAAHint()

const String& Ogre::Texture::getFSAAHint ( ) const

inline

Get the multisample AA hint if this texture is a rendertarget.

◆ getHeight()

uint32 Ogre::Texture::getHeight ( void ) const

inline

Returns the height of the texture.

◆ getWidth()

uint32 Ogre::Texture::getWidth ( void ) const

inline

Returns the width of the texture.

◆ getDepth()

uint32 Ogre::Texture::getDepth ( void ) const

inline

Returns the depth of the texture (only applicable for 3D textures).

◆ getSrcHeight()

uint32 Ogre::Texture::getSrcHeight ( void ) const

inline

Returns the height of the original input texture (may differ due to hardware requirements).

◆ getSrcWidth()

uint32 Ogre::Texture::getSrcWidth ( void ) const

inline

Returns the width of the original input texture (may differ due to hardware requirements).

◆ getSrcDepth()

uint32 Ogre::Texture::getSrcDepth ( void ) const

inline

Returns the original depth of the input texture (only applicable for 3D textures).

◆ setHeight()

void Ogre::Texture::setHeight ( uint32 h )

inline

Set the height of the texture; can only do this before load();.

◆ setWidth()

void Ogre::Texture::setWidth ( uint32 w )

inline

Set the width of the texture; can only do this before load();.

◆ setDepth()

void Ogre::Texture::setDepth ( uint32 d )

inline

Set the depth of the texture (only applicable for 3D textures); can only do this before load();.

◆ getUsage()

int Ogre::Texture::getUsage ( ) const

inline

Returns the TextureUsage identifier for this Texture.

◆ setUsage()

void Ogre::Texture::setUsage ( int u )

inline

Sets the TextureUsage identifier for this Texture; only useful before load()

Parameters

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

◆ createInternalResources()

void Ogre::Texture::createInternalResources ( void )

Creates the internal texture resources for this texture.

This method creates the internal texture resources (pixel buffers, texture surfaces etc) required to begin using this texture. You do not need to call this method directly unless you are manually creating a texture, in which case something must call it, after having set the size and format of the texture (e.g. the ManualResourceLoader might be the best one to call it). If you are not defining a manual texture, or if you use one of the self-contained load...() methods, then it will be called for you.

◆ freeInternalResources()

void Ogre::Texture::freeInternalResources ( void )

Deprecated:: use unload() instead

◆ copyToTexture()

virtual void Ogre::Texture::copyToTexture ( TexturePtr & target )

virtual

Copies (and maybe scales to fit) the contents of this texture to another texture.

Reimplemented in Ogre::D3D9Texture, and Ogre::D3D11Texture.

◆ loadImage()

void Ogre::Texture::loadImage ( const Image & img )

Loads the data from an image.

Attention: only call this from outside the load() routine of a Resource. Don't call it within (including ManualResourceLoader) - use _loadImages() instead. This method is designed to be external, performs locking and checks the load status before loading.

◆ loadRawData()

void Ogre::Texture::loadRawData	(	DataStreamPtr &	stream,
		ushort	uWidth,
		ushort	uHeight,
		PixelFormat	eFormat
	)

Loads the data from a raw stream.

Attention: only call this from outside the load() routine of a Resource. Don't call it within (including ManualResourceLoader) - use _loadImages() instead. This method is designed to be external, performs locking and checks the load status before loading.

Parameters

stream	Data stream containing the raw pixel data
uWidth	Width of the image
uHeight	Height of the image
eFormat	The format of the pixel data

◆ _loadImages()

void Ogre::Texture::_loadImages ( const ConstImagePtrList & images )

Internal method to load the texture from a set of images.

Attention: Do NOT call this method unless you are inside the load() routine already, e.g. a ManualResourceLoader. It is not threadsafe and does not check or update resource loading status.

◆ getFormat()

PixelFormat Ogre::Texture::getFormat ( ) const

inline

Returns the pixel format for the texture surface.

Referenced by Ogre::VulkanWindow::suggestPixelFormat().

◆ getDesiredFormat()

PixelFormat Ogre::Texture::getDesiredFormat ( void ) const

inline

Returns the desired pixel format for the texture surface.

◆ getSrcFormat()

PixelFormat Ogre::Texture::getSrcFormat ( void ) const

inline

Returns the pixel format of the original input texture (may differ due to hardware requirements and pixel format conversion).

◆ setFormat()

void Ogre::Texture::setFormat ( PixelFormat pf )

Sets the desired pixel format for the texture surface; can only be set before load().

◆ hasAlpha()

bool Ogre::Texture::hasAlpha ( void ) const

Returns true if the texture has an alpha layer.

◆ setDesiredIntegerBitDepth()

void Ogre::Texture::setDesiredIntegerBitDepth ( ushort bits )

Sets desired bit depth for integer pixel format textures.

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.

◆ getDesiredIntegerBitDepth()

ushort Ogre::Texture::getDesiredIntegerBitDepth ( void ) const

gets desired bit depth for integer pixel format textures.

◆ setDesiredFloatBitDepth()

void Ogre::Texture::setDesiredFloatBitDepth ( ushort bits )

Sets desired bit depth for float pixel format textures.

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.

◆ getDesiredFloatBitDepth()

ushort Ogre::Texture::getDesiredFloatBitDepth ( void ) const

gets desired bit depth for float pixel format textures.

◆ setDesiredBitDepths()

void Ogre::Texture::setDesiredBitDepths	(	ushort	integerBits,
		ushort	floatBits
	)

Sets desired bit depth for integer and float pixel format.

◆ setTreatLuminanceAsAlpha()

void Ogre::Texture::setTreatLuminanceAsAlpha ( bool asAlpha )

Deprecated:: use setFormat(PF_A8)

◆ getNumFaces()

uint32 Ogre::Texture::getNumFaces ( ) const

Return the number of faces this texture has.

This will be 6 for a cubemap texture and 1 for a 1D, 2D or 3D one.

◆ getBuffer()

virtual const HardwarePixelBufferSharedPtr& Ogre::Texture::getBuffer	(	size_t	face = `0`,
		size_t	mipmap = `0`
	)

virtual

Return hardware pixel buffer for a surface.

This buffer can then be used to copy data from and to a particular level of the texture.

Parameters

face	Face number, in case of a cubemap texture. Must be 0 for other types of textures. For cubemaps, this is one of +X (0), -X (1), +Y (2), -Y (3), +Z (4), -Z (5)
mipmap	Mipmap level. This goes from 0 for the first, largest mipmap level to getNumMipmaps()-1 for the smallest.

Returns: A shared pointer to a hardware pixel buffer.

Remarks: The buffer is invalidated when the resource is unloaded or destroyed. Do not use it after the lifetime of the containing texture.

Reimplemented in Ogre::D3D9Texture.

◆ convertToImage()

void Ogre::Texture::convertToImage	(	Image &	destImage,
		bool	includeMipMaps = `false`
	)

Populate an Image with the contents of this texture.

Parameters

destImage	The target image (contents will be overwritten)
includeMipMaps	Whether to embed mipmaps in the image

◆ getCustomAttribute() [1/2]

virtual void Ogre::Texture::getCustomAttribute	(	const String &	name,
		void *	pData
	)

virtual

Retrieve a platform or API-specific piece of information from this texture.

This method of retrieving information should only be used if you know what you're doing.

Name	Description
GLID	The OpenGL texture object id

Parameters

name	The name of the attribute to retrieve.
pData	Pointer to memory matching the type of data you want to retrieve.

Reimplemented in Ogre::VulkanTextureGpuWindow, and Ogre::GLTextureCommon.

◆ getCustomAttribute() [2/2]

uint Ogre::Texture::getCustomAttribute ( const String & name )

inline

simplified API for bindings

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

◆ createShaderAccessPoint()

virtual void Ogre::Texture::createShaderAccessPoint	(	uint	bindPoint,
		TextureAccess	access = `TA_READ_WRITE`,
		int	mipmapLevel = `0`,
		int	textureArrayIndex = `0`,
		PixelFormat	format = `PF_UNKNOWN`
	)

inlinevirtual

Enable read and/or write privileges to the texture from shaders.

Parameters

bindPoint	The buffer binding location for shader access. For OpenGL this must be unique and is not related to the texture binding point.
access	The texture access privileges given to the shader.
mipmapLevel	The texture mipmap level to use.
textureArrayIndex	The index of the texture array to use. If texture is not a texture array, set to 0.
format	Texture format to be read in by shader. For OpenGL this may be different than the bound texture format.

Reimplemented in Ogre::GL3PlusTexture, and Ogre::D3D11Texture.

◆ setLayerNames()

void Ogre::Texture::setLayerNames ( const std::vector< String > & names )

inline

Set image names to be loaded as layers (3d & texture array) or cubemap faces.

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

OgreTexture.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Texture()

◆ ~Texture()

Member Function Documentation

◆ setTextureType()

◆ getTextureType()

◆ getNumMipmaps()

◆ setNumMipmaps()

◆ getMipmapsHardwareGenerated()

◆ getGamma()

◆ setGamma()

◆ setHardwareGammaEnabled()

◆ isHardwareGammaEnabled()

◆ setFSAA()

◆ getFSAA()

◆ getFSAAHint()

◆ getHeight()

◆ getWidth()

◆ getDepth()

◆ getSrcHeight()

◆ getSrcWidth()

◆ getSrcDepth()

◆ setHeight()

◆ setWidth()

◆ setDepth()

◆ getUsage()

◆ setUsage()

◆ createInternalResources()

◆ freeInternalResources()

◆ copyToTexture()

◆ loadImage()

◆ loadRawData()

◆ _loadImages()

◆ getFormat()

◆ getDesiredFormat()

◆ getSrcFormat()

◆ setFormat()

◆ hasAlpha()

◆ setDesiredIntegerBitDepth()

◆ getDesiredIntegerBitDepth()

◆ setDesiredFloatBitDepth()

◆ getDesiredFloatBitDepth()

◆ setDesiredBitDepths()

◆ setTreatLuminanceAsAlpha()

◆ getNumFaces()

◆ getBuffer()

◆ convertToImage()

◆ getCustomAttribute() [1/2]

◆ getCustomAttribute() [2/2]

◆ createShaderAccessPoint()

◆ setLayerNames()