Urho3D::Texture2D Class Reference

2D texture resource. More...

#include <Urho3D/Graphics/Texture2D.h>

Inheritance diagram for Urho3D::Texture2D:

Collaboration diagram for Urho3D::Texture2D:

Public Member Functions
	Texture2D (Context *context)
	Construct.
virtual	~Texture2D ()
	Destruct.
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 void	OnDeviceLost ()
	Mark the GPU resource destroyed on context destruction.
virtual void	OnDeviceReset ()
	Recreate the GPU resource and restore data if applicable.
virtual void	Release ()
	Release the texture.
bool	SetSize (int width, int height, unsigned format, TextureUsage usage=TEXTURE_STATIC, int multiSample=1, bool autoResolve=true)
	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, bool useAlpha=false)
	Set data from an image. Return true if successful. Optionally make a single channel image alpha-only.
bool	GetData (unsigned level, void *dest) const
	Get data from a mip level. The destination buffer must be big enough. Return true if successful.
SharedPtr< Image >	GetImage () const
	Get image data from zero mip level. Only RGB and RGBA textures are supported.
RenderSurface *	GetRenderSurface () const
	Return render surface.
Public Member Functions inherited from Urho3D::Texture
	Texture (Context *context)
	Construct.
virtual	~Texture ()
	Destruct.
void	SetNumLevels (unsigned levels)
	Set number of requested mip levels. Needs to be called before setting size. More...
void	SetFilterMode (TextureFilterMode filter)
	Set filtering mode.
void	SetAddressMode (TextureCoordinate coord, TextureAddressMode address)
	Set addressing mode by texture coordinate.
void	SetAnisotropy (unsigned level)
	Set texture max. anisotropy level. No effect if not using anisotropic filtering. Value 0 (default) uses the default setting from Renderer.
void	SetShadowCompare (bool enable)
	Set shadow compare mode. Not used on Direct3D9.
void	SetBorderColor (const Color &color)
	Set border color for border addressing mode.
void	SetSRGB (bool enable)
	Set sRGB sampling and writing mode.
void	SetBackupTexture (Texture *texture)
	Set backup texture to use when rendering to this texture.
void	SetMipsToSkip (int quality, int toSkip)
	Set mip levels to skip on a quality setting when loading. Ensures higher quality levels do not skip more.
unsigned	GetFormat () const
	Return API-specific texture format.
bool	IsCompressed () const
	Return whether the texture format is compressed.
unsigned	GetLevels () const
	Return number of mip levels.
int	GetWidth () const
	Return width.
int	GetHeight () const
	Return height.
int	GetDepth () const
	Return depth.
TextureFilterMode	GetFilterMode () const
	Return filtering mode.
TextureAddressMode	GetAddressMode (TextureCoordinate coord) const
	Return addressing mode by texture coordinate.
unsigned	GetAnisotropy () const
	Return texture max. anisotropy level. Value 0 means to use the default value from Renderer.
bool	GetShadowCompare () const
	Return whether shadow compare is enabled. Not used on Direct3D9.
const Color &	GetBorderColor () const
	Return border color.
bool	GetSRGB () const
	Return whether is using sRGB sampling and writing.
int	GetMultiSample () const
	Return texture multisampling level (1 = no multisampling).
bool	GetAutoResolve () const
	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.
bool	IsResolveDirty () const
	Return whether multisampled texture needs resolve.
bool	GetLevelsDirty () const
	Return whether rendertarget mipmap levels need regenration.
Texture *	GetBackupTexture () const
	Return backup texture.
int	GetMipsToSkip (int quality) const
	Return mip levels to skip on a quality setting when loading.
int	GetLevelWidth (unsigned level) const
	Return mip level width, or 0 if level does not exist.
int	GetLevelHeight (unsigned level) const
	Return mip level width, or 0 if level does not exist.
int	GetLevelDepth (unsigned level) const
	Return mip level depth, or 0 if level does not exist.
TextureUsage	GetUsage () const
	Return texture usage type.
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
	Return number of image components required to receive pixel data from GetData(), or 0 for compressed images.
bool	GetParametersDirty () const
	Return whether the parameters are dirty.
void	SetParameters (XMLFile *xml)
	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)
	Convert format to sRGB. Not used on Direct3D9.
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)
	Add new metadata variable or overwrite old value.
void	RemoveMetadata (const String &name)
	Remove metadata variable.
void	RemoveAllMetadata ()
	Remove all metadata variables.
const Variant &	GetMetadata (const String &name) const
	Return metadata variable.
bool	HasMetadata () const
	Return whether the resource has metadata.
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 String &fileName)
	Load resource from file.
virtual bool	SaveFile (const String &fileName) const
	Save resource to file.
void	SetName (const String &name)
	Set 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
	Return name.
StringHash	GetNameHash () const
	Return name hash.
unsigned	GetMemoryUse () const
	Return memory use in bytes, possibly approximate.
unsigned	GetUseTimer ()
	Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero.
AsyncLoadState	GetAsyncLoadState () const
	Return the asynchronous loading state.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
	Return type hash.
virtual const String &	GetTypeName () const =0
	Return type name.
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.
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	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.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
	Return global variable based on key.
const VariantMap &	GetGlobalVars () const
	Return all global variables.
void	SetGlobalVar (StringHash key, const Variant &value)
	Set global variable with the respective key and 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
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
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.
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
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
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.
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
	Return whether data is lost due to context loss.
bool	HasPendingData () const
	Return whether has pending data assigned while graphics context was lost.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object factory.
Static Public Member Functions inherited from Urho3D::Texture
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)
	Return the shader resource view format corresponding to a texture format. Handles conversion of typeless depth texture formats. Only used on Direct3D11.
static unsigned	GetDSVFormat (unsigned format)
	Return the depth-stencil view format corresponding to a texture format. Handles conversion of typeless depth texture formats. Only used on Direct3D11.
static unsigned	GetExternalFormat (unsigned format)
	Return the non-internal texture format corresponding to an OpenGL internal format.
static unsigned	GetDataType (unsigned format)
	Return the data type corresponding to an OpenGL internal format.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Member Functions
virtual bool	Create ()
	Create the GPU texture.
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.
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.

Private Member Functions
	URHO3D_OBJECT (Texture2D, Texture)
void	HandleRenderSurfaceUpdate (StringHash eventType, VariantMap &eventData)
	Handle render surface update event.

Private Attributes
SharedPtr< RenderSurface >	renderSurface_
	Render surface.
SharedPtr< Image >	loadImage_
	Image file acquired during BeginLoad.
SharedPtr< XMLFile >	loadParameters_
	Parameter file acquired during BeginLoad.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Texture
union {
void *   shaderResourceView_
	Direct3D11 shader resource view.
unsigned   target_
	OpenGL target.
};
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 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_
	Filtering mode.
TextureAddressMode	addressMode_ [MAX_COORDS]
	Addressing mode.
unsigned	anisotropy_
	Texture anisotropy level.
unsigned	mipsToSkip_ [MAX_TEXTURE_QUALITY_LEVELS]
	Mip levels to skip when loading per texture quality setting.
Color	borderColor_
	Border color.
int	multiSample_
	Multisampling level.
bool	sRGB_
	sRGB sampling and writing mode flag.
bool	parametersDirty_
	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.

Detailed Description

2D texture resource.

Member Function Documentation

bool Urho3D::Texture2D::SetSize	(	int	width,
		int	height,
		unsigned	format,
		TextureUsage	usage = TEXTURE_STATIC,
		int	multiSample = 1,
		bool	autoResolve = true
	)

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 and is not supported on Direct3D9.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Source/Urho3D/Graphics/Texture2D.h
• Source/Urho3D/Graphics/OpenGL/OGLTexture2D.cpp
• Source/Urho3D/Graphics/Texture2D.cpp