Interface Filter

An effect.

interface Filter {
    applyEffect(target): boolean;
    getColorParameter(parameterName): number;
    getDoubleParameter(parameterName): number;
    getNetworkSyncData(): any;
    isEnabled(target): boolean;
    removeEffect(target): boolean;
    setEnabled(target, enabled): boolean;
    updateBooleanParameter(parameterName, value): void;
    updateColorParameter(parameterName, value): void;
    updateDoubleParameter(parameterName, value): void;
    updateFromNetworkSyncData(syncData): void;
    updatePreRender(target): any;
    updateStringParameter(parameterName, value): void;
}

Implemented by

Index

Methods

applyEffect getColorParameter getDoubleParameter getNetworkSyncData isEnabled removeEffect setEnabled updateBooleanParameter updateColorParameter updateDoubleParameter updateFromNetworkSyncData updatePreRender updateStringParameter

Methods

applyEffect

applyEffect(target): boolean
Apply the effect on the PixiJS DisplayObject. Called after the effect is initialized.
Parameters
- target: EffectsTarget
Returns boolean
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:77

getColorParameter

getColorParameter(parameterName): number
Parameters
- parameterName: string
Returns number
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:93

getDoubleParameter

getDoubleParameter(parameterName): number
Parameters
- parameterName: string
Returns number
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:92

getNetworkSyncData

getNetworkSyncData(): any
Returns any
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:94

isEnabled

isEnabled(target): boolean
Check if an effect is enabled.
Parameters
- target: EffectsTarget
Returns boolean
true if the filter is enabled
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:67

removeEffect

removeEffect(target): boolean
Parameters
- target: EffectsTarget
Returns boolean
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:78

setEnabled

setEnabled(target, enabled): boolean
Enable an effect.
Parameters
- target: EffectsTarget
- enabled: boolean
  Set to true to enable, false to disable
Returns boolean
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:72

updateBooleanParameter

updateBooleanParameter(parameterName, value): void
The function to be called to update a parameter (with a boolean)
Parameters
- parameterName: string
- value: boolean
Returns void
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:90

updateColorParameter

updateColorParameter(parameterName, value): void
Parameters
- parameterName: string
- value: number
Returns void
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:91

updateDoubleParameter

updateDoubleParameter(parameterName, value): void
The function to be called to update a parameter (with a number)
Parameters
- parameterName: string
- value: number
Returns void
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:82

updateFromNetworkSyncData

updateFromNetworkSyncData(syncData): void
Parameters
- syncData: any
Returns void
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:95

updatePreRender

updatePreRender(target): any
The function to be called to update the filter at every frame before the rendering.
Parameters
- target: EffectsTarget
Returns any
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:80

updateStringParameter

updateStringParameter(parameterName, value): void
The function to be called to update a parameter (with a string)
Parameters
- parameterName: string
- value: string
Returns void
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:88

Interface Filter

Implemented by

Index

Methods

Methods

applyEffect

Parameters

Returns boolean

getColorParameter

Parameters

Returns number

getDoubleParameter

Parameters

Returns number

getNetworkSyncData

Returns any

isEnabled

Parameters

Returns boolean

removeEffect

Parameters

Returns boolean

setEnabled

Parameters

Returns boolean

updateBooleanParameter

Parameters

Returns void

updateColorParameter

Parameters

Returns void

updateDoubleParameter

Parameters

Returns void

updateFromNetworkSyncData

Parameters

Returns void

updatePreRender

Parameters

Returns any

updateStringParameter

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page