Urho3D::Texture Class Reference

Base class for texture resources. More...

#include <Urho3D/Graphics/Texture.h>

Inheritance diagram for Urho3D::Texture:

Collaboration diagram for Urho3D::Texture:

Public Member Functions
	Texture (Context *context)
	Construct.
	~Texture () override
	Destruct.
void	SetNumLevels (unsigned levels)
	Set number of requested mip levels. Needs to be called before setting size. More...
void	SetFilterMode (TextureFilterMode mode)
void	SetAddressMode (TextureCoordinate coord, TextureAddressMode mode)
void	SetAnisotropy (unsigned level)
void	SetShadowCompare (bool enable)
	Set shadow compare mode. Not used on Direct3D9.
void	SetBorderColor (const Color &color)
void	SetSRGB (bool enable)
void	SetBackupTexture (Texture *texture)
void	SetMipsToSkip (MaterialQuality quality, int toSkip)
unsigned	GetFormat () const
bool	IsCompressed () const
unsigned	GetLevels () const
int	GetWidth () const
int	GetHeight () const
int	GetDepth () const
	Return depth.
TextureFilterMode	GetFilterMode () const
TextureAddressMode	GetAddressMode (TextureCoordinate coord) const
unsigned	GetAnisotropy () const
bool	GetShadowCompare () const
	Return whether shadow compare is enabled. Not used on Direct3D9.
const Color &	GetBorderColor () const
bool	GetSRGB () const
int	GetMultiSample () const
bool	GetAutoResolve () const
bool	IsResolveDirty () const
bool	GetLevelsDirty () const
Texture *	GetBackupTexture () const
int	GetMipsToSkip (MaterialQuality quality) const
int	GetLevelWidth (unsigned level) const
int	GetLevelHeight (unsigned level) const
int	GetLevelDepth (unsigned level) const
	Return mip level depth, or 0 if level does not exist.
TextureUsage	GetUsage () const
unsigned	GetDataSize (int width, int height) const
	Return data size in bytes for a rectangular region.
unsigned	GetDataSize (int width, int height, int depth) const
	Return data size in bytes for a volume region.
unsigned	GetRowDataSize (int width) const
	Return data size in bytes for a pixel or block row.
unsigned	GetComponents () const
bool	GetParametersDirty () const
	Return whether the parameters are dirty.
void	SetParameters (XMLFile *file)
	Set additional parameters from an XML file.
void	SetParameters (const XMLElement &element)
	Set additional parameters from an XML element.
void	SetParametersDirty ()
	Mark parameters dirty. Called by Graphics.
void	UpdateParameters ()
	Update dirty parameters to the texture object. Called by Graphics when assigning the texture.
void *	GetShaderResourceView () const
	Return shader resource view. Only used on Direct3D11.
void *	GetSampler () const
	Return sampler state object. Only used on Direct3D11.
void *	GetResolveTexture () const
	Return resolve texture. Only used on Direct3D11.
unsigned	GetTarget () const
	Return texture's target. Only used on OpenGL.
unsigned	GetSRGBFormat (unsigned format)
void	SetResolveDirty (bool enable)
	Set or clear the need resolve flag. Called internally by Graphics.
void	SetLevelsDirty ()
	Set the mipmap levels dirty flag. Called internally by Graphics.
void	RegenerateLevels ()
	Regenerate mipmap levels for a rendertarget after rendering and before sampling. Called internally by Graphics. No-op on Direct3D9. On OpenGL the texture must have been bound to work properly.
Public Member Functions inherited from Urho3D::ResourceWithMetadata
	ResourceWithMetadata (Context *context)
	Construct.
void	AddMetadata (const String &name, const Variant &value)
void	RemoveMetadata (const String &name)
	Remove metadata variable.
void	RemoveAllMetadata ()
	Remove all metadata variables.
const Variant &	GetMetadata (const String &name) const
bool	HasMetadata () const
Public Member Functions inherited from Urho3D::Resource
	Resource (Context *context)
	Construct.
bool	Load (Deserializer &source)
	Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.
virtual bool	BeginLoad (Deserializer &source)
	Load resource from stream. May be called from a worker thread. Return true if successful.
virtual bool	EndLoad ()
	Finish resource loading. Always called from the main thread. Return true if successful.
virtual bool	Save (Serializer &dest) const
	Save resource. Return true if successful.
bool	LoadFile (const String &fileName)
virtual bool	SaveFile (const String &fileName) const
void	SetName (const String &name)
void	SetMemoryUse (unsigned size)
	Set memory use in bytes, possibly approximate.
void	ResetUseTimer ()
	Reset last used timer.
void	SetAsyncLoadState (AsyncLoadState newState)
	Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.
const String &	GetName () const
StringHash	GetNameHash () const
	Return name hash.
unsigned	GetMemoryUse () const
unsigned	GetUseTimer ()
AsyncLoadState	GetAsyncLoadState () const
	Return the asynchronous loading state.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const String &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events).
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, Args... args)
	Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const String &	GetCategory () const
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.
Public Member Functions inherited from Urho3D::GPUObject
	GPUObject (Graphics *graphics)
	Construct with graphics subsystem pointer.
virtual	~GPUObject ()
	Destruct. Remove from the Graphics.
virtual void	OnDeviceLost ()
	Mark the GPU resource destroyed on graphics context destruction.
virtual void	OnDeviceReset ()
	Recreate the GPU resource and restore data if applicable.
virtual void	Release ()
	Unconditionally release the GPU resource.
void	ClearDataLost ()
	Clear the data lost flag.
Graphics *	GetGraphics () const
	Return the graphics subsystem associated with this GPU object.
void *	GetGPUObject () const
	Return the object pointer. Applicable only on Direct3D.
unsigned	GetGPUObjectName () const
	Return the object name. Applicable only on OpenGL.
bool	IsDataLost () const
bool	HasPendingData () const
	Return whether has pending data assigned while graphics context was lost.

Static Public Member Functions
static unsigned	CheckMaxLevels (int width, int height, unsigned requestedLevels)
	Check maximum allowed mip levels for a specific texture size.
static unsigned	CheckMaxLevels (int width, int height, int depth, unsigned requestedLevels)
	Check maximum allowed mip levels for a specific 3D texture size.
static unsigned	GetSRVFormat (unsigned format)
static unsigned	GetDSVFormat (unsigned format)
static unsigned	GetExternalFormat (unsigned format)
static unsigned	GetDataType (unsigned format)
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Member Functions
void	CheckTextureBudget (StringHash type)
	Check whether texture memory budget has been exceeded. Free unused materials in that case to release the texture references.
virtual bool	Create ()
	Create the GPU texture. Implemented in subclasses.
Protected Member Functions inherited from Urho3D::ResourceWithMetadata
void	LoadMetadataFromXML (const XMLElement &source)
	Load metadata from <metadata> children of XML element.
void	LoadMetadataFromJSON (const JSONArray &array)
	Load metadata from JSON array.
void	SaveMetadataToXML (XMLElement &destination) const
	Save as <metadata> children of XML element.
void	CopyMetadata (const ResourceWithMetadata &source)
	Copy metadata from another resource.

Protected Attributes
unsigned	target_ {}
	OpenGL target.
void *	shaderResourceView_ {}
	Direct3D11 shader resource view.
void *	sampler_ {}
	Direct3D11 sampler state object.
void *	resolveTexture_ {}
	Direct3D11 resolve texture object when multisample with autoresolve is used.
unsigned	format_ {}
	Texture format.
TextureUsage	usage_ {TEXTURE_STATIC}
	Texture usage type.
unsigned	levels_ {}
	Current mip levels.
unsigned	requestedLevels_ {}
	Requested mip levels.
int	width_ {}
	Texture width.
int	height_ {}
	Texture height.
int	depth_ {}
	Texture depth.
bool	shadowCompare_ {}
	Shadow compare mode.
TextureFilterMode	filterMode_ {FILTER_DEFAULT}
	Filtering mode.
TextureAddressMode	addressModes_ [MAX_COORDS] {ADDRESS_WRAP, ADDRESS_WRAP, ADDRESS_WRAP}
	Addressing mode.
unsigned	anisotropy_ {}
	Texture anisotropy level.
unsigned	mipsToSkip_ [MAX_TEXTURE_QUALITY_LEVELS] {2, 1, 0}
	Mip levels to skip when loading per texture quality setting.
Color	borderColor_
	Border color.
int	multiSample_ {1}
	Multisampling level.
bool	sRGB_ {}
	sRGB sampling and writing mode flag.
bool	parametersDirty_ {true}
	Parameters dirty flag.
bool	autoResolve_ {}
	Multisampling autoresolve flag.
bool	resolveDirty_ {}
	Multisampling resolve needed -flag.
bool	levelsDirty_ {}
	Mipmap levels regeneration needed -flag.
SharedPtr< Texture >	backupTexture_
	Backup texture.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.
Protected Attributes inherited from Urho3D::GPUObject
WeakPtr< Graphics >	graphics_
	Graphics subsystem.
GPUObjectHandle	object_ {}
	Object pointer or name.
bool	dataLost_ {}
	Data lost flag.
bool	dataPending_ {}
	Data pending flag.

Private Member Functions
	URHO3D_OBJECT (Texture, ResourceWithMetadata)

Detailed Description

Base class for texture resources.

Member Function Documentation

GetAddressMode()

TextureAddressMode Urho3D::Texture::GetAddressMode ( TextureCoordinate  coord ) const

inline

Return addressing mode by texture coordinate.

GetAnisotropy()

unsigned Urho3D::Texture::GetAnisotropy ( ) const

inline

Return texture max. anisotropy level. Value 0 means to use the default value from Renderer.

GetAutoResolve()

bool Urho3D::Texture::GetAutoResolve ( ) const

inline

Return texture multisampling autoresolve mode. When true, the texture is resolved before being sampled on SetTexture(). When false, the texture will not be resolved and must be read as individual samples in the shader.

Here is the caller graph for this function:

GetBackupTexture()

Texture* Urho3D::Texture::GetBackupTexture ( ) const

inline

Return backup texture.

GetBorderColor()

const Color& Urho3D::Texture::GetBorderColor ( ) const

inline

Return border color.

GetComponents()

unsigned Urho3D::Texture::GetComponents

(

)

const

Return number of image components required to receive pixel data from GetData(), or 0 for compressed images.

Here is the call graph for this function:

Here is the caller graph for this function:

GetDataType()

unsigned Urho3D::Texture::GetDataType ( unsigned  format )

static

Return the data type corresponding to an OpenGL internal format.

Here is the caller graph for this function:

GetDSVFormat()

static unsigned Urho3D::Texture::GetDSVFormat ( unsigned  format )

static

Return the depth-stencil view format corresponding to a texture format. Handles conversion of typeless depth texture formats. Only used on Direct3D11.

GetExternalFormat()

unsigned Urho3D::Texture::GetExternalFormat ( unsigned  format )

static

Return the non-internal texture format corresponding to an OpenGL internal format.

Here is the caller graph for this function:

GetFilterMode()

TextureFilterMode Urho3D::Texture::GetFilterMode ( ) const

inline

Return filtering mode.

GetFormat()

unsigned Urho3D::Texture::GetFormat ( ) const

inline

Return API-specific texture format.

Here is the caller graph for this function:

GetHeight()

int Urho3D::Texture::GetHeight ( ) const

inline

Return height.

Here is the caller graph for this function:

GetLevelHeight()

int Urho3D::Texture::GetLevelHeight

(

unsigned

level

)

const

Return mip level width, or 0 if level does not exist.

Here is the call graph for this function:

Here is the caller graph for this function:

GetLevels()

unsigned Urho3D::Texture::GetLevels ( ) const

inline

Return number of mip levels.

GetLevelsDirty()

bool Urho3D::Texture::GetLevelsDirty ( ) const

inline

Return whether rendertarget mipmap levels need regenration.

GetLevelWidth()

int Urho3D::Texture::GetLevelWidth

(

unsigned

level

)

const

Return mip level width, or 0 if level does not exist.

Here is the call graph for this function:

Here is the caller graph for this function:

GetMipsToSkip()

int Urho3D::Texture::GetMipsToSkip

(

MaterialQuality

quality

)

const

Return mip levels to skip on a quality setting when loading.

GetMultiSample()

int Urho3D::Texture::GetMultiSample ( ) const

inline

Return texture multisampling level (1 = no multisampling).

Here is the caller graph for this function:

GetSRGB()

bool Urho3D::Texture::GetSRGB ( ) const

inline

Return whether is using sRGB sampling and writing.

Here is the caller graph for this function:

GetSRGBFormat()

unsigned Urho3D::Texture::GetSRGBFormat

(

unsigned

format

)

Convert format to sRGB. Not used on Direct3D9.

Here is the caller graph for this function:

GetSRVFormat()

static unsigned Urho3D::Texture::GetSRVFormat ( unsigned  format )

static

Return the shader resource view format corresponding to a texture format. Handles conversion of typeless depth texture formats. Only used on Direct3D11.

GetUsage()

TextureUsage Urho3D::Texture::GetUsage ( ) const

inline

Return texture usage type.

Here is the caller graph for this function:

GetWidth()

int Urho3D::Texture::GetWidth ( ) const

inline

Return width.

Here is the caller graph for this function:

IsCompressed()

bool Urho3D::Texture::IsCompressed

(

)

const

Return whether the texture format is compressed.

Here is the caller graph for this function:

IsResolveDirty()

bool Urho3D::Texture::IsResolveDirty ( ) const

inline

Return whether multisampled texture needs resolve.

SetAddressMode()

void Urho3D::Texture::SetAddressMode	(	TextureCoordinate	coord,
		TextureAddressMode	mode
	)

Set addressing mode by texture coordinate.

Here is the caller graph for this function:

SetAnisotropy()

void Urho3D::Texture::SetAnisotropy

(

unsigned

level

)

Set texture max. anisotropy level. No effect if not using anisotropic filtering. Value 0 (default) uses the default setting from Renderer.

SetBackupTexture()

void Urho3D::Texture::SetBackupTexture

(

Texture *

texture

)

Set backup texture to use when rendering to this texture.

SetBorderColor()

void Urho3D::Texture::SetBorderColor

(

const Color &

color

)

Set border color for border addressing mode.

SetFilterMode()

void Urho3D::Texture::SetFilterMode

(

TextureFilterMode

mode

)

Set filtering mode.

SetMipsToSkip()

void Urho3D::Texture::SetMipsToSkip	(	MaterialQuality	quality,
		int	toSkip
	)

Set mip levels to skip on a quality setting when loading. Ensures higher quality levels do not skip more.

Here is the caller graph for this function:

SetNumLevels()

void Urho3D::Texture::SetNumLevels

(

unsigned

levels

)

Set number of requested mip levels. Needs to be called before setting size.

The default value (0) allocates as many mip levels as necessary to reach 1x1 size. Set value 1 to disable mipmapping. Note that rendertargets need to regenerate mips dynamically after rendering, which may cost performance. Screen buffers and shadow maps allocated by Renderer will have mipmaps disabled.

SetSRGB()

void Urho3D::Texture::SetSRGB

(

bool

enable

)

Set sRGB sampling and writing mode.

Here is the call graph for this function:

---

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

• Source/Urho3D/Graphics/Texture.h
• Source/Urho3D/Graphics/OpenGL/OGLTexture.cpp
• Source/Urho3D/Graphics/Texture.cpp