Interface IEffectLayerOptions

Effect layer options. This helps customizing the behaviour of the effect layer.

interface IEffectLayerOptions {
    alphaBlendingMode: number;
    camera: Nullable<Camera>;
    generateStencilBuffer: boolean;
    mainTextureFixedSize?: number;
    mainTextureFormat: number;
    mainTextureRatio: number;
    mainTextureType: number;
    renderingGroupId: number;
}

Properties

alphaBlendingMode: number

Alpha blending mode used to apply the blur. Default depends of the implementation. Default: ALPHA_COMBINE

The camera attached to the layer. Default: null

generateStencilBuffer: boolean

Whether or not to generate a stencil buffer. Default: false

mainTextureFixedSize?: number

Enforces a fixed size texture to ensure effect stability across devices. Default: undefined

mainTextureFormat: number

The format of the main texture. Default: TEXTUREFORMAT_RGBA

mainTextureRatio: number

Multiplication factor apply to the canvas size to compute the render target size used to generated the objects (the smaller the faster). Default: 0.5

mainTextureType: number

The type of the main texture. Default: TEXTURETYPE_UNSIGNED_BYTE

renderingGroupId: number

The rendering group to draw the layer in. Default: -1