HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
HdStUdimTextureObject Class Referencefinal

#include <udimTextureObject.h>

+ Inheritance diagram for HdStUdimTextureObject:

Public Member Functions

HDST_API HdStUdimTextureObject (const HdStTextureIdentifier &textureId, HdSt_TextureObjectRegistry *textureObjectRegistry)
 
HDST_API ~HdStUdimTextureObject () override
 
HgiTextureHandle const & GetTexelTexture () const
 
HgiTextureHandle const & GetLayoutTexture () const
 
HDST_API bool IsValid () const override
 
HDST_API HdTextureType GetTextureType () const override
 
- Public Member Functions inherited from HdStTextureObject
const HdStTextureIdentifier & GetTextureIdentifier () const
 
size_t GetTargetMemory () const
 
HDST_API void SetTargetMemory (size_t)
 
virtual HDST_API ~HdStTextureObject ()
 

Protected Member Functions

HDST_API void _Load () override
 
HDST_API void _Commit () override
 
- 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)
 
HDST_API void _AddToTotalTextureMemory (const HgiTextureHandle &texture)
 
HDST_API void _SubtractFromTotalTextureMemory (const HgiTextureHandle &texture)
 

Detailed Description

A UDIM texture.

Definition at line 54 of file udimTextureObject.h.

Constructor & Destructor Documentation

HDST_API HdStUdimTextureObject::HdStUdimTextureObject ( const HdStTextureIdentifier &  textureId,
HdSt_TextureObjectRegistry *  textureObjectRegistry 
)
HDST_API HdStUdimTextureObject::~HdStUdimTextureObject ( )
override

Member Function Documentation

HDST_API void HdStUdimTextureObject::_Commit ( )
overrideprotectedvirtual

Commit texture to GPU (not thread-safe)

Implements HdStTextureObject.

HDST_API void HdStUdimTextureObject::_Load ( )
overrideprotectedvirtual

Load texture to CPU (thread-safe)

Implements HdStTextureObject.

HgiTextureHandle const& HdStUdimTextureObject::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& HdStUdimTextureObject::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 HdStUdimTextureObject::GetTextureType ( ) const
overridevirtual

Get texture type

Implements HdStTextureObject.

HDST_API bool HdStUdimTextureObject::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: