A UsdRenderSettings prim specifies global settings for a render process, including an enumeration of the RenderProducts that should result, and the UsdGeomImageable purposes that should be rendered. More...

#include <settings.h>

Inheritance diagram for UsdRenderSettings:

Public Member Functions
	UsdRenderSettings (const UsdPrim &prim=UsdPrim())
	Construct a UsdRenderSettings on UsdPrim `prim` .

	UsdRenderSettings (const UsdSchemaBase &schemaObj)
	Construct a UsdRenderSettings on the prim held by `schemaObj` .

virtual USDRENDER_API	~UsdRenderSettings ()
	Destructor.

USDRENDER_API UsdAttribute	GetIncludedPurposesAttr () const
	The list of UsdGeomImageable purpose values that should be included in the render.

USDRENDER_API UsdAttribute	CreateIncludedPurposesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetIncludedPurposesAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRENDER_API UsdAttribute	GetMaterialBindingPurposesAttr () const
	Ordered list of material purposes to consider when resolving material bindings in the scene.

USDRENDER_API UsdAttribute	CreateMaterialBindingPurposesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaterialBindingPurposesAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRENDER_API UsdAttribute	GetRenderingColorSpaceAttr () const
	Describes a renderer's working (linear) colorSpace where all the renderer/shader math is expected to happen.

USDRENDER_API UsdAttribute	CreateRenderingColorSpaceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetRenderingColorSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRENDER_API UsdRelationship	GetProductsRel () const
	The set of RenderProducts the render should produce.

USDRENDER_API UsdRelationship	CreateProductsRel () const
	See GetProductsRel(), and also Create vs Get Property Methods for when to use Get vs Create.

Public Member Functions inherited from UsdRenderSettingsBase
	UsdRenderSettingsBase (const UsdPrim &prim=UsdPrim())
	Construct a UsdRenderSettingsBase on UsdPrim `prim` .

	UsdRenderSettingsBase (const UsdSchemaBase &schemaObj)
	Construct a UsdRenderSettingsBase on the prim held by `schemaObj` .

virtual USDRENDER_API	~UsdRenderSettingsBase ()
	Destructor.

USDRENDER_API UsdAttribute	GetResolutionAttr () const
	The image pixel resolution, corresponding to the camera's screen window.

USDRENDER_API UsdAttribute	CreateResolutionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetResolutionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRENDER_API UsdAttribute	GetPixelAspectRatioAttr () const
	The aspect ratio (width/height) of image pixels.

USDRENDER_API UsdAttribute	CreatePixelAspectRatioAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPixelAspectRatioAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRENDER_API UsdAttribute	GetAspectRatioConformPolicyAttr () const
	Indicates the policy to use to resolve an aspect ratio mismatch between the camera aperture and image settings.

USDRENDER_API UsdAttribute	CreateAspectRatioConformPolicyAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetAspectRatioConformPolicyAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRENDER_API UsdAttribute	GetDataWindowNDCAttr () const
	dataWindowNDC specifies the axis-aligned rectangular region in the adjusted aperture window within which the renderer should produce data.

USDRENDER_API UsdAttribute	CreateDataWindowNDCAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDataWindowNDCAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRENDER_API UsdAttribute	GetInstantaneousShutterAttr () const
	Deprecated - use disableMotionBlur instead.

USDRENDER_API UsdAttribute	CreateInstantaneousShutterAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetInstantaneousShutterAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRENDER_API UsdAttribute	GetDisableMotionBlurAttr () const
	Disable all motion blur by setting the shutter interval of the targeted camera to [0,0] - that is, take only one sample, namely at the current time code.

USDRENDER_API UsdAttribute	CreateDisableMotionBlurAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDisableMotionBlurAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRENDER_API UsdAttribute	GetDisableDepthOfFieldAttr () const
	Disable all depth of field by setting F-stop of the targeted camera to infinity.

USDRENDER_API UsdAttribute	CreateDisableDepthOfFieldAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDisableDepthOfFieldAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRENDER_API UsdRelationship	GetCameraRel () const
	The camera relationship specifies the primary camera to use in a render.

USDRENDER_API UsdRelationship	CreateCameraRel () const
	See GetCameraRel(), and also Create vs Get Property Methods for when to use Get vs Create.

Public Member Functions inherited from UsdTyped
	UsdTyped (const UsdPrim &prim=UsdPrim())
	Construct a UsdTyped on UsdPrim `prim` .

	UsdTyped (const UsdSchemaBase &schemaObj)
	Construct a UsdTyped on the prim held by `schemaObj` .

virtual USD_API	~UsdTyped ()
	Destructor.

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.

bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.

bool	IsAPISchema () const
	Returns whether this is an API schema or not.

bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.

bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is.

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim.

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`.

virtual USD_API	~UsdSchemaBase ()
	Destructor.

UsdPrim	GetPrim () const
	Return this schema object's held prim.

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath().

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.

USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

Static Public Member Functions
static USDRENDER_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

static USDRENDER_API UsdRenderSettings	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdRenderSettings holding the prim adhering to this schema at `path` on `stage`.

static USDRENDER_API UsdRenderSettings	Define (const UsdStagePtr &stage, const SdfPath &path)
	Attempt to ensure a UsdPrim adhering to this schema at `path` is defined (according to UsdPrim::IsDefined()) on this stage.

static USDRENDER_API UsdRenderSettings	GetStageRenderSettings (const UsdStageWeakPtr &stage)
	Fetch and return `stage` 's render settings, as indicated by root layer metadata.

Static Public Member Functions inherited from UsdRenderSettingsBase
static USDRENDER_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

static USDRENDER_API UsdRenderSettingsBase	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdRenderSettingsBase holding the prim adhering to this schema at `path` on `stage`.

Static Public Member Functions inherited from UsdTyped
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

static USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdTyped holding the prim adhering to this schema at `path` on `stage`.

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdRenderSettingsBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USDRENDER_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdRenderSettingsBase
USDRENDER_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdTyped
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

USD_API bool	_IsCompatible () const override
	Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility.

Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind	_GetSchemaType () const

const TfType &	_GetType () const

USD_API UsdAttribute	_CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const

Friends
class	UsdSchemaRegistry

Detailed Description

A UsdRenderSettings prim specifies global settings for a render process, including an enumeration of the RenderProducts that should result, and the UsdGeomImageable purposes that should be rendered.

How settings affect rendering

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdRenderTokens. So to set an attribute to the value "rightHanded", use UsdRenderTokens->rightHanded as the value.

Definition at line 48 of file settings.h.

Constructor & Destructor Documentation

◆ UsdRenderSettings() [1/2]

UsdRenderSettings ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a UsdRenderSettings on UsdPrim prim .

Equivalent to UsdRenderSettings::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 60 of file settings.h.

◆ UsdRenderSettings() [2/2]

UsdRenderSettings ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdRenderSettings on the prim held by schemaObj .

Should be preferred over UsdRenderSettings(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 68 of file settings.h.

◆ ~UsdRenderSettings()

virtual USDRENDER_API ~UsdRenderSettings ( )

virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDRENDER_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdTyped.

◆ CreateIncludedPurposesAttr()

USDRENDER_API UsdAttribute CreateIncludedPurposesAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetIncludedPurposesAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

◆ CreateMaterialBindingPurposesAttr()

USDRENDER_API UsdAttribute CreateMaterialBindingPurposesAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetMaterialBindingPurposesAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

◆ CreateProductsRel()

USDRENDER_API UsdRelationship CreateProductsRel ( ) const

See GetProductsRel(), and also Create vs Get Property Methods for when to use Get vs Create.

◆ CreateRenderingColorSpaceAttr()

USDRENDER_API UsdAttribute CreateRenderingColorSpaceAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetRenderingColorSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

◆ Define()

static USDRENDER_API UsdRenderSettings Define	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

◆ Get()

static USDRENDER_API UsdRenderSettings Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a UsdRenderSettings holding the prim adhering to this schema at path on stage.

If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

UsdRenderSettings(stage->GetPrimAtPath(path));

UsdRenderSettings

A UsdRenderSettings prim specifies global settings for a render process, including an enumeration of ...

Definition: settings.h:49

◆ GetIncludedPurposesAttr()

USDRENDER_API UsdAttribute GetIncludedPurposesAttr ( ) const

The list of UsdGeomImageable purpose values that should be included in the render.

Note this cannot be specified per-RenderProduct because it is a statement of which geometry is present.


Declaration	`uniform token[] includedPurposes = ["default", "render"]`
C++ Type	VtArray<TfToken>
Usd Type	SdfValueTypeNames->TokenArray
Variability	SdfVariabilityUniform

◆ GetMaterialBindingPurposesAttr()

USDRENDER_API UsdAttribute GetMaterialBindingPurposesAttr ( ) const

Ordered list of material purposes to consider when resolving material bindings in the scene.

The empty string indicates the "allPurpose" binding.


Declaration	`uniform token[] materialBindingPurposes = ["full", ""]`
C++ Type	VtArray<TfToken>
Usd Type	SdfValueTypeNames->TokenArray
Variability	SdfVariabilityUniform
Allowed Values	full, preview, ""

◆ GetProductsRel()

USDRENDER_API UsdRelationship GetProductsRel ( ) const

The set of RenderProducts the render should produce.

This relationship should target UsdRenderProduct prims. If no products are specified, an application should produce an rgb image according to the RenderSettings configuration, to a default display or image name.

◆ GetRenderingColorSpaceAttr()

USDRENDER_API UsdAttribute GetRenderingColorSpaceAttr ( ) const

Describes a renderer's working (linear) colorSpace where all the renderer/shader math is expected to happen.

When no renderingColorSpace is provided, renderer should use its own default.


Declaration	`uniform token renderingColorSpace`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform

◆ GetSchemaAttributeNames()

static USDRENDER_API const TfTokenVector & GetSchemaAttributeNames ( bool includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

◆ GetStageRenderSettings()

static USDRENDER_API UsdRenderSettings GetStageRenderSettings ( const UsdStageWeakPtr & stage )

static

Fetch and return stage 's render settings, as indicated by root layer metadata.

If unauthored, or the metadata does not refer to a valid UsdRenderSettings prim, this will return an invalid UsdRenderSettings prim.

Friends And Related Function Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 132 of file settings.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped

static

Compile time constant representing what kind of schema this class is.

See also: UsdSchemaKind

Definition at line 54 of file settings.h.

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

pxr/usd/usdRender/settings.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ UsdRenderSettings() [1/2]

◆ UsdRenderSettings() [2/2]

◆ ~UsdRenderSettings()

Member Function Documentation

◆ _GetSchemaKind()

◆ CreateIncludedPurposesAttr()

◆ CreateMaterialBindingPurposesAttr()

◆ CreateProductsRel()

◆ CreateRenderingColorSpaceAttr()

◆ Define()

◆ Get()

◆ GetIncludedPurposesAttr()

◆ GetMaterialBindingPurposesAttr()

◆ GetProductsRel()

◆ GetRenderingColorSpaceAttr()

◆ GetSchemaAttributeNames()

◆ GetStageRenderSettings()

Friends And Related Function Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind