Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface defining initialization parameters for Engine class

Hierarchy

  • WebGLContextAttributes
    • EngineOptions

Index

Properties

adaptToDeviceRatio?: boolean

Defines whether to adapt to the device's viewport characteristics (default: false)

audioEngine?: boolean

Defines if webaudio should be initialized as well

see

https://doc.babylonjs.com/how_to/playing_sounds_and_music

audioEngineOptions?: IAudioEngineOptions

Specifies options for the audio engine

autoEnableWebVR?: boolean

Defines if webvr should be enabled automatically

see

https://doc.babylonjs.com/how_to/webvr_camera

deterministicLockstep?: boolean

Defines if animations should run using a deterministic lock step

see

https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep

disableWebGL2Support?: boolean

Defines if webgl2 should be turned off even if supported

see

https://doc.babylonjs.com/features/webgl2

doNotHandleContextLost?: boolean

Defines that engine should ignore context lost events If this event happens when this parameter is true, you will have to reload the page to restore rendering

doNotHandleTouchAction?: boolean

Defines that engine should ignore modifying touch action attribute and style If not handle, you might need to set it up on your side for expected touch devices behavior.

failIfMajorPerformanceCaveat?: boolean

Will prevent the system from falling back to software implementation if a hardware device cannot be created

forceSRGBBufferSupportState?: boolean

If sRGB Buffer support is not set during construction, use this value to force a specific state This is added due to an issue when processing textures in chrome/edge/firefox This will not influence NativeEngine and WebGPUEngine which set the behavior to true during construction.

limitDeviceRatio?: number

Defines if the engine should no exceed a specified device ratio

see

https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio

lockstepMaxSteps?: number

Defines the maximum steps to use with deterministic lock step mode

timeStep?: number

Defines the seconds between each deterministic lock step

useHighPrecisionFloats?: boolean

Defines that engine should compile shaders with high precision floats (if supported). True by default

useHighPrecisionMatrix?: boolean

Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default

xrCompatible?: boolean

Make the canvas XR Compatible for XR sessions

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme