Interface RendererMainSettings

Remarks

This is used to render the scene graph. If not provided, a new canvas element will be created and appended to the target element.

Remarks

This is used to determine if and which version of the createImageBitmap API is supported by the runtime. This is used to determine if the renderer can use createImageBitmap to load images.

Options supported

• Auto - Automatically determine the supported version
• Basic - Supports createImageBitmap(image)
• Options - Supports createImageBitmap(image, options)
• Full - Supports createImageBitmap(image, sx, sy, sw, sh, options)

Note with auto detection, the renderer will attempt to use the most advanced version of the API available. If the API is not available, the renderer will fall back to the next available version.

This will affect startup performance as the renderer will need to determine the supported version of the API.

Remarks

This value allows auto-scaling to support larger/small resolutions than the app was authored for.

If the app was authored for 1920x1080 and this value is 2, the app's canvas will be rendered at 3840x2160 logical pixels.

Likewise, if the app was authored for 1920x1080 and this value is 0.66667, the app's canvas will be rendered at 1280x720 logical pixels.

Remarks

This value allows auto-scaling to support devices with different pixel densities.

This controls the number of physical pixels that are used to render each logical pixel. For example, if the device has a pixel density of 2, each logical pixel will be rendered using 2x2 physical pixels.

By default, it will be set to window.devicePixelRatio which is the pixel density of the device the app is running on reported by the browser.

Remarks

When enabled the number of calls to each context method over the fpsUpdateInterval will be included in the FPS update payload's contextSpyData property.

Enabling the context spy has a serious impact on performance so only use it when you need to extract context call information.

Remarks

The font engines to use for text rendering. CanvasTextRenderer is supported on all platforms. SdfTextRenderer is a more performant renderer. When using renderEngine=CanvasCoreRenderer you can only use CanvasTextRenderer. The renderEngine=WebGLCoreRenderer supports both CanvasTextRenderer and SdfTextRenderer.

This setting is used to enable tree shaking of unused font engines. Please import your font engine(s) as follows:

import { CanvasTextRenderer } from '@lightning/renderer/canvas';
import { SdfTextRenderer } from '@lightning/renderer/webgl';
Copy

If both CanvasTextRenderer and SdfTextRenderer are provided, the first renderer provided will be asked first if it can render the font. If it cannot render the font, the next renderer will be asked. If no renderer can render the font, the text will not be rendered.

Note that if you have fonts available in both engines the second font engine will not be used. This is because the first font engine will always be asked first.

Remarks

Force the renderer to use WebGL2. This can be used to force the renderer to use WebGL2 even if the browser supports WebGL1.

Remarks

If set to 0, FPS updates will be disabled.

Remarks

The inspector will replicate the state of the Nodes created in the renderer and allow inspection of the state of the nodes.

Remarks

On devices with multiple cores, this can be used to improve image loading as well as reduce the impact of image loading on the main thread. Set to 0 to disable image workers.

Remarks

By default the Lightning 3 renderer will load a webplatform, assuming it runs inside a web browsr. However for special cases there might be a need to provide an abstracted platform layer to run on non-web or non-standard JS engines

Remarks

The renderer engine to use. Spawns a WebGL or Canvas renderer. WebGL is more performant and supports more features. Canvas is supported on most platforms.

Note: When using CanvasCoreRenderer you can only use CanvasTextRenderer. The WebGLCoreRenderer supports both CanvasTextRenderer and SdfTextRenderer for Text Rendering.

Remarks

Enable strict bounds for the renderer. This will ensure that the renderer will not render outside the bounds of the canvas.

Remarks

The maximum amount of time the renderer is allowed to process textures in a single frame. If the processing time exceeds this limit, the renderer will skip processing the remaining textures and continue rendering the frame.