DocumentationSubstance 3DSubstance 3D Designer

Shape splatter v2 to mask

Last update: Tue Apr 14 2026 00:00:00 GMT+0000 (Coordinated Universal Time)

Shape splatter v2 to mask icon

In: Generator > Pattern

Description

Computes a mask out of a selection of shapes generated by the Shape splatter v2 node .

Available options include random selection as well as selecting ranges of shapes by unique identifier and/or material ID/pattern ID*.

Shapes are pre-masked by the Shape splatter v2 node from their height blend with the background height.
Both the background and the unselected shapes are pure black. (I.e a value of 0)

*: One of the values retrieved from the Shape splatter UVW input is either the material ID or pattern ID, depending on the Shape type used in the Shape splatter v2 node:
- SDF/primitive: Material ID
- Pattern input/Grid atlas: Pattern ID, I.e. the index of the pattern in the list/atlas.

TIP
This node requires input data generated by the Shape splatter v2 node.
Other nodes in the Shape splatter v2 family:

Inputs

Splatter UVW Color
R - U component of the shapes’ UVs.
G - V component of the shapes’ UVs.
B - The shapes’ height. (W)
A - Packed data:
      - Integer part: The shapes’ unique identifier. (ID)
      - Fractional part: Depends on the Shape type: Material ID if SDF/primitive, pattern ID* if pattern input/grid atlas.

*: The pattern ID is the index of the shape in the list/atlas.

Outputs

Output
The computed mask of the selected shapes.

Parameters

Output Integer
The values used for the selected shapes in the output mask.

- Binary mask: Selected shapes all use a value of 1.
- Shape ID (integer): Selected shapes use their unique identifier. (ID)
- Material ID (integer): Selected shapes use their material ID.
- Shape ID (normalized): Selected shapes use their unique identifier (ID) mapped to the [0, 1] range from the lowest selected ID to the highest.
- Material ID (normalized): Selected shapes use their material ID mapped to the [0, 1] range from the lowest selected material ID to the highest.
Shape ID start range Integer
The shape unique identifier (ID) used as the start of the selection range. (Included)
Shape ID end range Integer
The shape unique identifier (ID) used as the end of the selection range. (Included)
Shape ID offset Integer
Offsets the shapes’ unique identifiers by the specified value, in the context of the selection range.

This makes it easy to offset the current selection by the specified value without having to adjust the start and end bounds manually.
Material / pattern id mask combination Integer
Specified the logical operator used to combine the selection by unique identifier (ID) with the selection by material ID/pattern ID.

- None: Ignore the material ID/pattern ID entirely for the selection.
- AND: Selected shapes have to be included in both the ID and material ID/pattern ID ranges. (Includes less shapes)
- OR: Selected shapes have to be included in either the ID or material ID/pattern ID ranges. (Includes more shapes)
Material / pattern ID start range Integer
The material ID or pattern ID* used as the start of the selection range. (Included)

*: See node description for details.
Material / pattern ID end range Integer
The material ID or pattern ID* used as the end of the selection range. (Included)

*: See node description for details.
Shape random mask Float
A factor for the random masking of shapes, where 1 means all shapes are masked.
recommendation-more-help
dd48abc6-e399-43d2-9777-578ec70c5a23