new PIXI.Filter (vertexSrc, fragmentSrc, uniforms) overrides
Name | Type | Attributes | Description |
---|---|---|---|
vertexSrc |
string |
<optional> |
The source of the vertex shader. |
fragmentSrc |
string |
<optional> |
The source of the fragment shader. |
uniforms |
object |
<optional> |
Custom uniforms to use to augment the built-in ones. |
Extends
Members
The default fragment shader source
The default vertex shader source
Used for caching shader IDs
If enabled, PixiJS will fit the filter area into boundaries for better performance. Switch it off if it does not work for specific shader.
Sets the blendmode of the filter
- Default Value:
- PIXI.BLEND_MODES.NORMAL
If enabled is true the filter is applied, if false it will not.
Legacy filters use position and uvs from attributes
The padding of the filter. Some filters require extra space to breath such as a blur. Increasing this will add extra width and height to the bounds of the object that the filter is applied to.
The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter.
state PIXI.State
The WebGL state the filter requires to render
Methods
Applies the filter
Name | Type | Attributes | Description |
---|---|---|---|
filterManager |
PIXI.FilterSystem |
The renderer to retrieve the filter from |
|
input |
PIXI.RenderTexture |
The input render target. |
|
output |
PIXI.RenderTexture |
The target to output to. |
|
clearMode |
PIXI.CLEAR_MODES |
Should the output be cleared before rendering to it. |
|
currentState |
object |
<optional> |
It's current state of filter. There are some useful properties in the currentState : target, filters, sourceFrame, destinationFrame, renderTarget, resolution |
Inherited Properties
From class PIXI.Shader
program PIXI.Program inherited
Program that the shader uses
uniforms object inherited
Shader uniform values, shortcut for uniformGroup.uniforms