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

#include <extComputationSchema.h>

+ Inheritance diagram for HdExtComputationSchema:

Classes

class  Builder
 

Public Member Functions

 HdExtComputationSchema (HdContainerDataSourceHandle container)
 
HD_API HdContainerDataSourceHandle GetInputValues ()
 
HD_API HdVectorDataSourceHandle GetInputComputations ()
 
HD_API HdVectorDataSourceHandle GetOutputs ()
 
HD_API HdStringDataSourceHandle GetGlslKernel ()
 
HD_API HdDataSourceBaseHandle GetCpuCallback ()
 
HD_API HdSizetDataSourceHandle GetDispatchCount ()
 
HD_API HdSizetDataSourceHandle GetElementCount ()
 
- Public Member Functions inherited from HdSchema
 HdSchema (HdContainerDataSourceHandle container)
 
HD_API HdContainerDataSourceHandle GetContainer ()
 Returns the container data source that this schema is interpreting. More...
 
HD_API bool IsDefined () const
 
 operator bool () const
 

Static Public Member Functions

static HD_API
HdContainerDataSourceHandle 
BuildRetained (const HdContainerDataSourceHandle &inputValues, const HdVectorDataSourceHandle &inputComputations, const HdVectorDataSourceHandle &outputs, const HdStringDataSourceHandle &glslKernel, const HdDataSourceBaseHandle &cpuCallback, const HdSizetDataSourceHandle &dispatchCount, const HdSizetDataSourceHandle &elementCount)
 
static HD_API
HdExtComputationSchema 
GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 
static HD_API const TfTokenGetSchemaToken ()
 
static HD_API const
HdDataSourceLocator
GetDefaultLocator ()
 
static HD_API const
HdDataSourceLocator
GetInputValuesLocator ()
 
static HD_API const
HdDataSourceLocator
GetInputComputationsLocator ()
 
static HD_API const
HdDataSourceLocator
GetOutputsLocator ()
 
static HD_API const
HdDataSourceLocator
GetDispatchCountLocator ()
 
static HD_API const
HdDataSourceLocator
GetElementCountLocator ()
 
static HD_API const
HdDataSourceLocator
GetGlslKernelLocator ()
 

Additional Inherited Members

- Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle _GetTypedDataSource (TfToken name)
 
- Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle _container
 

Detailed Description

Definition at line 57 of file extComputationSchema.h.

Constructor & Destructor Documentation

HdExtComputationSchema::HdExtComputationSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 60 of file extComputationSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdExtComputationSchema::BuildRetained ( const HdContainerDataSourceHandle &  inputValues,
const HdVectorDataSourceHandle &  inputComputations,
const HdVectorDataSourceHandle &  outputs,
const HdStringDataSourceHandle glslKernel,
const HdDataSourceBaseHandle &  cpuCallback,
const HdSizetDataSourceHandle dispatchCount,
const HdSizetDataSourceHandle elementCount 
)
static

Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.

HD_API HdDataSourceBaseHandle HdExtComputationSchema::GetCpuCallback ( )
static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetDefaultLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

HD_API HdSizetDataSourceHandle HdExtComputationSchema::GetDispatchCount ( )
static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetDispatchCountLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the dispatchcount data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

HD_API HdSizetDataSourceHandle HdExtComputationSchema::GetElementCount ( )
static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetElementCountLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the elementcount data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

static HD_API HdExtComputationSchema HdExtComputationSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

Retrieves a container data source with the schema's default name token "extComputation" from the parent container and constructs a HdExtComputationSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

HD_API HdStringDataSourceHandle HdExtComputationSchema::GetGlslKernel ( )
static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetGlslKernelLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the glslkernel data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

HD_API HdVectorDataSourceHandle HdExtComputationSchema::GetInputComputations ( )
static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetInputComputationsLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the inputcomputations data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

HD_API HdContainerDataSourceHandle HdExtComputationSchema::GetInputValues ( )
static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetInputValuesLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the inputvalues data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

HD_API HdVectorDataSourceHandle HdExtComputationSchema::GetOutputs ( )
static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetOutputsLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the outputs data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

static HD_API const TfToken& HdExtComputationSchema::GetSchemaToken ( )
static

Returns a token where the container representing this schema is found in a container by default.


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