A base class for uv textures. More...

#include <textureObject.h>

Inheritance diagram for HdStUvTextureObject:

Public Member Functions
HgiTextureHandle const &	GetTexture () const
	Get the handle to the actual GPU resource.

const std::pair< HdWrap, HdWrap > &	GetWrapParameters () const
	Opinion about wrapS and wrapT parameters from the texture file.

HDST_API HdStTextureType	GetTextureType () const override final
	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	HdStUvTextureObject (const HdStTextureIdentifier &textureId, HdSt_TextureObjectRegistry *textureObjectRegistry)

HDST_API void	_SetWrapParameters (const std::pair< HdWrap, HdWrap > &wrapParameters)

HDST_API void	_SetCpuData (std::unique_ptr< HdStTextureCpuData > &&)

HDST_API HdStTextureCpuData *	_GetCpuData () const

HDST_API void	_CreateTexture (const HgiTextureDesc &desc)

HDST_API void	_GenerateMipmaps ()

HDST_API void	_DestroyTexture ()

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 base class for uv textures.

Definition at line 142 of file textureObject.h.

Member Function Documentation

◆ GetCommittedSize()

HDST_API size_t GetCommittedSize ( ) const

overridevirtual

Returns the actual amount of memory committed to the GPU.

Implements HdStTextureObject.

◆ GetTexture()

HgiTextureHandle const & GetTexture ( ) const

inline

Get the handle to the actual GPU resource.

Only valid after commit phase.

Definition at line 152 of file textureObject.h.

◆ GetTextureType()

HDST_API HdStTextureType GetTextureType ( ) const

finaloverridevirtual

Get texture type.

Implements HdStTextureObject.

◆ GetWrapParameters()

const std::pair< HdWrap, HdWrap > & GetWrapParameters ( ) const

inline

Opinion about wrapS and wrapT parameters from the texture file.

Only valid after commit phase. Can be HdWrapNoOpinion.

Definition at line 159 of file textureObject.h.

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

pxr/imaging/hdSt/textureObject.h