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

#include <extCompInputSource.h>

+ Inheritance diagram for Hd_ExtCompInputSource:

Public Member Functions

HD_API Hd_ExtCompInputSource (const TfToken &inputName)
 Constructs the input binding with the name inputName. More...
 
virtual HD_API ~Hd_ExtCompInputSource ()=default
 
virtual HD_API TfToken constGetName () const final
 Returns the name of the input. More...
 
virtual HD_API const VtValueGetValue () const =0
 Returns the value associated with the input. More...
 
- Public Member Functions inherited from HdNullBufferSource
virtual HD_API void constGetData () const override
 Following interfaces will be called after Resolve. More...
 
virtual HD_API size_t ComputeHash () const override
 Computes and returns a hash value for the underlying data. More...
 
virtual HD_API size_t GetNumElements () const override
 
virtual HD_API HdTupleType GetTupleType () const override
 Returns the data type and count (array size) for this buffer source. More...
 
virtual HD_API void GetBufferSpecs (HdBufferSpecVector *specs) const override
 
- Public Member Functions inherited from HdBufferSource
 HdBufferSource ()
 
virtual HD_API ~HdBufferSource ()
 
virtual bool Resolve ()=0
 
bool IsResolved () const
 Returns true it this computation has already been resolved. More...
 
bool HasResolveError () const
 Returns true if an error occurred during resolve. More...
 
HD_API bool IsValid () const
 
virtual HD_API bool HasPreChainedBuffer () const
 Returns true if this buffer has a pre-chained buffer. More...
 
virtual HD_API
HdBufferSourceSharedPtr 
GetPreChainedBuffer () const
 Returns the pre-chained buffer. More...
 
virtual HD_API bool HasChainedBuffer () const
 Returns true if this buffer has any chained buffer(s) More...
 
virtual HD_API
HdBufferSourceSharedPtrVector 
GetChainedBuffers () const
 Returns the vector of chained buffers. More...
 

Additional Inherited Members

- Protected Member Functions inherited from HdBufferSource
void _SetResolved ()
 
void _SetResolveError ()
 
bool _TryLock ()
 
virtual bool _CheckValid () const =0
 

Detailed Description

Abstract base class for a Buffer Source that represents a binding to an input to an ExtComputation.

Definition at line 44 of file extCompInputSource.h.

Constructor & Destructor Documentation

HD_API Hd_ExtCompInputSource::Hd_ExtCompInputSource ( const TfToken inputName)

Constructs the input binding with the name inputName.

virtual HD_API Hd_ExtCompInputSource::~Hd_ExtCompInputSource ( )
virtualdefault

Member Function Documentation

virtual HD_API TfToken const& Hd_ExtCompInputSource::GetName ( ) const
finalvirtual

Returns the name of the input.

Reimplemented from HdNullBufferSource.

virtual HD_API const VtValue& Hd_ExtCompInputSource::GetValue ( ) const
pure virtual

Returns the value associated with the input.

Implemented in Hd_CompExtCompInputSource, and Hd_SceneExtCompInputSource.


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