HdStUdimTextureObject Class Reference

A UDIM texture. More...

#include <udimTextureObject.h>

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.
HgiTextureHandle const &	GetLayoutTexture () const
	Get the gpu texture name for the layout.
HDST_API bool	IsValid () const override
	Is texture valid? Only correct after commit phase.
HDST_API HdStTextureType	GetTextureType () const override
	Get texture type.
HDST_API size_t	GetCommittedSize () const override
	Returns the actual amount of memory committed to the GPU.
Public Member Functions inherited from HdStTextureObject
const HdStTextureIdentifier &	GetTextureIdentifier () const
	Get texture identifier.
size_t	GetTargetMemory () const
	Get the target memory for the texture.
HDST_API void	SetTargetMemory (size_t)
	Set the target memory (in bytes).
virtual HDST_API size_t	GetCommittedSize () const =0
	Returns the actual amount of memory committed to the GPU.
virtual HDST_API bool	IsValid () const =0
	Is texture valid? Only correct after commit phase.
virtual HDST_API HdStTextureType	GetTextureType () const =0
	Get texture type.

Protected Member Functions
HDST_API void	_Load () override
	Load texture to CPU (thread-safe)
HDST_API void	_Commit () override
	Commit texture to GPU (not thread-safe)
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
virtual HDST_API void	_Load ()=0
	Load texture to CPU (thread-safe)
virtual HDST_API void	_Commit ()=0
	Commit texture to GPU (not thread-safe)
HDST_API void	_AdjustTotalTextureMemory (int64_t memDiff)
	Add signed number to total texture memory amount maintained by registry.
HDST_API void	_AddToTotalTextureMemory (const HgiTextureHandle &texture)
	Compute memory of texture and add to total texture memory amount maintained by registry.
HDST_API void	_SubtractFromTotalTextureMemory (const HgiTextureHandle &texture)
	Compute memory of texture and subtract to total texture memory amount maintained by registry.

Detailed Description

A UDIM texture.

Definition at line 37 of file udimTextureObject.h.

Member Function Documentation

_Commit()

HDST_API void _Commit ( )

overrideprotectedvirtual

Commit texture to GPU (not thread-safe)

Implements HdStTextureObject.

_Load()

HDST_API void _Load ( )

overrideprotectedvirtual

Load texture to CPU (thread-safe)

Implements HdStTextureObject.

GetCommittedSize()

HDST_API size_t GetCommittedSize ( ) const

overridevirtual

Returns the actual amount of memory committed to the GPU.

Implements HdStTextureObject.

GetLayoutTexture()

HgiTextureHandle const & GetLayoutTexture ( ) const

inline

Get the gpu texture name for the layout.

Only valid after commit phase.

Definition at line 58 of file udimTextureObject.h.

GetTexelTexture()

HgiTextureHandle const & GetTexelTexture ( ) const

inline

Get the gpu texture name for the texels.

Only valid after commit phase.

Definition at line 52 of file udimTextureObject.h.

GetTextureType()

HDST_API HdStTextureType GetTextureType ( ) const

overridevirtual

Get texture type.

Implements HdStTextureObject.

IsValid()

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:

• pxr/imaging/hdSt/udimTextureObject.h