Interface Filter

An effect.

Hierarchy

Filter

Implemented by

Index

Methods

Methods

applyEffect

applyEffect(target: EffectsTarget): boolean

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:79
Apply the effect on the PixiJS DisplayObject. Called after the effect is initialized.

Parameters
- target: EffectsTarget
Returns boolean

getColorParameter

getColorParameter(parameterName: string): number

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:95
Parameters
- parameterName: string
Returns number

getDoubleParameter

getDoubleParameter(parameterName: string): number

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:94
Parameters
- parameterName: string
Returns number

getNetworkSyncData

getNetworkSyncData(): any

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:96
Returns any

isEnabled

isEnabled(target: EffectsTarget): boolean

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:67
Check if an effect is enabled.

Parameters
- target: EffectsTarget
Returns boolean
true if the filter is enabled

removeEffect

removeEffect(target: EffectsTarget): boolean

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:80
Parameters
- target: EffectsTarget
Returns boolean

setEnabled

setEnabled(target: EffectsTarget, enabled: boolean): boolean

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:72
Enable an effect.

Parameters
- target: EffectsTarget
- enabled: boolean
  
  Set to true to enable, false to disable
Returns boolean

updateBooleanParameter

updateBooleanParameter(parameterName: string, value: boolean): void

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:92
The function to be called to update a parameter (with a boolean)

Parameters
- parameterName: string
- value: boolean
Returns void

updateColorParameter

updateColorParameter(parameterName: string, value: number): void

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:93
Parameters
- parameterName: string
- value: number
Returns void

updateDoubleParameter

updateDoubleParameter(parameterName: string, value: number): void

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:84
The function to be called to update a parameter (with a number)

Parameters
- parameterName: string
- value: number
Returns void

updateFromNetworkSyncData

updateFromNetworkSyncData(syncData: any): void

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:97
Parameters
- syncData: any
Returns void

updatePreRender

updatePreRender(target: EffectsTarget): any

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:82
The function to be called to update the filter at every frame before the rendering.

Parameters
- target: EffectsTarget
Returns any

updateStringParameter

updateStringParameter(parameterName: string, value: string): void

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:90
The function to be called to update a parameter (with a string)

Parameters
- parameterName: string
- value: string
Returns void

Generated using TypeDoc