| On this page | |
| Since | 20.0 |
Overview ¶
This node generates work items that render a USD file or a LOP network using Karma (by default). The render executes using the Houdini husk executable. This node has similar options to the 
USD Render ROP node.
The difference between this node and the 
USD Render Files node is that this node will automatically extract the render output paths from the USD heirarchy, and can be used to render both a .usd file on disk or a LOP network in the current scene file.
TOP Attributes ¶
|
|
string |
The complexity of the render as specified by the Complexity parameter. |
|
|
file |
The path to the output image pattern for the render. This is what is passed to the husk, and it should contain symbols that can be expanded by the husk. |
|
|
string |
If Output File Tag is enabled, this attribute is set to the custom file tag that should be assigned to output files produced by work items in the node. |
|
|
float3 |
The start, end, and increment frame range values associated with the work item. If the work item is in a batch, these values refer to the range for the entire batch. |
|
|
string |
The path to the |
|
|
string |
The full husk command that is executed by the job. It is created when the Create Husk Command Attribute parameter is turned on, and it is added after the job cooks. |
Parameters ¶
USD Render Scene ¶
Generate When
Determines when this node will generate work items. You should generally leave this set to “Automatic” unless you know the node requires a specific generation mode, or that the work items need to be generated dynamically.
All Upstream Items are Generated
This node will generate work items once all of the input nodes have generated their work items.
All Upstream Items are Cooked
This node will generate work items once all of the input nodes have cooked their work items.
Each Upstream Item is Cooked
This node will generate work items each time a work item in an input node is cooked.
Automatic
The generation mode is selected based on the generation mode of the input nodes. If any of the input nodes are generating work items when their inputs cook, this node will be set to Each Upstream Item is Cooked. Otherwise, it will be set to All Upstream Items are Generated.
Cache Mode
Determines how the processor node handles work items that report expected file results.
Automatic
If the expected result file exists on disk, the work item is marked as cooked without being scheduled. If the file does not exist on disk, the work item is scheduled as normal. If upstream work item dependencies write out new files during a cook, the cache files on work items in this node will also be marked as out-of-date.
Automatic (Ignore Upstream)
The same as Automatic, except upstream file writes do not invalidate cache files on work items in this node and this node will only check output files for its own work items.
Read Files
If the expected result file exists on disk, the work item is marked as cooked without being scheduled. Otherwise the work item is marked as failed.
Write Files
Work items are always scheduled and the expected result file is ignored even if it exists on disk.
Cook Type
Determines how work items in the node should cook, e.g. if they should run in process, out of process, or using services.
Input USD
Determines the source of the USD file.
Upstream Output File
The output file produced by the upstream work item is used as the path to the USD file.
Custom File Path
The custom file path specified by File Path is used as the path to the USD file.
LOP Node
The USD file is created by writing out a LOP network to disk.
File Tag
Specifies the data tag that is used to select the result from the upstream work item. This parameter is only available when Input USD is set to Upstream Output File.
File Path
Specifies the path to the USD file to be rendered. This parameter is only available when Input USD is set to Custom File Path.
LOP Path
Specifies the path to the LOP network to be rendered. This parameter is only availalbe when Input USD is set to LOP Node.
Temp File Path
Specifies where the LOP network should be written to, when Input USD is set to LOP Node.
Save Style
Specifies the save style to use when writing out the temporary .usd file for rendering. See the USD ROP documentation for details. This parameter is only available when Input USD is set to LOP Node.
Flush Data After Each Frame
When this is on, the node writes out each frame’s data to disk before cooking the LOP Network to generate the next frame of data. When this is off (the default), the node cooks the data for all frames into memory and writes out the animated files all at once. See the USD ROP documentation for details. This parameter is only available when Input USD is set to LOP Node.
Error Saving Layers With Implicit Paths
This parameter is only available when Input USD is set to LOP Node. When this is on, work items that try to save a .usd file for rendering with an anonymous in-memory layer will fail. See the USD ROP documentation for details.
Population Mask
Specifies as mask to use when loading the .usd file to look for output paths, when Input USD is set to Custom File Path or Upstream Output File.
Evaluate with Work Item Attributes
Specifies whether the LOP network should evaluated for each work item in this node when determining output paths. This is only available when Input USD is set to LOP Node.
Output From
Specifies how the node should determine the output file path for render tasks.
Custom Path
Outputs are determined using a custom path.
Primitive
Outputs are determined by a render product prim in the USD heirarchy.
Output Path
When Output From is set to Custom Path, this parameter determines the output path for the render.
Render Product
The path to the render product that describes the output paths for the USD heirarchy.
Primitive Name
The name of the primitive in the render product that specifies the output path.
Purpose
Specifies the purpose for rendering.
This is a comma separated list of purposes (from {'geometry', 'guide', 'proxy', 'render'}).
Render Settings Prim
Specifies the scene graph path to the RenderSettings prim with which you want to render. You can specify a path relative to /Render.
If this parameter field is empty, the node looks for default render settings on the root prim. If the root prim has no render settings, the node uses default settings.
Complexity
Specifies the geometric complexity ({'low', 'medium', 'high', 'veryhigh'}).
Other Delegate
When on, specifies the Hydra client to use to render your images. By default, the Hydra client is Karma.
You must register any alternate Hydra clients with Houdini’s USD libraries. For more information, see how the node gets the list of available renderers above.
Checkpoint Interval
When on, specifies the interval (in seconds) at which the renderer writes out a checkpoint file and partial image.
Command Prefix
Specifies a command to be executed instead of the husk executable. This command will be passed the full generated husk command line. To function properly this wrapper program should pass through the stdout from husk.
Extra Husk Arguments
Specifies any extra arguments to pass to the husk executable along with those determined by the parameters.
Create Husk Command Attribute
When on, creates a work item attribute with the value of the full husk command that is executed by the job. This attribute is created after the job cooks.
Seconds
When on, specifies the rendering time limit (in seconds).
Time Limit Is Per Frame
This parameter is only available when Seconds is on.
When on, the Seconds time limit applies to images rather than your whole sequence.
No Partial Results on Timeout
This parameter is only available when Seconds is on.
When on, partial results are not saved when the Seconds time limit is exceeded.
Level
Determines the amount of information to print out while rendering. A higher number means more information is printed during the render.
VEX Profiling
Allows you to use VEX profiling.
Off
VEX profiling is disabled.
VEX
VEX profiling is enabled.
VEX and NAN Checks
VEX profiling with NAN checks is enabled.
Warning
This parameter impacts performance.
Alfred Syle Progress
When on, the node writes print percentage complete values as files in the style expected by Pixar’s Alfred render queue.
Message Time Stamps
When on, time stamps are applied to messages.
Schedulers ¶
TOP Scheduler Override
This parameter overrides the TOP scheduler for this node.
Schedule When
When enabled, this parameter can be used to specify an expression that determines which work items from the node should be scheduled. If the expression returns zero for a given work item, that work item will immediately be marked as cooked instead of being queued with a scheduler. If the expression returns a non-zero value, the work item is scheduled normally.
Work Item Label
Determines how the node should label its work items. This parameter allows you to assign non-unique label strings to your work items which are then used to identify the work items in the attribute panel, task bar, and scheduler job names.
Use Default Label
The work items in this node will use the default label from the TOP network, or have no label if the default is unset.
Inherit From Upstream Item
The work items inherit their labels from their parent work items.
Custom Expression
The work item label is set to the Label Expression custom expression which is evaluated for each item.
Node Defines Label
The work item label is defined in the node’s internal logic.
Label Expression
When on, this parameter specifies a custom label for work items created by this node. The parameter can be an expression that includes references to work item attributes or built-in properties. For example, $OS: @pdg_frame will set the label of each work item based on its frame value.
Work Item Priority
This parameter determines how the current scheduler prioritizes the work items in this node.
Inherit From Upstream Item
The work items inherit their priority from their parent items. If a work item has no parent, its priority is set to 0.
Custom Expression
The work item priority is set to the value of Priority Expression.
Node Defines Priority
The work item priority is set based on the node’s own internal priority calculations.
This option is only available on the 
Python Processor TOP, 
ROP Fetch TOP, and ROP Output TOP nodes. These nodes define their own prioritization schemes that are implemented in their node logic.
Priority Expression
This parameter specifies an expression for work item priority. The expression is evaluated for each work item in the node.
This parameter is only available when Work Item Priority is set to Custom Expression.
| See also |
Render IFD
