JOS JOS Compositor

Node reference

Image nodes

CheckerBoard

A checkerboard in the project format, with optional lines between squares and through the middle.

Inputs: none (it makes its own picture).

Setting Default Range or choices What it does
box size 64 1 to 512 The width and height of each square, in pixels.
colour 0 0.1 0.1 0.1 1 0 to 1 The colour of the squares on one diagonal, alternating with colour 2.
colour 1 0.5 0.5 0.5 1 0 to 1 The colour of the squares on the other diagonal, alternating with colour 3.
colour 2 0.1 0.1 0.1 1 0 to 1 The colour of the squares on one diagonal, alternating with colour 0.
colour 3 0.5 0.5 0.5 1 0 to 1 The colour of the squares on the other diagonal, alternating with colour 1.
line colour 1 0 to 1 The colour of the lines between the squares.
line width 0 0 to 20 The width of the lines between the squares, in pixels (0: no lines).
centre line colour 1 1 0 1 0 to 1 The colour of the two lines through the middle of the format.
centre line width 3 0 to 20 The width of the two lines through the middle of the format, in pixels (0: none).

ColorBars

Test colour bars in the project format: SMPTE's (NTSC) or EBU's (PAL).

Inputs: none (it makes its own picture).

Setting Default Range or choices What it does
bar intensity 0.5 0 to 1 The coloured bars' level (full white stays at 1).
PAL off EBU's eight full-height bars instead of SMPTE's.

ColorWheel

A wheel of hues: saturation and value from the centre to the edge.

Inputs: none (it makes its own picture).

Setting Default Range or choices What it does
channels rgba rgba, rgb, alpha The channels the node changes; the others pass through.
centre saturation 0 0 to 1 The saturation at the wheel's centre, blending to the edge's outwards.
edge saturation 1 0 to 1 The saturation at the wheel's rim.
centre value 1 0 to 1 The brightness (HSV value) at the wheel's centre, blending to the edge's outwards.
edge value 1 0 to 1 The brightness (HSV value) at the wheel's rim.
gamma 0.45 0.2 to 2 R, G, B raised to 1 / gamma.
rotate 0 -180 to 180 Degrees: where red sits.
fill format on Off: the wheel fills the box below.
left 0 0 to 4096 Used when fill format is off.
bottom 0 0 to 4096 Used when fill format is off.
right 100 0 to 4096 Used when fill format is off.
top 100 0 to 4096 Used when fill format is off.

Constant

A solid colour of a given size, in the working colour space.

Inputs: none (it makes its own picture).

Setting Default Range or choices What it does
colour 0 0 to 1 The colour every pixel gets, in the working colour space.
width 1920 1 to 8192 The image's width, in pixels.
height 1080 1 to 8192 The image's height, in pixels.
channels rgb rgba, rgb, alpha The channels it makes. rgb has no alpha: giving the colour an alpha above 0 switches it to rgba. Pick rgb again to leave the alpha out.

Read

Reads an image file or sequence. Use #### or %04d in the path for the frame number. Reads OpenEXR (single-part, multi-part and multilayer), PNG, JPEG, TIFF and WebP, and movies (QuickTime, MP4, MXF, MKV, AVI: ProRes, H.264, H.265, DNxHD... through FFmpeg; frames numbered from 1), and Blackmagic RAW clips (.braw, with their decode settings). Colour is converted from the file's colour space (OCIO file rules: EXR is scene-linear, 8-bit formats sRGB) to the working space.

Inputs: none (it makes its own picture).

Setting Default Range or choices What it does
file File path, optionally with a frame placeholder (####, %04d) and Nuke's Tcl commands ([value root.name]...).
first 0 0 to 1000 First frame of the sequence (file frame numbers). 0 and 0: no range.
last 0 0 to 1000 Last frame of the sequence.
before hold hold, loop, bounce, black What to show before the first frame: hold it, loop the clip, bounce back and forth, or black.
after hold hold, loop, bounce, black What to show after the last frame.
frame mode start at expression, start at, offset How frame sets which file frame shows (as Nuke's Read): expression: frame is a formula of the comp frame (e.g. frame+5; empty: the comp frame); start at: the first file frame shows at that comp frame; offset: file frame = comp frame + frame.
frame The frame mode's value: a formula of frame, a start frame or an offset (empty: none).
colour space Colour space of the file. Empty: chosen by the OCIO config's file rules.
on error error error, black A file that can't be read: stop the render (error) or give black in the project's format.
auto alpha off Adds a white (1) alpha when the file has none.
premultiply off Multiplies R, G and B by alpha, for files whose colour is stored unpremultiplied (straight).
sound none none, track 1, track 2, track 3, track 4, track 5, track 6, track 7, track 8 A movie's sound played with the timeline and drawn in it: which track.
main layer Layer used as the main RGBA picture when the file has no plain R/G/B (e.g. Blender's ViewLayer.Combined). Empty: detect automatically. "none": keep channels as they are. Other layers stay available as named channels.
use GPU if available off Decodes on the GPU (CUDA on NVIDIA cards, else OpenCL) when there is one; else, or if it fails, on the CPU (the node's warning says so). Off by default, as in Nuke.
decode resolution Full Res Full Res, 1/2 Res, 1/4 Res, 1/8 Res Decodes at full, half, a quarter or an eighth of the clip's resolution: the Read's format is that size. Proxy levels decode smaller still.
decode using Camera Metadata Camera Metadata, Clip Custom Camera Metadata: the clip's own settings (the camera's, or its .sidecar file's). Clip Custom: the settings below.
colour science 5 4, 5 Blackmagic colour science generation. Only Generation 5 has colour spaces here: Generation 4 decodes read as raw unless a colour space is set.
colour space Blackmagic Design Blackmagic Design, Rec.709, Rec.2020, DCI-P3 D65, DCI-P3 Theater, ACES AP0, ACES AP1, CIE 1931 XYZ D65, CIE 1931 XYZ D50 (PCS), V-Gamut, Canon Cinema Gamut, Alexa Wide Gamut, DaVinci Wide Gamut The gamut the clip is decoded to. With the gamma, it sets the colour space the Read reads in (Blackmagic Design + Film: BMDFilm WideGamut Gen5; + Linear: Linear BMD WideGamut Gen5; DaVinci Wide Gamut, ACES, Rec.709, Rec.2020...).
gamma Blackmagic Design Film Blackmagic Design Film, Blackmagic Design Video, Blackmagic Design Extended Video, Blackmagic Design Custom, Linear, Rec.2100 Hybrid Log Gamma, Rec.2100 ST2084 (PQ), Rec.709, ACEScct, V-Log, Canon Log2, Log C, N-Log, DaVinci Intermediate The gamma the clip is decoded to. Linear gives scene-linear values, not clamped.
saturation 1 0 to 2 Increases or decreases saturation.
contrast 1 0 to 2 Increases or decreases contrast.
midpoint 0.409 0 to 1 Moves the contrast's midpoint.
highlight rolloff 1 0 to 2 Highlight rolloff.
shadow rolloff 1 0 to 2 Shadow rolloff.
black level 0 -1 to 1 Raises or lowers the black level.
white level 1 0 to 2 Raises or lowers the white level.
use video black level off Lifted (video) blacks.
ISO 0 0 to 3200 The ISO to decode at (one the clip's analog gain allows). 0: the clip's.
exposure 0 -5 to 5 Exposure, in stops.
highlight recovery off Recovers clipped highlights from the channels that aren't clipped.
gamut compression off Compresses colours outside the gamut into it.
apply LUT off Applies the clip's 3D LUT (embedded in the clip, or in its sidecar) after decoding.
LUT source Disabled Disabled, Embedded, Sidecar Which LUT: the clip's embedded one or its sidecar's (Disabled: whichever it has).
white balance As Shot As Shot, Daylight, Cloudy, Shade, Tungsten, Fluorescent, Flash, Custom As Shot: the clip's. A preset sets the colour temperature (Daylight 5600 K, Cloudy 6500, Shade 7500, Tungsten 3200, Fluorescent 4000, Flash 5500). Custom: the two below.
white balance (K) 5600 2500 to 10000 Colour temperature, in kelvin.
tint 10 -50 to 50 Green-magenta tint.

Write

Writes its input to a file when rendered. Passes the image through for viewing. Formats: OpenEXR, PNG, JPEG, TIFF, WebP, and movies (.mov, .mp4, .mkv) (from the file extension). Colour is converted to the file's colour space (OCIO file rules unless set). The + under its settings adds outputs (an EXR sequence and a QuickTime at once...): the input is rendered once a frame for all of them.

Inputs: input.

Setting Default Range or choices What it does
file Output path, optionally with a frame placeholder (####, %04d), and Nuke's Tcl commands: [value version], [file dirname [value [topnode].file]], [format %03d ...]; ours: [shot_name] (the top Read's file name without folder, extension and frame number). The path they give shows under it.
file type , exr, jpeg, png, tiff, mov, webp The format (Nuke's file_type, its blank a space; webp is ours); blank: from the file's extension (also .mp4, .mkv). Another type changes the extension (out.exr written as out.jpg).
colour space Colour space to write. Empty: chosen by the OCIO config's file rules.
channels rgb rgba, rgb, all The channels the node changes; the others pass through.
compression Zip (1 scanline) none, Zip (1 scanline), Zip (16 scanlines), PIZ Wavelet (32 scanlines), RLE, B44, B44A, DWAA, DWAB OpenEXR compression (Nuke's): Zip and PIZ, RLE are lossless; B44, B44A (half channels), DWAA and DWAB are lossy.
datatype 16 bit half 16 bit half, 32 bit float OpenEXR sample type (Nuke's datatype; projects from before it keep 32 bit float).
compression level 45 0 to 500 DWAA and DWAB quality (Nuke's and OpenEXR's default 45): higher makes smaller, lossier files.
metadata all metadata no metadata, default metadata, default metadata and exr/, all metadata except input/, all metadata What goes in the EXR's header (Nuke's choices): no metadata; default (ours: Cryptomatte's manifests); and exr/ (the keys an EXR was read with, under their own names); all except input/; all (other keys as nuke/, as Nuke writes them). Ours defaults to all metadata (Nuke's: default metadata, which drops Cryptomatte manifests and pipeline keys).
bit depth 8 8, 16, float PNG and TIFF sample depth (TIFF can also be float). JPEG and WebP are 8-bit; EXR: datatype.
quality 95 1 to 100 JPEG, WebP, H.264 and H.265 quality, 1-100 (lossless WebP: the effort, smaller files for more time).
lossless off WebP: exact 8-bit values, larger files (ours: Nuke doesn't write WebP).
movie codec prores_422hq prores_422hq, prores_4444, prores_422, h264, h265, ffv1 Codec for .mov/.mp4/.mkv files (FFmpeg): ProRes 422 HQ (10-bit), ProRes 4444 (12-bit, alpha), ProRes 422, H.264 (8-bit), H.265 (10-bit; needs an NVIDIA, AMD or Intel graphics card), FFV1 (lossless 16-bit, alpha). Movies are written a whole frame range at a time, at the project's fps.
output transform colorspace colorspace, display colorspace: written in the colour space above; display: through a display and view, as the viewer shows it (Nuke's).
display default The display (OCIO); default, or one the config lacks: the config's default.
view sRGB The display's view; one the config lacks: the display's default.
create directories on Make the output folder if it doesn't exist (off: the render stops with a message, as Nuke's default).
frame range off Render first..last with the Render button instead of the project's range.
first 1 0 to 1000 First frame rendered (with limit to range).
last 1 0 to 1000 Last frame rendered (with limit to range).
enabled on Write this output when the Write renders (off: skipped, the other outputs still written). D leaves the whole Write out.
version 0 0 to 100 Nuke's (hidden there): [value version] in the file path is replaced by this number.
before render Python run before the render (Nuke's beforeRender); an error stops the render.
before each frame Python run before each frame; an error stops the render.
after each frame Python run after each frame is written.
after render Python run after the render (Nuke's afterRender).