#include <extComputationSchema.h>

Inheritance diagram for HdExtComputationSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdSampledDataSourceContainerSchema	GetInputValues () const

HD_API HdExtComputationInputComputationContainerSchema	GetInputComputations () const

HD_API HdExtComputationOutputContainerSchema	GetOutputs () const

HD_API HdStringDataSourceHandle	GetGlslKernel () const

HD_API HdExtComputationCpuCallbackDataSourceHandle	GetCpuCallback () const

HD_API HdSizetDataSourceHandle	GetDispatchCount () const

HD_API HdSizetDataSourceHandle	GetElementCount () const

Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)

HD_API HdContainerDataSourceHandle	GetContainer () const
	Returns the container data source that this schema is interpreting. More...

HD_API bool	IsDefined () const

	operator bool () const

Static Public Member Functions
Schema location
static HD_API const TfToken &	GetSchemaToken ()

static HD_API const HdDataSourceLocator &	GetDefaultLocator ()

Data source locators for members
The following methods return an HdDataSourceLocator (relative to the prim-level data source) where the data source for a member can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
static HD_API const HdDataSourceLocator &	GetInputValuesLocator ()
	Prim-level relative data source locator to locate inputValues. More...

static HD_API const HdDataSourceLocator &	GetInputComputationsLocator ()
	Prim-level relative data source locator to locate inputComputations. More...

static HD_API const HdDataSourceLocator &	GetOutputsLocator ()
	Prim-level relative data source locator to locate outputs. More...

static HD_API const HdDataSourceLocator &	GetGlslKernelLocator ()
	Prim-level relative data source locator to locate glslKernel. More...

static HD_API const HdDataSourceLocator &	GetCpuCallbackLocator ()
	Prim-level relative data source locator to locate cpuCallback. More...

static HD_API const HdDataSourceLocator &	GetDispatchCountLocator ()
	Prim-level relative data source locator to locate dispatchCount. More...

static HD_API const HdDataSourceLocator &	GetElementCountLocator ()
	Prim-level relative data source locator to locate elementCount. More...

Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdContainerDataSourceHandle &inputValues, const HdContainerDataSourceHandle &inputComputations, const HdContainerDataSourceHandle &outputs, const HdStringDataSourceHandle &glslKernel, const HdExtComputationCpuCallbackDataSourceHandle &cpuCallback, const HdSizetDataSourceHandle &dispatchCount, const HdSizetDataSourceHandle &elementCount)

Schema retrieval
	HdExtComputationSchema (HdContainerDataSourceHandle container)

static HD_API HdExtComputationSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource

Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name) const

Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 60 of file extComputationSchema.h.

Constructor & Destructor Documentation

HdExtComputationSchema::HdExtComputationSchema ( HdContainerDataSourceHandle container )

inline

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.

Definition at line 66 of file extComputationSchema.h.

Member Function Documentation

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

static

Deprecated:: Use Builder instead.

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 HdExtComputationCpuCallbackDataSourceHandle HdExtComputationSchema::GetCpuCallback ( ) const

static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetCpuCallbackLocator ( )

static

Prim-level relative data source locator to locate cpuCallback.

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 ( ) const

static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetDispatchCountLocator ( )

static

Prim-level relative data source locator to locate dispatchCount.

HD_API HdSizetDataSourceHandle HdExtComputationSchema::GetElementCount ( ) const

static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetElementCountLocator ( )

static

Prim-level relative data source locator to locate elementCount.

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 ( ) const

static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetGlslKernelLocator ( )

static

Prim-level relative data source locator to locate glslKernel.

HD_API HdExtComputationInputComputationContainerSchema HdExtComputationSchema::GetInputComputations ( ) const

static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetInputComputationsLocator ( )

static

Prim-level relative data source locator to locate inputComputations.

HD_API HdSampledDataSourceContainerSchema HdExtComputationSchema::GetInputValues ( ) const

static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetInputValuesLocator ( )

static

Prim-level relative data source locator to locate inputValues.

HD_API HdExtComputationOutputContainerSchema HdExtComputationSchema::GetOutputs ( ) const

static HD_API const HdDataSourceLocator& HdExtComputationSchema::GetOutputsLocator ( )

static

Prim-level relative data source locator to locate outputs.

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:

pxr/imaging/hd/extComputationSchema.h

Classes

Public Member Functions

Static Public Member Functions

Schema retrieval

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation