HdSceneGlobalsSchema Class Reference

The HdSceneGlobalsSchema encapsulates "global" state to orchestrate a render. More...

Inheritance diagram for HdSceneGlobalsSchema:

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
	HdSceneGlobalsSchema (HdContainerDataSourceHandle container)
HD_API HdPathDataSourceHandle	GetActiveRenderSettingsPrim ()
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
	Returns true if this schema is applied on top of a non-null container. More...

Static Public Member Functions
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdPathDataSourceHandle &activeRenderSettingsPrim)
	Builds a container data source which includes the provided child data sources. More...
static HD_API HdSceneGlobalsSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
	Retrieves a container data source with the schema's default name token "sceneGlobals" from the parent container and constructs a HdSceneGlobalsSchema instance. More...
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
	Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default. More...
static HD_API const HdDataSourceLocator &	GetActiveRenderSettingsPrimLocator ()
	Returns an HdDataSourceLocator (relative to the prim-level data source) where the activerendersettingsprim data source can be found. More...

Additional Inherited Members
Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name)
	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. More...
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

The HdSceneGlobalsSchema encapsulates "global" state to orchestrate a render.

It currently houses the active render settings prim path that describes the information necessary to generate images from a single invocation of a renderer.

We shall use the convention of a container data source at the root locator of the scene index that is populated with this global state. The renderer and downstream scene indices can query it to configure their behavior as necessary.

Definition at line 62 of file sceneGlobalsSchema.h.

Member Function Documentation

BuildRetained()

static HD_API HdContainerDataSourceHandle BuildRetained ( const HdPathDataSourceHandle &  activeRenderSettingsPrim )

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.

GetActiveRenderSettingsPrimLocator()

static HD_API const HdDataSourceLocator& GetActiveRenderSettingsPrimLocator ( )

static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the activerendersettingsprim data source can be found.

This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

GetDefaultLocator()

static HD_API const HdDataSourceLocator& GetDefaultLocator ( )

static

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

GetFromParent()

static HD_API HdSceneGlobalsSchema GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "sceneGlobals" from the parent container and constructs a HdSceneGlobalsSchema instance.

Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

---

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

• pxr/imaging/hd/sceneGlobalsSchema.h