HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdStTextureObject Class Referenceabstract

#include <textureObject.h>

+ Inheritance diagram for HdStTextureObject:

Public Member Functions

HDST_API const
HdStTextureIdentifier
GetTextureIdentifier () const
 
HDST_API size_t GetTargetMemory () const
 
HDST_API void SetTargetMemory (size_t)
 
virtual HDST_API bool IsValid () const =0
 
virtual HDST_API HdTextureType GetTextureType () const =0
 
virtual HDST_API ~HdStTextureObject ()
 

Protected Member Functions

 HdStTextureObject (const HdStTextureIdentifier &textureId, HdSt_TextureObjectRegistry *textureObjectRegistry)
 
Hgi_GetHgi () const
 
virtual HDST_API void _Load ()=0
 
virtual HDST_API void _Commit ()=0
 

Friends

class HdSt_TextureObjectRegistry
 

Detailed Description

Base class for a texture object. The actual GPU resources will be allocated during the commit phase.

Definition at line 58 of file textureObject.h.

Constructor & Destructor Documentation

virtual HDST_API HdStTextureObject::~HdStTextureObject ( )
virtual
HdStTextureObject::HdStTextureObject ( const HdStTextureIdentifier textureId,
HdSt_TextureObjectRegistry textureObjectRegistry 
)
protected

Member Function Documentation

virtual HDST_API void HdStTextureObject::_Commit ( )
protectedpure virtual
Hgi* HdStTextureObject::_GetHgi ( ) const
protected
virtual HDST_API void HdStTextureObject::_Load ( )
protectedpure virtual
HDST_API size_t HdStTextureObject::GetTargetMemory ( ) const
inline

Get the target memory for the texture.

Definition at line 71 of file textureObject.h.

HDST_API const HdStTextureIdentifier& HdStTextureObject::GetTextureIdentifier ( ) const
inline

Get texture identifier

Definition at line 66 of file textureObject.h.

virtual HDST_API HdTextureType HdStTextureObject::GetTextureType ( ) const
pure virtual
virtual HDST_API bool HdStTextureObject::IsValid ( ) const
pure virtual

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.

Implemented in HdStUdimTextureObject, HdStPtexTextureObject, HdStFieldTextureObject, HdStAssetUvTextureObject, and HdStDynamicUvTextureObject.

HDST_API void HdStTextureObject::SetTargetMemory ( size_t  )

Set the target memory (in bytes).

When uploading the texture to the GPU, it will be downsampled to meet this target memory.

Friends And Related Function Documentation

Definition at line 115 of file textureObject.h.


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