API

Interface IThinGlowLayerOptions

Glow layer options. This helps customizing the behaviour of the glow layer.

interface IThinGlowLayerOptions {
    alphaBlendingMode?: number;
    blurKernelSize?: number;
    camera?: Nullable<Camera>;
    excludeByDefault?: boolean;
    ldrMerge?: boolean;
    mainTextureFixedSize?: number;
    mainTextureFormat?: number;
    mainTextureRatio?: number;
    mainTextureType?: number;
    renderingGroupId?: number;
}

Hierarchy (View Summary)

Index
alphaBlendingMode?: number

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

blurKernelSize?: number

How big is the kernel of the blur texture. Default: 32

camera?: Nullable<Camera>

The camera attached to the layer. Default: null

excludeByDefault?: boolean

Exclude all meshes from the glow layer by default. This is useful if you have dynamic meshes and you want to control them specifically and make sure that there are no "leaking" glowing meshes. Default: false

ldrMerge?: boolean

Forces the merge step to be done in ldr (clamp values > 1). Default: false

mainTextureFixedSize?: number

Enforces a fixed size texture to ensure resize independent blur. 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 glowing 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