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.
All nodes connected to this node are treated as if flowing to the parent node, and inherits any transformation changes along the chain. Notably, Post FX cannot be connected, they should be connected to the incoming video node.
Parameters
These properties control the 3D transforms of the node. Transforms will generally be inherited by child nodes, although they can be ignored through the Inherit Transform Channels attributes.
Parameter Details
Transform in Pixels Switch the transform options for this node to pixels.
Position X Move along the local x-axis.
Position Y Move along the local y-axis.
Position Z Move along the local z-axis.
Rotation Bank Rotate around the local z-axis.
Scale X Scale along the local x-axis.
Scale Y Scale along the local 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.
Toggle which transform channels should be inherited from the parent node. By default, all transforms will be inherited.
Parameter Details
Position X Toggle inheritance of the X Position from the parent.
Position Y Toggle inheritance of the Y Position from the parent.
Position Z Toggle inheritance of the Z Position from the parent.
Rotation Heading Toggle inheritance of the Rotation Heading from the parent.
Rotation Pitch Toggle inheritance of the Rotation Pitch from the parent.
Rotation Bank Toggle inheritance of the Rotation Bank from the parent.
Scale X Toggle inheritance of the X Scale from the parent.
Scale Y Toggle inheritance of the Y Scale from the parent.
Scale Z Toggle inheritance of the Z Scale from the parent.
World Position Only Inherit the world position from the parent only, rotation and scale will be ignored. Overrides above properties.
Inherit Time Toggle inheritance of time from the parent.
These properties control the core behaviours of the node.
Parameter Details
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.
These properties control the transofrms of the image in UV space, before the local transform properties.
Parameter Details
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.
These properties control how a video will behave if selected in the Image property.
Parameter Details
Frame Offset Offset the start frame.
Frame Rate Control the frame rate of the video.
Loop End Frame Choose when the video stops looping.
These properties will control how to apply texture animations for sprite sheets.
Parameter Details
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.
These properties control how the image is cropped from its initial size.
Parameter Details
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
These properties control the 3D transforms of the node. Transforms will generally be inherited by child nodes, although they can be ignored through the Inherit Transform Channels attributes.
| Parameter | Details |
|---|---|
| Transform in Pixels | Switch the transform options for this node to pixels. |
| Position X | Move along the local x-axis. |
| Position Y | Move along the local y-axis. |
| Position Z | Move along the local z-axis. |
| Rotation Bank | Rotate around the local z-axis. |
| Scale X | Scale along the local x-axis. |
| Scale Y | Scale along the local 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. |
Toggle which transform channels should be inherited from the parent node. By default, all transforms will be inherited.
| Parameter | Details |
|---|---|
| Position X | Toggle inheritance of the X Position from the parent. |
| Position Y | Toggle inheritance of the Y Position from the parent. |
| Position Z | Toggle inheritance of the Z Position from the parent. |
| Rotation Heading | Toggle inheritance of the Rotation Heading from the parent. |
| Rotation Pitch | Toggle inheritance of the Rotation Pitch from the parent. |
| Rotation Bank | Toggle inheritance of the Rotation Bank from the parent. |
| Scale X | Toggle inheritance of the X Scale from the parent. |
| Scale Y | Toggle inheritance of the Y Scale from the parent. |
| Scale Z | Toggle inheritance of the Z Scale from the parent. |
| World Position Only | Inherit the world position from the parent only, rotation and scale will be ignored. Overrides above properties. |
| Inherit Time | Toggle inheritance of time from the parent. |
These properties control the core behaviours of the node.
| Parameter | Details |
|---|---|
| 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.
|
| 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. |
These properties control the transofrms of the image in UV space, before the local transform properties.
| Parameter | Details |
|---|---|
| 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. |
These properties control how a video will behave if selected in the Image property.
| Parameter | Details |
|---|---|
| Frame Offset | Offset the start frame. |
| Frame Rate | Control the frame rate of the video. |
| Loop End Frame | Choose when the video stops looping. |
These properties will control how to apply texture animations for sprite sheets.
| Parameter | Details |
|---|---|
| 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. |
These properties control how the image is cropped from its initial size.
| Parameter | Details |
|---|---|
| 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. |
| Name | Description | Typical 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 Modifiers | Apply the transforms of another node to this node. | Null |
| Target Node | Modifiy the rotations of the node to always direct the z axis towards the input. | Null |
| Local Transform Override | Apply the transforms of another node to this node, relative to its parent. | Null |