Class EmptyFilter

Hierarchy

EmptyFilter

Implements

Filter

Index

Methods

Constructors

constructor

Methods

applyEffect

applyEffect(target: EffectsTarget): boolean

Implementation of Filter.applyEffect
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:281
Apply the effect on the PixiJS DisplayObject. Called after the effect is initialized.

Parameters
- target: EffectsTarget
Returns boolean

getColorParameter

getColorParameter(parameterName: string): number

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

getDoubleParameter

getDoubleParameter(parameterName: string): number

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

getNetworkSyncData

getNetworkSyncData(): any

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

isEnabled

isEnabled(target: EffectsTarget): boolean

Implementation of Filter.isEnabled
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:275
Check if an effect is enabled.

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

removeEffect

removeEffect(target: EffectsTarget): boolean

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

setEnabled

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

Implementation of Filter.setEnabled
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:278
Enable an effect.

Parameters
- target: EffectsTarget
- enabled: boolean
Returns boolean

updateBooleanParameter

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

Implementation of Filter.updateBooleanParameter
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:290
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

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

updateDoubleParameter

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

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

Parameters
- parameterName: string
- value: number
Returns void

updateFromNetworkSyncData

updateFromNetworkSyncData(syncData: any): void

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

updatePreRender

updatePreRender(target: EffectsTarget): any

Implementation of Filter.updatePreRender
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:287
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

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

Parameters
- parameterName: string
- value: string
Returns void

Constructors

constructor

new EmptyFilter(): EmptyFilter

Returns EmptyFilter

Generated using TypeDoc