Phaser API Documentation

  Version: 
addGlow([color], [outerStrength], [innerStrength], [knockout], [quality], [distance])

Description:

Adds a Glow effect.

The glow effect is a visual technique that creates a soft, luminous halo around game objects, characters, or UI elements. This effect is used to emphasize importance, enhance visual appeal, or convey a sense of energy, magic, or otherworldly presence. The effect can also be set on the inside of the Game Object. The color and strength of the glow can be modified.

Parameters:

name type arguments Default description
color number <optional> 0xffffff

The color of the glow effect as a number value.

outerStrength number <optional> 4

The strength of the glow outward from the edge of the Sprite.

innerStrength number <optional> 0

The strength of the glow inward from the edge of the Sprite.

knockout boolean <optional> false

If true only the glow is drawn, not the texture itself.

quality number <optional> 0.1

Only available for PostFX. Sets the quality of this Glow effect. Default is 0.1. Cannot be changed post-creation.

distance number <optional> 10

Only available for PostFX. Sets the distance of this Glow effect. Default is 10. Cannot be changed post-creation.

Returns:
Description:

The Glow FX Controller.

Since: 3.60.0