Sint.JS

Class: AlphaFilter

SINT.magic.AlphaFilter

Simplest filter - applies alpha

Use this instead of Container's alpha property to avoid visual layering of individual elements. AlphaFilter applies alpha evenly across the entire display object and any opaque elements it contains. If elements are not opaque, they will blend with each other anyway.

Very handy if you want to use common features of all filters:

  1. Assign a blendMode to this filter, blend all elements inside display object with background.

  2. To use clipping in display coordinates, assign a filterArea to the same container that has this filter.

new SINT.magic.AlphaFilter (alpha)

Name Type Default Description
alpha number 1 optional

Amount of alpha from 0 to 1, where 0 is transparent

Extends

Members

alpha number

Coefficient for alpha multiplication

Default Value:
  • 1

autoFit boolean inherited overrides

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

blendMode number inherited overrides

Sets the blendmode of the filter

Default Value:
  • SINT.BLEND_MODES.NORMAL

enabled boolean inherited overrides

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

fragmentSrc string inherited overrides

The fragment shader.

padding number inherited overrides

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.

resolution number inherited overrides

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

uniforms object inherited overrides

An object containing the current values of custom uniforms.

Example

Updating the value of a custom uniform

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

vertexSrc string inherited overrides

The vertex shader.

Methods

apply (filterManager, input, output, clear, currentState) inherited overrides

Applies the filter

Name Type Description
filterManager SINT.FilterManager

The renderer to retrieve the filter from
input SINT.RenderTarget

The input render target.
output SINT.RenderTarget

The target to output to.
clear boolean

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