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
HgiTextureHandle constGetTexture () const
const GfBBox3dGetBoundingBox () const
const GfMatrix4dGetSamplingTransform () const
HDST_API bool IsValid () const override
HDST_API HdTextureType GetTextureType () const override
- Public Member Functions inherited from HdStTextureObject
const HdStTextureIdentifierGetTextureIdentifier () const
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)
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
HDST_API void _AdjustTotalTextureMemory (int64_t memDiff)
HDST_API void _AddToTotalTextureMemory (const HgiTextureHandle &texture)
HDST_API void _SubtractFromTotalTextureMemory (const HgiTextureHandle &texture)

Detailed Description

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

Definition at line 232 of file textureObject.h.

Constructor & Destructor Documentation

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

Member Function Documentation

HDST_API void HdStFieldTextureObject::_Commit ( )

Commit texture to GPU (not thread-safe)

Implements HdStTextureObject.

HDST_API void HdStFieldTextureObject::_Load ( )

Load texture to CPU (thread-safe)

Implements HdStTextureObject.

const GfBBox3d& HdStFieldTextureObject::GetBoundingBox ( ) const

The box the texture fills out.

Only valid after the commit phase.

Definition at line 255 of file textureObject.h.

const GfMatrix4d& HdStFieldTextureObject::GetSamplingTransform ( ) const

The sampling transform.

Only valid after the commit phase.

Definition at line 261 of file textureObject.h.

HgiTextureHandle const& HdStFieldTextureObject::GetTexture ( ) const

Get the handle to the actual GPU resource.

Only valid after commit phase.

Definition at line 247 of file textureObject.h.

HDST_API HdTextureType HdStFieldTextureObject::GetTextureType ( ) const

Get texture type

Implements HdStTextureObject.

HDST_API bool HdStFieldTextureObject::IsValid ( ) const

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: