#include <renderSettingsSchema.h>

Inheritance diagram for HdRenderSettingsSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdContainerDataSourceHandle	GetNamespacedSettings () const

HD_API HdBoolDataSourceHandle	GetActive () const

HD_API HdRenderProductVectorSchema	GetRenderProducts () const

HD_API HdTokenArrayDataSourceHandle	GetIncludedPurposes () const

HD_API HdTokenArrayDataSourceHandle	GetMaterialBindingPurposes () const

HD_API HdTokenDataSourceHandle	GetRenderingColorSpace () const

HD_API HdVec2dDataSourceHandle	GetShutterInterval () 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
static HD_API const HdDataSourceLocator &	GetFrameLocator ()

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 &	GetNamespacedSettingsLocator ()
	Prim-level relative data source locator to locate namespacedSettings. More...

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

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

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

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

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

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

Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdContainerDataSourceHandle &namespacedSettings, const HdBoolDataSourceHandle &active, const HdVectorDataSourceHandle &renderProducts, const HdTokenArrayDataSourceHandle &includedPurposes, const HdTokenArrayDataSourceHandle &materialBindingPurposes, const HdTokenDataSourceHandle &renderingColorSpace, const HdVec2dDataSourceHandle &shutterInterval)

Schema retrieval
	HdRenderSettingsSchema (HdContainerDataSourceHandle container)

static HD_API HdRenderSettingsSchema	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 55 of file renderSettingsSchema.h.

Constructor & Destructor Documentation

HdRenderSettingsSchema::HdRenderSettingsSchema ( HdContainerDataSourceHandle container )

inline

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.

Definition at line 61 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,
		const HdVec2dDataSourceHandle &	shutterInterval
	)

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

Frame-relative time interval representing the sampling window for data relevant to motion blur. Renderers can use this interval when querying time-sampled data (e.g., xforms, points, velocities, ...) to simulate motion blur effects. Note: This closely relates to the (frame- relative) shutter interval of a camera specified via shutter open and close times and is expected to span the union of the shutter intervals of cameras used in generating the render artifacts.

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetActiveLocator ( )

static

Prim-level relative data source locator to locate active.

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 const HdDataSourceLocator& HdRenderSettingsSchema::GetFrameLocator ( )

static

This locator is to pass along dirtying of the currentFrame locator on the Scene Globals Scene Index through the render Settings prim.

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

Frame-relative time interval representing the sampling window for data relevant to motion blur. Renderers can use this interval when querying time-sampled data (e.g., xforms, points, velocities, ...) to simulate motion blur effects. Note: This closely relates to the (frame- relative) shutter interval of a camera specified via shutter open and close times and is expected to span the union of the shutter intervals of cameras used in generating the render artifacts.

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetIncludedPurposesLocator ( )

static

Prim-level relative data source locator to locate includedPurposes.

HD_API HdTokenArrayDataSourceHandle HdRenderSettingsSchema::GetMaterialBindingPurposes ( ) const

Frame-relative time interval representing the sampling window for data relevant to motion blur. Renderers can use this interval when querying time-sampled data (e.g., xforms, points, velocities, ...) to simulate motion blur effects. Note: This closely relates to the (frame- relative) shutter interval of a camera specified via shutter open and close times and is expected to span the union of the shutter intervals of cameras used in generating the render artifacts.

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetMaterialBindingPurposesLocator ( )

static

Prim-level relative data source locator to locate materialBindingPurposes.

HD_API HdContainerDataSourceHandle HdRenderSettingsSchema::GetNamespacedSettings ( ) const

Frame-relative time interval representing the sampling window for data relevant to motion blur. Renderers can use this interval when querying time-sampled data (e.g., xforms, points, velocities, ...) to simulate motion blur effects. Note: This closely relates to the (frame- relative) shutter interval of a camera specified via shutter open and close times and is expected to span the union of the shutter intervals of cameras used in generating the render artifacts.

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetNamespacedSettingsLocator ( )

static

Prim-level relative data source locator to locate namespacedSettings.

HD_API HdTokenDataSourceHandle HdRenderSettingsSchema::GetRenderingColorSpace ( ) const

Frame-relative time interval representing the sampling window for data relevant to motion blur. Renderers can use this interval when querying time-sampled data (e.g., xforms, points, velocities, ...) to simulate motion blur effects. Note: This closely relates to the (frame- relative) shutter interval of a camera specified via shutter open and close times and is expected to span the union of the shutter intervals of cameras used in generating the render artifacts.

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetRenderingColorSpaceLocator ( )

static

Prim-level relative data source locator to locate renderingColorSpace.

HD_API HdRenderProductVectorSchema HdRenderSettingsSchema::GetRenderProducts ( ) const

Frame-relative time interval representing the sampling window for data relevant to motion blur. Renderers can use this interval when querying time-sampled data (e.g., xforms, points, velocities, ...) to simulate motion blur effects. Note: This closely relates to the (frame- relative) shutter interval of a camera specified via shutter open and close times and is expected to span the union of the shutter intervals of cameras used in generating the render artifacts.

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetRenderProductsLocator ( )

static

Prim-level relative data source locator to locate renderProducts.

static HD_API const TfToken& HdRenderSettingsSchema::GetSchemaToken ( )

static

Returns a token where the container representing this schema is found in a container by default.

HD_API HdVec2dDataSourceHandle HdRenderSettingsSchema::GetShutterInterval ( ) const

Frame-relative time interval representing the sampling window for data relevant to motion blur. Renderers can use this interval when querying time-sampled data (e.g., xforms, points, velocities, ...) to simulate motion blur effects. Note: This closely relates to the (frame- relative) shutter interval of a camera specified via shutter open and close times and is expected to span the union of the shutter intervals of cameras used in generating the render artifacts.

static HD_API const HdDataSourceLocator& HdRenderSettingsSchema::GetShutterIntervalLocator ( )

static

Prim-level relative data source locator to locate shutterInterval.

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

pxr/imaging/hd/renderSettingsSchema.h

Classes

Public Member Functions

Static Public Member Functions

Schema retrieval

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation