PIXI.filters.BulgePinchFilter

class BulgePinchFilter extends PIXI.Filter

Bulges or pinches the image in a circle.
originalfilter

See:

Constructor


new PIXI.filters.BulgePinchFilter(options: object) → {}
Parameters:
Name Type Attributes Default Description
options object

<optional>

Options to use for filter.

options.center PIXI.Point | number<Array>

<optional>

[0,0]

The x and y coordinates of the center of the circle of effect.

options.radius number

<optional>

100

The radius of the circle of effect.

options.strength number

<optional>

1

-1 to 1 (-1 is strong pinch, 0 is no effect, 1 is strong bulge)

Summary


Properties from BulgePinchFilter

BulgePinchFilterOptions
static defaults

Default constructor options.

PIXI.Point | number<Array>
center

The x and y coordinates of the center of the circle of effect.

number
radius

The radius of the circle of effect.

number
strength

The strength of the effect. -1 to 1 (-1 is strong pinch, 0 is no effect, 1 is strong bulge)

Properties inherited from Filter

boolean
autoFit = true
PIXI.BLEND_MODES
blendMode = PIXI.BLEND_MODES.NORMAL
boolean
enabled

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

boolean
legacy
PIXI.MSAA_QUALITY
multisample

The samples of the filter.

number
padding
number
resolution
PIXI.State
state

The WebGL state the filter requires to render.

Properties inherited from Shader

PIXI.Program
program

Program that the shader uses.

Dict<any>
uniforms

Methods inherited from Filter

void
apply(filterManager: PIXI.FilterSystem, input: PIXI.RenderTexture, output: PIXI.RenderTexture, clearMode: PIXI.CLEAR_MODES, _currentState: object)

Public Properties


defaults BulgePinchFilter.ts:32
static defaults: BulgePinchFilterOptions

Default constructor options.

center BulgePinchFilter.ts:88
center: PIXI.Point | number<Array>

The x and y coordinates of the center of the circle of effect.

radius BulgePinchFilter.ts:64
radius: number

The radius of the circle of effect.

strength BulgePinchFilter.ts:76
strength: number

The strength of the effect. -1 to 1 (-1 is strong pinch, 0 is no effect, 1 is strong bulge)


Powered by webdoc!