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, PostFX 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 controls so they are expressed as per pixel in screen space
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.
Control the inheritance of the transforms from the parent.
These properties control the core behaviours of the node.
Parameter Details Inherit Parent Transform Toggle whether this node inherits the transforms from its parent nodes.
Aspect-Based Scaling Mode Scale the image to retain its original aspect ratio
Apply Aspect Before Rotation Apply the Aspect ratio before rotations are applied, so scaled images maintain their aspect ratio.
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.
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.
Set As Background Control the render order of the image
Texture Filter Mode Control which texture filter is used.
Texture Wrap Mode U Change how the image wraps around the x axis.
Texture Wrap Mode V Change how the image wraps around the y axis.
Preview In Viewport Preview the effect blended with alpha in the viewport.
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 controls so they are expressed as per pixel in screen space |
| 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. |
Control the inheritance of the transforms from the parent.
These properties control the core behaviours of the node.
| Parameter | Details |
|---|---|
| Inherit Parent Transform | Toggle whether this node inherits the transforms from its parent nodes. |
| Aspect-Based Scaling Mode | Scale the image to retain its original aspect ratio |
| Apply Aspect Before Rotation | Apply the Aspect ratio before rotations are applied, so scaled images maintain their aspect ratio. |
| 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. |
| 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. |
| Set As Background | Control the render order of the image |
| Texture Filter Mode | Control which texture filter is used. |
| Texture Wrap Mode U | Change how the image wraps around the x axis. |
| Texture Wrap Mode V | Change how the image wraps around the y axis. |
| Preview In Viewport | Preview the effect blended with alpha in the viewport. |
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. | 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. | 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 |