HdImageShaderSchema Class Reference

#include <imageShaderSchema.h>

Inheritance diagram for HdImageShaderSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdBoolDataSourceHandle	GetEnabled () const
HD_API HdIntDataSourceHandle	GetPriority () const
HD_API HdStringDataSourceHandle	GetFilePath () const
HD_API HdSampledDataSourceContainerSchema	GetConstants () const
HD_API HdMaterialNetworkSchema	GetMaterialNetwork () 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 &	GetEnabledLocator ()
	Prim-level relative data source locator to locate enabled. More...
static HD_API const HdDataSourceLocator &	GetPriorityLocator ()
	Prim-level relative data source locator to locate priority. More...
static HD_API const HdDataSourceLocator &	GetFilePathLocator ()
	Prim-level relative data source locator to locate filePath. More...
static HD_API const HdDataSourceLocator &	GetConstantsLocator ()
	Prim-level relative data source locator to locate constants. More...
static HD_API const HdDataSourceLocator &	GetMaterialNetworkLocator ()
	Prim-level relative data source locator to locate materialNetwork. More...
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdBoolDataSourceHandle &enabled, const HdIntDataSourceHandle &priority, const HdStringDataSourceHandle &filePath, const HdContainerDataSourceHandle &constants, const HdContainerDataSourceHandle &materialNetwork)

Schema retrieval
	HdImageShaderSchema (HdContainerDataSourceHandle container)
static HD_API HdImageShaderSchema	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 51 of file imageShaderSchema.h.

Constructor & Destructor Documentation

HdImageShaderSchema::HdImageShaderSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "imageShader" from the parent container and constructs a HdImageShaderSchema 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 57 of file imageShaderSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdImageShaderSchema::BuildRetained ( const HdBoolDataSourceHandle &  enabled, const HdIntDataSourceHandle &  priority, const HdStringDataSourceHandle &  filePath, const HdContainerDataSourceHandle &  constants, const HdContainerDataSourceHandle &  materialNetwork  )

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 HdSampledDataSourceContainerSchema HdImageShaderSchema::GetConstants

(

)

const

static HD_API const HdDataSourceLocator& HdImageShaderSchema::GetConstantsLocator ( )

static

Prim-level relative data source locator to locate constants.

static HD_API const HdDataSourceLocator& HdImageShaderSchema::GetDefaultLocator ( )

static

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

HD_API HdBoolDataSourceHandle HdImageShaderSchema::GetEnabled

(

)

const

static HD_API const HdDataSourceLocator& HdImageShaderSchema::GetEnabledLocator ( )

static

Prim-level relative data source locator to locate enabled.

HD_API HdStringDataSourceHandle HdImageShaderSchema::GetFilePath

(

)

const

static HD_API const HdDataSourceLocator& HdImageShaderSchema::GetFilePathLocator ( )

static

Prim-level relative data source locator to locate filePath.

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

static

Retrieves a container data source with the schema's default name token "imageShader" from the parent container and constructs a HdImageShaderSchema 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 HdMaterialNetworkSchema HdImageShaderSchema::GetMaterialNetwork

(

)

const

static HD_API const HdDataSourceLocator& HdImageShaderSchema::GetMaterialNetworkLocator ( )

static

Prim-level relative data source locator to locate materialNetwork.

HD_API HdIntDataSourceHandle HdImageShaderSchema::GetPriority

(

)

const

static HD_API const HdDataSourceLocator& HdImageShaderSchema::GetPriorityLocator ( )

static

Prim-level relative data source locator to locate priority.

static HD_API const TfToken& HdImageShaderSchema::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/imageShaderSchema.h