Skip to content

Color

Visual reference
FXMasterFilter effectAPI type: color

Adjusts scene color balance, saturation, gamma, brightness, contrast, tint, and opacity.

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 color
Exposed parameters 15
  • Tint: Applies the selected tint across the scene before the blend mode and color adjustments are calculated. Disable Apply to leave the original hue unchanged.
  • Blend Mode: How the adjusted color result blends with the sampled scene color.
  • Saturation: Changes the amount of color in the scene. Lower values move toward grayscale; higher values make colors more vivid.
  • Contrast: Changes the separation between dark and bright values. Higher values deepen shadows and strengthen highlights.
  • Brightness: Raises or lowers the overall scene brightness after the tint and blend mode are applied.
  • Gamma: Adjusts midtone brightness without moving the darkest and brightest values as aggressively as Brightness.
  • Use Tint and Blend Mode for broad grading, then make smaller Saturation, Contrast, Brightness, and Gamma adjustments.
  • Color is often most useful near the end of the filter stack because it can grade the output of earlier particles and filters together.
Preset API name Availability Variants
Black Sun black-sun FXMaster+ Normal
Sakura Bloom sakura-bloom FXMaster+ Normal, Top Down
Sunshower sunshower FXMaster Normal, Top Down
Veilfall veilfall FXMaster+ Normal

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.

15 exposed parameters1 Scene-only1 Region-onlycolor API type

Hover 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.

ParameterControlDefaultRange or choicesAvailability
Below Tokens
belowTokens
checkboxOffAlways
Below Tiles
belowTiles
checkboxOffAlways
Below Foreground
belowForeground
checkboxOffAlways
Levels
levelsScene only
scene-levelsAll LevelsAlways
Tint
color
color#ffffff (disabled)Always
Sound FX
soundFxEnabled
checkboxOffAlways
Sound FX Sounds
soundFxManualSoundIds
multi-selectRule default
Blend Mode
blendMode
selectnormalNormal, Multiply, Screen, Overlay, Soft Light, Hard Light, Color Dodge, Color Burn, Darken, Lighten, Difference, ExclusionAlways
Saturation
saturation
range10–2 · step 0.1Always
Contrast
contrast
range10–2 · step 0.1Always
Brightness
brightness
range10–2 · step 0.1Always
Gamma
gamma
range10–2 · step 0.1Always
Darkness Activation
darknessActivationEnabled
checkboxOffAlways
Darkness Activation Range
darknessActivationRange
range-dual{"min":0,"max":1}0–1 · step 0.01
Edge Fade %
fadePercentRegion only
range00–1 · step 0.01Always

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_wikicolor_f",
"type": "color",
"options": {
"color": {
"apply": true,
"value": "#7c75aa"
},
"saturation": 1,
"contrast": 1,
"brightness": 1,
"gamma": 1
}
}],
});
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.