Loading...
Searching...
No Matches
HdStUvTextureObject Class Reference

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 HdTextureType GetTextureType () const override final
 Get texture type.
 
- Public Member Functions inherited from HdStTextureObject
const HdStTextureIdentifierGetTextureIdentifier () 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 bool IsValid () const =0
 Is texture valid? Only correct after commit phase.
 
virtual HDST_API HdTextureType GetTextureType () const =0
 Get texture type.
 

Protected Member Functions

 HdStUvTextureObject (const HdStTextureIdentifier &textureId, HdSt_TextureObjectRegistry *textureObjectRegistry)
 
void _SetWrapParameters (const std::pair< HdWrap, HdWrap > &wrapParameters)
 
void _SetCpuData (std::unique_ptr< HdStTextureCpuData > &&)
 
HdStTextureCpuData_GetCpuData () const
 
void _CreateTexture (const HgiTextureDesc &desc)
 
void _GenerateMipmaps ()
 
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 155 of file textureObject.h.

Member Function Documentation

◆ GetTexture()

HgiTextureHandle const & GetTexture ( ) const
inline

Get the handle to the actual GPU resource.

Only valid after commit phase.

Definition at line 164 of file textureObject.h.

◆ GetTextureType()

HDST_API HdTextureType 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 171 of file textureObject.h.


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