Shader as a Mask

Demonstrates how to use a custom GLSL shader as a dynamic mask for an image. It shows how to create a shader object and apply it to a Game Object through the filters system to create animated masking effects.

800 × 600

GitHub

class Example extends Phaser.Scene
{
    preload ()
    {
        this.load.setBaseURL('https://cdn.phaserfiles.com/v410');
        this.load.glsl('wave', 'assets/shaders/shader1.frag');
        this.load.image('pic', 'assets/pics/sao-sinon.png');
        this.load.image('bg', 'assets/pics/purple-dots.png');
    }

    create ()
    {
        this.add.image(400, 300, 'bg');

        const shader = this.make.shader({
            config: {
                name: 'wave',
                fragmentKey: 'wave',
                initialUniforms: {
                    resolution: [ 800, 600 ]
                },
                setupUniforms: (setUniform, drawingContext) => {
                    setUniform('time', this.game.loop.getDuration());
                }
            },
            x: 400,
            y: 300,
            width: 800,
            height: 600,
            add: false
        });

        //  Apply the mask to this image
        this.add.image(400, 300, 'pic').enableFilters().filters.external.addMask(shader);
    }
}

const config = {
    scale: { mode: Phaser.Scale.FIT },
    type: Phaser.WEBGL,
    parent: 'game-container',
    width: 800,
    height: 600,
    scene: Example
};

const game = new Phaser.Game(config);

More in Shaders15 examples

Shader Feedback BuffersDemonstrates how to create a shader feedback loop by rendering multiple shaders to textures and using the output of one as the input for another.

Shader Render to TextureDemonstrates how to render a GLSL shader to a texture and then use that texture across multiple Game Objects simultaneously.

Shader Render-to-Texture FeedbackDemonstrates how to create a feedback loop between multiple shaders by rendering each to a texture and passing those textures as sampler inputs to one another.

Shader SandboxDemonstrates layering multiple shaders with standard images and animating shader uniforms using the Tween Manager.