Outline

Introduction

Outline post processing filter. Reference

  • Author: Rex
  • A camera filter

Live demos

Usage

Sample code

Install plugin

Load minify file

  • Load plugin (minify file) in preload stage
    scene.load.plugin('rexoutlinepipelineplugin', 'https://raw.githubusercontent.com/rexrainbow/phaser3-rex-notes/master/dist/rexoutlinepipelineplugin.min.js', true);
    
  • Apply effect
    • Apply effect to game object
      var pipelineInstance = scene.plugins.get('rexoutlinepipelineplugin').add(gameObject, config);
      
    • Apply effect to camera
      var pipelineInstance = scene.plugins.get('rexoutlinepipelineplugin').add(camera, config);
      

Import plugin

  • Install rex plugins from npm
    npm i phaser3-rex-plugins
    
  • Install plugin in configuration of game
    import OutlinePipelinePlugin from 'phaser3-rex-plugins/plugins/outlinepipeline-plugin.js';
    var config = {
        // ...
        plugins: {
            global: [{
                key: 'rexOutlinePipeline',
                plugin: OutlinePipelinePlugin,
                start: true
            },
            // ...
            ]
        }
        // ...
    };
    var game = new Phaser.Game(config);
    
  • Apply effect
    • Apply effect to game object
      var pipelineInstance = scene.plugins.get('rexOutlinePipeline').add(gameObject, config);
      
    • Apply effect to camera
      var pipelineInstance = scene.plugins.get('rexOutlinePipeline').add(camera, config);
      

Import class

  • Install rex plugins from npm
    npm i phaser3-rex-plugins
    
  • Add to game config
    import OutlinePostFx from 'phaser3-rex-plugins/plugins/outlinepipeline.js';
    var config = {
        // ...
        pipeline: [OutlinePostFx]
        // ...
    };
    var game = new Phaser.Game(config);
    
  • Apply effect
    • Apply effect to game object
      gameObject.setPostPipeline(OutlinePostFx);
      
    • Apply effect to camera
      camera.setPostPipeline(OutlinePostFx);
      

Apply effect

  • Apply effect to game object. A game object only can add 1 outline effect.
    var pipelineInstance = scene.plugins.get('rexOutlinePipeline').add(gameObject, {
        // thickness: 3,
        // outlineColor: 0x000000,
    
        // nane: 'rexOutlinePostFx'
    });
    
    • thickness : Thickness of outline.
    • outlineColor : Color of outline.
  • Apply effect to camera. A camera only can add 1 outline effect.
    var pipelineInstance = scene.plugins.get('rexOutlinePipeline').add(camera, config);
    

Remove effect

  • Remove effect from game object
    scene.plugins.get('rexOutlinePipeline').remove(gameObject);
    
  • Remove effect from camera
    scene.plugins.get('rexOutlinePipeline').remove(camera);
    

Get effect

  • Get effect from game object
    var pipelineInstance = scene.plugins.get('rexOutlinePipeline').get(gameObject);
    
  • Get effect from camera
    var pipelineInstance = scene.plugins.get('rexOutlinePipeline').get(camera);
    

Thickness

  • Get
    var thickness = pipelineInstance.thickness;
    
  • Set
    pipelineInstance.thickness = thickness;
    // pipelineInstance.thickness += value;
    
    or
    pipelineInstance.setThickness(value);
    

Outline color

  • Get
    var color = pipelineInstance.outlineColor;
    
    • color : Color object.
      • Red: color.red, 0~255.
      • Green: color.green, 0~255.
      • Blue: color.blue, 0~255.
  • Set
    pipelineInstance.setOutlineColor(value);
    
    pipelineInstance.outlineColor = value;
    
    • value : A number 0xRRGGBB, or a JSON object {r:255, g:255, b:255}

Quality

  • Get
    var quality = pipelineInstance.quality;
    
  • Set
    pipelineInstance.setQuality(quality);
    
    or
    pipelineInstance.quality = quality;
    
    • quality : 0 ~ 1, default is 0.1.
      • 0.1 : 10 sample points.
      • 0.08 : 8 sample points.
      • 1 : 100 sample points.