All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdStUdimTextureObject Class Referencefinal

A UDIM texture. More...

+ Inheritance diagram for HdStUdimTextureObject:

Public Member Functions

HDST_API HdStUdimTextureObject (const HdStTextureIdentifier &textureId, HdSt_TextureObjectRegistry *textureObjectRegistry)
 
HgiTextureHandle const & GetTexelTexture () const
 Get the gpu texture name for the texels. More...
 
HgiTextureHandle const & GetLayoutTexture () const
 Get the gpu texture name for the layout. More...
 
HDST_API bool IsValid () const override
 Is texture valid? Only correct after commit phase. More...
 
HDST_API HdTextureType GetTextureType () const override
 Get texture type. More...
 
- Public Member Functions inherited from HdStTextureObject
const HdStTextureIdentifierGetTextureIdentifier () const
 Get texture identifier. More...
 
size_t GetTargetMemory () const
 Get the target memory for the texture. More...
 
HDST_API void SetTargetMemory (size_t)
 Set the target memory (in bytes). More...
 

Protected Member Functions

HDST_API void _Load () override
 Load texture to CPU (thread-safe) More...
 
HDST_API void _Commit () override
 Commit texture to GPU (not thread-safe) More...
 
- Protected Member Functions inherited from HdStTextureObject
 HdStTextureObject (const HdStTextureIdentifier &textureId, HdSt_TextureObjectRegistry *textureObjectRegistry)
 
HDST_API HdStResourceRegistry_GetResourceRegistry () const
 
HDST_API Hgi_GetHgi () const
 
HDST_API std::string _GetDebugName (const HdStTextureIdentifier &textureId) const
 
HDST_API bool _GetPremultiplyAlpha (const HdStSubtextureIdentifier *const subId) const
 
HDST_API HioImage::SourceColorSpace _GetSourceColorSpace (const HdStSubtextureIdentifier *const subId) const
 
HDST_API void _AdjustTotalTextureMemory (int64_t memDiff)
 Add signed number to total texture memory amount maintained by registry. More...
 
HDST_API void _AddToTotalTextureMemory (const HgiTextureHandle &texture)
 Compute memory of texture and add to total texture memory amount maintained by registry. More...
 
HDST_API void _SubtractFromTotalTextureMemory (const HgiTextureHandle &texture)
 Compute memory of texture and subtract to total texture memory amount maintained by registry. More...
 

Detailed Description

A UDIM texture.

Definition at line 54 of file udimTextureObject.h.

Member Function Documentation

HDST_API void _Commit ( )
overrideprotectedvirtual

Commit texture to GPU (not thread-safe)

Implements HdStTextureObject.

HDST_API void _Load ( )
overrideprotectedvirtual

Load texture to CPU (thread-safe)

Implements HdStTextureObject.

HgiTextureHandle const& GetLayoutTexture ( ) const
inline

Get the gpu texture name for the layout.

Only valid after commit phase.

Definition at line 75 of file udimTextureObject.h.

HgiTextureHandle const& GetTexelTexture ( ) const
inline

Get the gpu texture name for the texels.

Only valid after commit phase.

Definition at line 69 of file udimTextureObject.h.

HDST_API HdTextureType GetTextureType ( ) const
overridevirtual

Get texture type.

Implements HdStTextureObject.

HDST_API bool IsValid ( ) const
overridevirtual

Is texture valid? Only correct after commit phase.

E.g., no file at given file path. Consulted by clients to determine whether to use the fallback value.

Implements HdStTextureObject.


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