Include dependency graph for spec.h:

Classes
struct	UsdRenderSpec
	A self-contained specification of render settings. More...

struct	UsdRenderSpec::Product
	Specification of a product. See UsdRenderProduct. More...

struct	UsdRenderSpec::RenderVar
	Specification of a render variable (aka AOV). See UsdRenderVar. More...

Functions
USDRENDER_API UsdRenderSpec	UsdRenderComputeSpec (UsdRenderSettings const &settings, TfTokenVector const &namespaces)
	Computes the specification of the render settings.

USDRENDER_API VtDictionary	UsdRenderComputeNamespacedSettings (UsdPrim const &prim, TfTokenVector const &namespaces)
	Returns a dictionary populated with attributes filtered by the namespaces.

Class Documentation

◆ UsdRenderSpec

struct UsdRenderSpec

A self-contained specification of render settings.

Note: This is preliminary API and is likely to change.

Definition at line 54 of file spec.h.

Class Members
VtArray< TfToken >	includedPurposes	List of purposes to use to filter scene contents.
VtArray< TfToken >	materialBindingPurposes	List of material binding purposes.
VtDictionary	namespacedSettings	Any extra settings values discovered in requested namespaces.
vector< Product >	products	The full list of products requested by this render.
vector< RenderVar >	renderVars	The full list of render vars requested by products in this render.

◆ UsdRenderSpec::Product

struct UsdRenderSpec::Product

Specification of a product. See UsdRenderProduct.

Definition at line 56 of file spec.h.

Class Members
GfVec2f	apertureSize	The camera aperture size as adjusted by aspectRatioConformPolicy.
TfToken	aspectRatioConformPolicy	The policy that was applied to conform aspect ratio mismatches between the aperture and image.
SdfPath	cameraPath	Path to the primary UsdGeomCamera camera to use for this product.
GfRange2f	dataWindowNDC	The data window, in NDC terms relative to the aperture. (0,0) corresponds to bottom-left and (1,1) corresponds to top-right. Note that the data window can partially cover or extend beyond the unit range, for representing overscan or cropped renders.
bool	disableDepthOfField	If set to true, disables depth of field.
bool	disableMotionBlur	If set to true, disables motion blur.
TfToken	name	The name of the product, which uniquely identifies it.
VtDictionary	namespacedSettings	Any extra settings values discovered in requested namespaces.
float	pixelAspectRatio	The pixel aspect ratio as adjusted by aspectRatioConformPolicy.
SdfPath	renderProductPath	The path of this product, which uniquely identifies it.
vector< size_t >	renderVarIndices	The render vars used by this product, as indices into the top-level renderVars array.
GfVec2i	resolution	The pixel resolution of the product.
TfToken	type	The type of product, ex: "raster".

◆ UsdRenderSpec::RenderVar

struct UsdRenderSpec::RenderVar

Specification of a render variable (aka AOV). See UsdRenderVar.

Definition at line 91 of file spec.h.

Class Members
TfToken	dataType	The value data type of the variable, as a USD type name.
VtDictionary	namespacedSettings	Any extra settings values discovered in requested namespaces.
SdfPath	renderVarPath	The path of this render var, which uniquely identifies it.
string	sourceName
TfToken	sourceType

Function Documentation

◆ UsdRenderComputeNamespacedSettings()

USDRENDER_API VtDictionary UsdRenderComputeNamespacedSettings	(	UsdPrim const &	prim,
		TfTokenVector const &	namespaces
	)

Returns a dictionary populated with attributes filtered by the namespaces.

If a non-empty list of namespaces is provided, only authored attributes within those namespaces are returned. If an empty list of namespaces is provided, all custom (non-schema) attributes are returned.

Note: Special handling is provided for connectable attributes that are used to represent node graph outputs.

◆ UsdRenderComputeSpec()

USDRENDER_API UsdRenderSpec UsdRenderComputeSpec	(	UsdRenderSettings const &	settings,
		TfTokenVector const &	namespaces
	)

Computes the specification of the render settings.

For each product, applies the aspectRatioConformPolicy and computes a final screenWindow and pixelAspectRatio.

Any other attributes encountered are returned in namespacedSettings. If a non-empty list of namespaces is provided, only attributes within those namespaces are returned. If an empty list of namespaces is provided, all custom (non-schema) attributes are returned. The same list of namespaces is used for finding namespacedSettings in all UsdRender prim types.

Classes