HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdStFieldTextureObject Class Referencefinal

#include <textureObject.h>

+ Inheritance diagram for HdStFieldTextureObject:

Public Member Functions

HDST_API HdStFieldTextureObject (const HdStTextureIdentifier &textureId, HdSt_TextureObjectRegistry *textureObjectRegistry)
 
HDST_API ~HdStFieldTextureObject () override
 
HDST_API HgiTextureHandle constGetTexture () const
 
HDST_API const GfBBox3dGetBoundingBox () const
 
HDST_API const GfMatrix4dGetSamplingTransform () const
 
HDST_API bool IsValid () const override
 
HDST_API HdTextureType GetTextureType () const override
 
- Public Member Functions inherited from HdStTextureObject
HDST_API const
HdStTextureIdentifier
GetTextureIdentifier () const
 
HDST_API size_t GetTargetMemory () const
 
HDST_API void SetTargetMemory (size_t)
 
virtual HDST_API ~HdStTextureObject ()
 

Protected Member Functions

HDST_API void _Load () override
 
HDST_API void _Commit () override
 
- Protected Member Functions inherited from HdStTextureObject
 HdStTextureObject (const HdStTextureIdentifier &textureId, HdSt_TextureObjectRegistry *textureObjectRegistry)
 
Hgi_GetHgi () const
 

Detailed Description

A uvw texture with a bounding box describing how to transform it.

Definition at line 203 of file textureObject.h.

Constructor & Destructor Documentation

HDST_API HdStFieldTextureObject::HdStFieldTextureObject ( const HdStTextureIdentifier textureId,
HdSt_TextureObjectRegistry textureObjectRegistry 
)
HDST_API HdStFieldTextureObject::~HdStFieldTextureObject ( )
override

Member Function Documentation

HDST_API void HdStFieldTextureObject::_Commit ( )
overrideprotectedvirtual

Commit texture to GPU (not thread-safe)

Implements HdStTextureObject.

HDST_API void HdStFieldTextureObject::_Load ( )
overrideprotectedvirtual

Load texture to CPU (thread-safe)

Implements HdStTextureObject.

HDST_API const GfBBox3d& HdStFieldTextureObject::GetBoundingBox ( ) const
inline

The box the texture fills out.

Only valid after the commit phase.

Definition at line 228 of file textureObject.h.

HDST_API const GfMatrix4d& HdStFieldTextureObject::GetSamplingTransform ( ) const
inline

The sampling transform.

Only valid after the commit phase.

Definition at line 235 of file textureObject.h.

HDST_API HgiTextureHandle const& HdStFieldTextureObject::GetTexture ( ) const
inline

Get the handle to the actual GPU resource.

Only valid after commit phase.

Definition at line 219 of file textureObject.h.

HDST_API HdTextureType HdStFieldTextureObject::GetTextureType ( ) const
overridevirtual

Get texture type

Implements HdStTextureObject.

HDST_API bool HdStFieldTextureObject::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: