Phaser API Documentation

  Version: 
drawBitmapMask(mask, camera, bitmapMaskPipeline)

Description:

Binds necessary resources and renders the mask to a separated framebuffer. The framebuffer for the masked object is also bound for further use.

Parameters:

name type description
mask Phaser.Display.Masks.BitmapMask

The BitmapMask instance that called beginMask.

camera Phaser.Cameras.Scene2D.Camera

The camera rendering the current mask.

bitmapMaskPipeline Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline

The BitmapMask Pipeline instance that is requesting the draw.

Since: 3.60.0