PIXI.filters.OutlineFilter

class OutlineFilter extends PIXI.Filter

OutlineFilter, originally by mishaa http://www.html5gamedevs.com/topic/10640-outline-a-sprite-change-certain-colors/?p=69966 http://codepen.io/mishaa/pen/emGNRB
filter


  someSprite.filters = [new OutlineFilter(2, 0x99ff99)];

See:

Constructor

new PIXI.filters.OutlineFilter(thickness: number, color: number, quality: number) → {}

Parameters:
Name	Type	Attributes	Default	Description
thickness	number	<optional>	1	The tickness of the outline. Make it 2 times more for resolution 2
color	number	<optional>	0x000000	The color of the outline.
quality	number	<optional>	0.1	The quality of the outline from `0` to `1`, using a higher quality setting will result in slower performance and more accuracy.

Summary

Properties from OutlineFilter

number	static MAX_SAMPLES = 100 The maximum number of samples for rendering outline.
number	static MIN_SAMPLES = 1 The minimum number of samples for rendering outline.
number	color = 0x000000
number	thickness = 1

Properties inherited from Filter

boolean	autoFit = true
PIXI.BLEND_MODES	blendMode = PIXI.BLEND_MODES.NORMAL
boolean	enabled If enabled is true the filter is applied, if false it will not.
boolean	legacy
PIXI.MSAA_QUALITY	multisample The samples of the filter.
number	padding
number	resolution
PIXI.State	state The WebGL state the filter requires to render.

Properties inherited from Shader

PIXI.Program

program

Program that the shader uses.

Dict<any>

uniforms

Methods inherited from Filter

void	apply(filterManager: PIXI.FilterSystem, input: PIXI.RenderTexture, output: PIXI.RenderTexture, clearMode: PIXI.CLEAR_MODES, _currentState: object)

Public Properties

MAX_SAMPLES OutlineFilter.ts:27

static MAX_SAMPLES: number = 100

The maximum number of samples for rendering outline.

MIN_SAMPLES OutlineFilter.ts:24

static MIN_SAMPLES: number = 1

The minimum number of samples for rendering outline.

color OutlineFilter.ts:70

color: number = 0x000000

The color of the glow.

thickness OutlineFilter.ts:83

thickness: number = 1

The thickness of the outline.