FilterEffectOptions

Filter effect options.

export class FilterEffectOptions {
  path?: string;
  strength?: number;
}

Properties

path

Local absolute path to the 3D cube map file used to implement custom filter effects. The referenced .cube file must strictly follow the Cube LUT (Lookup Table) specification, otherwise the filter effect will not take effect. Example of a .cube file:

LUT_3D_SIZE 32
0.0039215689 0 0.0039215682
0.0086021447 0.0037950677 0
...
0.0728652592 0.0039215689 0

Note:

The LUT_3D_SIZE identifier in the first line of the cube map file indicates the size of the 3D lookup table. Currently, only LUT size 32 is supported.
The SDK provides a built-in built_in_whiten_filter.cube file. Passing the absolute path of this file enables a whitening filter effect.

strength

Strength of the filter effect, ranging from [0.0,1.0], where 0.0 means no filter effect. The default value is 0.5. The higher the value, the stronger the filter effect.