UsdRenderSpec::Product Struct Reference

Specification of a product. See UsdRenderProduct. More...

#include <spec.h>

Public Attributes
SdfPath	renderProductPath
	The path of this product, which uniquely identifies it. More...
TfToken	type
	The type of product, ex: "raster". More...
TfToken	name
	The name of the product, which uniquely identifies it. More...
SdfPath	cameraPath
	Path to the primary UsdGeomCamera camera to use for this product. More...
bool	disableMotionBlur
	If set to true, disables motion blur. More...
bool	disableDepthOfField
	If set to true, disables depth of field. More...
GfVec2i	resolution = GfVec2i(0)
	The pixel resolution of the product. More...
float	pixelAspectRatio
	The pixel aspect ratio as adjusted by aspectRatioConformPolicy. More...
TfToken	aspectRatioConformPolicy
GfVec2f	apertureSize = GfVec2f(0)
	The camera aperture size as adjusted by aspectRatioConformPolicy. More...
GfRange2f	dataWindowNDC
std::vector< size_t >	renderVarIndices
VtDictionary	namespacedSettings
	Any extra settings values discovered in requested namespaces. More...

Detailed Description

Specification of a product. See UsdRenderProduct.

Definition at line 39 of file spec.h.

Member Data Documentation

GfVec2f UsdRenderSpec::Product::apertureSize = GfVec2f(0)

The camera aperture size as adjusted by aspectRatioConformPolicy.

Definition at line 60 of file spec.h.

TfToken UsdRenderSpec::Product::aspectRatioConformPolicy

The policy that was applied to conform aspect ratio mismatches between the aperture and image.

Definition at line 58 of file spec.h.

SdfPath UsdRenderSpec::Product::cameraPath

Path to the primary UsdGeomCamera camera to use for this product.

Definition at line 47 of file spec.h.

GfRange2f UsdRenderSpec::Product::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.

Definition at line 66 of file spec.h.

bool UsdRenderSpec::Product::disableDepthOfField

If set to true, disables depth of field.

Definition at line 51 of file spec.h.

bool UsdRenderSpec::Product::disableMotionBlur

If set to true, disables motion blur.

Definition at line 49 of file spec.h.

TfToken UsdRenderSpec::Product::name

The name of the product, which uniquely identifies it.

Definition at line 45 of file spec.h.

VtDictionary UsdRenderSpec::Product::namespacedSettings

Any extra settings values discovered in requested namespaces.

Definition at line 71 of file spec.h.

float UsdRenderSpec::Product::pixelAspectRatio

The pixel aspect ratio as adjusted by aspectRatioConformPolicy.

Definition at line 55 of file spec.h.

SdfPath UsdRenderSpec::Product::renderProductPath

The path of this product, which uniquely identifies it.

Definition at line 41 of file spec.h.

std::vector<size_t> UsdRenderSpec::Product::renderVarIndices

The render vars used by this product, as indices into the top-level renderVars array.

Definition at line 69 of file spec.h.

GfVec2i UsdRenderSpec::Product::resolution = GfVec2i(0)

The pixel resolution of the product.

Definition at line 53 of file spec.h.

TfToken UsdRenderSpec::Product::type

The type of product, ex: "raster".

Definition at line 43 of file spec.h.

---

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

• pxr/usd/usdRender/spec.h