Method #
Generates a combined sheet of images (sometimes known as a sprite sheet) from multiple inputs.
The following example shows how to do this using Polygon generators, but any image node can be used as input. The number of connected input nodes is not limited.
This can be used, for example, to set up a single particle system where each particle uses a randomly-selected image from a set. Note that the number of tiles in X and Y needs to be matched on the Point Renderer manually.
Particles Example #
This node can be connected to any node which accepts an image input.
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.
Control the inheritance of the transforms from the parent.
These properties control the core behaviours of the node.
Parameter Details
Active Enables or disables the effect. Disabling the effect means it will no longer compute, so disabling a node when not in use can improve performance.
Preview In Viewport Preview the effect blended with alpha in the viewport.
Width The resolution of the effect along its width.
Height The resolution of the effect along its height.
Update Time Mode How the generator updates with relation to the timecode.
- Locked To Timecode : The generator animations are locked to the timecode and the same time will always yield the same result.
- Running / Loopable : The generator animations are disconnected from the timecode and will loop seamlessly at the end of the layer.
Num Tiles Mode The method used to determine the arrangement of tiles.
- Auto : Automatically determine the number of tiles in X and Y from the total number of input images
- Use Num Tiles X Y : Uses the specified number of tiles in X and Y.
Num Tiles X The number of tiles in X. This is ignored in auto mode.
Num Tiles Y The number of tiles in Y. This is ignored in auto mode.
Tile Write Offset An index offset for the tiles.
Clear Mode The sheet clearing behaviour. Clearing less often can improve performance.
- Every Frame : Re-evaluates the input images on every frame.
- On Reset : Evaluate the input images on timeline reset.
- Never : Doesn’t update the image, except by manual timeline resets in Builder.
Border (Pixels) The size of the border to add around each tile. This helps to avoid issues with filtering and interpolation at tile edges.
Tile Sorting Control how the tile sheet should be sorted while being generated.
- None : Unsorted.
- Luminance : Sort the tiles by luminance.
These properties control how the generators are coloured and blended with other images.
Parameter Details
Colour Change the colour of the generated image.
Blend Amount The amount the generator is blended with the output.
Blend Mode Choose how the image blends with the scene. See Blend Modes for details.
- Solid : The generator is solid, with a filled alpha channel.
- Blend : The generator RGBA values have matching alpha channels.
- Pre-Mul Blend : The RGB values are solid white, and the generator colours are stored in the alpha channel alpha. Usually gives the best results for colour blending.
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.
Control the inheritance of the transforms from the parent.
These properties control the core behaviours of the node.
Parameter | Details |
---|---|
Active | Enables or disables the effect. Disabling the effect means it will no longer compute, so disabling a node when not in use can improve performance. |
Preview In Viewport | Preview the effect blended with alpha in the viewport. |
Width | The resolution of the effect along its width. |
Height | The resolution of the effect along its height. |
Update Time Mode | How the generator updates with relation to the timecode.
|
Num Tiles Mode | The method used to determine the arrangement of tiles.
|
Num Tiles X | The number of tiles in X. This is ignored in auto mode. |
Num Tiles Y | The number of tiles in Y. This is ignored in auto mode. |
Tile Write Offset | An index offset for the tiles. |
Clear Mode | The sheet clearing behaviour. Clearing less often can improve performance.
|
Border (Pixels) | The size of the border to add around each tile. This helps to avoid issues with filtering and interpolation at tile edges. |
Tile Sorting | Control how the tile sheet should be sorted while being generated.
|
These properties control how the generators are coloured and blended with other images.
Parameter | Details |
---|---|
Colour | Change the colour of the generated image. |
Blend Amount | The amount the generator is blended with the output. |
Blend Mode | Choose how the image blends with the scene. See Blend Modes for details.
|
Name | Description | Typical Input |
---|---|---|
Tile Images | The individual images to combine in to one sheet. | Loader |
Colour Ramp | Specify a range of colours the generator can use through its gradient. | Colour Ramp |