Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StartupSettings

Interface for a configuration object containing the settings that need to be given before shader compilation.

The default values for StartupSettings can be found in defaultStartupSettings.

Hierarchy

  • StartupSettings

Index

Properties

backgroundColor

backgroundColor: vec3 | vec4

The default background color of the scene, can have transparency on every platform.

enableContextLostSimulator

enableContextLostSimulator: boolean

Many context lost event will be simulated when enabled.

Useful for testing.

enableStopwatch

enableStopwatch: boolean

Creates a stopwatch used for measuring the GPU render time when its required extension is available.

You should only have one renderer with enabled stopwatch.

ignoreWebGL2

ignoreWebGL2: boolean

When set to true, rendering will fall back to WebGL even when WebGL2 is present.

Useful for testing compatibility.

lightPenetrationRatio

lightPenetrationRatio: number

The illumination is multiplied by this constant where the distance field is negative (i.e. inside objects).

Should be between 0 and 1, but other values are also permitted.

paletteSize

paletteSize: number

Gives the number of possible object colors for the scene.

When using WebGL, only 256 different colors can be used. On WebGL2, its value should not be larger than 4096 for maintaining compatibility with low-end devices.

shadowTraceCount

shadowTraceCount: number

The raytracing algorithm used for shadows requires a step count. Sensible values for this are between 8 and 32.

The higher the number, the harder the shadows will get. Some ambient occlusion like effects can be visible on lower trace counts.