All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdNullBufferSource Class Reference

A abstract base class for pure cpu computation. More...

+ Inheritance diagram for HdNullBufferSource:

Public Member Functions

virtual HD_API TfToken const & GetName () const override
 Return the name of this buffer source. More...
 
virtual HD_API void const * GetData () 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
 Returns the number of elements (e.g. More...
 
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
 Add the buffer spec for this buffer source into given bufferspec vector. More...
 
- Public Member Functions inherited from HdBufferSource
virtual bool Resolve ()=0
 Prepare the access of GetData(). More...
 
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
 Checks the validity of the source buffer. More...
 
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 HdBufferSourceVector GetChainedBuffers () const
 Returns the vector of chained buffers. More...
 

Additional Inherited Members

- Protected Member Functions inherited from HdBufferSource
void _SetResolved ()
 Marks this buffer source as resolved. More...
 
void _SetResolveError ()
 Called during Resolve() to indicate an unrecoverable failure occurred and the results of the computation can not be used. More...
 
bool _TryLock ()
 Non-blocking lock acquisition. More...
 
virtual bool _CheckValid () const =0
 Checks the validity of the source buffer. More...
 

Detailed Description

A abstract base class for pure cpu computation.

the result won't be scheduled for GPU transfer.

Definition at line 235 of file bufferSource.h.

Member Function Documentation

virtual HD_API size_t ComputeHash ( ) const
overridevirtual

Computes and returns a hash value for the underlying data.

Reimplemented from HdBufferSource.

Reimplemented in HdStExtCompGpuPrimvarBufferSource.

virtual HD_API void GetBufferSpecs ( HdBufferSpecVector *  specs) const
overridevirtual

Add the buffer spec for this buffer source into given bufferspec vector.

note: buffer specs has to be determined before the source resolution.

Implements HdBufferSource.

Reimplemented in HdStExtCompGpuPrimvarBufferSource.

virtual HD_API void const* GetData ( ) const
overridevirtual

Following interfaces will be called after Resolve.

Returns the raw pointer to the underlying data.

Implements HdBufferSource.

virtual HD_API TfToken const& GetName ( ) const
overridevirtual

Return the name of this buffer source.

Implements HdBufferSource.

Reimplemented in HdExtCompCpuComputation, and HdStExtCompGpuPrimvarBufferSource.

virtual HD_API size_t GetNumElements ( ) const
overridevirtual

Returns the number of elements (e.g.

VtVec3dArray().GetLength()) from the source array.

Implements HdBufferSource.

Reimplemented in HdExtCompCpuComputation, and HdStExtCompGpuPrimvarBufferSource.

virtual HD_API HdTupleType GetTupleType ( ) const
overridevirtual

Returns the data type and count (array size) for this buffer source.

Implements HdBufferSource.

Reimplemented in HdStExtCompGpuPrimvarBufferSource.


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