Abstract base class that defines render settings that can be specified on either a RenderSettings prim or a RenderProduct prim. More...

#include <settingsBase.h>

Inheritance diagram for UsdRenderSettingsBase:

Public Member Functions
	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 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::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 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

Abstract base class that defines render settings that can be specified on either a RenderSettings prim or a RenderProduct prim.

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 47 of file settingsBase.h.

Constructor & Destructor Documentation

◆ UsdRenderSettingsBase() [1/2]

UsdRenderSettingsBase ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a UsdRenderSettingsBase on UsdPrim prim .

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

Definition at line 59 of file settingsBase.h.

◆ UsdRenderSettingsBase() [2/2]

UsdRenderSettingsBase ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdRenderSettingsBase on the prim held by schemaObj .

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

Definition at line 67 of file settingsBase.h.

◆ ~UsdRenderSettingsBase()

virtual USDRENDER_API ~UsdRenderSettingsBase ( )

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.

◆ CreateAspectRatioConformPolicyAttr()

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.

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.

◆ CreateCameraRel()

USDRENDER_API UsdRelationship CreateCameraRel ( ) const

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

◆ CreateDataWindowNDCAttr()

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.

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.

◆ CreateDisableDepthOfFieldAttr()

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.

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.

◆ CreateDisableMotionBlurAttr()

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.

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.

◆ CreateInstantaneousShutterAttr()

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.

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.

◆ CreatePixelAspectRatioAttr()

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.

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.

◆ CreateResolutionAttr()

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.

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.

◆ Get()

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

static

Return a UsdRenderSettingsBase 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:

UsdRenderSettingsBase(stage->GetPrimAtPath(path));

UsdRenderSettingsBase

Abstract base class that defines render settings that can be specified on either a RenderSettings pri...

Definition: settingsBase.h:48

◆ GetAspectRatioConformPolicyAttr()

USDRENDER_API UsdAttribute GetAspectRatioConformPolicyAttr ( ) const

Indicates the policy to use to resolve an aspect ratio mismatch between the camera aperture and image settings.

This policy allows a standard render setting to do something reasonable given varying camera inputs.

The camera aperture aspect ratio is determined by the aperture atributes on the UsdGeomCamera.

The image aspect ratio is determined by the resolution and pixelAspectRatio attributes in the render settings.

"expandAperture": if necessary, expand the aperture to fit the image, exposing additional scene content
"cropAperture": if necessary, crop the aperture to fit the image, cropping scene content
"adjustApertureWidth": if necessary, adjust aperture width to make its aspect ratio match the image
"adjustApertureHeight": if necessary, adjust aperture height to make its aspect ratio match the image
"adjustPixelAspectRatio": compute pixelAspectRatio to make the image exactly cover the aperture; disregards existing attribute value of pixelAspectRatio


Declaration	`uniform token aspectRatioConformPolicy = "expandAperture"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	expandAperture, cropAperture, adjustApertureWidth, adjustApertureHeight, adjustPixelAspectRatio

◆ GetCameraRel()

USDRENDER_API UsdRelationship GetCameraRel ( ) const

The camera relationship specifies the primary camera to use in a render.

It must target a UsdGeomCamera.

◆ GetDataWindowNDCAttr()

USDRENDER_API UsdAttribute GetDataWindowNDCAttr ( ) const

dataWindowNDC specifies the axis-aligned rectangular region in the adjusted aperture window within which the renderer should produce data.

It is specified as (xmin, ymin, xmax, ymax) in normalized device coordinates, where the range 0 to 1 corresponds to the aperture. (0,0) corresponds to the bottom-left corner and (1,1) corresponds to the upper-right corner.

Specifying a window outside the unit square will produce overscan data. Specifying a window that does not cover the unit square will produce a cropped render.

A pixel is included in the rendered result if the pixel center is contained by the data window. This is consistent with standard rules used by polygon rasterization engines. UsdRenderRasterization

The data window is expressed in NDC so that cropping and overscan may be resolution independent. In interactive workflows, incremental cropping and resolution adjustment may be intermixed to isolate and examine parts of the scene. In compositing workflows, overscan may be used to support image post-processing kernels, and reduced-resolution proxy renders may be used for faster iteration.

The dataWindow:ndc coordinate system references the aperture after any adjustments required by aspectRatioConformPolicy.


Declaration	`uniform float4 dataWindowNDC = (0, 0, 1, 1)`
C++ Type	GfVec4f
Usd Type	SdfValueTypeNames->Float4
Variability	SdfVariabilityUniform

◆ GetDisableDepthOfFieldAttr()

USDRENDER_API UsdAttribute GetDisableDepthOfFieldAttr ( ) const

Disable all depth of field by setting F-stop of the targeted camera to infinity.


Declaration	`uniform bool disableDepthOfField = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

◆ GetDisableMotionBlurAttr()

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.


Declaration	`uniform bool disableMotionBlur = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

◆ GetInstantaneousShutterAttr()

USDRENDER_API UsdAttribute GetInstantaneousShutterAttr ( ) const

Deprecated - use disableMotionBlur instead.

Override the targeted camera's shutterClose to be equal to the value of its shutterOpen, to produce a zero-width shutter interval. This gives us a convenient way to disable motion blur.


Declaration	`uniform bool instantaneousShutter = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

◆ GetPixelAspectRatioAttr()

USDRENDER_API UsdAttribute GetPixelAspectRatioAttr ( ) const

The aspect ratio (width/height) of image pixels.

The default ratio 1.0 indicates square pixels.


Declaration	`uniform float pixelAspectRatio = 1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float
Variability	SdfVariabilityUniform

◆ GetResolutionAttr()

USDRENDER_API UsdAttribute GetResolutionAttr ( ) const

The image pixel resolution, corresponding to the camera's screen window.


Declaration	`uniform int2 resolution = (2048, 1080)`
C++ Type	GfVec2i
Usd Type	SdfValueTypeNames->Int2
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.

Friends And Related Function Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 106 of file settingsBase.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped

static

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

See also: UsdSchemaKind

Definition at line 53 of file settingsBase.h.

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

pxr/usd/usdRender/settingsBase.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ UsdRenderSettingsBase() [1/2]

◆ UsdRenderSettingsBase() [2/2]

◆ ~UsdRenderSettingsBase()

Member Function Documentation

◆ _GetSchemaKind()

◆ CreateAspectRatioConformPolicyAttr()

◆ CreateCameraRel()

◆ CreateDataWindowNDCAttr()

◆ CreateDisableDepthOfFieldAttr()

◆ CreateDisableMotionBlurAttr()

◆ CreateInstantaneousShutterAttr()

◆ CreatePixelAspectRatioAttr()

◆ CreateResolutionAttr()

◆ Get()

◆ GetAspectRatioConformPolicyAttr()

◆ GetCameraRel()

◆ GetDataWindowNDCAttr()

◆ GetDisableDepthOfFieldAttr()

◆ GetDisableMotionBlurAttr()

◆ GetInstantaneousShutterAttr()

◆ GetPixelAspectRatioAttr()

◆ GetResolutionAttr()

◆ GetSchemaAttributeNames()

Friends And Related Function Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind