Documentation
Filters processing.mask
The Mask node on the VFX Loom graph canvas.
Fig. 1 The Mask node in its resting, collapsed state on the VFX Loom graph canvas.

Overview

Sets or multiplies alpha, from a mask image or the input itself.

Applies sampled mask coverage. Strength blends original alpha with masked alpha; Clear RGB optionally zeros fully transparent color.

Category
Filters
Internal ID
processing.mask
Version
VFX Loom 1.0

Inputs

InputTypeRequiredDefaultMeaning
in Image Required image whose alpha is being set
mask Image Optional bright areas keep the image; unconnected uses the image itself; scalar Field inputs are read directly

Properties

PropertyTypeDefaultAnimatableRange / optionsEffect
Source Channel Enum Luminance Not declared Luminance · Alpha · Red Selects the source channel behavior; each option changes the operation described in the overview.
Mode Enum Replace Not declared Replace · Multiply · Min · Max Selects the mode behavior; each option changes the operation described in the overview.
Invert Bool false Not declared Local control documented by the production node behavior.
Strength Scalar 1 Yes Hard 0..1 Animatable control; changing it over time varies the node response.
Clear RGB Bool false Not declared Output group

Outputs

OutputTypeMeaning
out Image The production node output described by the overview.

Usage

In practice

  • Use Mask when the graph needs Sets or multiplies alpha, from a mask image or the input itself.
  • Applies sampled mask coverage. Strength blends original alpha with masked alpha; Clear RGB optionally zeros fully transparent color.
  • Place it after the image or mask it should process, and check its alpha and edge behavior before using the result in a tiled graph.

Examples

These examples show Mask in supplied VFX Loom graph setups. Each graph link opens the corresponding node reference; the explanation below the media is specific to this node's role in that setup.

Shape / Warp / Glow with a moving wave branch

Two branches meet at Mask: a Shape branch is warped, outlined, and bloomed, while Time drives Motion → Mapping → Wave Texture → Transform to create a moving secondary field.

VFX Loom graph showing Shape, Warp, Outline, Glow / Bloom, Time, Motion, Mapping, Wave Texture, Transform, and Mask connected around a white striped preview.
Fig. 2The two-branch mask setup in the graph canvas, shown at a single flipbook frame.
Fig. 3The same setup running: the Time-driven branch advances through the flipbook while the graph remains unchanged.

How Mask contributes

Mask is the convergence point. It receives the treated Shape branch and the animated wave branch so the final output can use both coverage contributions.

Gradient → Colorize → Glow / Bloom

A radial colour treatment combines a Gradient source with a Shape mask at Mask, then sends the coloured field through Glow / Bloom for the visible halo.

VFX Loom graph showing Gradient connected to Colorize and Glow / Bloom, with Shape also feeding Mask and a blue-green glowing circle preview.
Fig. 4The coloured gradient and Shape mask converge into the glowing circular result.

How Mask contributes

Mask receives the glow branch and Shape coverage. It is the final gate that combines the colour treatment with the circular silhouette.

Animated Mapping → Noise → Levels → Mask → Blur

An animated procedural field meets a transformed capsule branch at Mask: Float Value controls Transform scale, while Animated Mapping drives Noise and Levels before the final Blur.

VFX Loom graph showing Float Value, Capsule / Beam Shape, Transform, Warp, Animated Mapping, Noise, Levels, Mask, and Blur, with a soft animated-form preview.
Fig. 5The capsule and animated-noise branches meeting at Mask before the final Blur stage.
Fig. 6The same graph running as a flipbook: Animated Mapping changes the noise field while the mask and blur respond.

How Mask contributes

Mask combines the warped capsule branch with the animated noise/Levels branch, defining the final coverage for the effect.

Notes / limitations

  • No step is declared for Strength.