Mask

.GameObjects.Components. Mask

Since:
  • 3.0.0
提供用于获取和设置游戏对象遮罩的方法.

Members

mask :Phaser.Display.Masks.BitmapMask|Phaser.Display.Masks.GeometryMask

Since:
  • 3.0.0
此游戏对象在渲染过程中使用的遮罩.
Type:

Methods

clearMask(destroyMaskopt) → {this}

Since:
  • 3.6.2
清除此游戏对象使用的掩码.
Parameters:
Name Type Attributes Default Description
destroyMask boolean <optional>
false 先破坏面具再清除?
Returns:
此游戏对象实例.
Type
this

createBitmapMask(renderableopt) → {Phaser.Display.Masks.BitmapMask}

Since:
  • 3.6.2
创建并返回位图蒙版.这个遮罩可以被任何游戏对象使用, 包括这个. 注意:位图蒙版仅适用于WebGL.几何蒙版既适用于网络几何图形,也适用于画布. 要创建遮罩,您需要传入一个可渲染游戏对象的引用. 可渲染游戏对象是使用纹理进行渲染的对象,例如 图像,精灵,渲染纹理或位图文本. 如果你没有提供一个可渲染的对象,并且这个游戏对象有纹理, 它会把自己当成物体.这意味着您可以调用此方法来创建 任何可渲染游戏对象的位图蒙版.
Parameters:
Name Type Attributes Description
renderable Phaser.GameObjects.GameObject <optional>
使用纹理的可渲染游戏对象,如精灵.
Returns:
创建的位图掩码.
Type
Phaser.Display.Masks.BitmapMask

createGeometryMask(graphicsopt) → {Phaser.Display.Masks.GeometryMask}

Since:
  • 3.6.2
创建并返回几何遮罩.这个遮罩可以被任何游戏对象使用, 包括这个. 要创建蒙版,你需要传入一个图形游戏对象的引用. 如果你没有提供图形对象,而这个游戏对象是一个实例 一个图形对象,然后它将使用自己来创建遮罩. 这意味着你可以调用这个方法从任何图形游戏对象创建一个几何图形遮罩.
Parameters:
Name Type Attributes Description
graphics Phaser.GameObjects.Graphics <optional>
图形游戏对象.其中的几何图形将用作遮罩.
Returns:
创建的几何遮罩.
Type
Phaser.Display.Masks.GeometryMask

setMask(mask) → {this}

Since:
  • 3.6.2
设置此游戏对象将用于渲染的遮罩. 掩码必须是以前创建的,可以是几何掩码或位图掩码. 注意:位图蒙版仅适用于WebGL.几何蒙版既适用于网络几何图形,也适用于画布. 如果在这个游戏对象上已经设置了一个遮罩,它将被立即替换. 遮罩位于全局空间中,与它们所对应的游戏对象无关 被应用.原因是多个游戏对象可以共享同一个遮罩. 遮罩对物理或输入检测没有影响.它们纯粹是一个渲染组件 这允许您限制渲染过程中可见的内容.
Parameters:
Name Type Description
mask Phaser.Display.Masks.BitmapMask | Phaser.Display.Masks.GeometryMask 此游戏对象在渲染时将使用的遮罩.
Returns:
此游戏对象实例.
Type
this