Class PixiFilterCreator`Abstract`

A wrapper allowing to create a PIXI filter and update it using a common interface

Implements

FilterCreator

Index

Constructors

Methods

getColorParameter getDoubleParameter getNetworkSyncData makeFilter makePIXIFilter updateBooleanParameter updateColorParameter updateDoubleParameter updateFromNetworkSyncData updatePreRender updateStringParameter

Constructors

constructor

new PixiFilterCreator(): PixiFilterCreator
Returns PixiFilterCreator

Methods

`Abstract` getColorParameter

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

`Abstract` getDoubleParameter

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

`Abstract` getNetworkSyncData

getNetworkSyncData(filter): any
Parameters
- filter: Filter
Returns any
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:149

makeFilter

makeFilter(target, effectData): Filter
Function to call to create the filter
Parameters
- target: EffectsTarget
- effectData: EffectData
Returns Filter
Implementation of FilterCreator.makeFilter
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:101

`Abstract` makePIXIFilter

makePIXIFilter(target, effectData): any
Function to call to create the filter
Parameters
- target: EffectsTarget
- effectData: EffectData
Returns any
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:109

`Abstract` updateBooleanParameter

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

`Abstract` updateColorParameter

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

`Abstract` updateDoubleParameter

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

`Abstract` updateFromNetworkSyncData

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

`Abstract` updatePreRender

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

`Abstract` updateStringParameter

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