HdRenderSettingsSchema Class Reference

#include <renderSettingsSchema.h>

Inheritance diagram for HdRenderSettingsSchema:

Classes
class	Builder

Public Member Functions
	HdRenderSettingsSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetNamespacedSettings ()
HD_API HdBoolDataSourceHandle	GetActive ()
HD_API HdRenderProductVectorSchema	GetRenderProducts ()
HD_API HdTokenArrayDataSourceHandle	GetIncludedPurposes ()
HD_API HdTokenArrayDataSourceHandle	GetMaterialBindingPurposes ()
HD_API HdTokenDataSourceHandle	GetRenderingColorSpace ()
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 &namespacedSettings, const HdBoolDataSourceHandle &active, const HdVectorDataSourceHandle &renderProducts, const HdTokenArrayDataSourceHandle &includedPurposes, const HdTokenArrayDataSourceHandle &materialBindingPurposes, const HdTokenDataSourceHandle &renderingColorSpace)
static HD_API HdRenderSettingsSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
static HD_API const HdDataSourceLocator &	GetNamespacedSettingsLocator ()
static HD_API const HdDataSourceLocator &	GetActiveLocator ()
static HD_API const HdDataSourceLocator &	GetRenderProductsLocator ()
static HD_API const HdDataSourceLocator &	GetIncludedPurposesLocator ()
static HD_API const HdDataSourceLocator &	GetMaterialBindingPurposesLocator ()
static HD_API const HdDataSourceLocator &	GetRenderingColorSpaceLocator ()

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 56 of file renderSettingsSchema.h.

Constructor & Destructor Documentation

HdRenderSettingsSchema::HdRenderSettingsSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 59 of file renderSettingsSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdRenderSettingsSchema::BuildRetained ( const HdContainerDataSourceHandle &  namespacedSettings, const HdBoolDataSourceHandle &  active, const HdVectorDataSourceHandle &  renderProducts, const HdTokenArrayDataSourceHandle &  includedPurposes, const HdTokenArrayDataSourceHandle &  materialBindingPurposes, const HdTokenDataSourceHandle &  renderingColorSpace  )

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 HdBoolDataSourceHandle HdRenderSettingsSchema::GetActive

(

)

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetActiveLocator ( )

static

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

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetDefaultLocator ( )

static

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

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

static

Retrieves a container data source with the schema's default name token "renderSettings" from the parent container and constructs a HdRenderSettingsSchema 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 HdTokenArrayDataSourceHandle HdRenderSettingsSchema::GetIncludedPurposes

(

)

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetIncludedPurposesLocator ( )

static

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

HD_API HdTokenArrayDataSourceHandle HdRenderSettingsSchema::GetMaterialBindingPurposes

(

)

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetMaterialBindingPurposesLocator ( )

static

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

HD_API HdContainerDataSourceHandle HdRenderSettingsSchema::GetNamespacedSettings

(

)

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetNamespacedSettingsLocator ( )

static

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

HD_API HdTokenDataSourceHandle HdRenderSettingsSchema::GetRenderingColorSpace

(

)

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetRenderingColorSpaceLocator ( )

static

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

HD_API HdRenderProductVectorSchema HdRenderSettingsSchema::GetRenderProducts

(

)

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetRenderProductsLocator ( )

static

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

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