Urho3D
Public Member Functions | Protected Member Functions | Protected Attributes
Urho3D::Texture Class Reference

Base class for texture resources. More...

#include <D3D9Texture.h>

Inheritance diagram for Urho3D::Texture:
Urho3D::Resource Urho3D::GPUObject Urho3D::Object Urho3D::RefCounted Urho3D::Texture2D Urho3D::TextureCube

List of all members.

Public Member Functions

 Texture (Context *context)
 Construct.
virtual ~Texture ()
 Destruct.
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 SetBorderColor (const Color &color)
 Set border color for border addressing mode.
void SetBackupTexture (Texture *texture)
 Set backup texture to use when rendering to this texture.
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.
TextureFilterMode GetFilterMode () const
 Return filtering mode.
TextureAddressMode GetAddressMode (TextureCoordinate coord) const
 Return addressing mode by texture coordinate.
const ColorGetBorderColor () const
 Return border color.
TextureGetBackupTexture () const
 Return backup texture.
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.
TextureUsage GetUsage () const
 Return texture usage type.
unsigned GetDataSize (int width, int height) const
 Return data size in bytes for a rectangular region.
unsigned GetRowDataSize (int width) const
 Return data size in bytes for a pixel or block row.
void LoadParameters ()
 Load parameters.
void LoadParameters (XMLFile *xml)
 Load parameters from an XML file.
void LoadParameters (const XMLElement &element)
 Load parameters from an XML element.
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
 Construct.
virtual bool Load (Deserializer &source)
 Load resource. Return true if successful.
virtual bool Save (Serializer &dest)
 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.
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.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual ShortStringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
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.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (ShortStringHash 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.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
- 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 subsystem.
virtual void OnDeviceLost ()
 Release default pool resources.
virtual void OnDeviceReset ()
 Recreate default pool resources.
virtual void Release ()
 Unconditionally release the GPU resource.
void ClearDataLost ()
 Clear the data lost flag.
GraphicsGetGraphics () const
 Return the graphics subsystem.
void * GetGPUObject () const
 Return Direct3D object.
bool IsDataLost () const
 Return whether data is lost due to device loss.
bool HasPendingData () const
 Return whether has pending data assigned while device was lost.

Protected Member Functions

void CheckTextureBudget (ShortStringHash type)
 Check whether texture memory budget has been exceeded. Free unused materials in that case to release the texture references.

Protected Attributes

unsigned format_
 Texture format.
unsigned pool_
 Memory pool.
unsigned usage_
 Texture usage type.
unsigned levels_
 Current mip levels.
unsigned requestedLevels_
 Requested mip levels.
int width_
 Texture width.
int height_
 Texture height.
TextureFilterMode filterMode_
 Filtering mode.
TextureAddressMode addressMode_ [MAX_COORDS]
 Addressing mode.
unsigned mipsToSkip_ [MAX_TEXTURE_QUALITY_LEVELS]
 Mipmaps to skip when loading.
Color borderColor_
 Border color.
SharedPtr< TexturebackupTexture_
 Backup texture.
- Protected Attributes inherited from Urho3D::GPUObject
WeakPtr< Graphicsgraphics_
 Graphics subsystem.
void * object_
 Direct3D object.
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: