2D texture resource. More...

#include <Urho3D/Graphics/Texture2D.h>

Inheritance diagram for Urho3D::Texture2D:

Public Member Functions
	Texture2D (Context *context)
	Construct.

	~Texture2D () override
	Destruct.

bool	BeginLoad (Deserializer &source) override
	Load resource from stream. May be called from a worker thread. Return true if successful.

bool	EndLoad () override
	Finish resource loading. Always called from the main thread. Return true if successful.

bool	SetSize (int width, int height, TextureFormat format, TextureFlags flags=TextureFlag::None, int multiSample=1)
	Set size, format, usage and multisampling parameters for rendertargets. Zero size will follow application window size. Return true if successful. More...

bool	SetData (unsigned level, int x, int y, int width, int height, const void *data)
	Set data either partially or fully on a mip level. Return true if successful.

bool	SetData (Image *image)
	Set data from an image. Return true if successful. Optionally make a single channel image alpha-only.

bool	GetData (unsigned level, void *dest)
	Get data from a mip level. The destination buffer must be big enough. Return true if successful.

bool	GetImage (Image &image)
	Get image data from zero mip level. Only RGB and RGBA textures are supported.

SharedPtr< Image >	GetImage ()
	Get image data from zero mip level. Only RGB and RGBA textures are supported.

Public Member Functions inherited from Urho3D::Texture
	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	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.

Static Public Member Functions
static void	RegisterObject (Context *context)

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.

Private Member Functions
	URHO3D_OBJECT (Texture2D, Texture)

Private Attributes
SharedPtr< Image >	loadImage_
	Image file acquired during BeginLoad.

SharedPtr< XMLFile >	loadParameters_
	Parameter file acquired during BeginLoad.

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Member Functions inherited from Urho3D::Texture
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 inherited from Urho3D::Texture
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.

Detailed Description

2D texture resource.

Member Function Documentation

◆ RegisterObject()

void Urho3D::Texture2D::RegisterObject ( Context * context )

static

Register object factory.

◆ SetSize()

bool Urho3D::Texture2D::SetSize	(	int	width,
		int	height,
		TextureFormat	format,
		TextureFlags	flags = `TextureFlag::None`,
		int	multiSample = `1`
	)

Set size, format, usage and multisampling parameters for rendertargets. Zero size will follow application window size. Return true if successful.

Autoresolve true means the multisampled texture will be automatically resolved to 1-sample after being rendered to and before being sampled as a texture. Autoresolve false means the multisampled texture will be read as individual samples in the shader.

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

Urho3D/Graphics/Texture2D.h
Urho3D/Graphics/Texture2D.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ RegisterObject()

◆ SetSize()