Custom Grayscale Shader via Batch Handler

Apply a custom shader effect to individual game objects by assigning a specific Batch Handler and updating its shader uniforms in real-time.

800 × 600

GitHub

// #module

import AddGrayscale from './assets/rendernodes/AddGrayscale.js';

export default class Example extends Phaser.Scene
{
    constructor ()
    {
        super();
    }

    preload ()
    {
        this.load.setBaseURL('https://cdn.phaserfiles.com/v410');
        this.load.setPath('assets/tests/pipeline/');

        this.load.image('cake', 'cake.png');
        this.load.image('crab', 'crab.png');
        this.load.image('fish', 'fish.png');
        this.load.image('pudding', 'pudding.png');
    }

    create ()
    {
        const renderNodeManager = this.renderer.renderNodes;
        this.grayscaleBatchHandler = AddGrayscale(renderNodeManager);

        this.add.sprite(100, 300, 'pudding');
        
        const crab = this.add.sprite(400, 300, 'crab').setScale(1.5);
        crab.setRenderNodeRole('BatchHandler', this.grayscaleBatchHandler);

        this.fish = this.add.sprite(400, 300, 'fish');
        this.fish.setRenderNodeRole('BatchHandler', this.grayscaleBatchHandler);

        this.add.sprite(700, 300, 'cake');

        this.input.on('pointermove', pointer => {

            this.fish.x = pointer.worldX;
            this.fish.y = pointer.worldY;

        });

        this.gray = 1;
        this.tweens.add({
            targets: this,
            gray: 0,
            yoyo: true,
            repeat: -1,
            delay: 2000,
            repeatDelay: 2000,
            duration: 2000,
            ease: 'Sine.easeInOut',
            onUpdate: () => {
                this.grayscaleBatchHandler.programManager.setUniform('uGray', this.gray);
            }
        });
    }
}

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

let game = new Phaser.Game(config);

More in Renderer14 examples

Custom Shader Single Texture Render NodeDemonstrates how to create a custom render node to apply a color-warping fragment shader and time-based uniforms to specific Sprites.

Custom Shader with Batch HandlerDemonstrates how to apply a custom GLSL shader to specific sprites using a BatchHandlerQuad render node and the setRenderNodeRole method.

Hue Rotation Shader via Batch HandlerApply a custom hue rotation shader to multiple sprites by registering a BatchHandler render node and updating shader uniforms in the game loop.

Local Grayscale Shader AdditionDemonstrates how to inject custom GLSL code into a specific batch handler to create a grayscale effect and apply it selectively to individual sprites using Render Node roles.