Class: TwistFilter

SINT.magic.TwistFilter

This filter applies a twist effect making display objects appear twisted in the given direction.
originalfilter

new SINT.magic.TwistFilter (radius, angle, padding)

Name Type Default Description
radius number 200 optional

The radius of the twist.

angle number 4 optional

The angle of the twist.

padding number 20 optional

Padding for filter area.

Extends

Members

angle number

The angle of the twist.

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.

offset SINT.Point

This point describes the the offset of the twist.

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.

radius number

The radius of the twist.

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