This is a base Filter class to use for any Phaser filter development.
The vast majority of filters (including all of those that ship with Phaser) use fragment shaders, and
therefore only work in WebGL and are not supported by Canvas at all.
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. |
Internal PIXI var.
The fragment shader code.
A reference to the currently running game.
The height (resolution uniform)
Internal PIXI var.
The previous position of the pointer (we don't update the uniform if the same)
The const type of this object, either Phaser.WEBGL_FILTER or Phaser.CANVAS_FILTER.
Default uniform mappings. Compatible with ShaderToy and GLSLSandbox.
The width (resolution uniform)
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. |
The newly added Image object.
Clear down this Filter and null out references
Should be over-ridden.
Set the resolution uniforms on the filter.
Name | Type | Description |
---|---|---|
width | number | The width of the display. |
height | number | The height of the display. |
Updates the filter.
Name | Type | Argument | Description |
---|---|---|---|
pointer | Phaser.Pointer | <optional> | A Pointer object to use for the filter. The coordinates are mapped to the mouse uniform. |
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Filter.html