Server

If Unreal Editor is running on a remote machine, enter the IP address of the machine here.

If Nuke and Unreal are running on the same machine, the default address is correct.

If Unreal Editor is running on a remote machine, enter the port the machine is listening on here.

If Nuke and Unreal are running on the same machine, the default port is correct.

Click to connect UnrealReader to Unreal Editor using the Host Name and Port values shown.

You only need to click this button once to initialize the connection and the button is replaced by Fetch Latest when the connection is established.

When the connection to Unreal Editor is established, click Fetch Latest to retrieve the latest updates from the Nuke Server and populate the following fields:

• Maps

• Sequences

• Linked Camera Output

• Available Object ID Passes

• OCIO settings and Custom Class Render Passes from the Unreal Engine Nuke Server panel

Displays the version of Nuke Server you're running under.

Project

Displays the file path to the Unreal Editor project you're working with currently.

Refines the available options in the Map dropdown. Searches can contain multiple words separated by the wild card character * (asterisk). For example:

shot0*take001*v002

Matches the following string:

cinematics/shot001/take0014/v002

When enabled, the Map Filter is case-sensitive.

Selects the map to use for rendering in Unreal Editor.

When enabled, all folders are searched for maps, not just the Project folder.

When disabled, only the Project folder is searched for maps.

Refines the available options in the Sequence dropdown. Searches can contain multiple words separated by the wild card character * (asterisk). For example:

shot0*take001*v002

Matches the following string:

cinematics/shot001/take0014/v002

When enabled, the Sequence Filter is case-sensitive.

Selects the sequence to use for rendering in Unreal Editor.

When enabled, all folders are searched for sequences, not just the Project folder.

When disabled, only the Project folder is searched for sequences.

Output

Sets the unit of measure for objects in the scene, either Nuke standard or Unreal Editor.

Sets whether the full image or stencil layers are rendered. Setting Render Mode to stencil layers enables the Layers controls in the Render tab in the Properties panel, allowing you to select which layers you want from Unreal Editor.

When enabled, the selected passes are rendered as cube maps producing six renders per pass.

Note:  Cryptomatte is not currently supported with cube maps.

Sets the resolution of the script in Nuke.

Sets the number of pixels to render outside Nuke's bounding box.

The first frame of the Unreal Editor sequence.

Sets the behavior of frames before the startFrame:

• hold - the first frame in the sequence is held until the startFrame frame is reached.

• loop - plays a clip loop until the startFrame frame is reached..

• bounce - substitutes a reversed equal number of frames, creating a clip bounce until the startFrame frame is reached.

• black - frames are black until the startFrame frame is reached.

The last frame of the Unreal Editor sequence.

Sets the behavior of frames after the endFrame:

• hold - the last frame in the sequence is held until the endFrame frame is reached.

• loop - plays a clip loop until the endFrame frame is reached..

• bounce - substitutes a reversed equal number of frames, creating a clip bounce until the endFrame frame is reached.

• black - frames are black until the endFrame frame is reached.

Write

Sets the file path to where the rendered files are stored.

Sets the file format to render. Currently only .exr files are supported.

Sets the bit depth of the rendered .exr files. Currently only 16 bit half bit-depth is supported.

Sets the compression type to apply to the rendered file:

• none

• Zip (1 scanline)

• Zip (16 scanline)

• PIZ wavelet

• RLE

• B44

• B44A

• DWAA

• DWAB

Sets the quality of images compressed with the DWAA and DWAB compression types. Higher values render smaller files, but with more data loss.

Note:  This control is only available when Compression is set to DWAA or DWAB.

Click to send a render job to the Unreal Movie Render Queue. The files are written to disk on the machine running Unreal Editor, which could be local or remote.

When enabled, clicking Write to Disk automatically creates a Read node referencing the output from the Unreal Movie Render Queue.

Depending on your machine's specifications and the number of shots Unreal Editor is rendering, the Read node may be in an error state until the files are written to disk.

When enabled, the Read node references the files rendered from write operation, rather than from Unreal Editor.

Click to add the selected render passes to the Nuke script. You can view the new channels by selecting them in the Viewer channels dropdown.

Passes

Select the render passes from the list of passes imported from Unreal Editor. Click the Update Channel List button to add the selected channels to the Nuke script.

Layers

When enabled, any stencil layers present in Unreal are displayed in the Viewer. Previewing layers assigns colors to stencils makes picking stencils easier.

Add stencils from Unreal to the Layer List. This uses Nuke's eyedropper color picker.

Click the color swatch next to Picker Add and Ctrl/Cmd + Click a stencil in the Viewer to add it to the selection.

Selected stencils are displayed in yellow in the Viewer. Multiple selections can be added. Once added, stencil names are added to the Layer List.

Remove stencils from the Layer List. This uses Nuke's eyedropper color picker.

Click the color swatch next to Picker Remove and Ctrl + Click a stencil to remove it from the selection.

Once removed, stencil names are also removed from the Layer List.

A list of currently selected layers. This list can be modified in text form or using the Picker Add and Picker Remove controls.

The Layer List supports basic wildcard functionality so asterisks (*) can be used to select multiple mattes on one line. Asterisks (*) can be appended to a word to represent any number or character.

Note:  For more information, see Using the Matte List.

Clears the Layer List.

All stencils are deselected.

When enabled, occlusions are removed from stencil layers.

Layers that occlude layers selected in the Layer List are hidden and their reflections removed before rendering the output.

When disabled, occlusions are baked into the rendered output.

When Remove Layer Occlusion is active, enabling this control removes shadows cast by hidden occluding layers.

When disabled, hidden layers cast shadows as normal.

Deferred Rendering

When enabled, multiple temporal or spatial sample accumulation includes an alpha channel.

To use this control, r.Postprocessing.propagateAlpha must be set to 1 or 2 in Unreal Editor.

Note:  Enabling this control increases processing time considerably.

When enabled, effects that blend pixels together, such depth of field and temporal anti-aliasing, are enabled.

When enabled, post process materials are written to a 32-bit render target instead of 16-bit.

Cryptomatte

Allows you to choose the segmentation type for the Cryptomatte render pass from your Unreal scene. Among the options available for Cryptomatte division are per actor, per folder, and per material.

This control on applies to Cryptomatte layers selected in the Render Passes table.

Anti-aliasing

Sets the number of frames used to create one overall sample.

Higher values increase anti-aliasing quality at the expense of processing time.

Sets the number of frames used to produce each output frame by blending the value of sub-steps specified.

Higher values increase anti-aliasing quality at the expense of processing time.

Sets the anti-aliasing method to use:

• use UE4 setting - anti-aliasing uses the method selected in Unreal Editor.

• none - no anti-aliasing is applied to the output frames.

• FXAA

• Temporal AA

• MXAA

Sets the number of frames rendered and then discarded to set up a temporal history for effects such as anti-aliasing.

If you're not using anti-aliasing or other temporal effects, you can use a low number of warm-up frames.

When enabled, the excess frames in the camera cut are use to determine engine warm up.

Sets the number of frames at the start of each shot that are run through without rendering. Engine warm-up frames can be used to make sure that things such as particle systems have enough time to process before rendering the frames in Nuke.

When enabled, the warm-up frames are processed on the GPU.

Generally, Nuke renders and responds better with this control disabled, but some processes, like GPU particle systems, need this enabled to process their warm-up as expected.

Camera

Sets a timing bias on the shutter angle:

• frame open - the motion to produce a frame represents the time from when the frame is rendered and onwards.

• frame center - the motion to produce a frame represents half the time before the frame and half the time after the frame is rendered.

• frame close - the motion to produce a frame comes from before and up to the frame being rendered.

Color Output

Controls whether or not OCIO color settings from Unreal Engine are enabled.

A read-only control displaying the OCIO config selected in Unreal Engine.

When OCIO is enabled and a configuration is selected in Unreal Engine, choose the source and destination color spaces to convert from and to while working with Unreal content in Nuke.

When enabled, the Filmic Tone Curve is applied to the output.

Disable this control if you want to write out linear .exr files.

Game Override

When enabled, the engine is automatically set to the Cinematic Scalability quality for renders.

Choose whether textures are disabled, loaded over time, or fully loaded up front to avoid blurring after camera cuts.

When enabled, use the highest LOD setting for meshes and particles.

When enabled, don't use hierarchical LOD and use the real meshes from Unreal Editor.

When enabled, shadow-related CVars (console variables) are replaced by high quality preset values.

Sets the shadow distance in the scene. Higher values produce better quality shadows, but at the cost of increased processing time.

Sets the threshold at which shadow casters with small screen space bounding sphere values are discarded.

When enabled, the MaxDrawDistance from Unreal is overridden.

MaxDrawDistance may have been reduced to improve in-game performance.

When override view distance scale is enabled, scale primitive's MaxDrawDistance by this value.

High Resolution

Causes the engine to use a higher detailed texture if a texture's details were lowered due to screen size.

Negative values produce sharper images, up to the resolution of the texture, but may result in noisy images. You can reduce the noise by increasing the Spatial Samples Count.

When enabled, more samples are used to improve SSS when no temporal history is available due to the tiling process.

Sets the number of samples used by SSS when override subsurface scattering is enabled.

Motion blur

When disabled, motion blur is not calculated.

Displays translation values from the Unreal Editor camera along the x, y, and z axes.

Displays rotation values from the Unreal Editor camera around the x, y, and z axes.

Displays the focal length from the Unreal Editor camera.

Displayed aperture information from the Unreal Editor camera.

Click to create a corresponding Camera node in Nuke with the same translate, rotate, and camera lens details.

The new camera does not affect the camera in Unreal Editor, but it is linked to it through an expression by default.

When enabled, clicking Create Camera adds a Camera node to the Node Graph with an expression link to the Unreal camera.

When disabled, no link is created so the Nuke camera is totally independent from Unreal Editor.

Sets the 3D system with which the Camera is compatible:

When enabled, clicking the Camera button adds a new 3D system camera to the Node Graph. New 3D system nodes are red by default.

When disabled, clicking the Camera button adds a classic 3D system camera to the Node Graph. Classic 3D system nodes are green by default.

Click to verify any variables and commands and rerender the sequence.

You can use this table to add console commands.

Click to add a console variable key/value pair.

Values are cached and restored after rendering.

Click to delete the selected console variable(s).

You can use this table to add commands to run when the shot starts.

If you want to restore the command after the shot is started, add a corresponding command in the End Console Commands table.

Click to add a start console command to execute when this shot is started.

Click to delete the selected start console command(s).

You can use this table to restore values in the Start Console Commands table after the shot is finished.

Click to add an end console command to execute when this shot is finished.