FrameHold
FrameHold: shows one frame of the input at every frame (increment 0), or every Nth frame from the first frame.
FrameHold: shows one frame of the input at every frame (increment 0), or every Nth frame from the first frame. A new node takes the frame on the timeline; Set to Current Frame takes it again. The first frame can be animated or an expression. Only the held frame is read, and its result is cached. rounding mode: whole frames rounds the time down; fractional time uses the nearest frame.
| Node | FrameHold |
|---|---|
| Type id | OC_N_framehold |
| Menu | Time › FrameHold |
| Nuke class | FrameHold |
| Code | opencomp_core/nodes/utility/framehold.py |
Inputs and outputs
| Port | Name | Type |
|---|---|---|
| input 0 | Image | image |
| output 0 | Image | image |
Knobs
Panel tab FrameHold, in panel order.
| Knob | Label | Type | Default | Range / values | Nuke knob | Description |
|---|---|---|---|---|---|---|
rounding_mode | Mode | menu | Whole frames | Whole frames, Fractional time | rounding_mode | |
first_frame | first frame | float | 1 | 0 to 2000 | firstFrame | Frame to hold (increment 0) or the first of every Nth |
set_to_current | Set to Current Frame | button (panel only) | ||||
increment | increment | float | 0 | 0 to 100 (integer) | increment | 0 = hold one frame; N = every Nth frame |
Other knobs (Python, .nk and the assistant; not on the panel)
| Knob | Label | Type | Default | Range / values | Nuke knob | Description |
|---|---|---|---|---|---|---|
gl_color | Viewer Controls Color | float ×3 | 0, 0, 0 | 0 to 1 | ||
postage_stamp_frame | Static Frame | int | 1 | -2147483648 to 2147483647 | ||
lifetimeStart | Lifetime Start | int | 0 | -2147483648 to 2147483647 | ||
lifetimeEnd | Lifetime End | int | 100 | -2147483648 to 2147483647 | ||
useLifetime | Use Lifetime | boolean | false | |||
cached | Cached | boolean | false | |||
bookmark | Bookmark | boolean | false | |||
dope_sheet | Dope Sheet | boolean | false | |||
clone_group | Clone Group | string | ||||
link_source | Link Source | string | ||||
link_overrides | Link Overrides | string | ||||
split_views | Split Views | string |
Nuke equivalent
Imports from and exports to Nuke's FrameHold.
Knobs with a different name here:
| Nuke knob | Knob here |
|---|---|
firstFrame | first_frame |
Nuke knobs not in this list import as a knob of the same name, or are kept unchanged for export. See .nk import.
Examples
Open these from Help › Examples…, or from the ? menu in this node's Properties panel.
- FrameHold (
examples/time/framehold.oink): FrameHold freezes its input on one frame (here frame 3 of the Beachball sequence) whatever the current frame is — the usual way to make a clean plate or a reference frame.