Interface RendererRuntimeSettings

Settings for the Renderer that can be updated during runtime.

interface RendererRuntimeSettings {
    appHeight: number;
    appWidth: number;
    boundsMargin: number | [number, number, number, number];
    clearColor: number;
    deviceLogicalPixelRatio: number;
    devicePhysicalPixelRatio: number;
    fpsUpdateInterval: number;
    inspector: false | typeof Inspector;
    textureMemory: Partial<TextureMemoryManagerSettings>;
    textureProcessingTimeLimit: number;
}

Properties

appHeight appWidth boundsMargin clearColor deviceLogicalPixelRatio devicePhysicalPixelRatio fpsUpdateInterval inspector textureMemory textureProcessingTimeLimit

Properties

appHeight

appHeight: number

Authored logical pixel height of the application

Default Value

1080

appWidth

appWidth: number

Authored logical pixel width of the application

Default Value

1920

boundsMargin

boundsMargin: number | [number, number, number, number]

Bounds margin to extend the boundary in which a Node is added as Quad.

clearColor

clearColor: number

RGBA encoded number of the background to use

Default Value

0x00000000

deviceLogicalPixelRatio

deviceLogicalPixelRatio: number

Factor to convert app-authored logical coorindates to device logical coordinates

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.

Default Value

1

devicePhysicalPixelRatio

devicePhysicalPixelRatio: number

Factor to convert device logical coordinates to device physical coordinates

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.

Default Value

window.devicePixelRatio

fpsUpdateInterval

fpsUpdateInterval: number

Interval in milliseconds to receive FPS updates

Remarks

If set to 0, FPS updates will be disabled.

Default Value

0 (disabled)

inspector

inspector: false | typeof Inspector

DOM Inspector

Remarks

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

textureMemory

textureMemory: Partial<TextureMemoryManagerSettings>

Texture Memory Manager Settings

textureProcessingTimeLimit

textureProcessingTimeLimit: number

Texture Processing Limit (in milliseconds)

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.

Default Value

10

Settings

Member Visibility

On This Page

Properties