|On this page|
A RenderProduct combines one or more RenderVars into a file (or interactive buffer).
A render product prim (
UsdRenderProduct) is referenced by a render settings prim (
UsdRenderSettings). The render settings prim holds the general configuration for rendering the scene. The render product prim may override any of the attributes on the settings prim for this particular product.
Specific renderers may support additional settings, such as a way to configure compression settings, filetype metadata, and so on. These settings would be encoded in attributes following a renderer-specific Schema API.
Render product prims must be somewhere under
/Renderin the scene graph tree.
Creating vs. editing prims
This node belongs to a class of nodes that create or edit USD prims directly. These nodes operate in Create mode or Edit mode. This is controlled by a Create primitives checkbox or a Create/Edit popup menu. In create mode, the node creates new prims. In edit mode, the node changes the attributes on an existing prim.
Parameters that correspond to a USD attribute have a pop-up menu to the left that controls how the node authors the attribute.
Pop-up menu item
Set or Create
Sets the attribute to the given value, whether it previously existed or not.
Set If Exists
Only set the attribute to the given value if it previously existed.
Use this mode to make sure an attribute is only set on primitives of the correct type. For example, only
Makes the attribute appear to not exist, so it takes on its default value. (If the attribute doesn’t already exist on the prim, this does nothing.)
Ignore this parameter, don’t create or change the attribute in any way.
Whether this node should create new prims, or edit existing prims.
In create mode, this lets you control where in the scene graph to create the prim(s).
The default is usually
/$OS. This creates a primitive at the root level with the same name as the node (for example,
/tube1). This is a useful default for preventing naming conflicts, but terrible for organization. You should try to remember to change the Primitive path to a better value when you create prims.
For example, instead of naming models after the node that created them, you might want to name them after the geometry inside, and organize them under a
The "Create primitives" section contains basic controls for how to create the new prim(s).
In edit mode, the node has a Primitive pattern parameter. This lets you specify the prim(s) the node should operate on. You can click the select button beside the text box to select the primitives from the scene graph tree. You can also use primitive patterns for advanced matching, including matching all prims in a collection.
Initialize Parameters For Edit
In edit mode, changes the state of all control menu parameters to
Do Nothing, so that this node will not apply any changes. Also grabs the current values of each property from the first Primitives match, and sets the values of the corresponding parameters to match. This means that changing any parameter’s control menu to
Set or Create mode will set the property to its current value, making it easier to apply changes to an existing value rather than setting a brand new value.
This section only appears when the node is creating primitives.
If you want to create a new cube primitive at
/world/objects/cube1on an empty stage: Set Primitive Specifier to "Define", and the Parent Primitive Type to "Xform".
If you want to override the radius of a sphere at
/world/objects/sphere1: Set Primitive Specifier to "Over", and the Parent Primitive Type to None. This makes sure the primitive types of any existing ancestor prims are not be modified by this node.
The number of primitives to create.
Set all created prims to have this kind.
Parent Primitive Type
If any parents of a path in Primitive paths do not exist, this node will automatically create them. In this case, it will create parent nodes of this type.
The USD operator to use when creating the new prims.
Authors a completely new prim. Use this if you want to create a brand new prim or replace an existing prim.
Authors an override of an existing prim. Attributes not explicitly authored on this prim will get their values from the existing prim on the lower layer.
Define a primitive class. This is usually not necessary unless you are doing deep USD magic.
Ordered Render Vars
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. However, only explicitly named RenderVars will appear in the specified order. RenderVars specified using wildcard matching or VEX evaluation will appear in alphabetical order after any explicitly named RenderVars.
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.
The type of output to produce. The default, "raster", indicates a 2D image.
In the future, UsdRender may define additional product types.
Path to a USD camera (
UsdGeomCamera) prim to render the scene from.
The horizontal and vertical size of the output image, in pixels.
Override the camera’s Shutter close parameter to be equal to its Shutter open time, to produce a zero-width shutter interval. This is a convenient way to disable motion blur.
Aspect Ratio Conform Policy
What to do if the aspect ratio of the output image (Resolution width divided by height) doesn’t match the aspect ratio of the camera aperture (controlled by attributes on the camera). This allows a standard renderer to do something reasonable when you switch between cameras.
If necessary, expand the camera aperture to match the image.
If necessary, crop the camera aperture to match the image.
Adjust Aperture Width
If necessary, change the camera aperture width to match the image.
Adjust Aperture Height
If necessary, change the camera aperture height to match the image.
Adjust Pixel Aspect Ratio
Change the aspect ratio of the image to match the camera.
Data Window NDC
Directs the renderer to only render within this window of the entire output image. The rectangle is specified in as
minX, minY, maxX, maxY, in a normalized range
0, 0 are the bottom left and
1, 1 are the top right. The default window
0, 0, 1, 1 covers the entire image (that is, is not cropped).
You can use this window to temporarily crop the render to a smaller region, for testing purposes.
You can also specify negative values and/or values greater than 1 to reveal overscan data.
Pixels are only rendered if they are fully inside the window.
The normalized coordinates map to the image after any adjustments by the Aspect ratio conform policy.
Pixel Aspect Ratio
The aspect ratio (width/height) of image pixels (not the image itself).
The default is
1.0, indicating square pixels.