Name | Type | Description |
---|---|---|
renderer |
PIXI.Renderer |
The renderer this System works for. |
Implements
Members
List of filters for the FilterSystem
Whether to clear output renderTexture in AUTO/BLIT mode. See PIXI.CLEAR_MODES.
A pool for storing filter states, save us creating new ones each tick.
texturePool PIXI.RenderTexturePool
Stores a bunch of POT textures used for filtering.
Old padding behavior is to use the max amount instead of sum padding. Use this flag if you need the old behavior.
- Default Value:
- false
Active state
globalUniforms PIXI.UniformGroup protected
This uniform group is attached to filter uniforms when used.
Properties:
Name | Type | Description |
---|---|---|
filterArea |
Float32Array | |
filterClamp |
Float32Array | |
inputClamp |
Float32Array | |
inputPixel |
Float32Array | |
inputSize |
Float32Array | |
outputFrame |
PIXI.Rectangle | |
resolution |
number |
quad PIXI.Quad protected
A very simple geometry used when drawing a filter effect to the screen.
quadUv PIXI.QuadUv protected
Quad UVs
Methods
Draws a filter using the default rendering process.
This should be called only by Filter#apply.
Name | Type | Attributes | Description |
---|---|---|---|
filter |
PIXI.Filter |
The filter to draw. |
|
input |
PIXI.RenderTexture |
The input render target. |
|
output |
PIXI.RenderTexture |
The target to output to. |
|
clearMode |
PIXI.CLEAR_MODES |
<optional> |
Should the output be cleared before rendering to it |
Binds a renderTexture with corresponding filterFrame
, clears it if mode corresponds.
Name | Type | Description |
---|---|---|
filterTexture |
PIXI.RenderTexture |
renderTexture to bind, should belong to filter pool or filter stack |
clearMode |
PIXI.CLEAR_MODES |
clearMode, by default its CLEAR/YES. See PIXI.CLEAR_MODES |
calculateSpriteMatrix (outputMatrix, sprite) PIXI.Matrix
Multiply input normalized coordinates to this matrix to get sprite texture normalized coordinates.
Use outputMatrix * vTextureCoord
in the shader.
Name | Type | Description |
---|---|---|
outputMatrix |
PIXI.Matrix |
The matrix to output to. |
sprite |
PIXI.Sprite |
The sprite to map to. |
Returns:
Type | Description |
---|---|
PIXI.Matrix | The mapped matrix. |
Destroys this Filter System.
Empties the texture pool.
getFilterTexture (input, resolution, multisample) PIXI.RenderTexture
Gets extra render texture to use inside current filter To be compliant with older filters, you can use params in any order
Name | Type | Attributes | Description |
---|---|---|---|
input |
PIXI.RenderTexture |
<optional> |
renderTexture from which size and resolution will be copied |
resolution |
number |
<optional> |
override resolution of the renderTexture |
multisample |
PIXI.MSAA_QUALITY |
<optional> |
number of samples of the renderTexture |
Returns:
Type | Description |
---|---|
PIXI.RenderTexture |
Pops off the filter and applies it.
Pushes a set of filters to be applied later to the system. This will redirect further rendering into an input render-texture for the rest of the filtering pipeline.
Name | Type | Description |
---|---|---|
target |
PIXI.DisplayObject |
The target of the filter to render. |
filters |
Array<PIXI.Filter> |
The filters to apply. |
Calls texturePool.resize()
, affects fullScreen renderTextures.
Frees a render texture back into the pool.
Name | Type | Description |
---|---|---|
renderTexture |
PIXI.RenderTexture |
The renderTarget to free |
getOptimalFilterTexture (minWidth, minHeight, resolution, multisample) PIXI.RenderTexture protected
Gets a Power-of-Two render texture or fullScreen texture
Name | Type | Default | Description |
---|---|---|---|
minWidth |
number |
The minimum width of the render texture in real pixels. |
|
minHeight |
number |
The minimum height of the render texture in real pixels. |
|
resolution |
number | 1 |
The resolution of the render texture. |
multisample |
PIXI.MSAA_QUALITY |
Number of samples of the render texture. |
Returns:
Type | Description |
---|---|
PIXI.RenderTexture |
|