Phaser Class: Filter

This is a base Filter class to use for any Phaser filter development.

Name	Type	Description
`game`	Phaser.Game	A reference to the currently running game.
`uniforms`	object	Uniform mappings object
`fragmentSrc`	Array \| string	The fragment shader code. Either an array, one element per line of code, or a string.

dirty :boolean

Internal PIXI var.

Default Value:

fragmentSrc :array|string

The fragment shader code.

A reference to the currently running game.

height :number

The height (resolution uniform)

padding :number

Internal PIXI var.

The previous position of the pointer (we don't update the uniform if the same)

type :number

The const type of this object, either Phaser.WEBGL_FILTER or Phaser.CANVAS_FILTER.

uniforms :object

Default uniform mappings. Compatible with ShaderToy and GLSLSandbox.

width :number

The width (resolution uniform)

addToWorld(x, y, width, height, anchorX, anchorY) → {Phaser.Image}

Creates a new Phaser.Image object using a blank texture and assigns this Filter to it. The image is then added to the world.

If you don't provide width and height values then Filter.width and Filter.height are used.

If you do provide width and height values then this filter will be resized to match those values.

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The x coordinate to place the Image at.
`y`	number	<optional>	0	The y coordinate to place the Image at.
`width`	number	<optional>		The width of the Image. If not specified (or null) it will use Filter.width. If specified Filter.width will be set to this value.
`height`	number	<optional>		The height of the Image. If not specified (or null) it will use Filter.height. If specified Filter.height will be set to this value.
`anchorX`	number	<optional>	0	Set the x anchor point of the Image. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right.
`anchorY`	number	<optional>	0	Set the y anchor point of the Image. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right.