Interface EffectHandler

interface EffectHandler {
    enableEffect(name, enable): void;
    isEffectEnabled(name): boolean;
    setEffectBooleanParameter(name, parameterName, value): boolean;
    setEffectDoubleParameter(name, parameterName, value): boolean;
    setEffectStringParameter(name, parameterName, value): boolean;
}

Implemented by

Methods

enableEffect isEffectEnabled setEffectBooleanParameter setEffectDoubleParameter setEffectStringParameter

Methods

enableEffect

isEffectEnabled

setEffectBooleanParameter

  • setEffectBooleanParameter(name, parameterName, value): boolean

  • Change an effect property value (for properties that are booleans).

    Parameters

    • name: string

      The name of the effect to update.

    • parameterName: string

      The name of the property to update.

    • value: boolean

      The new value (boolean).

    Returns boolean

setEffectDoubleParameter

  • setEffectDoubleParameter(name, parameterName, value): boolean

  • Change an effect property value (for properties that are numbers).

    Parameters

    • name: string

      The name of the effect to update.

    • parameterName: string

      The name of the property to update.

    • value: number

      The new value (number).

    Returns boolean

setEffectStringParameter

  • setEffectStringParameter(name, parameterName, value): boolean

  • Change an effect property value (for properties that are strings).

    Parameters

    • name: string

      The name of the effect to update.

    • parameterName: string

      The name of the property to update.

    • value: string

      The new value (string).

    Returns boolean

Settings

Member Visibility

Theme

On This Page

enableEffectisEffectEnabledsetEffectBooleanParametersetEffectDoubleParametersetEffectStringParameter