Wind
Canvas-locked wind distortion with turbulence, gusts, streaks, synchronized direction, and manual painting.
Environmental filters change the Scene surface or atmosphere. They can cover the full Scene, be limited to Regions, and be moved within the effect stack.
| Reference | Value |
|---|---|
| Package | FXMaster+ |
| Effect kind | Filter effect |
| Category | Environmental |
| Runtime type | wind |
| Exposed parameters | 28 |
Procedural and painted Wind
Section titled “Procedural and painted Wind”Wind can run across the complete Scene or Region, or it can be limited to a painted mask.
Procedural Wind
Section titled “Procedural Wind”Start with Direction, Speed, and Density. Then use Scale and Opacity to set the overall coverage. Distortion, Turbulence, Sway Strength, Sway Frequency, Gustiness, Streakiness, and Highlight shape the movement and visible detail.
Direction Randomization adds variation around the base direction. Direction Change Radius sets the allowed range, and Time Between Direction Changes controls how often a new target is selected.
Manual Painting
Section titled “Manual Painting”Enable Manual Painting to create a movement mask. Brush Radius (Grid Spaces) controls the painted area, while the Painting actions add to, erase, or clear the mask. This can work well for wind passing through a doorway, moving around a large obstruction, following a canyon, or remaining on one side of a Region.
See Wind Painting for the complete painting workflow.
Synchronized direction
Section titled “Synchronized direction”Wind can act as the direction source for compatible effects. Enable Synchronized Direction on a supported particle or filter to follow Wind’s direction changes while retaining its own speed, scale, density, and appearance.
Important controls
Section titled “Important controls”- Manual Painting: Restrict movement to painted areas while leaving the subtle visible wind sheen across the full Scene or Region.
- Direction: Sets the base direction of the wind movement.
- Direction Randomization: Randomly shifts the effect direction over time. At 1, the direction can randomize anywhere around the full compass.
- Turbulence: Irregular movement inside painted Manual Painting areas. Higher values create rougher local motion.
- Gustiness: Adds larger shared pulses in wind speed so the effect accelerates and eases instead of remaining constant.
- Streakiness: Controls how strongly the wind appears as long directional streaks.
- Highlight: Controls the brightness of the subtle moving highlight used to make the wind visible.
Setup notes
Section titled “Setup notes”- Manual Painting opens the Wind painting tools. Brush Radius (Grid Spaces) controls the paint area, and the Painting actions add, erase, or clear the mask.
- Direction Randomization and Time Between Direction Changes create evolving wind, while Sway, Turbulence, Gustiness, Streakiness, and Highlight shape its appearance.
- Wind can drive Synchronized Direction on compatible particle and filter effects.
Bundled preset usage
Section titled “Bundled preset usage”| Preset | API name | Availability | Variants |
|---|---|---|---|
| Arcane Winds | arcane-winds |
FXMaster+ | Normal |
| Gravewind | gravewind |
FXMaster+ | Normal |
| Windy | windy |
FXMaster+ | Normal |
Parameters
Section titled “Parameters”The table combines the settings available for this effect in Scene and Region contexts. Scene-only and Region-only badges identify controls limited to one context. Hover or focus an info button to see what the parameter changes on the canvas. Select it to keep the card open. Each card also includes the default, range or choices, context, availability, API key, and control type.
wind API typeHover or focus an info button to see what the parameter changes on the canvas. Select it to keep the card open. Context badges identify Scene-only and Region-only controls; unbadged parameters are available in both. Hover or focus an availability condition to highlight the parameter that controls it.
| Parameter | Control | Default | Range or choices | Availability |
|---|---|---|---|---|
Below Tokens belowTokens | checkbox | Off | — | Always |
Below Tiles belowTiles | checkbox | Off | — | Always |
Below Foreground belowForeground | checkbox | Off | — | Always |
Levels levelsScene only | scene-levels | All Levels | — | Always |
Manual Painting manualPlacement | checkbox | Off | — | Always |
Distortion distortion | range | 0.35 | 0–1 · step 0.05 | |
Turbulence turbulence | range | 0.2 | 0–1 · step 0.05 | |
Sway Strength swayStrength | range | 0.25 | 0–1 · step 0.05 | |
Sway Frequency swayFrequency | range | 0.32 | 0–1 · step 0.01 | |
Brush Radius (Grid Spaces) manualPaintBrushSize | range | 1.25 | 0.1–8 · step 0.05 | |
Painting manualPaintActions | filter-actions | | — | |
Highlight Tint color | color | #dfefff (enabled) | — | Always |
Sound FX soundFxEnabled | checkbox | Off | — | Always |
Sound FX Sounds soundFxManualSoundIds | multi-select | Rule default | — | |
Scale dimensions | range | 0.26 | 0–1 · step 0.01 | Always |
Speed speed | range | 0.2 | 0.05–1 · step 0.05 | Always |
Density density | range | 0.25 | 0–1 · step 0.05 | Always |
Direction Randomization directionRandomization | range | 0 | 0–1 · step 0.01 | Always |
Direction Change Radius directionRandomizationRadius | range | 1 | 0–1 · step 0.01 | |
Time Between Direction Changes directionChangeTime | range | 8 | 1–60 · step 0.5 | |
Gustiness gustiness | range | 0.45 | 0–1 · step 0.05 | Always |
Streakiness streakiness | range | 0.6 | 0–1 · step 0.05 | Always |
Highlight sheenStrength | range | 0.2 | 0–1 · step 0.05 | Always |
Opacity opacity | range | 1 | 0–1 · step 0.05 | Always |
Direction direction | range | 0 | 0–360 · step 5 | Always |
Darkness Activation darknessActivationEnabled | checkbox | Off | — | Always |
Darkness Activation Range darknessActivationRange | range-dual | {"min":0,"max":1} | 0–1 · step 0.01 | |
Edge Fade % fadePercentRegion only | range | 0 | 0–1 · step 0.01 | Always |
Direct-effect API example
Section titled “Direct-effect API example”The Direct Effect API creates a separate row shown through Manage API Effects. Add a stable apiMacro_…_p or apiMacro_…_f ID when later macro calls need to update or stop the same row.
const created = await FXMASTER.api.effects.play({ filters: [{ "id": "apiMacro_wikiwind_f", "type": "wind", "options": { "manualPlacement": false, "direction": 180, "speed": 0.4, "density": 0.55, "turbulence": 0.5, "gustiness": 0.45 } }],});
await FXMASTER.api.effects.filters.stop(created.filters);For complete API behavior, scene targeting, stack ordering, and toggle groups, see the Direct Effect API guide.