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

#include <compExtCompInputSource.h>

+ Inheritance diagram for Hd_CompExtCompInputSource:

Public Member Functions

HD_API Hd_CompExtCompInputSource (const TfToken &inputName, const HdExtCompCpuComputationSharedPtr &source, const TfToken &sourceOutputName)
 
virtual HD_API ~Hd_CompExtCompInputSource ()=default
 
virtual HD_API bool Resolve () override
 Returns true once the source computation has been resolved. More...
 
virtual HD_API const VtValueGetValue () const override
 Obtains the value of the output from the source computation. More...
 
- Public Member Functions inherited from Hd_ExtCompInputSource
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...
 
- 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 ()
 
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...
 

Protected Member Functions

virtual bool _CheckValid () const override
 Returns true if the binding is successful. More...
 
- Protected Member Functions inherited from HdBufferSource
void _SetResolved ()
 
void _SetResolveError ()
 
bool _TryLock ()
 

Detailed Description

An Hd Buffer Source Computation that is used to bind an ExtComputation input to a specific output of another ExtComputation.

Definition at line 46 of file compExtCompInputSource.h.

Constructor & Destructor Documentation

HD_API Hd_CompExtCompInputSource::Hd_CompExtCompInputSource ( const TfToken inputName,
const HdExtCompCpuComputationSharedPtr source,
const TfToken sourceOutputName 
)

Constructs the computation, binding inputName to sourceOutputName on buffer source representation of the source computation.

virtual HD_API Hd_CompExtCompInputSource::~Hd_CompExtCompInputSource ( )
virtualdefault

Member Function Documentation

virtual bool Hd_CompExtCompInputSource::_CheckValid ( ) const
overrideprotectedvirtual

Returns true if the binding is successful.

Implements HdBufferSource.

virtual HD_API const VtValue& Hd_CompExtCompInputSource::GetValue ( ) const
overridevirtual

Obtains the value of the output from the source computation.

Implements Hd_ExtCompInputSource.

virtual HD_API bool Hd_CompExtCompInputSource::Resolve ( )
overridevirtual

Returns true once the source computation has been resolved.

Implements HdBufferSource.


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