Rebel Fork Framework
Urho3D::Texture3D Class Reference

3D texture resource. More...

#include <Urho3D/Graphics/Texture3D.h>

Inheritance diagram for Urho3D::Texture3D:
Urho3D::Texture Urho3D::ResourceWithMetadata Urho3D::GPUObject Urho3D::Resource Urho3D::Object Urho3D::RefCounted

Public Member Functions

 Texture3D (Context *context)
 Construct.
 
 ~Texture3D () 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.
 
void OnDeviceLost () override
 Mark the GPU resource destroyed on context destruction.
 
void OnDeviceReset () override
 Recreate the GPU resource and restore data if applicable.
 
void Release () override
 Release the texture.
 
bool SetSize (int width, int height, int depth, unsigned format, TextureUsage usage=TEXTURE_STATIC)
 Set size, format and usage. Zero size will follow application window size. Return true if successful.
 
bool SetData (unsigned level, int x, int y, int z, int width, int height, int depth, 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.
 
- Public Member Functions inherited from Urho3D::Texture
 Texture (Context *context)
 Construct.
 
 ~Texture () override
 Destruct.
 
void SetNumLevels (unsigned levels)
 Set number of requested mip levels. Needs to be called before setting size. More...
 
void SetFilterMode (TextureFilterMode mode)
 
void SetAddressMode (TextureCoordinate coord, TextureAddressMode mode)
 
void SetAnisotropy (unsigned level)
 
void SetShadowCompare (bool enable)
 Set shadow compare mode.
 
void SetBorderColor (const Color &color)
 
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)
 
void SetUnorderedAccess (bool enabled)
 Set whether to support unordered access.
 
unsigned 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.
 
const ColorGetBorderColor () const
 
bool GetLinear () const
 Return whether the texture data are in linear space (instead of gamma space).
 
bool GetSRGB () const
 
bool GetUnorderedAccess () const
 Return whether to support unordered access.
 
int GetMultiSample () const
 
bool GetAutoResolve () const
 
bool IsResolveDirty () const
 
bool GetLevelsDirty () const
 
TextureGetBackupTexture () const
 
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.
 
TextureUsage GetUsage () const
 
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
 
bool GetParametersDirty () const
 Return whether the parameters are dirty.
 
void SetParameters (XMLFile *file)
 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)
 
void SetResolveDirty (bool enable)
 Set or clear the need resolve flag. Called internally by Graphics.
 
bool IsUnorderedAccessSupported () const
 Return whether the texture can be used as unordered access resource.
 
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. On OpenGL the texture must have been bound to work properly.
 
GraphicsGetGraphics () const
 Return the graphics subsystem associated with this GPU object.
 
- 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 TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
 
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.
 
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.
 
VariantMapGetEventDataMap () 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.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
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 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.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () 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.
 
- 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.
 
GraphicsGetGraphics () 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
 
bool HasPendingData () const
 Return whether has pending data assigned while graphics context was lost.
 

Static Public Member Functions

static void RegisterObject (Context *context)
 
- 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)
 
static unsigned GetDSVFormat (unsigned format)
 
static unsigned GetExternalFormat (unsigned format)
 
static unsigned GetDataType (unsigned format)
 
static bool IsComputeWriteable (unsigned format)
 Returns true if the given texture format is viable as a compute shader write-target (ie. it's a plain RGBA nature).
 
- Static Public Member Functions inherited from Urho3D::Resource
static ResourceLoadFromCache (Context *context, StringHash type, const ea::string &name)
 Load resource by reference.
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 

Protected Member Functions

bool Create () override
 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.
 

Private Member Functions

 URHO3D_OBJECT (Texture3D, Texture)
 

Private Attributes

SharedPtr< ImageloadImage_
 Image file acquired during BeginLoad.
 
SharedPtr< XMLFileloadParameters_
 Parameter file acquired during BeginLoad.
 

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Texture
unsigned target_ {}
 OpenGL target.
 
void * shaderResourceView_ {}
 Direct3D11 shader resource view.
 
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_STATIC}
 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.
 
bool unorderedAccess_ {}
 Whether to use this texture as UAV resource in shader.
 
TextureFilterMode filterMode_ {FILTER_DEFAULT}
 Filtering mode.
 
TextureAddressMode addressModes_ [MAX_COORDS] {ADDRESS_WRAP, ADDRESS_WRAP, ADDRESS_WRAP}
 Addressing mode.
 
unsigned anisotropy_ {}
 Texture anisotropy level.
 
unsigned mipsToSkip_ [MAX_TEXTURE_QUALITY_LEVELS] {2, 1, 0}
 Mip levels to skip when loading per texture quality setting.
 
Color borderColor_
 Border color.
 
int multiSample_ {1}
 Multisampling level.
 
bool sRGB_ {}
 sRGB sampling and writing mode flag.
 
bool linear_ {}
 Whether the texture data is in linear color space (instead of gamma space).
 
bool parametersDirty_ {true}
 Parameters dirty flag.
 
bool autoResolve_ {}
 Multisampling autoresolve flag.
 
bool resolveDirty_ {}
 Multisampling resolve needed -flag.
 
bool levelsDirty_ {}
 Mipmap levels regeneration needed -flag.
 
SharedPtr< TexturebackupTexture_
 Backup texture.
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 
- Protected Attributes inherited from Urho3D::GPUObject
WeakPtr< Graphicsgraphics_
 Graphics subsystem.
 
GPUObjectHandle object_ {}
 Object pointer or name.
 
bool dataLost_ {}
 Data lost flag.
 
bool dataPending_ {}
 Data pending flag.
 

Detailed Description

3D texture resource.

Member Function Documentation

◆ RegisterObject()

void Urho3D::Texture3D::RegisterObject ( Context context)
static

Register object factory.


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