Bloom

Visual reference

FXMasterFilter effectAPI type: bloom

Adds a bright-pass glow around luminous scene content.

Visual filters change the rendered Scene. Check map, token, and text visibility after changing their strength or opacity.

Reference	Value
Package	FXMaster
Effect kind	Filter effect
Category	Visual
Runtime type	bloom
Exposed parameters	12

Important controls

• Threshold: Sets how bright a scene pixel must be before Bloom affects it. Lower values bloom more of the map; higher values restrict the glow to the brightest areas.
• Bloom: Controls the strength of the bloom added around pixels that pass the Threshold setting. Higher values make those highlights brighter and more prominent.
• Blur: Controls how far bright pixels spread before they are composited back over the scene. Higher values create a softer, wider glow.

Setup notes

• Raise Threshold before Bloom when only the brightest highlights should glow.
• Bloom compounds with bright particles, lighting, and emissive artwork, so review it with the complete stack active.

Bundled preset usage

Preset	API name	Availability	Variants
Arcane Winds	arcane-winds	FXMaster+	Normal
Heat Wave	heat-wave	FXMaster	Normal

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.

12 exposed parameters1 Scene-only1 Region-onlybloom API type

iHover 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 Tokensi belowTokens	checkbox	Off	—	Always
Below Tilesi belowTiles	checkbox	Off	—	Always
Below Foregroundi belowForeground	checkbox	Off	—	Always
Levelsi levelsScene only	scene-levels	All Levels	—	Always
Bluri blur	range	1	0–10 · step 1	Always
Bloomi bloomScale	range	0.1	0–1 · step 0.1	Always
Thresholdi threshold	range	0.5	0–1 · step 0.1	Always
Sound FXi soundFxEnabled	checkbox	Off	—	Always
Sound FX Soundsi soundFxManualSoundIds	multi-select	Rule default	—	Shown when Sound FX = On and the matching enabled SoundFX rule uses Multi-Sound Mode = Manual with at least two configured sounds
Darkness Activationi darknessActivationEnabled	checkbox	Off	—	Always
Darkness Activation Rangei darknessActivationRange	range-dual	{"min":0,"max":1}	0–1 · step 0.01	Shown when Darkness Activation = On
Edge Fade %i fadePercentRegion only	range	0	0–1 · step 0.01	Always

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_wikibloom_f",
    "type": "bloom",
    "options": {
      "blur": 2,
      "bloomScale": 1,
      "threshold": 0.5
    }
  }],
});

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.