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

#include <materialNodeSchema.h>

+ Inheritance diagram for HdMaterialNodeSchema:

Classes

class  Builder
 

Public Member Functions

Schema retrieval
 HdMaterialNodeSchema (HdContainerDataSourceHandle container)
 
Member accessor
HD_API
HdMaterialNodeParameterContainerSchema 
GetParameters ()
 
HD_API
HdMaterialConnectionVectorContainerSchema 
GetInputConnections ()
 
HD_API HdTokenDataSourceHandle GetNodeIdentifier ()
 
HD_API HdContainerDataSourceHandle GetRenderContextNodeIdentifiers ()
 
HD_API HdContainerDataSourceHandle GetNodeTypeInfo ()
 
- 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

Schema construction
static HD_API
HdContainerDataSourceHandle 
BuildRetained (const HdContainerDataSourceHandle &parameters, const HdContainerDataSourceHandle &inputConnections, const HdTokenDataSourceHandle &nodeIdentifier, const HdContainerDataSourceHandle &renderContextNodeIdentifiers, const HdContainerDataSourceHandle &nodeTypeInfo)
 

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)
 
- Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle _container
 

Detailed Description

Definition at line 66 of file materialNodeSchema.h.

Constructor & Destructor Documentation

HdMaterialNodeSchema::HdMaterialNodeSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 72 of file materialNodeSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdMaterialNodeSchema::BuildRetained ( const HdContainerDataSourceHandle &  parameters,
const HdContainerDataSourceHandle &  inputConnections,
const HdTokenDataSourceHandle nodeIdentifier,
const HdContainerDataSourceHandle &  renderContextNodeIdentifiers,
const HdContainerDataSourceHandle &  nodeTypeInfo 
)
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 HdMaterialConnectionVectorContainerSchema HdMaterialNodeSchema::GetInputConnections ( )

This identifies the shader the node represents. The renderContextNodeIdentifier container can store alternative values for this. A consumer which is interested in a specific render context should check for that token within renderContextNodeIdentifiers and fall back on this value in its absence.

HD_API HdTokenDataSourceHandle HdMaterialNodeSchema::GetNodeIdentifier ( )

This identifies the shader the node represents. The renderContextNodeIdentifier container can store alternative values for this. A consumer which is interested in a specific render context should check for that token within renderContextNodeIdentifiers and fall back on this value in its absence.

HD_API HdContainerDataSourceHandle HdMaterialNodeSchema::GetNodeTypeInfo ( )

Rather than having an identifier, a shader can be specified by other information.

HD_API HdMaterialNodeParameterContainerSchema HdMaterialNodeSchema::GetParameters ( )

This identifies the shader the node represents. The renderContextNodeIdentifier container can store alternative values for this. A consumer which is interested in a specific render context should check for that token within renderContextNodeIdentifiers and fall back on this value in its absence.

HD_API HdContainerDataSourceHandle HdMaterialNodeSchema::GetRenderContextNodeIdentifiers ( )

A shading node can hold a nodeIdentifier value for multiple render contexts at once. This allows multiple renderer target representations to coexist in the same renderable scene. The contents of this container are alternate possible values for nodeIdentifier. A consumer which is interested in a specific render context should check for that token within this container and fall back on nodeIdentifier in its absence.


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