HdRenderProductSchema Class Reference

#include <renderProductSchema.h>

Inheritance diagram for HdRenderProductSchema:

Classes
class	Builder

Public Member Functions
	HdRenderProductSchema (HdContainerDataSourceHandle container)
HD_API HdPathDataSourceHandle	GetPath ()
HD_API HdTokenDataSourceHandle	GetType ()
HD_API HdTokenDataSourceHandle	GetName ()
HD_API HdVec2iDataSourceHandle	GetResolution ()
HD_API HdRenderVarVectorSchema	GetRenderVars ()
HD_API HdPathDataSourceHandle	GetCameraPrim ()
HD_API HdFloatDataSourceHandle	GetPixelAspectRatio ()
HD_API HdTokenDataSourceHandle	GetAspectRatioConformPolicy ()
HD_API HdVec2fDataSourceHandle	GetApertureSize ()
HD_API HdVec4fDataSourceHandle	GetDataWindowNDC ()
HD_API HdBoolDataSourceHandle	GetDisableMotionBlur ()
HD_API HdContainerDataSourceHandle	GetNamespacedSettings ()
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 HdPathDataSourceHandle &path, const HdTokenDataSourceHandle &type, const HdTokenDataSourceHandle &name, const HdVec2iDataSourceHandle &resolution, const HdVectorDataSourceHandle &renderVars, const HdPathDataSourceHandle &cameraPrim, const HdFloatDataSourceHandle &pixelAspectRatio, const HdTokenDataSourceHandle &aspectRatioConformPolicy, const HdVec2fDataSourceHandle &apertureSize, const HdVec4fDataSourceHandle &dataWindowNDC, const HdBoolDataSourceHandle &disableMotionBlur, const HdContainerDataSourceHandle &namespacedSettings)
static HD_API HdRenderProductSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
static HD_API const HdDataSourceLocator &	GetResolutionLocator ()
static HD_API const HdDataSourceLocator &	GetRenderVarsLocator ()
static HD_API const HdDataSourceLocator &	GetNamespacedSettingsLocator ()

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 62 of file renderProductSchema.h.

Constructor & Destructor Documentation

HdRenderProductSchema::HdRenderProductSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 65 of file renderProductSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdRenderProductSchema::BuildRetained ( const HdPathDataSourceHandle &  path, const HdTokenDataSourceHandle &  type, const HdTokenDataSourceHandle &  name, const HdVec2iDataSourceHandle &  resolution, const HdVectorDataSourceHandle &  renderVars, const HdPathDataSourceHandle &  cameraPrim, const HdFloatDataSourceHandle &  pixelAspectRatio, const HdTokenDataSourceHandle &  aspectRatioConformPolicy, const HdVec2fDataSourceHandle &  apertureSize, const HdVec4fDataSourceHandle &  dataWindowNDC, const HdBoolDataSourceHandle &  disableMotionBlur, const HdContainerDataSourceHandle &  namespacedSettings  )

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 HdVec2fDataSourceHandle HdRenderProductSchema::GetApertureSize

(

)

HD_API HdTokenDataSourceHandle HdRenderProductSchema::GetAspectRatioConformPolicy

(

)

HD_API HdPathDataSourceHandle HdRenderProductSchema::GetCameraPrim

(

)

HD_API HdVec4fDataSourceHandle HdRenderProductSchema::GetDataWindowNDC

(

)

static HD_API const HdDataSourceLocator& HdRenderProductSchema::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 HdRenderProductSchema::GetDisableMotionBlur

(

)

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

static

Retrieves a container data source with the schema's default name token "renderProduct" from the parent container and constructs a HdRenderProductSchema 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 HdRenderProductSchema::GetName

(

)

HD_API HdContainerDataSourceHandle HdRenderProductSchema::GetNamespacedSettings

(

)

static HD_API const HdDataSourceLocator& HdRenderProductSchema::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 HdPathDataSourceHandle HdRenderProductSchema::GetPath

(

)

HD_API HdFloatDataSourceHandle HdRenderProductSchema::GetPixelAspectRatio

(

)

HD_API HdRenderVarVectorSchema HdRenderProductSchema::GetRenderVars

(

)

static HD_API const HdDataSourceLocator& HdRenderProductSchema::GetRenderVarsLocator ( )

static

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

HD_API HdVec2iDataSourceHandle HdRenderProductSchema::GetResolution

(

)

static HD_API const HdDataSourceLocator& HdRenderProductSchema::GetResolutionLocator ( )

static

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

static HD_API const TfToken& HdRenderProductSchema::GetSchemaToken ( )

static

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

HD_API HdTokenDataSourceHandle HdRenderProductSchema::GetType

(

)

---

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

• pxr/imaging/hd/renderProductSchema.h