Phaser.GameObjects.Components.Mask
Scope: static
Source: src/gameobjects/components/Mask.js#L10
Since: 3.0.0
Static functions
mask
mask: Phaser.Display.Masks.GeometryMask
Description:
The Mask this Game Object is using during render.
Source: src/gameobjects/components/Mask.js#L22
Since: 3.0.0
Static functions
clearMask
<instance> clearMask([destroyMask])
Description:
Clears the mask that this Game Object was using.
This only works in the Canvas Renderer.
In WebGL, use a Mask filter instead (see Phaser.GameObjects.Components.FilterList#addMask).
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| destroyMask | boolean | Yes | false | Destroy the mask before clearing it? |
Returns: Phaser.GameObjects.Components.Mask - This Game Object instance.
Source: src/gameobjects/components/Mask.js#L66
Since: 3.6.2
createGeometryMask
<instance> createGeometryMask([graphics])
Description:
Creates and returns a Geometry Mask. This mask can be used by any Game Object,
including this one.
To create the mask you need to pass in a reference to a Graphics Game Object.
If you do not provide a graphics object, and this Game Object is an instance
of a Graphics object, then it will use itself to create the mask.
This means you can call this method to create a Geometry Mask from any Graphics Game Object.
This only works in the Canvas Renderer.
In WebGL, use a Mask filter instead (see Phaser.GameObjects.Components.FilterList#addMask).
Tags:
- generic
- generic
- genericUse
Parameters:
| name | type | optional | description |
|---|---|---|---|
| graphics | Phaser.GameObjects.Graphics | Phaser.GameObjects.Shape | Yes | A Graphics Game Object, or any kind of Shape Game Object. The geometry within it will be used as the mask. |
Returns: Phaser.Display.Masks.GeometryMask - This Geometry Mask that was created.
Source: src/gameobjects/components/Mask.js#L93
Since: 3.6.2
setMask
<instance> setMask(mask)
Description:
Sets the mask that this Game Object will use to render with.
The mask must have been previously created and must be a GeometryMask.
This only works in the Canvas Renderer.
In WebGL, use a Mask filter instead (see Phaser.GameObjects.Components.FilterList#addMask).
If a mask is already set on this Game Object it will be immediately replaced.
Masks are positioned in global space and are not relative to the Game Object to which they
are applied. The reason for this is that multiple Game Objects can all share the same mask.
Masks have no impact on physics or input detection. They are purely a rendering component
that allows you to limit what is visible during the render pass.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| mask | Phaser.Display.Masks.GeometryMask | No | The mask this Game Object will use when rendering. |
Returns: Phaser.GameObjects.Components.Mask - This Game Object instance.
Source: src/gameobjects/components/Mask.js#L31
Since: 3.6.2