Notch Reference Manual
0.9.23
0.9.23
0.9.22
0.9.21
Table of Contents
Notch Reference Manual
0.9.23
Notch Reference Manual — 0.9.23
Notch Reference Manual — 0.9.22
Notch Reference Manual — 0.9.21
Introduction
User Interface
Resources Panel
Properties Panel
Viewport
Nodegraph
Timeline
Curve Editor
Other Windows
Performance Panel
Render Queue
Exporting Video
Render Still
Bins
Preferences
Keyboard Shortcuts
Nodes
Cameras
Camera
Camera Focus Target
Cylindrical Camera
Exposable Camera
Fisheye Camera
Hardware Tracking Camera
Multi Camera
Orbit Camera
Proxy Camera
Region Camera
Stereo Camera
UV Camera
VR 360 Camera
VR Headset Camera
Cloning
Clone Cache
Clone To Image
Clone To Mesh
Clone To Particles
Clone To Point Cache
Clone To Procedurals
Clone To Spline
Clone To Transform Array
Clone To Volume
Cloner
Random Cloner
Effectors
Colour Ramp Effector
FFT Effector
Image Effector
Kill Box Effector
Plain Effector
Quantise Effector
Randomise Effector
Rigid Body Effector
Ripple Effector
Sine Effector
Spring Effector
Target Effector
Turbulence Effector
Deformers
3D Plasma Deformer
Chunk Effector Deformer
Colour Map Deformer
Colour Ramp Deformer
Cull Deformer
Curl Noise Deformer
Displacement Deformer
Displacement Map
Distortion Deformer
Extrude Faces Deformer
Face Tracking Deformer
FFT Deformer
Generate Fertilizer Times Deformer
Generate UVs
Generate Weightmap Deformer
MDD Deformer
Mirror Deformer
Morph Controller
Ocean Wave Deformer
Particle Bone Deformer
Particle Mesh Deformer
Plain Deformer
Point Deformer
Quantise Deformer
Ripple Deformer
Separate Faces Deformer
Sine Deformer
Slice Deformer
Smoothing Deformer
Spline Deformer
Taper Deformer
Turbulence Deformer
Twist Deformer
Fields
Field Cache
Field Level Set Root
Field Root
Affectors
3D Object Collision Affector
Curl Noise Affector
Derivative Feedback
Field Affector
Field Feedback
Fluid Affector
Image Affector
Points Affector
Primitive Affector
Primitive Collision Affector
Turbulence Affector
Velocity Affector
Vortex Affector
Deformers
Fbm Deformer
Sine Deformer
Emitters
3D Object Emitter
Field – Field Emitter
Image Emitter
Particle Emitter
Primitive Emitter
Procedural Emitter
Reaction Diffusion
Rendering
Field Lighting
Field Renderer
Field Shadows
Render To Object Surface
Generators
Cells
Curve Mask
FFT Texture
Flat Colour
Fractal Noise
Freehand Mask
Gradient
Grid
Hilbert Curve
Jigsaw
MIDI Keyboard Texture
Noise
Plasma
Polygon
QR Code
Star
Tile Sheet
Tiles
Truchet
Voronoi
Geometry
3D Object
Auto Bounding Box
Bone
Bounding Box
Combine Geometry
Convex Hull
Decal
Exposable Null
Extruded Spline
Face Tracking Geometry
Freeze Geometry
Geometry Exporter
Geometry Network Receiver
Geometry Network Sender
Image Plane
Imported 3D Scene
Depth Camera / Kinect Mesh
Kinect1 Skeleton
Kinect2 Skeleton
Kinect4 Skeleton
Line Renderer
Lines
Mocap Stream
Node Trail
Null
NVIDIA AR Body Tracker Skeleton
Optitrack Mocap Skeleton
Perception Neuron Mocap Skeleton
Shape 3D
Skybox
Spline
Text
Tweening Null
XSens Mocap Skeleton
Interactive
Artnet Recording Playback
Blacktrax Tracked Body
Clock Time Modifier
Hot Zone
Keyboard Modifier
Mouse Picker
RSS Feed Node
RSS Text Selector
VR Controller
VR Look-At Trigger
Array Operators
Array Average
Array Copy
Array Element Extractor
Array Sources
Blacktrax Array
CSV/Table Array
Exposable Array
Hokuyo UST Lidar Array
Mouse Point Array
Transform Array
TUIO Array
Windows Touch Array
Lighting
Ambient Light
Area Light
Area Lights From Polygons
Bake Lighting To Object
Directional Light
Environment Image
Environment Map
Fog Scattering
Light
Planar Environment Map
Planar Reflection
Point Cache
Point Lights From Vertices
Probe Grid
Probe Lighting
Project Image
Screen Space Ambient Occlusion
Screen Space Reflections
Shadow Volume
Sky Light
Volumetric Lighting
Voxel Cone Lighting
Logic
Execute Child Nodes
Jump to Time
Loop Time
Select Child Node
Select Input Node
State Machine
State Machine Event
State Machine State
Materials
Alpha Blend (Transparent) Material
Diffuse Material
Emissive Material
Glass RT Material
Material
Metallic Material
Multi Material
Semi-Transparent RT Material
Shadow Catcher Material
Substance Material
Using Substance Painter exports
Using Substance Designer Materials with Procedurals
Import and Using a Substance Designer materials
Modifiers
Accumulator
Beat Pulse Modifier
Combiner
Condition Modifier
Continuous Modifier
CSV/Table Read Modifier
Delay Value
Direction-Weighted Motion Modifier
Envelope Modifier
Expression
Extractor
FPS Counter Value
Gradient Remap Modifier
Input Selector Modifier
Limiter Modifier
Math Modifier
MIDI Modifier
MIDI Note As Value Modifier
OSC Modifier
Proximity Modifier
Quantise Modifier
Range Remap
Smooth Envelope Modifier
Sound Modifier
Speed Tracking Modifier
Text As Value
Triggerable Envelope Modifier
Video Sampler Modifier
Nodes
Colour
Colour Image Ramp
Colour Ramp
Comment
Debug Log
Image 2D
Image 2D Equirectangular
Layer Precomp
Mapping
Motion Direction Follower
Motion Predictor
OSC Output
Parent To Vertex
Region
Render Layer
Render To Surfaces
Render To Texture
Root
Screen Projection
Select Render Layer For Child Nodes
Spline Follower
Time Stretch
Triangle Octree Node
Particles
Particle Bounding Box
Particle Cache
Particle Event
Particle Root
Affectors
Cloth Affector
Collision Affector
Curl Noise Fluid Affector
Depth Image Collision Affector
Explode Affector
Field Affector
Flocking Affector
Fluid FLIP Affector
Force Affector
Image Affector
Kill Box Affector
Mesh Attractor
Object Distance Field Affector
Points Affector
Primitive Affector
Primitive Collision Affector
Procedural Affector
Rigid Body Collision Affector
Shockwave Affector
SPH Affector
Spline Attractor
Spring Affector
Turbulence Affector
Velocity Affector
Vortex Affector
Scale Affector
Emitters
Field Emitter
Image Emitter
Mesh Emitter
Point Cache Emitter
Primitive Emitter
Procedural Emitter
SDF Emitter
Screen Emitter
Spline Emitter
Trail Emitter
Video Feature Emitter
Rendering
Dot Matrix Renderer
Geometry Connection Renderer
Gradient 2D Renderer
Line Connection Renderer
Line Renderer
Mesh Renderer
Point Renderer
Render Particles To Surfaces
Trail Renderer
Volume Renderer
Shading
Attribute Shading
Density Shading
Displace To Shape
Distance Shading
Image Displacement
Image Shading
Keyed Colour
Life Colour Shading
Lighting
Noise Shading
Volume Shadow Shading
Voxel Cone Shading
Physics
Physics / Rigid Body Root
Rigid Body
Rigid Body Collision Mesh
Rigid Body Depth Image
Rigid Body Force Affector
Rigid Body Procedural
Post-FX
Antialiasing
FXAA Antialiasing
Temporal Antialiasing
Blur
Blur
Depth Of Field
Directional Blur
Edge-Aware Blur
Feedback Blur
FFT Blur / Glow
Frame Feedback
Glow
Glow 2
Motion Blur
Radial Blur
Tilt Shift
VHS Blur
Colour Processing
Apply Colour LUT
Colour Channel Mixer
Colour Correction
Colour Grading
Colour Limiter
Combine Colour Grades
Invert
Local Contrast
Recolour
Strobe
Tint
Tone Map
Distortion
Distortion
Dither
Line Distortion
Noise
RGB Distortion
Generators
Composite Image
Gradient 2D
Gradient 3D
Gradient Patch
Grid
Light Scattering Beam
Voronoi 2D
Image Compression
Compress UV Animation
Decompress UV Animation
Image Processing
Auto Key Colour Mask
Bit Crush
Capture Image File
Channel Boolean
Chroma Key
Crop
Custom Shader Post Effect
Dilate
Edge Detect
Erode
Frame Buffer
Frame Delay
Frame Difference
Frame Loop
Generate Normal Map
Histogram Normalise
Key Colour Mask
Median Filter
NDI Output
NVIDIA Virtual Background
Output GBuffer
Range Remap
Replace Colour
Threshold
Video Exporter
Stylisation
3D Object Outline
Cross Hatch
Digital Block Glitch
Digital Chroma Glitch
Dot Matrix
Film Grading
Halftone
Motion Datamosh
Pixel Sorting Glitches
Pixellate
Sharpen
Slit Scan
Streaks
VHS Scanlines
Vector Blur
Voronoi Post Process
Warping
Barrel Distortion
Bezier Warp
Bump Map Warp
Curl Noise Warp
Droste Warp
Field Position-Based Warp
Field Warp
Four Point Warp
Mirror
Moebius Warp
Randomise Tiles
Ripple
Screen Warp
Sine Warp
Stretch
Transform Image
Turbulence Warp
Twirl Image Warp
Water Ripples
Procedural
Procedural Root
Cloning
Clone
Mirror
Repeat
Displacement
FBM Displacement
Fluid Affector
Melt
Onion
Pyroclastic Displacement
Generators
3D Primitive
3D Object
Cellular Noise
Editable Code
Fractal Noise
Image
Level Set (Field)
Null
Particles
Particles As Primitives
Reaction-Diffusion
Voronoi
Render Nodes
Heightmap Generator
Procedural Meshing
Procedural Shading Node
Volume Generator
Volumetric Tracer
Texturing
Meshing Texture Map
CSG Operation
Ray Tracing
RT Diffuse Bounces
Pathtracer
RT Multi-Bounce Reflection
RT Ambient Occlusion
RT Real-Time Denoiser
RT Mirror Reflection
RT Refinement
RT Glass Refraction
Scripting
Javascript Node
Shading Nodes
Fractal Noise Shading Node
Gradient Shading Node
Grid Shading Node
Noise Shading Node
Procedural Shading Node
Texture Shading Node
Sound
Capture Sound
Play Sound
Text Strings
Blend Text Strings
Change Text String Case
Clock Time As Text
Combine Text Strings
CSV/Table Entry As Text
Date As Text
OSC Text String
Replace Text String
Reshape Arabic Text String
Reverse Text String
Scramble Text String
Split Text Strings
Text String
Time Counter As Text
Timecode As Text
Value As Text
Video Processing
Video Null
Depth Processing
Luminance From Depth
Feature Tracking
Face Tracker
NVIDIA AR Body Tracker
Image Processing
AI Upscale
Composite Sources
Downsample
Frame Buffer
Frame Delay Frame
Generate Normal Map
Raycast Lighting
Resize
Upsample
Input Output
Colour and Depth Source
Depth Camera / Kinect Source
GBuffer To Image
Image File Loader
Image Tile File Loader
Multiplex Sources
Rendered Video Source
Video Clip
Video In Source
Video Loader
Video NDI Source
Motion Processing
Optical Flow
Temporal Filter
Video Motion Blur
Blend Modes
Node Hierarchies
Techniques
HLSL Shaders
Fake Glass Material
Raytracing Techniques
Raytracing Basics
Raytracing Lighting
Raytracing Nodes
Reflections and Refractions
Pathtracer Basics
Refining and Denoising
Raytracing Materials
Cloners and Particles
Antialiasing Methods
Virtual Production
Location & Specs
Pre-visualisation
Optimisation tools for Virtual Production
Live Network Editing
Front-plate and Back-plate
Integration & Control
The Obvious
VP Shipped Resources
Real-Time Reflections: A Practical Guide
Javascript
Anatomy of a Notch JS Script
Adding a JS script to your scene
Manipulating the scene with JS
API Reference
Inbuilt Functions
FileOrDirectoryExists()
GetDirectoryFileList()
GetFileModifiedDate()
GetGPUName()
GetViewportSize()
JumpGlobalTime()
Log()
SetPausePlayback()
Timer()
CancelTimer()
Document Object
FindLayer()
FindResourceByName()
GetExposedPropertyValue()
GetLayer()
GetNumLayers()
SetExposedPropertyValue()
Layer Object
FindNode()
GetEndTime()
GetName()
GetNode()
GetNodes()
GetNumNodes()
GetStartTime()
GetVisible()
SetVisible()
Node Object
AddChild()
AsRSSFeedNode()
GetChild()
GetEndTime()
GetEnvelopeValue()
GetFloat()
GetInt()
GetName()
GetNodeGraphPosition()
GetNumChildren()
GetStartTime()
GetString()
GetTransformArrayColour()
GetTransformArrayPRS()
GetTransformArrayUVScaleOffset()
GetVisible()
RemoveChild()
RSSTextSelectorChangeText()
SetEnvelopeValue()
SetFloat()
SetInt()
SetName()
SetPropertyArtnetLocation()
SetPropertyArtnetDisabled()
SetPropertyArtnet16Bit()
SetString()
SetTransformArrayColour()
SetTransformArrayPRS()
SetTransformArrayUVScaleOffset()
SetVisible()
RSSFeedNode
GetEntryImageFilename()
GetEntryTitle()
GetNumEntries()
UpdateContext Object
GlobalTime
Layer
LocalTime
Node
TimeDelta
HTTP Functions
HTTPGet
HTTPGetFile
NFetch
Resource Object
ReloadResource()
GetCSVFileContents()
GetCSVFileContents2D()
GetCSVEntry()
Devices & Protocols
ArtNet
Audio Devices
Intel Realsense 2.0 Camera Setup
Kinect Setup
NDI
OSC
Streaming via RTMP/RTMPS/RTP
Streaming via Virtual WebCam (NotchCam)
Video Capture
Web / HTTP API
Standalone
Standalone – Multi-head Output
Key and Fill
Notch Blocks
Managing Performance in Media Servers
Using Notch in 7thSense Delta
Using Notch in Ai
Using Notch in disguise (formerly d3)
Using Notch in Hippotizer
Using Notch in Screenberry
Exposing Attributes
Proxy Block
SDK Dependencies when using Media Servers
Using FXPlayerHost to test Blocks
Codemeter Licensing
Academic License Server
Get a License Diagnostic file
VR
Using Headset VR
Creating VR / 360 Videos
Web GUI
FAQ
Apple macOS Support
Issues when installing or starting Notch
Log file location
Optimising 3D scenes
How do game engine XYZ compare to Notch?
Extending GPU Timeout Detection
Multi-GPU
Supported Video Codecs
Using VR Controllers For Virtual Production
Remote Network Editing
Release Notes
Notch 0.9.23 Release Notes
NotchLC
NotchLC Plugin for Adobe CC
NotchLC for AVI & Legacy Quicktime
Application Privacy
Download as PDF
FAQ
Apple macOS/OSX Support
Extending
GPU
Timeout Detection
Issues starting Notch
Log files
Multi-
GPU
Optimising 3D Scenes for Notch
Project Upgrade Guide
Supported Video Codecs
Web GUI
Apple macOS Support