All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
spec.h File Reference
+ Include dependency graph for spec.h:

Go to the source code of this file.

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, UsdTimeCode time, std::vector< std::string > const &namespaces)
 Computes the specification of the render settings. More...
 

Class Documentation

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
VtDictionary extraSettings Any extra settings values discovered in requested namespaces.
VtArray< TfToken > includedPurposes List of purposes to use to filter scene contents.
VtArray< TfToken > materialBindingPurposes List of material binding purposes.
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.
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.

VtDictionary extraSettings Any extra settings values discovered in requested namespaces.
bool instantaneousShutter If set to true, disables motion blur.
TfToken name The name of the product, which uniquely identifies it.
float pixelAspectRatio The pixel aspect ratio as adjusted by aspectRatioConformPolicy.
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".
struct UsdRenderSpec::RenderVar

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

Definition at line 87 of file spec.h.

Class Members
TfToken dataType The value data type of the variable, as a USD type name.
VtDictionary extraSettings 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

USDRENDER_API UsdRenderSpec UsdRenderComputeSpec ( UsdRenderSettings const &  settings,
UsdTimeCode  time,
std::vector< std::string > 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 extraSettings. 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 extraSettings in all UsdRender prim types.