Base class for texture resources. More...

#include <OGLTexture.h>

Inheritance diagram for Urho3D::Texture:
Collaboration diagram for Urho3D::Texture:

Public Member Functions

 Texture (Context *context)
virtual ~Texture ()
void SetNumLevels (unsigned levels)
 Set number of requested mip levels. Needs to be called before setting size.
void SetFilterMode (TextureFilterMode filter)
 Set filtering mode.
void SetAddressMode (TextureCoordinate coord, TextureAddressMode address)
 Set addressing mode by texture coordinate.
void SetShadowCompare (bool enable)
 Set shadow compare mode.
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.
void SetParametersDirty ()
 Dirty the parameters.
void UpdateParameters ()
 Update changed parameters to OpenGL. Called by Graphics when binding the texture.
unsigned GetTarget () const
 Return texture's OpenGL target.
unsigned GetFormat () const
 Return 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 height.
bool GetParametersDirty () const
 Return whether parameters are dirty.
TextureFilterMode GetFilterMode () const
 Return filtering mode.
TextureAddressMode GetAddressMode (TextureCoordinate coord) const
 Return addressing mode by texture coordinate.
bool GetShadowCompare () const
 Return whether shadow compare is enabled.
const ColorGetBorderColor () const
 Return border color.
bool GetSRGB () const
 Return whether is using sRGB sampling and writing.
TextureGetBackupTexture () 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.
void SetParameters (XMLFile *xml)
 Set additional parameters from an XML file.
void SetParameters (const XMLElement &element)
 Set additional parameters from an XML element.
unsigned GetSRGBFormat (unsigned format)
 Return the corresponding SRGB texture format if supported. If not supported, return format unchanged.
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
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.
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 StringGetName () 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)
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
virtual const TypeInfoGetTypeInfo () 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. More...
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () 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 StringGetCategory () 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.
RefCountRefCountPtr ()
 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 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.
GraphicsGetGraphics () const
 Return the graphics subsystem.
unsigned GetGPUObject () const
 Return the object's OpenGL handle.
bool IsDataLost () const
 Return whether data is lost due to context loss.
bool HasPendingData () const
 Return whether has pending data assigned while context was lost.

Static Public Member Functions

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.

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

Protected Attributes

TextureUsage usage_
 Texture usage type.
unsigned target_
 OpenGL target.
unsigned format_
 Texture format.
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.
bool parametersDirty_
 Parameters dirty flag.
TextureFilterMode filterMode_
 Filtering mode.
TextureAddressMode addressMode_ [MAX_COORDS]
 Addressing mode.
 Mip levels to skip when loading per texture quality setting.
Color borderColor_
 Border color.
bool sRGB_
 sRGB sampling and writing mode flag.
SharedPtr< TexturebackupTexture_
 Backup texture.
- Protected Attributes inherited from Urho3D::GPUObject
WeakPtr< Graphicsgraphics_
 Graphics subsystem.
unsigned object_
 Object handle.
bool dataLost_
 Data lost flag.
bool dataPending_
 Data pending flag.

Detailed Description

Base class for texture resources.

The documentation for this class was generated from the following files:
  • /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/OpenGL/OGLTexture.h
  • /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/OpenGL/OGLTexture.cpp