Interface Options

Options used to configure the Lightning Stage

Remarks

See the Runtime Configuration for more information.

interface Options {
    autostart: boolean;
    bufferMemory: number;
    canvas: null | HTMLCanvasElement;
    canvas2d: boolean;
    clearColor: null | number | RGBA;
    context: null | CanvasRenderingContext2D | WebGLRenderingContext;
    debugFrame: boolean;
    defaultFontFace: string;
    devicePixelRatio: number;
    fixedDt: number;
    fontSharp: boolean | { fontSize: number; precision: number };
    forceTxCanvasSource: boolean;
    h: number;
    memoryPressure: number;
    pauseRafLoopOnIdle: boolean;
    platform: null | typeof WebPlatform;
    precision: number;
    readPixelsAfterDraw: boolean;
    readPixelsAfterDrawThreshold: number;
    readPixelsBeforeDraw: boolean;
    srcBasePath: null | string;
    textRenderIssueMargin: number;
    useImageWorker: boolean;
    w: number;
}

Properties

autostart bufferMemory canvas canvas2d clearColor context debugFrame defaultFontFace devicePixelRatio fixedDt fontSharp forceTxCanvasSource h memoryPressure pauseRafLoopOnIdle platform precision readPixelsAfterDraw readPixelsAfterDrawThreshold readPixelsBeforeDraw srcBasePath textRenderIssueMargin useImageWorker w

Properties

autostart

autostart: boolean

If set to false, no automatic binding to requestAnimationFrame

Default Value

true

bufferMemory

bufferMemory: number

Memory size of quad buffer (in bytes)

Default Value

2e6

canvas

canvas: null | HTMLCanvasElement

If specified, an existing Canvas to be used for rendering by Lightning

Default Value

null (create new canvas)

canvas2d

canvas2d: boolean

If set to true, the Lightning uses a canvas2d instead of WebGL for rendering.

Remarks

See Runtime Config - Limitations of Canvas2D for information about the limitations of using Canvas2D.

Default Value

false

clearColor

clearColor: null | number | RGBA

Color to clear the Stage with before each frame

Remarks

Value can be one of 3 types:

  • number representing an ARGB color (i.e. 0xfffefdfc)
  • RGBA color array tuple
  • null
    • Causes the stage buffer to not be cleared before each frame

Default Value

[0, 0, 0, 0] (transparent)

context

context: null | CanvasRenderingContext2D | WebGLRenderingContext

If specified, an existing WebGL / Canvas2D context to be used

Default Value

null (create a new context)

debugFrame

debugFrame: boolean

If set to true, logs debug information about each frame including how many render-to-texture elements were re-rendered.

Remarks

This may impact performance and should not be turned on in production.

Default Value

false

defaultFontFace

defaultFontFace: string

Default font family to use for text

Remarks

See TextTexture.Settings.fontFace for how this value ends up being used.

The special CSS defined font family values of "serif" and "sans-serif" may be used as well.

Default Value

'sans-serif'

devicePixelRatio

devicePixelRatio: number

The Device Pixel Ratio (DPR) affects how touch events are registered and handled on a device, including the conversion of physical pixel coordinates to logical pixel coordinates and the adjustment of element size and layout based on the device's pixel density.

Default Value

1

fixedDt

fixedDt: number

Use fixed time step per frame (in ms)

Default Value

0 (use auto dt)

fontSharp

fontSharp: boolean | { fontSize: number; precision: number }

FontSharp settings

Remarks

See Runtime Config - FontSharp for more information.

Default Value

{precision:0.6666666667, fontSize: 24}

forceTxCanvasSource

forceTxCanvasSource: boolean

If set to true, forces the Render Engine to use the canvasSource over getImageData for text

Remarks

This helps with text generation on certain devices.

See PR #393 for more information about this option.

Default Value

false

h

h: number

Height of the rendered Stage

Default Value

1080

memoryPressure

memoryPressure: number

Maximum GPU memory usage in pixels

Remarks

See Runtime Config - GPU Memory Tweak for more information.

Default Value

24e6

pauseRafLoopOnIdle

pauseRafLoopOnIdle: boolean

If set to true, will stop the Render Engine from calling RequestAnimationFrame when there are no stage updates.

Remarks

See Issue #380 for more information about this option.

Default Value

false

platform

platform: null | typeof WebPlatform

Set an alternative platform class type

Default Value

null (WebPlatform will be used)

precision

precision: number

Global stage scaling

Remarks

See Runtime Config - Downscaling for more information.

Default Value

1

readPixelsAfterDraw

readPixelsAfterDraw: boolean

If set to true, forces the Render Engine to readPixels after drawing, turning the Render pipeline synchronous.

Remarks

This option helps with flickering artifacts on certain devices.

Note: This will affect performance!

You may set readPixelsAfterDrawThreshold to control the number of render-to-texture element re-renders that trigger the syncronous pipeline.

See PR #393 for more information about this option.

Default Value

false

See

readPixelsBeforeDraw

readPixelsAfterDrawThreshold

readPixelsAfterDrawThreshold: number

If readPixelsAfterDraw is set to true, this is the number of render-to-texture element re-renders in a frame that will trigger the synchronous Render pipeline.

Remarks

This can enable full performance on frames that would not normally suffer from the flickering artifacts exhibited on certain devices.

Default Value

0

readPixelsBeforeDraw

readPixelsBeforeDraw: boolean

If set to true, forces the Render Engine to readPixels before drawing, turning the Render pipeline synchronous.

Remarks

This option helps with flickering artifacts on certain devices.

Note: This will affect performance!

Default Value

false

See

readPixelsAfterDraw

srcBasePath

srcBasePath: null | string

Base path used by the ImageTexture

Default Value

null

textRenderIssueMargin

textRenderIssueMargin: number

Number of additional pixels to add to the width of every text texture

Remarks

WARNING: This can distort text.

Default Value

0

useImageWorker

useImageWorker: boolean

Use image web workers, if web works are supported on the platform, for fetching and processing images off-thread (web only)

Default Value

true

w

w: number

Width of the rendered Stage

Default Value

1920

Settings

Member Visibility

On This Page

Properties