The renderer this System works for.
ProtectedactiveActive state
ReadonlydefaultList of filters for the FilterSystem
Whether to clear output renderTexture in AUTO/BLIT mode. See PIXI.CLEAR_MODES.
ProtectedglobalThis uniform group is attached to filter uniforms when used.
ProtectedquadA very simple geometry used when drawing a filter effect to the screen.
ProtectedquadQuad UVs
A pool for storing filter states, save us creating new ones each tick.
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.
Draws a filter using the default rendering process.
This should be called only by PIXI.Filter#apply.
The filter to draw.
The input render target.
The target to output to.
OptionalclearMode: CLEAR_MODESShould the output be cleared before rendering to it
Binds a renderTexture with corresponding filterFrame, clears it if mode corresponds.
renderTexture to bind, should belong to filter pool or filter stack
OptionalclearMode: CLEAR_MODESclearMode, by default its CLEAR/YES. See PIXI.CLEAR_MODES
Multiply input normalized coordinates to this matrix to get sprite texture normalized coordinates.
Use outputMatrix * vTextureCoord in the shader.
The matrix to output to.
The sprite to map to.
The mapped matrix.
Destroys this Filter System.
Empties the texture pool.
Gets extra render texture to use inside current filter To be compliant with older filters, you can use params in any order
Optionalinput: RenderTexturerenderTexture from which size and resolution will be copied
Optionalresolution: numberoverride resolution of the renderTexture
Optionalmultisample: MSAA_QUALITYnumber of samples of the renderTexture
ProtectedgetGets a Power-of-Two render texture or fullScreen texture
The minimum width of the render texture in real pixels.
The minimum height of the render texture in real pixels.
Optionalresolution: numberThe resolution of the render texture.
Optionalmultisample: MSAA_QUALITYNumber of samples of the render texture.
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.
The target of the filter to render.
The filters to apply.
Calls texturePool.resize(), affects fullScreen renderTextures.
Frees a render texture back into the pool.
The renderTarget to free
System plugin to the renderer to manage filters.
Pipeline
The FilterSystem executes the filtering pipeline by rendering the display-object into a texture, applying its [filters]PIXI.Filter in series, and the last filter outputs into the final render-target.
The filter-frame is the rectangle in world space being filtered, and those contents are mapped into
(0, 0, filterFrame.width, filterFrame.height)into the filter render-texture. The filter-frame is also called the source-frame, as it is used to bind the filter render-textures. The last filter outputs to thefilterFramein the final render-target.Usage
PIXI.Container#renderAdvanced is an example of how to use the filter system. It is a 3 step process:
push: Use PIXI.FilterSystem#push to push the set of filters to be applied on a filter-target. render: Render the contents to be filtered using the renderer. The filter-system will only capture the contents inside the bounds of the filter-target. NOTE: Using PIXI.Renderer#render is illegal during an existing render cycle, and it may reset the filter system. pop: Use PIXI.FilterSystem#pop to pop & execute the filters you initially pushed. It will apply them serially and output to the bounds of the filter-target.
Memberof
PIXI