PIXI.filters.AdjustmentFilter

class AdjustmentFilter extends PIXI.Filter

The ability to adjust gamma, contrast, saturation, brightness, alpha or color-channel shift. This is a faster and much simpler to use than ColorMatrixFilter because it does not use a matrix.
originalfilter

See:

Constructor


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

<optional>

The optional parameters of the filter.

options.gamma number

<optional>

1

The amount of luminance

options.saturation number

<optional>

1

The amount of color saturation

options.contrast number

<optional>

1

The amount of contrast

options.brightness number

<optional>

1

The overall brightness

options.red number

<optional>

1

The multipled red channel

options.green number

<optional>

1

The multipled green channel

options.blue number

<optional>

1

The multipled blue channel

options.alpha number

<optional>

1

The overall alpha amount

Summary


Properties from AdjustmentFilter

number
alpha = 1

The amount of alpha channel

number
blue = 1

The amount of blue channel

number
brightness = 1

The amount of brightness

number
contrast = 1

The amount of contrast

number
gamma = 1

The amount of luminance

number
green = 1

The amount of green channel

number
red = 1

The amount of red channel

number
saturation = 1

The amount of saturation

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


alpha AdjustmentFilter.ts:54
alpha: number = 1

The amount of alpha channel

blue AdjustmentFilter.ts:51
blue: number = 1

The amount of blue channel

brightness AdjustmentFilter.ts:42
brightness: number = 1

The amount of brightness

contrast AdjustmentFilter.ts:39
contrast: number = 1

The amount of contrast

gamma AdjustmentFilter.ts:33
gamma: number = 1

The amount of luminance

green AdjustmentFilter.ts:48
green: number = 1

The amount of green channel

red AdjustmentFilter.ts:45
red: number = 1

The amount of red channel

saturation AdjustmentFilter.ts:36
saturation: number = 1

The amount of saturation


Powered by webdoc!