#include <usdRenderSettingsSchema.h>

Inheritance diagram for UsdImagingUsdRenderSettingsSchema:

Classes
class	Builder

Public Member Functions
Member accessor
USDIMAGING_API HdVec2iDataSourceHandle	GetResolution ()

USDIMAGING_API HdFloatDataSourceHandle	GetPixelAspectRatio ()

USDIMAGING_API HdTokenDataSourceHandle	GetAspectRatioConformPolicy ()

USDIMAGING_API HdVec4fDataSourceHandle	GetDataWindowNDC ()

USDIMAGING_API HdBoolDataSourceHandle	GetDisableMotionBlur ()

USDIMAGING_API HdBoolDataSourceHandle	GetDisableDepthOfField ()

USDIMAGING_API HdPathDataSourceHandle	GetCamera ()

USDIMAGING_API HdTokenArrayDataSourceHandle	GetIncludedPurposes ()

USDIMAGING_API HdTokenArrayDataSourceHandle	GetMaterialBindingPurposes ()

USDIMAGING_API HdTokenDataSourceHandle	GetRenderingColorSpace ()

USDIMAGING_API HdPathArrayDataSourceHandle	GetProducts ()

USDIMAGING_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
Schema location
static USDIMAGING_API const TfToken &	GetSchemaToken ()

static USDIMAGING_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 USDIMAGING_API const HdDataSourceLocator &	GetResolutionLocator ()
	Prim-level relative data source locator to locate resolution. More...

static USDIMAGING_API const HdDataSourceLocator &	GetPixelAspectRatioLocator ()
	Prim-level relative data source locator to locate pixelAspectRatio. More...

static USDIMAGING_API const HdDataSourceLocator &	GetAspectRatioConformPolicyLocator ()
	Prim-level relative data source locator to locate aspectRatioConformPolicy. More...

static USDIMAGING_API const HdDataSourceLocator &	GetDataWindowNDCLocator ()
	Prim-level relative data source locator to locate dataWindowNDC. More...

static USDIMAGING_API const HdDataSourceLocator &	GetDisableMotionBlurLocator ()
	Prim-level relative data source locator to locate disableMotionBlur. More...

static USDIMAGING_API const HdDataSourceLocator &	GetDisableDepthOfFieldLocator ()
	Prim-level relative data source locator to locate disableDepthOfField. More...

static USDIMAGING_API const HdDataSourceLocator &	GetCameraLocator ()
	Prim-level relative data source locator to locate camera. More...

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

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

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

static USDIMAGING_API const HdDataSourceLocator &	GetProductsLocator ()
	Prim-level relative data source locator to locate products. More...

static USDIMAGING_API const HdDataSourceLocator &	GetNamespacedSettingsLocator ()
	Prim-level relative data source locator to locate namespacedSettings. More...

Schema construction
static USDIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdVec2iDataSourceHandle &resolution, const HdFloatDataSourceHandle &pixelAspectRatio, const HdTokenDataSourceHandle &aspectRatioConformPolicy, const HdVec4fDataSourceHandle &dataWindowNDC, const HdBoolDataSourceHandle &disableMotionBlur, const HdBoolDataSourceHandle &disableDepthOfField, const HdPathDataSourceHandle &camera, const HdTokenArrayDataSourceHandle &includedPurposes, const HdTokenArrayDataSourceHandle &materialBindingPurposes, const HdTokenDataSourceHandle &renderingColorSpace, const HdPathArrayDataSourceHandle &products, const HdContainerDataSourceHandle &namespacedSettings)

Schema retrieval
	UsdImagingUsdRenderSettingsSchema (HdContainerDataSourceHandle container)

static USDIMAGING_API UsdImagingUsdRenderSettingsSchema	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)

Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 73 of file usdRenderSettingsSchema.h.

Constructor & Destructor Documentation

UsdImagingUsdRenderSettingsSchema::UsdImagingUsdRenderSettingsSchema ( HdContainerDataSourceHandle container )

inline

Retrieves a container data source with the schema's default name token "__usdRenderSettings" from the parent container and constructs a UsdImagingUsdRenderSettingsSchema 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 79 of file usdRenderSettingsSchema.h.

Member Function Documentation

static USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdRenderSettingsSchema::BuildRetained	(	const HdVec2iDataSourceHandle &	resolution,
		const HdFloatDataSourceHandle &	pixelAspectRatio,
		const HdTokenDataSourceHandle &	aspectRatioConformPolicy,
		const HdVec4fDataSourceHandle &	dataWindowNDC,
		const HdBoolDataSourceHandle &	disableMotionBlur,
		const HdBoolDataSourceHandle &	disableDepthOfField,
		const HdPathDataSourceHandle &	camera,
		const HdTokenArrayDataSourceHandle &	includedPurposes,
		const HdTokenArrayDataSourceHandle &	materialBindingPurposes,
		const HdTokenDataSourceHandle &	renderingColorSpace,
		const HdPathArrayDataSourceHandle &	products,
		const HdContainerDataSourceHandle &	namespacedSettings
	)

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.

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetAspectRatioConformPolicy ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetAspectRatioConformPolicyLocator ( )

static

Prim-level relative data source locator to locate aspectRatioConformPolicy.

USDIMAGING_API HdPathDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetCamera ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetCameraLocator ( )

static

Prim-level relative data source locator to locate camera.

USDIMAGING_API HdVec4fDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetDataWindowNDC ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetDataWindowNDCLocator ( )

static

Prim-level relative data source locator to locate dataWindowNDC.

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetDefaultLocator ( )

static

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

USDIMAGING_API HdBoolDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetDisableDepthOfField ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetDisableDepthOfFieldLocator ( )

static

Prim-level relative data source locator to locate disableDepthOfField.

USDIMAGING_API HdBoolDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetDisableMotionBlur ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetDisableMotionBlurLocator ( )

static

Prim-level relative data source locator to locate disableMotionBlur.

static USDIMAGING_API UsdImagingUsdRenderSettingsSchema UsdImagingUsdRenderSettingsSchema::GetFromParent ( const HdContainerDataSourceHandle & fromParentContainer )

static

Retrieves a container data source with the schema's default name token "__usdRenderSettings" from the parent container and constructs a UsdImagingUsdRenderSettingsSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

USDIMAGING_API HdTokenArrayDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetIncludedPurposes ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetIncludedPurposesLocator ( )

static

Prim-level relative data source locator to locate includedPurposes.

USDIMAGING_API HdTokenArrayDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetMaterialBindingPurposes ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetMaterialBindingPurposesLocator ( )

static

Prim-level relative data source locator to locate materialBindingPurposes.

USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetNamespacedSettings ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetNamespacedSettingsLocator ( )

static

Prim-level relative data source locator to locate namespacedSettings.

USDIMAGING_API HdFloatDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetPixelAspectRatio ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetPixelAspectRatioLocator ( )

static

Prim-level relative data source locator to locate pixelAspectRatio.

USDIMAGING_API HdPathArrayDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetProducts ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetProductsLocator ( )

static

Prim-level relative data source locator to locate products.

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetRenderingColorSpace ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetRenderingColorSpaceLocator ( )

static

Prim-level relative data source locator to locate renderingColorSpace.

USDIMAGING_API HdVec2iDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetResolution ( )

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetResolutionLocator ( )

static

Prim-level relative data source locator to locate resolution.

static USDIMAGING_API const TfToken& UsdImagingUsdRenderSettingsSchema::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/usdImaging/usdImaging/usdRenderSettingsSchema.h

Classes

Public Member Functions

Static Public Member Functions

Schema retrieval

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation