Babylon.js API documentation|

WebGPUEngineOptions

Interface WebGPUEngineOptions

Options to create the WebGPU engine

Hierarchy

GPURequestAdapterOptions
- WebGPUEngineOptions

Index

Properties

Properties

Optional adaptToDeviceRatio Search playground for adaptToDeviceRatio

adaptToDeviceRatio?: boolean

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

Optional antialiasing Search playground for antialiasing

antialiasing?: boolean

Defines whether MSAA is enabled on the canvas.

Optional audioEngine Search playground for audioEngine

audioEngine?: boolean

Defines if webaudio should be initialized as well

see: https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic

Optional deterministicLockstep Search playground for deterministicLockstep

deterministicLockstep?: boolean

If delta time between frames should be constant

see: https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep

Optional deviceDescriptor Search playground for deviceDescriptor

deviceDescriptor?: GPUDeviceDescriptor

Defines the device descriptor used to create a device.

Optional doNotHandleContextLost Search playground for doNotHandleContextLost

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

Optional doNotHandleTouchAction Search playground for doNotHandleTouchAction

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.

Optional enableGPUDebugMarkers Search playground for enableGPUDebugMarkers

enableGPUDebugMarkers?: boolean

Defines whether we should generate debug markers in the gpu command lists (can be seen with PIX for eg)

Optional forceFallbackAdapter Search playground for forceFallbackAdapter

forceFallbackAdapter?: boolean

Optional glslangOptions Search playground for glslangOptions

glslangOptions?: GlslangOptions

Options to load the associated Glslang library

Optional limitDeviceRatio Search playground for limitDeviceRatio

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

Optional lockstepMaxSteps Search playground for lockstepMaxSteps

lockstepMaxSteps?: number

Maximum about of steps between frames (Default: 4)

see: https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep

Optional powerPreference Search playground for powerPreference

powerPreference?: GPUPowerPreference

Defines the category of adapter to use. Is it the discrete or integrated device.

Optional premultipliedAlpha Search playground for premultipliedAlpha

premultipliedAlpha?: boolean

Defines whether the canvas should be created in "premultiplied" mode (if false, the canvas is created in the "opaque" mode) (true by default)

Optional stencil Search playground for stencil

stencil?: boolean

Defines whether the stencil buffer should be enabled.

Optional swapChainFormat Search playground for swapChainFormat

swapChainFormat?: GPUTextureFormat

Defines the requested Swap Chain Format.

Optional timeStep Search playground for timeStep

timeStep?: number

Defines the seconds between each deterministic lock step

Optional twgslOptions Search playground for twgslOptions

twgslOptions?: TwgslOptions

Options to load the associated Twgsl library

Optional useHighPrecisionMatrix Search playground for useHighPrecisionMatrix

useHighPrecisionMatrix?: boolean

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