Urho3D::Texture Class Reference

Base class for texture resources. More...

#include <Urho3D/Graphics/Texture.h>

Inheritance diagram for Urho3D::Texture:

Public Member Functions
	Texture (Context *context)
	Construct.
	~Texture () override
	Destruct.
TextureFormat	GetFormat () const
bool	IsCompressed () const
unsigned	GetLevels () const
int	GetWidth () const
int	GetHeight () const
IntVector2	GetSize () const
	Return size.
IntRect	GetRect () const
	Return viewport rectange.
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.
bool	GetLinear () const
	Return whether the texture data are in linear space (instead of gamma space).
bool	GetSRGB () const
int	GetMultiSample () const
bool	GetAutoResolve () const
Texture *	GetBackupTexture () const
RenderSurface *	GetRenderSurface (unsigned index=0) const
	Return render surface for given index.
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.
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
void	SetParameters (XMLFile *file)
	Set additional parameters from an XML file.
void	SetParameters (const XMLElement &element)
	Set additional parameters from an XML element.
void	SetFilterMode (TextureFilterMode mode)
void	SetAddressMode (TextureCoordinate coord, TextureAddressMode mode)
void	SetAnisotropy (unsigned level)
void	SetShadowCompare (bool enable)
	Set shadow compare mode.
void	SetNumLevels (unsigned levels)
	Set number of requested mip levels. Needs to be called before setting size. More...
void	SetLinear (bool linear)
	Set whether the texture data is in linear color space (instead of gamma space).
void	SetSRGB (bool enable)
void	SetBackupTexture (Texture *texture)
void	SetMipsToSkip (MaterialQuality quality, int toSkip)
bool	IsRenderTarget () const
bool	IsDepthStencil () const
bool	IsUnorderedAccess () const
Public Member Functions inherited from Urho3D::ResourceWithMetadata
	ResourceWithMetadata (Context *context)
	Construct.
void	AddMetadata (const ea::string &name, const Variant &value)
void	RemoveMetadata (const ea::string &name)
	Remove metadata variable.
void	RemoveAllMetadata ()
	Remove all metadata variables.
const StringVector &	GetMetadataKeys () const
	Return all metadata keys.
const Variant &	GetMetadata (const ea::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 FileIdentifier &fileName)
	Load resource from file.
virtual bool	SaveFile (const FileIdentifier &fileName) const
	Save resource to file.
void	SetName (const ea::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.
void	SetAbsoluteFileName (const ea::string &fileName)
	Set absolute file name.
const ea::string &	GetName () const
StringHash	GetNameHash () const
	Return name hash.
unsigned	GetMemoryUse () const
unsigned	GetUseTimer ()
AsyncLoadState	GetAsyncLoadState () const
	Return the asynchronous loading state.
const ea::string &	GetAbsoluteFileName () const
	Return absolute file name.
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 ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
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	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	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 ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
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, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
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 ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
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.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

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.
bool	CreateForImage (const RawTextureParams &baseParams, Image *image)
bool	UpdateFromImage (unsigned arraySlice, Image *image)
	Set texture data from image.
bool	ReadToImage (unsigned arraySlice, unsigned level, Image *image)
	Read texture data to image.
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	requestedLevels_ {}
	Requested mip levels.
bool	requestedSRGB_ {}
	Whether sRGB sampling and writing is requested.
unsigned	mipsToSkip_ [MAX_TEXTURE_QUALITY_LEVELS] {2, 1, 0}
	Mip levels to skip when loading per texture quality setting.
bool	linear_ {}
	Whether the texture data is in linear color space (instead of gamma space).
bool	resolveDirty_ {}
	Multisampling resolve needed -flag.
bool	levelsDirty_ {}
	Mipmap levels regeneration needed -flag.
SharedPtr< Texture >	backupTexture_
	Backup texture.
ea::vector< SharedPtr< RenderSurface > >	renderSurfaces_
	Render surface(s).
unsigned	mostDetailedLevel_ {}
	Most detailed mip level currently used.
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Private Member Functions
	URHO3D_OBJECT (Texture, ResourceWithMetadata)
void	HandleRenderSurfaceUpdate ()
	Handle render surface update event.
void	OnCreateGPU () override
void	OnDestroyGPU () override
bool	TryRestore () override

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Resource
static Resource *	LoadFromCache (Context *context, StringHash type, const ea::string &name)
	Load resource by reference.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Detailed Description

Base class for texture resources.

Member Function Documentation

CreateForImage()

bool Urho3D::Texture::CreateForImage ( const RawTextureParams &  baseParams, Image *  image  )

protected

Create texture so it can fit the image. Size and format are deduced from the image. Number of mips is adjusted according to the image.

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.

GetBackupTexture()

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

inline

Return backup texture.

GetComponents()

unsigned Urho3D::Texture::GetComponents

(

)

const

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

GetFilterMode()

TextureFilterMode Urho3D::Texture::GetFilterMode ( ) const

inline

Return filtering mode.

GetFormat()

TextureFormat Urho3D::Texture::GetFormat ( ) const

inline

Return API-specific texture format.

GetHeight()

int Urho3D::Texture::GetHeight ( ) const

inline

Return height.

GetLevelHeight()

int Urho3D::Texture::GetLevelHeight

(

unsigned

level

)

const

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

GetLevels()

unsigned Urho3D::Texture::GetLevels ( ) const

inline

Return number of mip levels.

GetLevelWidth()

int Urho3D::Texture::GetLevelWidth

(

unsigned

level

)

const

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

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

GetSRGB()

bool Urho3D::Texture::GetSRGB

(

)

const

Return whether is using sRGB sampling and writing.

GetWidth()

int Urho3D::Texture::GetWidth ( ) const

inline

Return width.

IsCompressed()

bool Urho3D::Texture::IsCompressed

(

)

const

Return whether the texture format is compressed.

IsRenderTarget()

bool Urho3D::Texture::IsRenderTarget ( ) const

inline

Getters.

OnCreateGPU()

void Urho3D::Texture::OnCreateGPU ( )

overrideprivate

Implement RawTexture.

SetAddressMode()

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

Set addressing mode by texture coordinate.

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.

SetFilterMode()

void Urho3D::Texture::SetFilterMode

(

TextureFilterMode

mode

)

Set default texture sampler. If this is called for already used texture, send ReloadFinished event from this texture. 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.

SetNumLevels()

void Urho3D::Texture::SetNumLevels

(

unsigned

levels

)

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

Set texture properties. Texture should be reloaded after calling this. 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.

---

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

• Urho3D/Graphics/Texture.h
• Urho3D/Graphics/Texture.cpp