UsdRender.md

UsdRender module — pxr-usd-api 105.1 documentation

pxr-usd-api

 »
Modules »
UsdRender module

 

# UsdRender module

Summary: The UsdRender module provides schemas and behaviors for describing renders.

Classes:

DenoisePass
A RenderDenoisePass generates renders via a denoising process.

Pass
A RenderPass prim encapsulates the necessary information to generate multipass renders.

Product
A UsdRenderProduct describes an image or other file-like artifact produced by a render.

Settings
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.

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

Tokens

Var
A UsdRenderVar describes a custom data variable for a render to produce.

class pxr.UsdRender.DenoisePass
A RenderDenoisePass generates renders via a denoising process. This
may be the same renderer that a pipeline uses for UsdRender, or may be
a separate one. Notably, a RenderDenoisePass requires another Pass to
be present for it to operate. The denoising process itself is not
generative, and requires images inputs to operate.
As denoising integration varies so widely across pipelines, all
implementation details are left to pipeline-specific prims that
inherit from RenderDenoisePass.
Methods:

Define
classmethod Define(stage, path) -> DenoisePass

Get
classmethod Get(stage, path) -> DenoisePass

GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]

static Define()
classmethod Define(stage, path) -> DenoisePass
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.

Parameters

stage (Stage) – 
path (Path) – 

static Get()
classmethod Get(stage, path) -> DenoisePass
Return a UsdRenderDenoisePass 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:
UsdRenderDenoisePass(stage->GetPrimAtPath(path));

Parameters

stage (Stage) – 
path (Path) – 

static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
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.

Parameters
includeInherited (bool) – 

class pxr.UsdRender.Pass
A RenderPass prim encapsulates the necessary information to generate
multipass renders. It houses properties for generating dependencies
and the necessary commands to run to generate renders, as well as
visibility controls for the scene. While RenderSettings describes the
information needed to generate images from a single invocation of a
renderer, RenderPass describes the additional information needed to
generate a time varying set of images.
There are two consumers of RenderPass prims - a runtime executable
that generates images from usdRender prims, and pipeline specific code
that translates between usdRender prims and the pipeline’s resource
scheduling software. We’ll refer to the latter as’job submission
code’.
The name of the prim is used as the pass’s name.
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.
Methods:

CreateCommandAttr(defaultValue, writeSparsely)
See GetCommandAttr() , and also Create vs Get Property Methods for when to use Get vs Create.

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

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

CreateFileNameAttr(defaultValue, writeSparsely)
See GetFileNameAttr() , and also Create vs Get Property Methods for when to use Get vs Create.

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

CreatePassTypeAttr(defaultValue, writeSparsely)
See GetPassTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.

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

Define
classmethod Define(stage, path) -> Pass

Get
classmethod Get(stage, path) -> Pass

GetCommandAttr()
The command to run in order to generate renders for this pass.

GetDenoiseEnableAttr()
When True, this Pass pass should be denoised.

GetDenoisePassRel()
The The UsdRenderDenoisePass prim from which to source denoise settings.

GetFileNameAttr()
The asset that contains the rendering prims or other information needed to render this pass.

GetInputPassesRel()
The set of other Passes that this Pass depends on in order to be constructed properly.

GetPassTypeAttr()
A string used to categorize differently structured or executed types of passes within a customized pipeline.

GetRenderSourceRel()
The source prim to render from.

GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]

CreateCommandAttr(defaultValue, writeSparsely) → Attribute
See GetCommandAttr() , 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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateDenoiseEnableAttr(defaultValue, writeSparsely) → Attribute
See GetDenoiseEnableAttr() , 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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateDenoisePassRel() → Relationship
See GetDenoisePassRel() , and also Create vs Get Property Methods for
when to use Get vs Create.

CreateFileNameAttr(defaultValue, writeSparsely) → Attribute
See GetFileNameAttr() , 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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateInputPassesRel() → Relationship
See GetInputPassesRel() , and also Create vs Get Property Methods for
when to use Get vs Create.

CreatePassTypeAttr(defaultValue, writeSparsely) → Attribute
See GetPassTypeAttr() , 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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateRenderSourceRel() → Relationship
See GetRenderSourceRel() , and also Create vs Get Property Methods for
when to use Get vs Create.

static Define()
classmethod Define(stage, path) -> Pass
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.

Parameters

stage (Stage) – 
path (Path) – 

static Get()
classmethod Get(stage, path) -> Pass
Return a UsdRenderPass 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:
UsdRenderPass(stage->GetPrimAtPath(path));

Parameters

stage (Stage) – 
path (Path) – 

GetCommandAttr() → Attribute
The command to run in order to generate renders for this pass.
The job submission code can use this to properly send tasks to the job
scheduling software that will generate products.
The command can contain variables that will be substituted
appropriately during submission, as seen in the example below with
{fileName}.
For example: command[0] =”prman”command[1] =”-progress”command[2]
=”-pixelvariance”command[3] =”-0.15”command[4] =”{fileName}”# the
fileName property will be substituted
Declaration
uniform string[] command
C++ Type
VtArray<std::string>
Usd Type
SdfValueTypeNames->StringArray
Variability
SdfVariabilityUniform

GetDenoiseEnableAttr() → Attribute
When True, this Pass pass should be denoised.
Declaration
uniform bool denoise:enable = 0
C++ Type
bool
Usd Type
SdfValueTypeNames->Bool
Variability
SdfVariabilityUniform

GetDenoisePassRel() → Relationship
The The UsdRenderDenoisePass prim from which to source denoise
settings.

GetFileNameAttr() → Attribute
The asset that contains the rendering prims or other information
needed to render this pass.
Declaration
uniform asset fileName
C++ Type
SdfAssetPath
Usd Type
SdfValueTypeNames->Asset
Variability
SdfVariabilityUniform

GetInputPassesRel() → Relationship
The set of other Passes that this Pass depends on in order to be
constructed properly.
For example, a Pass A may generate a texture, which is then used as an
input to Pass B.
By default, usdRender makes some assumptions about the relationship
between this prim and the prims listed in inputPasses. Namely, when
per-frame tasks are generated from these pass prims, usdRender will
assume a one-to-one relationship between tasks that share their frame
number. Consider a pass named’composite’whose inputPasses targets a
Pass prim named’beauty`.  By default, each frame for’composite’will
depend on the same frame from’beauty’: beauty.1 ->composite.1 beauty.2
->composite.2 etc
The consumer of this RenderPass graph of inputs will need to resolve
the transitive dependencies.

GetPassTypeAttr() → Attribute
A string used to categorize differently structured or executed types
of passes within a customized pipeline.
For example, when multiple DCC’s (e.g. Houdini, Katana, Nuke) each
compute and contribute different Products to a final result, it may be
clearest and most flexible to create a separate RenderPass for each.
Declaration
uniform token passType
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform

GetRenderSourceRel() → Relationship
The source prim to render from.
If fileName is not present, the source is assumed to be a
RenderSettings prim present in the current Usd stage. If fileName is
present, the source should be found in the file there. This
relationship might target a string attribute on this or another prim
that identifies the appropriate object in the external container.
For example, for a Usd-backed pass, this would point to a
RenderSettings prim. Houdini passes would point to a Rop. Nuke passes
would point to a write node.

static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
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.

Parameters
includeInherited (bool) – 

class pxr.UsdRender.Product
A UsdRenderProduct describes an image or other file-like artifact
produced by a render. A RenderProduct combines one or more RenderVars
into a file or interactive buffer. It also provides all the controls
established in UsdRenderSettingsBase as optional overrides to whatever
the owning UsdRenderSettings prim dictates.
Specific renderers may support additional settings, such as a way to
configure compression settings, filetype metadata, and so forth. Such
settings can be encoded using renderer-specific API schemas applied to
the product 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.
Methods:

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

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

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

Define
classmethod Define(stage, path) -> Product

Get
classmethod Get(stage, path) -> Product

GetOrderedVarsRel()
Specifies the RenderVars that should be consumed and combined into the final product.

GetProductNameAttr()
Specifies the name that the output/display driver should give the product.

GetProductTypeAttr()
The type of output to produce.

GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]

CreateOrderedVarsRel() → Relationship
See GetOrderedVarsRel() , and also Create vs Get Property Methods for
when to use Get vs Create.

CreateProductNameAttr(defaultValue, writeSparsely) → Attribute
See GetProductNameAttr() , 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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateProductTypeAttr(defaultValue, writeSparsely) → Attribute
See GetProductTypeAttr() , 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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

static Define()
classmethod Define(stage, path) -> Product
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.

Parameters

stage (Stage) – 
path (Path) – 

static Get()
classmethod Get(stage, path) -> Product
Return a UsdRenderProduct 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:
UsdRenderProduct(stage->GetPrimAtPath(path));

Parameters

stage (Stage) – 
path (Path) – 

GetOrderedVarsRel() → Relationship
Specifies the RenderVars that should be consumed and combined into the
final product.
If ordering is relevant to the output driver, then the ordering of
targets in this relationship provides the order to use.

GetProductNameAttr() → Attribute
Specifies the name that the output/display driver should give the
product.
This is provided as-authored to the driver, whose responsibility it is
to situate the product on a filesystem or other storage, in the
desired location.
Declaration
token productName =""
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token

GetProductTypeAttr() → Attribute
The type of output to produce.
The default,”raster”, indicates a 2D image.
In the future, UsdRender may define additional product types.
Declaration
uniform token productType ="raster"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform

static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
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.

Parameters
includeInherited (bool) – 

class pxr.UsdRender.Settings
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.
Methods:

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

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

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

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

Define
classmethod Define(stage, path) -> Settings

Get
classmethod Get(stage, path) -> Settings

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

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

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

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

GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]

GetStageRenderSettings
classmethod GetStageRenderSettings(stage) -> Settings

CreateIncludedPurposesAttr(defaultValue, writeSparsely) → Attribute
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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateMaterialBindingPurposesAttr(defaultValue, writeSparsely) → Attribute
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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

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

CreateRenderingColorSpaceAttr(defaultValue, writeSparsely) → Attribute
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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

static Define()
classmethod Define(stage, path) -> Settings
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.

Parameters

stage (Stage) – 
path (Path) – 

static Get()
classmethod Get(stage, path) -> Settings
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));

Parameters

stage (Stage) – 
path (Path) – 

GetIncludedPurposesAttr() → Attribute
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() → Attribute
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() → Relationship
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() → Attribute
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

static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
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.

Parameters
includeInherited (bool) – 

static GetStageRenderSettings()
classmethod GetStageRenderSettings(stage) -> Settings
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.

Parameters
stage (UsdStageWeak) – 

class pxr.UsdRender.SettingsBase
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.
Methods:

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

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

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

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

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

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

CreateResolutionAttr(defaultValue, writeSparsely)
See GetResolutionAttr() , and also Create vs Get Property Methods for when to use Get vs Create.

Get
classmethod Get(stage, path) -> SettingsBase

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

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

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

GetDisableMotionBlurAttr()
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.

GetInstantaneousShutterAttr()
Deprecated - use disableMotionBlur instead.

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

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

GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]

CreateAspectRatioConformPolicyAttr(defaultValue, writeSparsely) → Attribute
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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

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

CreateDataWindowNDCAttr(defaultValue, writeSparsely) → Attribute
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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateDisableMotionBlurAttr(defaultValue, writeSparsely) → Attribute
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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateInstantaneousShutterAttr(defaultValue, writeSparsely) → Attribute
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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreatePixelAspectRatioAttr(defaultValue, writeSparsely) → Attribute
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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateResolutionAttr(defaultValue, writeSparsely) → Attribute
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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

static Get()
classmethod Get(stage, path) -> SettingsBase
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));

Parameters

stage (Stage) – 
path (Path) – 

GetAspectRatioConformPolicyAttr() → Attribute
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() → Relationship
The camera relationship specifies the primary camera to use in a
render.
It must target a UsdGeomCamera.

GetDataWindowNDCAttr() → Attribute
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

GetDisableMotionBlurAttr() → Attribute
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() → Attribute
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() → Attribute
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() → Attribute
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

static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
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.

Parameters
includeInherited (bool) – 

class pxr.UsdRender.Tokens
Attributes:

adjustApertureHeight

adjustApertureWidth

adjustPixelAspectRatio

aspectRatioConformPolicy

camera

color3f

command

cropAperture

dataType

dataWindowNDC

denoiseEnable

denoisePass

disableMotionBlur

expandAperture

fileName

full

includedPurposes

inputPasses

instantaneousShutter

intrinsic

lpe

materialBindingPurposes

orderedVars

passType

pixelAspectRatio

preview

primvar

productName

productType

products

raster

raw

renderSettingsPrimPath

renderSource

renderingColorSpace

resolution

sourceName

sourceType

adjustApertureHeight = 'adjustApertureHeight'

adjustApertureWidth = 'adjustApertureWidth'

adjustPixelAspectRatio = 'adjustPixelAspectRatio'

aspectRatioConformPolicy = 'aspectRatioConformPolicy'

camera = 'camera'

color3f = 'color3f'

command = 'command'

cropAperture = 'cropAperture'

dataType = 'dataType'

dataWindowNDC = 'dataWindowNDC'

denoiseEnable = 'denoise:enable'

denoisePass = 'denoise:pass'

disableMotionBlur = 'disableMotionBlur'

expandAperture = 'expandAperture'

fileName = 'fileName'

full = 'full'

includedPurposes = 'includedPurposes'

inputPasses = 'inputPasses'

instantaneousShutter = 'instantaneousShutter'

intrinsic = 'intrinsic'

lpe = 'lpe'

materialBindingPurposes = 'materialBindingPurposes'

orderedVars = 'orderedVars'

passType = 'passType'

pixelAspectRatio = 'pixelAspectRatio'

preview = 'preview'

primvar = 'primvar'

productName = 'productName'

productType = 'productType'

products = 'products'

raster = 'raster'

raw = 'raw'

renderSettingsPrimPath = 'renderSettingsPrimPath'

renderSource = 'renderSource'

renderingColorSpace = 'renderingColorSpace'

resolution = 'resolution'

sourceName = 'sourceName'

sourceType = 'sourceType'

class pxr.UsdRender.Var
A UsdRenderVar describes a custom data variable for a render to
produce. The prim describes the source of the data, which can be a
shader output or an LPE (Light Path Expression), and also allows
encoding of (generally renderer-specific) parameters that configure
the renderer for computing the variable.
The name of the RenderVar prim drives the name of the data variable
that the renderer will produce.
In the future, UsdRender may standardize RenderVar representation for
well-known variables under the sourceType intrinsic , such as r,
g, b, a, z, or id. 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.
Methods:

CreateDataTypeAttr(defaultValue, writeSparsely)
See GetDataTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.

CreateSourceNameAttr(defaultValue, writeSparsely)
See GetSourceNameAttr() , and also Create vs Get Property Methods for when to use Get vs Create.

CreateSourceTypeAttr(defaultValue, writeSparsely)
See GetSourceTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.

Define
classmethod Define(stage, path) -> Var

Get
classmethod Get(stage, path) -> Var

GetDataTypeAttr()
The type of this channel, as a USD attribute type.

GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]

GetSourceNameAttr()
The renderer should look for an output of this name as the computed value for the RenderVar.

GetSourceTypeAttr()
Indicates the type of the source.

CreateDataTypeAttr(defaultValue, writeSparsely) → Attribute
See GetDataTypeAttr() , 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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateSourceNameAttr(defaultValue, writeSparsely) → Attribute
See GetSourceNameAttr() , 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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

CreateSourceTypeAttr(defaultValue, writeSparsely) → Attribute
See GetSourceTypeAttr() , 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 .

Parameters

defaultValue (VtValue) – 
writeSparsely (bool) – 

static Define()
classmethod Define(stage, path) -> Var
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.

Parameters

stage (Stage) – 
path (Path) – 

static Get()
classmethod Get(stage, path) -> Var
Return a UsdRenderVar 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:
UsdRenderVar(stage->GetPrimAtPath(path));

Parameters

stage (Stage) – 
path (Path) – 

GetDataTypeAttr() → Attribute
The type of this channel, as a USD attribute type.
Declaration
uniform token dataType ="color3f"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform

static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
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.

Parameters
includeInherited (bool) – 

GetSourceNameAttr() → Attribute
The renderer should look for an output of this name as the computed
value for the RenderVar.
Declaration
uniform string sourceName =""
C++ Type
std::string
Usd Type
SdfValueTypeNames->String
Variability
SdfVariabilityUniform

GetSourceTypeAttr() → Attribute
Indicates the type of the source.

“raw”: The name should be passed directly to the renderer. This
is the default behavior.
“primvar”: This source represents the name of a primvar. Some
renderers may use this to ensure that the primvar is provided; other
renderers may require that a suitable material network be provided, in
which case this is simply an advisory setting.
“lpe”: Specifies a Light Path Expression in the OSL Light Path
Expressions language as the source for this RenderVar. Some renderers
may use extensions to that syntax, which will necessarily be non-
portable.
“intrinsic”: This setting is currently unimplemented, but
represents a future namespace for UsdRender to provide portable
baseline RenderVars, such as camera depth, that may have varying
implementations for each renderer.

Declaration
uniform token sourceType ="raw"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
raw, primvar, lpe, intrinsic

© Copyright 2019-2023, NVIDIA.
      Last updated on Nov 14, 2023.