Using BitmapMask inside container has interesting behavior.

Version

• Phaser Version:3.17.0 and 3.18.1

• Operating system: Windows 10

• Browser: Google Chrome Version 75.0.3770.100 (Official Build) (64-bit)

Description

We have a container added to scene and 2 sprites in it (sprite0 and sprite1). Trying to set mask to sprite0 from sprite1 and both of them are becoming invisible.

before applying mask after

Example Test Code

var config = {
    type: Phaser.WEBGL,
    width: 800,
    height: 600,
    backgroundColor: '#000066',
    parent: 'phaser-example',
    scene: {
        preload: preload,
        create: create,
    }
};

var controls;

var game = new Phaser.Game(config);

function preload ()
{
    this.load.image('brain', 'assets/sprites/brain.png');
    this.load.image('truck', 'assets/sprites/astorm-truck.png');
}

function create ()
{
    var container = this.add.container(400, 300);
    var sprite0 = this.add.sprite(10, 0, 'truck');
    var sprite1 = this.add.sprite(0, 0, 'truck');
    container.add(sprite0);
    container.add(sprite1)
    sprite1.setMask(sprite0.createBitmapMask())
}

Additional Information

lets change texture of sprite0 to brain and we’ll see another unexpected behavior.

var config = {
    type: Phaser.WEBGL,
    width: 800,
    height: 600,
    backgroundColor: '#000066',
    parent: 'phaser-example',
    scene: {
        preload: preload,
        create: create,
    }
};

var controls;

var game = new Phaser.Game(config);

function preload ()
{
    this.load.image('brain', 'assets/sprites/brain.png');
    this.load.image('truck', 'assets/sprites/astorm-truck.png');
}

function create ()
{
    var container = this.add.container(400, 300);
    var sprite0 = this.add.sprite(10, 0, 'brain');
    var sprite1 = this.add.sprite(0, 0, 'truck');
    container.add(sprite0);
    container.add(sprite1)
    sprite1.setMask(sprite0.createBitmapMask())
}

[photonstorm]

That beta build was probably from before I fixed this yesterday, use the one attached:

dev.zip

[taoabc]

Because mask cannot add to container, I’m forced fallback to phaser 2. @RollinSafary Like your situation, I need a batch of cirle mask above avatar. Then attach the root container to dragonbones or spine slot.