HdMaterialNodeParameterSchema Class Reference

The MaterialNodeParameter schema defines the value data source for the parameter. More...

#include <materialNodeParameterSchema.h>

Inheritance diagram for HdMaterialNodeParameterSchema:

Classes
class	Builder
	Utility class for setting sparse sets of child data source fields to be filled as arguments into BuildRetained. More...

Public Member Functions
Schema retrieval
	HdMaterialNodeParameterSchema (HdContainerDataSourceHandle container)
Member accessor
HD_API HdSampledDataSourceHandle	GetValue () const
HD_API HdTokenDataSourceHandle	GetColorSpace () const
HD_API HdTokenDataSourceHandle	GetTypeName () 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.
HD_API bool	IsDefined () const
	operator bool () const
	Returns true if this schema is applied on top of a non-null container.

Static Public Member Functions
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdSampledDataSourceHandle &value, const HdTokenDataSourceHandle &colorSpace, const HdTokenDataSourceHandle &typeName)

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
	Returns a datasource of the requested type for the given name: schema implementations can use this to ask for child containers, sampled values, vectors, etc.
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

The MaterialNodeParameter schema defines the value data source for the parameter.

Definition at line 51 of file materialNodeParameterSchema.h.

Constructor & Destructor Documentation

HdMaterialNodeParameterSchema()

HdMaterialNodeParameterSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 57 of file materialNodeParameterSchema.h.

Member Function Documentation

BuildRetained()

static HD_API HdContainerDataSourceHandle BuildRetained ( const HdSampledDataSourceHandle &  value, const HdTokenDataSourceHandle &  colorSpace, const HdTokenDataSourceHandle &  typeName  )

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.

---

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

• pxr/imaging/hd/materialNodeParameterSchema.h