Notch Reference Manual

Image 2D

Method

This node displays an image in 2D space on top of the rendered scene, with no respect paid to the 3D camera, viewport or objects within it. This is useful for displaying full screen images, overlays and so on.

Transform

Name Description
Transform in Pixels Switch the transform options for this node to pixels.
Position X Move its position along the x-axis in local space.
Position Y Move its position along the y-axis in local space.
Position Z Move its position along the z-axis in local space.
Rotation Bank Rotate the object about the z-axis.
Scale X Scale along the x-axis.
Scale Y Scale along the y-axis.
Left The left position of the image2D canvas.
Right The right position of the image2D canvas.
Top The top position of the image2D canvas.
Bottom The bottom position of the image2D canvas.

Inherit Transform Channels

Toggle which transform channels should be inherited. By default, all are on.

Attributes

Name Description
Image Select an image to be displayed on the image plane.
Alpha Image Use an image to control the alpha values.
UV Remap Image Use an image to remap the UVs for the image.
Colour Add a colour filter over the image.
Blend Mode Choose how the image blends with the scene. See Blend Modes for details.
Frame If the image is animated, choose which frame is displayed.
Alpha Control the alpha value of the image.
Alpha Sort Bias Biases the alpha sort in order to make it render in front or behind other transparent objects.
Aspect Based Scaling Mode Scale the image to retain its original aspect ratio.
  • Disabled, Does not function.
  • Scale X, The x scale is changed until it matches the original files aspect ratio.
  • Scale Y, The y scale is changed until it matches the original files aspect ratio.
  • Larger, Chooses the larger scale mode.
  • Smaller, Chooses the smaller scale mode.
UV Remap Filtering Remap the colour image to the Image 2D based on a UV map.
No Image Behaviour Select what colour should appear in the absence of an image input.

UV Transform

Name Description
UV Offset X Move the object UV along the x axis, local to the screen.
UV Offset Y Move the object UV along the y axis, local to the screen.
UV Scale X Scale the object UV along the x axis, local to the screen.
UV Scale Y Scale the object UV along the y axis, local to the screen.

Video

Name Description
Frame Offset Offset the start frame.
Frame Rate Control the frame rate of the video.
Loop End Frame Choose when the video stops looping.

Texture Animation

Name Description
Is Texture Animation Page Toggle whether the input image should be treated as an animation page containing multiple frames of an animation.
Num Frames X The number of animation frames in the X axis contained in the image.
Num Frames Y The number of animation frames in the Y axis contained in the image.

Crop

Name Description
Crop In Pixels Switch the crop options for this node to pixels.
Crop Left How much of the image is cropped from the left.
Crop Right How much of the image is cropped from the right.
Crop Top How much of the image is cropped from the bottom.
Crop Bottom How much of the image is cropped from the top.

Inputs

Name Description Typical Node Input
Video Node Add an image to be displayed on the Image2D node. Video Loader
Alpha Image Add an image to override the alpha channel of the Image 2D node. Fractal Noise
UV Image Remap Add an image to use as a UV remap on the Image 2D node. Video Loader
Transform Modifier Links all transform properties to the input node. Null
Target Node Always faces the x-axis towards the inputs anchor point. Null
Local Transform Override Override the transformation values of the node, relative to its parent. Null

Outputs

All nodes connected to this node are treated as if flowing to the parent node, and inherits any transformation changes along the chain.