Class: DisplacementFilter

SINT.magic.DisplacementFilter

new SINT.magic.DisplacementFilter (density, speed, zoom)

Name Type Description
density number optional
speed number optional
zoom number optional

Extends

Members

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

density number

This density of the Filter noise.

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.

speed number

This speed 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.

zoom number

This zoom of the Filter.

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