HdRenderPassSchema Class Reference

#include <renderPassSchema.h>

Inheritance diagram for HdRenderPassSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdTokenDataSourceHandle	GetPassType () const
HD_API HdPathDataSourceHandle	GetRenderSource () 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 &	GetPassTypeLocator ()
	Prim-level relative data source locator to locate passType. More...
static HD_API const HdDataSourceLocator &	GetRenderSourceLocator ()
	Prim-level relative data source locator to locate renderSource. More...
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdTokenDataSourceHandle &passType, const HdPathDataSourceHandle &renderSource)

Schema retrieval
	HdRenderPassSchema (HdContainerDataSourceHandle container)
static HD_API HdRenderPassSchema	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 47 of file renderPassSchema.h.

Constructor & Destructor Documentation

HdRenderPassSchema::HdRenderPassSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "renderPass" from the parent container and constructs a HdRenderPassSchema 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 53 of file renderPassSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdRenderPassSchema::BuildRetained ( const HdTokenDataSourceHandle &  passType, const HdPathDataSourceHandle &  renderSource  )

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.

static HD_API const HdDataSourceLocator& HdRenderPassSchema::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 HdRenderPassSchema HdRenderPassSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "renderPass" from the parent container and constructs a HdRenderPassSchema 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 HdTokenDataSourceHandle HdRenderPassSchema::GetPassType

(

)

const

static HD_API const HdDataSourceLocator& HdRenderPassSchema::GetPassTypeLocator ( )

static

Prim-level relative data source locator to locate passType.

HD_API HdPathDataSourceHandle HdRenderPassSchema::GetRenderSource

(

)

const

static HD_API const HdDataSourceLocator& HdRenderPassSchema::GetRenderSourceLocator ( )

static

Prim-level relative data source locator to locate renderSource.

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