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

#include <extCompPrimvarBufferSource.h>

+ Inheritance diagram for HdExtCompPrimvarBufferSource:

Public Member Functions

HD_API HdExtCompPrimvarBufferSource (const TfToken &primvarName, const HdExtCompCpuComputationSharedPtr &source, const TfToken &sourceOutputName, const HdTupleType &valueType)
 
virtual HD_API ~HdExtCompPrimvarBufferSource ()=default
 
virtual HD_API TfToken constGetName () const override
 Returns the name of the primvar. More...
 
virtual HD_API void GetBufferSpecs (HdBufferSpecVector *specs) const override
 Adds this Primvar's buffer description to the buffer spec vector. More...
 
virtual HD_API size_t ComputeHash () const override
 Computes and returns a hash value for the underlying data. More...
 
virtual HD_API bool Resolve () override
 Extracts the primvar from the source computation. More...
 
virtual HD_API void constGetData () const override
 Returns a raw pointer to the primvar data. More...
 
virtual HD_API HdTupleType GetTupleType () const override
 Returns the tuple data format of the primvar data. More...
 
virtual HD_API size_t GetNumElements () const override
 Returns a count of the number of elements. More...
 
- 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 HD_API bool _CheckValid () const override
 Returns true if the binding to the source computation was successful. More...
 
- Protected Member Functions inherited from HdBufferSource
void _SetResolved ()
 
void _SetResolveError ()
 
bool _TryLock ()
 

Detailed Description

Hd Buffer Source that binds a primvar to a Ext Computation output. This buffer source is compatible with being bound to a Bar.

Definition at line 44 of file extCompPrimvarBufferSource.h.

Constructor & Destructor Documentation

HD_API HdExtCompPrimvarBufferSource::HdExtCompPrimvarBufferSource ( const TfToken primvarName,
const HdExtCompCpuComputationSharedPtr source,
const TfToken sourceOutputName,
const HdTupleType valueType 
)

Constructs a new primvar buffer source called primvarName and binds it to the output called sourceOutputName from the computation identified by source.

Default value provides type information for the primvar and may be used in the event of an error.

virtual HD_API HdExtCompPrimvarBufferSource::~HdExtCompPrimvarBufferSource ( )
virtualdefault

Member Function Documentation

virtual HD_API bool HdExtCompPrimvarBufferSource::_CheckValid ( ) const
overrideprotectedvirtual

Returns true if the binding to the source computation was successful.

Implements HdBufferSource.

virtual HD_API size_t HdExtCompPrimvarBufferSource::ComputeHash ( ) const
overridevirtual

Computes and returns a hash value for the underlying data.

Reimplemented from HdBufferSource.

virtual HD_API void HdExtCompPrimvarBufferSource::GetBufferSpecs ( HdBufferSpecVector specs) const
overridevirtual

Adds this Primvar's buffer description to the buffer spec vector.

Implements HdBufferSource.

virtual HD_API void const* HdExtCompPrimvarBufferSource::GetData ( ) const
overridevirtual

Returns a raw pointer to the primvar data.

Implements HdBufferSource.

virtual HD_API TfToken const& HdExtCompPrimvarBufferSource::GetName ( ) const
overridevirtual

Returns the name of the primvar.

Implements HdBufferSource.

virtual HD_API size_t HdExtCompPrimvarBufferSource::GetNumElements ( ) const
overridevirtual

Returns a count of the number of elements.

Implements HdBufferSource.

virtual HD_API HdTupleType HdExtCompPrimvarBufferSource::GetTupleType ( ) const
overridevirtual

Returns the tuple data format of the primvar data.

Implements HdBufferSource.

virtual HD_API bool HdExtCompPrimvarBufferSource::Resolve ( )
overridevirtual

Extracts the primvar from the source computation.

Implements HdBufferSource.


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