Loading...
Searching...
No Matches
HdStCubemapTextureObject Class Reference

A base class for cubemap textures. More...

#include <textureObject.h>

+ Inheritance diagram for HdStCubemapTextureObject:

Public Member Functions

HgiTextureHandle const & GetTexture () const
 Get the handle to the actual GPU resource.
 
HDST_API HdStTextureType GetTextureType () const 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 HdStTextureType GetTextureType () const =0
 Get texture type.
 

Protected Member Functions

HDST_API HdStCubemapTextureObject (const HdStTextureIdentifier &textureId, HdSt_TextureObjectRegistry *textureObjectRegistry)
 
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 cubemap textures.

Definition at line 281 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 291 of file textureObject.h.

◆ GetTextureType()

HDST_API HdStTextureType GetTextureType ( ) const
finalvirtual

Get texture type.

Implements HdStTextureObject.


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