This appendix lists the preferences supported by Nuke.
The Preferences dialog is divided into the following sections:
General |
Settings for auto-saving and path substitutions. |
Project Defaults |
General project settings, and settings for color management. |
Performance |
Settings for caching, hardware, and threads/processes. |
Behaviors |
Settings for start up, file handling, export options, scripting, node behaviors, and more. |
Panels |
Settings for the interface appearance, file browser, control panels, nodes, Viewers, script editors, and scopes. |
The General section includes the following controls:
Autosave |
|
force project autosave after <300> seconds |
Set the number of seconds after which to automatically save your project. Disable this by setting it to zero. |
idle comp autosave after <5> seconds |
Define how long (in seconds) Nuke waits before performing an automatic backup after you have left the system idle (that is, haven’t used the mouse or the keyboard). If you set the value to 0, automatic backups are disabled. |
force comp autosave after <30> seconds |
Define how long (in seconds) Nuke waits before performing an automatic backup regardless of whether the system is idle. If you set the value to 0, forced automatic backups are disabled. |
autosave comp filename |
Sets the file name of the autosaved project. If this is not set, it defaults to [firstof[value root.name] [getenv NUKE_TEMP_DIR]/].autosave |
Path Substitutions |
|
path substitutions |
Allows you to remap file paths in order to easily share projects across different operating systems. When the application encounters a file path, any text in the OSX/Linux column is replaced with the text in the Windows column, or vice versa. For example, if you enter /Volumes/networkmount in the OSX/Linux column and Z: in the Windows column: • On Mac OS X and Linux, any file paths that start with Z: are converted to start with /Volumes/networkmount. • On Windows, any file paths that start with /Volumes/networkmount are converted to start with Z:. To be able to enter text in either column, you need to click on the + button below to add a row to the table. |
+ |
Adds a row under path substitutions. |
- |
Deletes the selected row(s) under path substitutions. |
The Project Defaults section includes the following controls:
NOTE: You must restart the application for changes to these preferences to be applied.
OpenColorIO config |
|
OpenColorIO config file |
Sets the OpenColorIO configuration to use if you don’t intend to use the default settings. Enter the filepath of the configuration file or click Choose to use the browser. NOTE: Nuke also includes an environment variable method for setting a config file. See Environment Variables for more information. |
Default Color Transform |
|
viewer |
Sets the default LUT applied to Timeline Viewers. |
thumbnails |
Sets the default LUT applied to thumbnails when ever they are generated. |
8 bit files 16 bit files log files floating point files |
Sets the default LUT applied to the specified ingested file type. |
Export |
|
use OCIO nodes when exporting to a comp |
When enabled, OCIO nodes are added to generated .nk scripts to handle color conversion instead of native LUTs. |
Format |
|
output resolution |
Use this to select the image output resolution in the Timeline environment. For a sequence, the video tracks are cropped to this format. By default, clips in the sequence are reformatted to fit this format. You can adjust the reformatting, by selecting clips in the timeline and adjusting the settings in the Sequence tab. Changing the output format for a clip is not currently supported. |
frame rate |
Select the frame rate for the current project in the Timeline environment. |
Sequence |
|
start timecode |
Use this to define the start timecode for the current project. For track items, this overrides the timecode defined in the media. |
time display |
You can use this to select the display format for times. You can select either Timecode or Frames. |
drop frame |
Use this to choose whether timecodes from this sequence are displayed in drop frame times or not. Drop Frame is a timecode display option that leaves out two frames from the 30 fps timecode sequence every minute (except every 10th minute) so that long running NTSC sequences are accurate to a real-time clock (NTSC frame rate is 3000/1001, or approximately 0.01% slower than 30fps). NOTE: Enabling Drop Frame is a Timecode display feature only - the source media remains a continuous stream of frames. |
The Performance section includes the following controls:
Localization |
|
auto-localize from |
Enter the location of the files you need automatically localized, unless otherwise specified in the Read node’s cache locally control. Commonly this would be your remote working folder. If you leave this field blank, automatic local file caching doesn’t take place. |
localize to |
Enter the file path where all the localized files are automatically stored. Localizing files allows for faster reloading for files that are stored in a location that is slow to access (such as a network drive). You should construct the file path as follows • Replace any leading forward or back slashes with underscores. For example, replace \\windowspath\to\my\network\file.dpx with __windowspath\to\my\network\file.dpx. • Replace any Windows drive signifiers (colons) with underscores. For example, replace t:\my\network\path\file.dpx with t_\my\network\path\file.dpx. This defaults to [getenv NUKE_TEMP_DIR]/localize. |
max localized files (GB) |
This allows you to set the maximum amount of space (in GB) to use for localized files. Set to zero for unlimited size. Values lower than zero, leave that amount of space free. |
Disk Caching |
|
temp directory |
This saves all recent images displayed in the Viewer for fast playback. Using this control, you can specify where you want Nuke to save these images. Select a local disk (for example, C:/temp), preferably with the fastest access time available. It’s also important to leave enough space for the maximum disk cache size (defined below). |
comp disk cache size (GB) |
Specifies the size of Nuke's disk cache, independent of the playback cache. It is the maximum amount of disk that Nuke can allocate for caching. When the limit is reached, Nuke attempts to free disk space before using any more. The environment variable NUKE_DISK_CACHE_GB overrides this setting. |
rotopaint cache size (GB) |
Specifies the size of Nuke's RotoPaint tile cache. It stores tiles for the output image of each RotoPaint node, enabling you to paint on top of existing RotoPaint without having to re-render the strokes underneath. If you run out of RotoPaint disk cache, response times may suffer when painting onto tiles containing lots of strokes. |
Memory Caching |
|
playback cache size (% of system RAM) |
Specifies the percentage of system RAM used for the timeline Viewer playback cache. The entire amount is allocated, even if you've only got a few frames in the Viewer. Recently used frames are retained in the memory to avoid relying on the disk buffering system. The cache is freed when you switch to the compositing Viewer and reallocated when you switch back to the timeline Viewer. TIP: On low-end machines, minimizing this may improve application responsiveness at the expense of smooth playback. |
comp cache size (% of system memory) |
Specifies the percentage of system memory available for comp caching. It is independent of the playback cache and is the maximum amount of memory that Nuke can use for caching. When the limit is reached, Nuke attempts to free memory before using any more. |
comp playback cache size (% of comp cache) |
Specifies the percentage of the comp cache available for comp playback. This cache holds data displayed in Nuke's compositing Viewer, the result from the node tree you're viewing. Results from further up the tree are sometimes cached inside the comp cache as well, such as the output from a node which is needed by more than one downstream node. |
comp paint cache size (% of comp cache) |
Specifies the percentage of the comp cache available for comp paint. The comp playback cache and comp paint cache are limits for the total memory that is used, so it's possible to have a combined size greater than 100%. How the memory is shared between the two depends on what you're doing, and you won't necessarily be filling both up at the same rate. For example, if you're doing a lot of paint work, you might want to allow the paint cache to fill up more than 50% of the available memory if the playback cache isn't using its full share. |
Audio Waveforms |
|
waveform memory (MB) |
Sets the amount of memory available for storing timeline audio waveforms. |
Application in Background |
|
pause timeline Viewer when the application goes to the background |
When enabled, pause timeline Viewer caching when the application is in the background. |
clear timeline Viewer cache when the application goes to the background |
When enabled, the timeline Viewer cache is cleared when the application goes into the background. NOTE: This preference is only available when pause timeline Viewer when the application goes to the background is enabled. |
pause comp Viewer when the application goes to the background |
When enabled, pause comp Viewer caching when the application is in the background. |
clear comp Viewer cache when the application goes to the background |
When enabled, the comp Viewer cache is cleared when the application goes into the background. NOTE: This preference is only available when pause comp Viewer when the application goes to the background is enabled. |
Undo Caching |
|
undo history size |
Allows you to set the amount of RAM to use for the undo history. If this limit is exceeded, older items are discarded. |
minimum undo events |
Use this to set the amount of undo events. This setting always applies, even if it breaches the memory limit. |
Audio |
|
audio device |
The audio device control allows you to select an existing audio device for playout from a list of automatically detected devices. You can disable playout on a device by selecting Disabled. |
RED Rocket |
|
use red rocket |
You can select the use red rocket checkbox to speed up decoding RED media. If you’re using R3D Rocket graphics card, note that using it is likely to only be considerably faster when you’re reading in at full resolution. If you’re reading in at half resolution, for instance, using without the R3D Rocket card enabled may be faster. This is because the R3D Rocket graphics card is designed to be fast when reading in multiple frames at the same time. This is not how it works internally, and therefore reads with the R3D Rocket card disabled may sometimes be faster when working in lower resolutions (< 4K widths). Also, note that the R3D Rocket card always produces better results than when downsampling. Also, the R3D Rocket card can only be used by one application at a time, so if you are viewing multiple scripts at once, you may only be able to use the R3D Rocket card in one. |
GPU |
|
expand 3 to 4 channels |
You can use this to expand images cached for playback from 3 to 4 color channels per pixel. Some graphics hardware performs better at loading images to video memory with 4 channels per pixel, than it does with 3. Enabling this option improves playback performance on such hardware, at the expense of reducing the number of frames that it's possible to cache. If you are seeing poor playback performance, enabling this option may help. However, if you are seeing acceptable playback performance with this option disabled, then leaving it disabled increases the number of frames that may be cached for smooth playback. NOTE: You must restart Nuke for this option to take effect. |
Enable PBO texture uploads |
Enabling Pixel Buffer Objects (PBOs) can improve playback performance for certain combinations of hardware, software, and file formats. NOTE: You must restart Nuke for this option to take effect. |
gpu texture cache size (MB) |
Use this to set the maximum amount of GPU memory to use for caching textures. |
default blink device |
You can use this to set the default blink device to use the CPU, or choose which GPU to use for GPU accelerated plug-ins, such as, ZDefocus, Convolve, Denoise, BlinkScript, Kronos, MotionBlur, and so on. Any changes to this setting only take effect after you have restarted the application. |
enable multi_GPU support |
If you're running Nuke on a late 2013 Mac Pro 6.1 (running OS X 10.9.3 'Mavericks', or later), you can enable this preference to share work between the available GPUs for extra processing speed. This is a global preference and is applied to all GPU enabled nodes. |
Playback |
|
default number of threads per reader |
Sets the number of threads to use per reader. If your source files are located on high performance local drives, increasing the number threads can significantly improve read times. CPU intensive operations, such as .jpg decoding, can also be improved by increasing the number of threads per reader. |
override number of threads per reader |
Allows you to override the default number of decode threads used, dependent on file format. Use the plus button to add an entry to the table and then select the file format using the dropdown menu. Double click the Number of threads column to set the required number of decode threads for that format. |
OpenEXR helper threads to use |
Sets the number of helper threads to use for OpenEXR only. The default, zero, automatically sets the number of helper threads used. |
ARRI helper threads to use |
Sets the number of helper threads to use for ARRI only. The default, zero, automatically sets the number of helper threads used. |
NOTE: The OpenEXR and ARRI helper thread preferences are independent of the threads per reader and override table per format settings. |
|
frame server Nuke processes to run |
Set the number of slave Nuke processes to run for the frame server. You must restart Nuke for this setting to take effect. |
QuickTime decoders to use |
Sets the number of background processes available to handle QuickTime file I/O. You must restart the application for this preference change to take effect. NOTE: Using too many decoders can affect performance, depending on the available hardware. |
Rendering |
|
export renders |
You can select from several render options: • limit renderer (more responsive ui) – Select this option to make the user interface more responsive during transcodes. It tells Nuke to use 2 threads to transcode and to use 25% of RAM to cache. Using this option is likely to result in slower transcodes. • no renderer limits – Select this option to ensure that transcodes happen as quickly as possible. This option may result in a less responsive user interface during transcodes. • customize render limits – Select this option to manually configure Nuke's cache memory setting and the number of threads used to do transcodes. |
number of threads |
Sets the number of threads that Nuke uses when transcoding. Lower numbers allow the Timeline environment's interface to be more responsive. Higher numbers allow faster transcodes. This setting is passed to Nuke using the -m option. |
cache memory (GB) |
Use this to set the number of gigabytes of RAM that Nuke uses for its Cache settings. Lower numbers may improve the Timeline environment's interface responsiveness, while higher numbers may improve the speed of the transcodes. This setting is passed to Nuke with the -c option. |
background renders |
Sets when background renders occur: • don't auto-start background renders – Comps on the timeline are not rendered in the background automatically. • start background renders on Comp save – Comps on the timeline are rendered in the background automatically when they are saved. • start background renders on Comp create, Comp save and Comp version change – Comps on the timeline are rendered in the background automatically when first created, when saved, and when a new version is selected. |
Downsize Filtering |
|
8-bit images 10-, 12- and 16-bit integer images 16-bit float images 32-bit images |
Customizes the downsize filtering behavior by bit-depth. The default (1x) retains the original image size. You can select 2x to halve the image size, or 4x to quarter the image size. The Viewer image quality dropdown affects the decode rate and resolution of clips displayed in the Viewer. Lower resolutions decode faster and vice versa. |
The Behaviors section includes the following controls:
documentation source |
Sets the source of the Properties ? button help: • local – use Nuke's built-in HTML help server. Nuke's local help server searches the NUKE_PATH for HTML files with the same name as the requested node, such as Blur.html. It also searches .nuke and .nuke/Documentation. • foundry – This uses The Foundry's Online Help, the most up-to-date version of the documentation. • custom – Select this to point to your own help server. |
auto port |
When enabled, assign a free port automatically. |
local port |
Specify a local documentation server port manually. This is usually >= 1024. You can also set this to 0 to automatically assign the port. |
range |
Specify a range of ports to attempt with the local documentation server. |
scan for file sequence range on drop into Bin view |
When enabled, identify and import the file range of media that is dropped into the bin. When disabled, no range is detected and only a single frame is ingested. (This does not affect container formats, such .mov and .r3d.) |
||||||
automatically rescan versions when moving off end of the version list |
When enabled, incrementing a clip or track item’s version past the end of the previously discovered versions list, forces a rescan to update the versions list. See Using Versions for more information. |
||||||
frame number style |
Sets the sequence display mode to be used in the file browser. |
||||||
assume fixed width frame numbers in file sequences |
When enabled, assume frames have a fixed width number. With this selected, frame numbers need to be padded with zeros to a fixed length, otherwise frame numbers without preceding zeros are assumed to belong to sequences with no padding. This is important as the sequence identifier specifies a unique file name for each and every frame. For example:
|
||||||
default red clip video decode mode |
Sets the default red clip decode mode for new projects. You can choose from FullPremium, HalfPremium, HalfGood, QuarterGood, EighthGood, or SixteenthGood. NOTE: Changing this preference does not change the default decode setting for existing projects. |
||||||
Alembic |
|||||||
always load abc files as all-in-one |
When enabled, all .abc files are imported as a single node, without displaying the Alembic import scenegraph. |
new Merge nodes connect A input |
When enabled, inserting a new Merge node automatically connects the A input. |
autokey roto shapes |
When enabled, keyframes are added automatically to Roto shapes when they are adjusted. |
when Viewer is closed delete its nodes |
When enabled, Viewer nodes are deleted when you close the associated Viewer. |
allow trial mode in OFX plugins |
When enabled, OFX plug-ins that offer a trial mode render in that mode, if a license cannot be found. When disabled, OFX plug-ins that can't get a license appear in an error state. |
show menus with previous item under the cursor |
When enabled, opening contextual menus positions them with the most recently used item under the pointer. |
script command dialog defaults to Tcl |
When enabled, the dialog that appears when you press X in the Node Graph defaults to Tcl, rather than Python. |
startup workspace |
Sets which workspace to display on startup. You can choose from Compositing, Conforming, Editing, Finishing, Reviewing, and Timeline. You can also choose to save a customized workspace, which would also be available from this list. |
show splash screen at startup |
When enabled, display the splash screen on startup. |
show startup dialog |
When enabled, display the dialog on startup. |
restore workspace when opening projects |
When enabled, restore the selected saved workspace when opening projects. |
R3D file timecode |
Sets the source timecode for RED files. You can choose from Default From File, Absolute Timecode, or Edge Timecode. |
other media timecode |
Sets the timecode source for file-per-frame media (such as .dpx). You can choose from File Header or Frame Number. If File Header is selected and a timecode exists, then the timecode is used. Otherwise it defaults back to using the frame number from the file name. |
max valid timebase (fps) |
Sets the maximum image header timebase above which the value is clamped. Image files are often created with application specific timebase values in the header description. This can lead to reading in spuriously high frame rates and the clamp aims to prevent this from happening. If your clips do have extremely high frame rates, increase this value as necessary to avoid clamping. |
EDL style spreadsheet timecodes |
When disabled, the srcOut and dstOut values in the spreadsheet use the film convention, representing the last frame of the cut. When enabled, the srcOut and dstOut values in the spreadsheet use the video convention, representing the frame directly after the cut. |
The Panels section includes the following controls:
Font |
Change the type, weight, angle, and size of the font used on Nuke’s user interface. |
UI Colors - right-click on any color button and select Set color to default to revert changes. |
|
Background |
Change the background color of most user interface elements (menus, toolbars, panes, properties panels, Viewers, and pop-up dialogs). |
Base |
Change the color of input fields, the input pane of the Script Editor, and the left side of the Curve Editor. |
Highlight |
Change the color of the highlighting that appears when you hover the cursor over a control, select a file or folder in the File Browser, or scrub to a new frame on the timeline. |
Highlighted Text |
Change the color of any highlighted text (for example, text you select in node properties). |
Label |
Change the color of labels and text on the application interface. Note that this does not set the color of the labels on nodes in the Node Graph. |
Button |
Change the color of buttons and dropdown menus. |
Animated |
Change the color that indicates a control has been animated. |
Keyframe |
Change the color that indicates a keyframe has been set. |
Cached frames |
Change the color of the cached frames on the Viewer timeline. |
Playhead |
Change the color of the frame marker on the Viewer timeline. |
In/Out Markers |
Change the color of the in and out frame markers on the Viewer timeline. |
Curve Editor / Dope Sheet - right-click on any color button and select Set color to default to revert changes. |
|
no. of curves visible |
Sets the maximum number of curves visible in the Curve Editor. |
background |
Change the background color of the Dope Sheet tab. |
unselected key |
Change the color used for an unselected key on the Dope Sheet. |
part-selected key |
Change the color used for a part-selected key on the Dope Sheet. |
selected key |
Change the color used for a selected key on the Dope Sheet. |
timeline |
Change the color used for the timeline on the Dope Sheet. |
control text |
Change the color used for the control text on the Dope Sheet. These indicate the frame number of a key when you select one. |
control text shadow |
Change the color used for the shadow of the control text on the Dope Sheet. |
time label |
Change the color used for the time labels on the Dope Sheet. These indicate frame numbers. |
current frame |
Change the color used for the current frame on the Dope Sheet. This is a vertical line that indicates the current frame on the timeline. |
project frame range |
Change the color used for the project frame range on the Dope Sheet. These are two vertical lines indicate your frame range. |
max nodes in properties bin |
Use this to set the maximum number of panels that can be open in the Properties pane. |
reopen acts like new panel |
When this is enabled, double-clicking a node that has been open before, places the panel in the same place as a new panel. If this is disabled, the panel appears in its previous position. |
expand / collapse panels in Properties bin to match selection |
If this is enabled, the node selection in the Node Graph determines which control panels are expanded (all unselected nodes automatically have their panels collapsed). This does not apply to floating control panels. |
input button action |
Use this to define node input button action, which is located in the top-left of the node properties panel. For example, you can set this to center a selected input of a node in the Node Graph. |
max items channel menu |
Use this to set the maximum number of channels or layers that are displayed in a single sub-menu of the main channel control. |
Color Panel |
|
color picker button opens |
Sets the type of color picker displayed when you click a color picker button in the properties panel: • in-panel color picker - opens a color wheel and sliders in the properties panel. • floating color picker - opens a color wheel and sliders in a floating panel. TIP: Holding Ctrl/Cmd and clicking the color picker button opens the alternate color picker to the one specified in the Preferences. |
start file browser from most recently used directory |
When enabled, new file browsers open at the last location used. When disabled, new file browsers open at the current working directory. |
autocolor |
Deselect this checkbox to ignore individual node color settings and, instead always use the All Others color. |
Shade Nodes |
Select this checkbox to apply a slight gradient shading to nodes. |
<node name or type> |
The
|
All Others |
Use this to select the color to use as default for all |
Text |
Use this to select the color used for node label text. |
Selected |
Use this to choose the highlight color applied to any selected nodes. |
Selected Input |
Use this to choose the color used for node inputs' label text when selected. |
GL Color |
Use this to select the color to draw nodes' Viewer controls in. For example, the Ramp node's gradient control. |
autolabel |
When disabled, nodes only show the filename or node name - most of the code in autolabel.py is disregarded. For example, the Blur node does not display the affected channels when this control is disabled. |
highlight running operators |
When enabled, highlight any nodes whose output is currently being calculated. |
postage stamp mode |
When displaying a thumbnail render of the node’s output on its surface (either using the PostageStamp node or the postage stamp control on the Node tab of each node), you can select one of two modes: • Current frame - The postage stamp is always updated to match the current frame. • Static frame - The postage stamp displays a fixed frame. To specify the frame to use, open the node’s controls, go to the Node tab, and adjust static frame. NOTE: If the frame number you use is outside the frame range for the node, it is clamped to the first or last frame in the range accordingly. |
node name background |
When a node is selected and the node’s name is too long to fit inside the node, a background is drawn behind the name to improve legibility. Use this control to set the intensity of the background, from 0 (no background) to 1 (fully opaque background).
|
label font |
Sets the font for labels. You can use the B and I, to the right of the font dropdown, to bold or italisize the selected label font. |
tile size (WxH) |
Sets the size of nodes in the Node Graph using the width and height. |
snap to node |
When enabled, nodes snap into positions (while dragging them) that line up horizontally and vertically with their inputs and outputs. |
grid size (WxH) |
Sets the grid size using width and height. |
snap to grid |
When enabled, nodes snap into positions (while dragging them) that line them up with the grid. |
show grid |
When enabled, display the grid using the overlay color. |
snap threshold |
When snap to grid is enabled, use this to set the maximum number of pixels to jump by, when snapping nodes to the grid or other nodes. |
Colors |
|
Node Graph |
Sets the color of the Node Graph background. |
Overlay |
Sets the color of the selection marquee when you lasso nodes. |
Elbow |
Sets the color of the dots created when you 'elbow' a connection pipe by holding Ctrl/Cmd. |
Arrow |
|
<directional arrows> | You can select one of the directional arrows (up, down, left, or right) to change the color it is displayed in. Simply click the arrow to open the color menu and select a new color. |
expression arrows |
Sets the color of expression arrows, if enabled. Select the enable checkbox to display expression arrows. |
clone arrows |
Sets the color of clone arrows, if enabled. Select the enable checkbox to display clone arrows. |
<arrow components> |
Sets arrow and arrow head, lengths and widths. You can also use the numeric field next to each component to enter a specific value. |
allow picking of connected arrow heads |
Select this checkbox to be able to pick up and move connected arrow heads. |
allow picking of arrow elbows to create Dots |
When enabled, press Ctrl (Cmd on a Mac) on the Node Graph to display yellow “elbows” on the Node Graph arrows and then click on these to insert Dot nodes.
If you Ctrl/Cmd+Shift+click on an elbow, the new Dot node is branched off to a new arrow rather than inserted in the existing arrow. When disabled, adding Dot nodes in this manner is not possible. |
drag-to-insert only work near middle of arrows |
Select this checkbox to restrict the arrow hotspot, for inserting nodes, to the middle of the arrow. |
size of dots |
Use this slider to set the size of the Dot nodes. You can also enter a specific value in the numeric field to the left of the slider. |
black point |
Use the slider or the entry box to select the black point value. |
white point |
Use the slider or the entry box to select the white point value. |
luma/chroma encoding |
Use this to select the video standard to use when converting from RGB to luma and chroma for scope display. |
include viewer color transforms |
Select this checkbox to include applied Viewer color transforms (gain, gamma, and LUT) in scope data. If this checkbox is disabled, all Viewer transforms are ignored. NOTE: If disabled, rendering may become slow as image calculation may be needed. |
Force full frame |
Select this checkbox so that the Viewer always requests full frame data when a scope is displaying data for that Viewer. If this checkbox is disabled, the scopes only display data for the current area requested by the Viewer, rather than the whole image. |
font |
Use this to select the font to use in the Script Editor. NOTE: This control also changes the font in the BlinkScript Kernel Source field. |
indent |
You can use this control to set the indent value to use when scripting. |
save and restore script editor history |
Disable this checkbox if you prefer that the contents of the Script Editor is not saved and restored between sessions of Nuke. |
echo python comments to output window |
Select this checkbox to print any Python commands executed by Nuke itself to the Script Editor output window. NOTE: Note that not everything you do results in a command being echoed, because many of Nuke's internal functions are not executed using Python commands. |
show frame end marker |
When enabled, an extra line is drawn on the timeline to the right of the playhead, indicating the end of the current frame. |
visible range follows playhead |
When enabled, the timeline scrolls with the playhead, constantly updating the view. When disabled, the playhead is allowed to move off screen. |
Defaults |
|
new Viewers go to own window |
When enabled, new Viewers are placed in their own window instead of docking in existing windows. |
prevent auto zoom for new Viewers |
When enabled, new Viewers are not auto-zoomed to the current Viewer's zoom level. |
apply LUT to color channels only |
When this is checked, look-up tables (LUTs) are only applied to the red, green, and blue channels. When this is NOT checked, LUTs are applied to all channels. |
byte |
Use this to select the OpenGL buffer depth, and enable use of the GPU for the Viewer process and input process. • byte – Converts to 8-bit with error diffusion. • half-float – Converts to 16-bit (half) float. In this mode, the GPU can be used to apply Viewer effects like gamma and the LUT in a Viewer process. • float – Uses a full 32-bit floating point texture. This may be slow on selected cards. In this mode, the GPU can be used to apply Viewer effects like gamma and the LUT in a Viewer process. You can choose a default value for this setting in the Preferences, or by using knobDefault() in a startup script. |
use GPU for Viewer when possible |
When this is checked, the Viewer applies its effects (such as gain, gamma, and the Viewer Process node) in the GPU when possible. However, in some cases, like when monitor output is enabled or gl buffer depth is set to byte in the Viewer settings, effects must still be computed in the CPU. |
use GPU for inputs when possible |
Normally, the Viewer only attempts to run its own effects (such as gain, gamma, and the Viewer Process node) on the GPU. However, when this is checked, any nodes connected to the Viewer are also computed on the GPU when possible. Note that this cannot be done for all nodes because not all nodes have a GPU implementation. If nodes are computed on the GPU, the color values displayed in the Viewer are inaccurate. This is because they show the color from the last node computed in the CPU prior to transferring the image into the graphics card. |
disable GPU Viewer dithering |
Check this to disable dithering in the Viewer when you’re using half-float depth. Uncheck to allow dithering at all times. |
no incomplete stereo for new viewers |
When this is checked, the Viewer only displays one view of a stereo project until both views have been rendered. This is to prevent disorienting effects when watching the results. When this is not checked, the Viewer displays both stereo views, even if the render of either is incomplete. |
Settings |
|
flip stereo interlaced views |
Select this checkbox to flip the left and right stereo views when the Viewer is set to Stereo Mode > Interlaced in the right-click/context menu. |
Texture Size (512x512) |
Use this to define OpenGL texture size in the 3D Viewer. The larger the texture size, the sharper it is, but larger texture sizes need more time and memory. You can choose from 256x256, 512x512, 1024x1024, and 2048x2048. |
Texture Mode (Multiframe) |
Use this to choose how textures are handled in the Viewer. You can choose from the following options: • Multiframe – Cache each frame of a texture; this gives animated textures and fast playback after each frame is cached, but uses a lot more memory. It also enables you to have multiple frames of a texture visible at one time (for example, on particles). • Classic – Textures are not updated in the Viewer during playback; this gives the fastest playback speed. |
playback mode |
Use this to set the Viewer playback mode: • Play All Frames - the default setting, plays all frames in real-time (dependent on hardware). • Skip Frames - plays frames in real-time skipping where necessary to maintain the frame rate. • Play All Frames, Buffering - plays all frames by buffering and playing frames back as they become available. |
guides |
You can use this to choose to show overlays in the image area. You can choose from: • Title Safe – Indicates where text should be entered to be visible. • Action Safe – Indicates the area in which to place actions so that they are visible. • Format – Displays the size of the format over the Viewer. |
fullscreen display |
Use this to select which display to use for fullscreen mode. This setting takes effect the next time fullscreen mode is entered. |
see through missing media |
Select this checkbox to see through missing media in the timeline, displaying the first displayable media in the underlying tracks. |
background |
Use this to select the Viewer background. You can select black, or gray (using the slider to determine the grayscale), or checkerboard (using the slider to determine the size of the squares). |
frame increment |
Use this to set the default number of frames skipped by the Viewer skip controls, and the timeline Nudge More commands. |
filtering mode |
Use this to determine the filtering used during rendering in the Timeline environment. You can select Auto, Nearest neighbour, or Linear. Auto uses ths same automatic selection as in the Compositing environment. This does not affect exports or rendering in the Compositing environment. |
Audio |
|
default latency adjustment (ms) |
Use this to adjust the default timing offset (in milliseconds) between audio and video to apply to new Viewers. Positive values make audio play earlier relative to video; negative values make audio play later. To convert from video frames to ms, divide 1000ms by the video frame rate. For example: • at 25fps, a video frame is 1000/25 = 40ms, or • a 1.5 video frame delay = 1.5 * 40ms = 60ms. |
default volume |
Use the slider or numeric field to set the default volume. |
Colors |
|
2D |
• bg – Change the background color of the 2D Viewer. • fg – Change the color of borders and text in the 2D Viewer. |
3D |
• bg – Change the background color of the 3D Viewer. • fg – Change the color of borders and text in the 3D Viewer. • sel –Change the color of the selected vertices or faces of an object in the 3D viewer. |
general |
• Expression color – Change the default color of the control points when an expression is set. • Focus color – Change the default color of the control points when focused. |
roto |
• Points - Change the default color of the points on RotoPaint shapes and strokes. • Curves - Change the default color of the rotoshape and stroke curves in RotoPaint and Roto. • Transform - Change the default color of the RotoPaint transform jack. • Locked - Change the default color of RotoPaint points and curves when locked or otherwise unmodifiable. |
splinewarp |
• A Sourcecolor - Change the default color of SplineWarp’s A source curves. • B Sourcecolor - Change the default color of SplineWarp’s B source curves. • draw source stippled - Check to change source curves from solid to stippled. • A Destinationcolor - Change the default color of SplineWarp’s A destination curves. • B Destinationcolor - Change the default color of SplineWarp’s B destination curves. • draw destination stippled - Check to change destination curves from solid to stippled. • Correspondencecolor - Change the default color of the SplineWarp correspondence lines. • Boundarycolor - Change the default color of the SplineWarp boundary curves. • Hardboundarycolor - Change the default color of the SplineWarp hard boundary curves. |
NOTE: To set a color back to its default, right-click on the button and select Set Color to Default. |
|
Controls |
|
middle button pans |
Check this to use the middle-mouse button to pan in the Viewer, Node Graph, the Curve Editor, and the Dope Sheet. |
left-middle to zoom |
Check this to use the left and the middle-mouse button together to zoom in the Viewer, Node Graph, the Curve Editor, and the Dope Sheet. |
show transform preview |
Check this to disable the OpenGL preview when manipulating the handles of 2D nodes, such as Transform and CornerPin. |
3D control type |
Select the navigation control scheme you want to use in the 3D Viewer: Nuke, Maya, Houdini, Lightwave, or Modo. |
2D handle size |
Adjust the size of the square control handles that appear on the Viewer for some operations, such as transformations, warps, and Bezier and B-spline shapes.
By default, this value is set to 5. You can also set the pickable area size of the square control handles in the numeric field or slider to the right of the 2D handle size control. |
3D handle size |
Adjust the size of the square control handles that appear when you’re, for instance, selecting vertices on a 3D object in the 3D view. By default, this value is set to 5. You can also set the pickable area size of the square control handles in the numeric field or slider to the right of the 3D handle size control. |
icon size |
Adjust the size of the 2D transformation overlay, 3D camera, 3D object normals, and 3D axis on the Viewer. By default, this value is set to 50. |
icon scaling |
Adjust how much the scale of display affects the size of the 2D transformation overlay, 3D camera, and 3D axis. When this is set to 0, these controls are always drawn the same size, regardless of the zoom level. When the value is set to 1, the controls scale with the displayed image or 3D scene when you zoom in or out. Intermediate values mix this so that the controls do scale, but not as much as the image does. This gives an optical illusion that you are zooming in or out without making the controls unusably small or large. |
object interaction speed |
Set how fast mouse movements rotate and translate 3D axis and cameras. The lower the value, the finer the movements. The default value is 1. |
camera interaction speed |
Set how fast mouse movements tumble and roll the 3D view in the Viewer. The lower the value, the finer the movements. The default value is 1. |
|