Shadow
The Shadow Filter.
This filter controller manages the shadow effect for a Camera.
The shadow effect is a visual technique used to create the illusion of depth and realism by adding darker,
offset silhouettes or shapes beneath game objects, characters, or environments. These simulated shadows
help to enhance the visual appeal and immersion, making the 2D game world appear more dynamic and three-dimensional.
A Shadow effect is added to a Camera via the FilterList component:
const camera = this.cameras.main;
camera.filters.internal.addShadow();
camera.filters.external.addShadow();
Constructor
new Shadow(camera, [x], [y], [decay], [power], [color], [samples], [intensity])
Parameters
| name | type | optional | default | description |
|---|---|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera | No | The camera that owns this filter. | |
| x | number | Yes | 0 | The horizontal offset of the shadow effect. |
| y | number | Yes | 0 | The vertical offset of the shadow effect. |
| decay | number | Yes | 0.1 | The amount of decay for the shadow effect. |
| power | number | Yes | 1 | The power of the shadow effect. |
| color | number | Yes | "0x000000" | The color of the shadow, as a hex value. |
| samples | number | Yes | 6 | The number of samples that the shadow effect will run for. |
| intensity | number | Yes | 1 | The intensity of the shadow effect. |
Scope: static
Extends
Source: src/filters/Shadow.js#L10
Since: 4.0.0
Inherited Members
From Phaser.Filters.Controller:
Public Members
color
color: number
Description:
The color of the shadow.
Source: src/filters/Shadow.js#L129
Since: 4.0.0
decay
decay: number
Description:
The amount of decay for the shadow effect.
Source: src/filters/Shadow.js#L76
Since: 4.0.0
glcolor
glcolor: Array.<number>
Description:
The internal gl color array.
Source: src/filters/Shadow.js#L94
Since: 4.0.0
intensity
intensity: number
Description:
The intensity of the shadow effect.
Source: src/filters/Shadow.js#L114
Since: 4.0.0
power
power: number
Description:
The power of the shadow effect.
Source: src/filters/Shadow.js#L85
Since: 4.0.0
samples
samples: number
Description:
The number of samples that the shadow effect will run for.
This should be an integer with a minimum value of 1 and a maximum of 12.
Source: src/filters/Shadow.js#L103
Since: 4.0.0
x
x: number
Description:
The horizontal offset of the shadow effect.
Source: src/filters/Shadow.js#L58
Since: 4.0.0
y
y: number
Description:
The vertical offset of the shadow effect.
Source: src/filters/Shadow.js#L67
Since: 4.0.0
Inherited Methods
From Phaser.Filters.Controller: