Class: SpriteMaskFilter

Tiny. SpriteMaskFilter

The SpriteMaskFilter class

Name Type Description
sprite Tiny.Sprite

the target sprite

Extends

Members

autoFitboolean

If enabled, will fit the filter area into boundaries for better performance.
Switch it off if it does not work for specific shader.

blendModenumber

Sets the blendmode of the filter

Version:
  • 1.2.0
Default Value:
  • Tiny.BLEND_MODES.NORMAL

enabledboolean

If enabled is true the filter is applied, if false it will not.

fragmentSrcstring

The fragment shader.

paddingnumber

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.

resolutionnumber

The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter.

uniformsobject

An object containing the current values of custom uniforms.

Example

Updating the value of a custom uniform

filter.uniforms.time = performance.now();

vertexSrcstring

The vertex shader.

Methods

apply(filterManager, input, output)

Applies the filter

Name Type Description
filterManager Tiny.FilterManager

The renderer to retrieve the filter from

input Tiny.RenderTarget

The input render target.

output Tiny.RenderTarget

The target to output to.

Documentation generated by JSDoc 3.4.3 on Mon Dec 03 2018 17:48:52 GMT+0800 (CST)