Class PixiFilterCreator

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

Hierarchy

PixiFilterCreator

Implements

FilterCreator

Index

Constructors

constructor

Methods

Constructors

constructor

new PixiFilterCreator(): PixiFilterCreator

Returns PixiFilterCreator

Methods

Abstract getColorParameter

getColorParameter(filter: Filter, parameterName: string): number

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

Abstract getDoubleParameter

getDoubleParameter(filter: Filter, parameterName: string): number

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

Abstract getNetworkSyncData

getNetworkSyncData(filter: Filter): any

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:151
Parameters
- filter: Filter
Returns any

makeFilter

makeFilter(target: EffectsTarget, effectData: EffectData): Filter

Implementation of FilterCreator.makeFilter
- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:103
Function to call to create the filter

Parameters
- target: EffectsTarget
- effectData: EffectData
Returns Filter

Abstract makePIXIFilter

makePIXIFilter(target: EffectsTarget, effectData: EffectData): any

- Defined in GDJS/Runtime/pixi-renderers/pixi-filters-tools.ts:111
Function to call to create the filter

Parameters
- target: EffectsTarget
- effectData: EffectData
Returns any

Abstract updateBooleanParameter

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

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

Parameters
- filter: Filter
- parameterName: string
- value: boolean
Returns void

Abstract updateColorParameter

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

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

Abstract updateDoubleParameter

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

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

Parameters
- filter: Filter
- parameterName: string
- value: number
Returns void

Abstract updateFromNetworkSyncData

updateFromNetworkSyncData(filter: Filter, syncData: any): void

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

Abstract updatePreRender

updatePreRender(filter: Filter, target: EffectsTarget): any

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

Parameters
- filter: Filter
- target: EffectsTarget
Returns any

Abstract updateStringParameter

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

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

Parameters
- filter: Filter
- parameterName: string
- value: string
Returns void

Generated using TypeDoc