Auragen docs
Auragen docs

Getting Started

OverviewInterfaceNode GraphParameters and Controls

Operators

Texture

Loading

Load ImageLoad VideoLoad SVG

Combining

BlendCompositePattern MixShape MaskShadow / GlowSwitch

Transforming

TransformTileFlipMirrorCropResolution

Colour

Color Correction SuiteLevelHSV AdjustInvertRecolorThresholdQuantizeLookupChannel ShuffleRamp

Surface

DisplaceNoise DisplaceNormal MapBump MapBlurFeedback

Vector

VectorizerFill Trace

Organising

Null
3D Preview
Texture

Shape Mask

Uses a shape, or a picture you supply, to choose between two pictures.

The Shape Mask node reveals one picture inside a shape and the other outside it. The shape can be one of the built-in ones, or the brightness of a third picture you wire in.

Shape Mask output

  • Two pictures in, plus an optional mask picture; one out
  • Built-in shapes, positionable and rotatable
  • A wired Mask Image takes over from the built-in shape
  • Found under Texture in the add-operator list
Example patch — drag onto the app to load

The image on the right is the example patch itself — drag and drop it onto the app (or load it with File → Load) to open the full graph.

Inputs and outputs

Shape Mask node

PortTypePurpose
InputTextureShown inside the shape
Input 2TextureShown outside the shape
Mask ImageTextureReplaces the built-in shape with this picture's brightness
OutputTextureThe result

Parameters

Shape Mask parameters

Opacity, Blend Mode, ALPHA — the standard operator header, on every operator. See Parameters and Controls.

  • Shape (default Circle) — the built-in shape used as the stencil.
  • Radius (0.01–1.5, default 0.5) — how big it is.
  • Edge Smooth (0–0.5, default 0.01) — how soft the edge is. Raise it for a gentle vignette rather than a hard cut-out.
  • Rotation (0–360, default 0) — turns the shape.
  • Position X and Position Y (−1 to 1, default 0) — move it off centre.
  • Invert (default off) — swaps inside for outside.
  • Pulse Speed (0–10, default 0) — makes the shape breathe in and out on its own.

Troubleshooting

The shape controls stopped working — a picture is wired into Mask Image, which takes priority. Unwire it to go back to the built-in shape.

The edge is hard and jagged — raise Edge Smooth.

Related

Pattern Mix

A repeating pattern as the stencil.

Composite

Combine with an operation and a mask.

Threshold

Build a mask from brightness.

Pattern Mix

Uses a built-in geometric pattern to choose between two pictures.

Shadow / Glow

Makes a soft, coloured copy of one picture and lays it behind the other, as a drop shadow or a glow.

On this page

Inputs and outputsParametersTroubleshootingRelated