| On this page |
This output operator is used to drive the RenderMan rendering program. The operator sets up all necessary options and then invokes the renderer. Alternatively, the output can be saved to disk as a script file to be rendered later.
Arguments may be passed to the script and variable expansion is done before calling the script.
Specific parameters other than those listed below map directly to a feature in RenderMan. Various options and attributes can be set using these parameters. If a parameter is blank, then no value will be output in the RIB (i.e. the default values from the rendermn.ini file will be used).
Parameters
Render to Disk
Renders to disk and show in MPlay.
Render to MPlay
Renders with the last render control settings, redirecting rendered frames to MPlay, instead of the specified path. If the Display Device is set to framebuffer or houdini, it will redirect to RenderMan’s Image Tool 'it'. Note that deep images will still be written out to their specified output path, if enabled.
Render to Disk in Background
Renders to disk in background.
Render Control
Opens the render control dialog to allow adjustments of the render parameters before rendering.
Valid Frame Range
Render Current Frame
Renders a single frame, based on the value in the playbar or the frame that is requested by a connected output render node.
Render Frame Range
Renders a sequence of frames. If an output render node is connected, this range is generally ignored in favor of frames requested by the output render node.
Render Frame Range (Strict)
Renders a sequence of frames. If an output render node is connected, this range restricts its requested frames to this frame range.
Start/End/Inc
Specifies the range of frames to render (start frame, end frame, and increment). All values may be floating point values. The range is inclusive.
These parameters determine the values of the local variables for the output driver.
For example, if the parameters are set to: table>>
There will be 4 frames rendered (10.5, 11, 11.5, and 12), so $NRENDER will have a value of 4. $N will have the value:
table>>
Render With Take
The output driver will switch to this take before rendering to restore the current take when rendering has been completed.
Camera
The camera object which defines the scene.
Override Camera Resolution
Properties
RIS
Integrator
Specify an integrator. If it is not specified, it will default to PxrPathTracer.
Pixel Variance
Set the upper bound on the acceptable estimated variance of the pixel values from the true pixel values.
Output Denoise EXR
If it is set to "Single Frame", it will use the current frame to output the multichannel exr for the denoiser input. If it is set to "Cross frame", it will use the current frame, previous frame, and next frame to output the multichannel exr required for the denoiser input.
Display
Hover your mouse over the parameter names and use the reference in the tool tip to look up the corresponding information in the RenderMan documentation.
LPE
Set your user LPEs. User LPEs are required for outputing AOVs for a certain Bxdf such as PxrSurface.
Ri AOV
Hover your mouse over the parameter names and use the reference in the tool tip to look up the corresponding information in the RenderMan documentation.
Hider
Hover your mouse over the parameter names and use the reference in the tool tip to look up the corresponding information in the RenderMan documentation.
Motion Blur
Allow Motion Blur
RenderMan will render the image using motion blur. The shutter parameter on the camera determines the duration of the shutter, specified as a fraction of the frame.
Shutter Opening
Specify the shutter opening and closing for the camera. It allows control over the speed with which the shutter opens and closes.
Xform Time Samples
The number of transformation blur motion samples. Each object (unless the parameter exists on the object) will have this many transforms output over the shutter duration. Increasing this number will result in smoother sub-frame motion, at a small memory and compute expense. Any number of segments may be specified.
Geo Time Samples
The number of deformation blur motion samples. Each object (unless the parameter exists on the object) will have this many copies of the geometry included in the RIB. When an object is deforming, increasing this parameter will result in smoother sub-frame motion blur.
This option has no effect objects, which use velocity blur, since velocity blur is linear by nature.
Note
Any number of segments may be specified; however, duplicate geometry is sent down for each sample which may significantly impact the memory footprint of RenderMan.
Shutter Offset
Specify an offset to be added to motion blur times.
Depth Of Field
Enable Depth of Field
Hover your mouse over the parameter name and use the reference in the tool tip to look up the corresponding information in the RenderMan documentation.
Focus and F-Stop are set in the Camera itself.
Focus Region
This non-physical control allows the user to increase or decrease the size around the location defined in Focus Distance. This is helpful to create incredibly thin slices of focus artificially.
Render
Hover your mouse over the parameter names and use the reference in the tool tip to look up the corresponding information in the RenderMan documentation for the Global Shadow Bias, Trace Displacements, Global Trace Depth, Enable Gaussian Texture, Enable Texture Lerp, and Volume Strategy parameters.
Create Image From Viewing Camera
Renders an image from the viewing camera. Sometimes, it is useful to skip this render, for example, when rendering shadow maps.
Auto-Generate Shadow Maps
Enable or disable shadow map generation. Each light also has its own controls to determine whether shadow maps will be generated.
Auto-Generate Environment Maps
Enable or disable environment map generation. Each object can be set up to generate an environment map of all the other objects in the scene.
Attributes
Hover your mouse over the parameter names and use the reference in the tool tip to look up the corresponding information in the RenderMan documentation.
Dicing
Micropolygon Length
The micropolygonlength value is the target edge length (measured in raster space, ie. in screen pixel units) of diced (tessellated) micropolygons.
Relative Micropolygon Length
This sets a relative micropolygon length.
Reset Relative Micropolygon Length
This resets the relative micropolygon length.
Watertight
When enabled, greatly reduces or eliminates cracking between faces of a Catmull-Clark subdivision mesh, even in the face of displacement shading disagreements on adjacent faces. This attribute requires pretessellation of the geometry and will force pretessellation if possible. Watertight dicing is currently only implemented for Catmull-Clark subdivision meshes
Pretessellate (option)
Enables "pre-tessellating" subdivision surfaces into polygons on the fly for improved memory performance.
Limits
Hover your mouse over the parameter names and use the reference in the tool tip to look up the corresponding information in the RenderMan documentation.
Paths
Hover your mouse over the parameter names and use the reference in the tool tip to look up the corresponding information in the RenderMan documentation.
Statistics
Hover your mouse over the parameter names and use the reference in the tool tip to look up the corresponding information in the RenderMan documentation.
Objects
The parameters on this tab determine which objects and lights are included in the RIB.
Candidate Objects
The geometry objects in this parameter will be included in the RIB if their display flags are turned on and their display channel is enabled.
Force Objects
Objects in this parameter are added to the RIB regardless of the state of their display. Objects can only be added to the RIB once.
Exclude Objects
Objects in this parameter are excluded from the scene, regardless of whether they are selected in the Candidate Objects or Force Objects.
Solo Light
Only lights in this parameter will be included in the RIB. This includes shadow map generation and illumination. If this parameter is set, the candidate, forced, and exclusion parameters are ignored.
Note
Using this parameter in conjunction with the render_viewcamera property provides a quick way of generating shadow maps for selected lights.
Candidate Lights
Each light in this parameter is added to the RIB if the dimmer channel of the light is not 0. The standard light sets the dimmer channel to 0 when the light is not enabled.
Force Lights
The lights in this parameter are added to the RIB regardless of the value in their dimmer channels.
Exclude Lights
These lights will be excluded from the scene, even if they are selected in Candidate Lights or Force Lights__.
Visible Fog
The fog/atmosphere objects in this parameter are included in the RIB if their display flags are turned on and their display channel is enabled.
Scripts
Each script command refers to an hscript command which will be run, regardless of the expression language selected for the parameter. The resulting string will be run as an hscript command.
Note
It is possible to use the python, unix or source hscript commands to perform complex processing.
The commands are always run when rendering occurs. The command checks the parameters of the output driver when it is rendering a range or sending output to a command.
Before the render occurs, Houdini will automatically set the current hscript directory to point to the output driver.
Pre-Render Script
This command is run before any RIBs are generated. It is only run once per render.
Pre-Frame Script
This command is run before each RIB is generated.
Post-Frame Script
This command is run after each RIB is generated.
Note
Although the RIB may have been generated, this does not necessarily mean that RenderMan has finished rendering the image when this command is run.
Post-Render Script
This command is run one time, after all RIBs have been generated.
Note
Although the RIB may have been generated, this does not necessarily mean that RenderMan has finished rendering the image when this command is run.
Driver
The output driver is responsible for generating RIB files. These files describe the Houdini scene to RenderMan. The Main tab determines how the RIB generation is processed.
Render Target
Chooses a target version of RenderMan allows you to generate a RIB targeted to a specific build of RenderMan.
RIB Backend
Chooses how to drive PRMan to render the scene.
SOHO
Uses SOHO, Houdini’s customizable Python scripted output system, to generate a RIB stream.
PRMan for Python
Use PRMan’s Python API to render directly. This has advantages and disadvantages over SOHO.
-
It’s probably faster than using SOHO, because it doesn’t have the overhead of writing the RIB to a file or pipe.
-
PRMan runs in the same process as Houdini, so if PRMan crashes, Houdini may crash.
-
Data structures in Python need to be massaged to fit properly with PRMan for Python, so it may use more memory.
Generate Python
Generates a Python script that uses PRMan’s Python API to render the scene.
RiBegin
The string Houdini passes to RiBegin() when RIB Backend is PRMan or Python.
See the documentation for PRMan for Python for more information.
The default is __render, which creates a rendering context.
Disk File
The location where the RIB file is saved to disk. You must turn on the Disk File checkbox to enable this parameter.
Command
The command where the RIB file is sent. This will be disabled if the RIB file is saved to disk.
Block Until Render Completes
When sending the output to a command, Houdini will normally return control after it is finished writing the RIB. This allows the render process to complete in the background. Turning on this parameter will force Houdini to block until the output driver finishes rendering the frame.
When rendering a frame range, this option is automatically turned on. However, the option is not automatically turned on when rendering in an hscript or python loop construct. Therefore caution must be used or it is possible to end up starting multiple background renders.
Note
The rps and rkill hscript commands can be used to query or kill background renders.
See the Troubleshooting section for more information.
Skip Existing Frames
Skip rendering of existing frames. There are three values for this parameter.
Overwrite existing frames
This option will render every frame, regardless whether there’s a file on disk or not.
Skip frames that exist
If there’s a disk file that matches the vm_picture parameter, no
render will be performed.
Skip frames that are valid images
If a disk file exists, the integrity of the image is checked before rendering is performed. This option incurs the cost of reading the image, but will re-render images that weren’t fully rendered.
Initialize Simulation OPs
If this option is turned on, all POP and DOP simulations will be put in a reset state before rendering.
Advanced
When generating blobby primitives in RIB, the string parameters were hard-coded to an empty list. SOHO will now search for a detail attribute named RiBlobby_Strings (case sensitive). This value of this string will be parsed using the syntax described in the Python function shlex.split(). The resulting list of strings will be output in the RiBlobby() call.
Locals
N
The current frame of the range specified. This always starts at 1.
NRENDER
Total number of frames being rendered.
| See also |
mantra output driver
