Class EmptyFilter

An effect.

Implements

Filter

Index

Constructors

Methods

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

Constructors

constructor

new EmptyFilter(): EmptyFilter
Returns EmptyFilter

Methods

applyEffect

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

getColorParameter

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

getDoubleParameter

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

getNetworkSyncData

getNetworkSyncData(): any
Returns any
Implementation of Filter.getNetworkSyncData
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:296

isEnabled

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

removeEffect

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

setEnabled

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

updateBooleanParameter

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

updateColorParameter

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

updateDoubleParameter

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

updateFromNetworkSyncData

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

updatePreRender

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

updateStringParameter

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