WebGPUEngineOptions | Babylon.js API documentation

Interface WebGPUEngineOptions

Options to create the WebGPU engine

interface WebGPUEngineOptions {
    adaptToDeviceRatio?: boolean;
    antialias?: boolean;
    audioEngine?: boolean;
    audioEngineOptions?: IAudioEngineOptions;
    deterministicLockstep?: boolean;
    deviceDescriptor?: GPUDeviceDescriptor;
    doNotHandleContextLost?: boolean;
    doNotHandleTouchAction?: boolean;
    enableAllFeatures?: boolean;
    enableGPUDebugMarkers?: boolean;
    featureLevel?: string;
    forceFallbackAdapter?: boolean;
    glslangOptions?: GlslangOptions;
    limitDeviceRatio?: number;
    lockstepMaxSteps?: number;
    powerPreference?: GPUPowerPreference;
    premultipliedAlpha?: boolean;
    setMaximumLimits?: boolean;
    stencil?: boolean;
    swapChainFormat?: GPUTextureFormat;
    timeStep?: number;
    twgslOptions?: TwgslOptions;
    useExactSrgbConversions?: boolean;
    useHighPrecisionMatrix?: boolean;
}

Hierarchy (View Summary)

AbstractEngineOptions
GPURequestAdapterOptions
- WebGPUEngineOptions

Properties

`Optional`adaptToDeviceRatio

adaptToDeviceRatio?: boolean

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

`Optional`antialias

antialias?: boolean

Defines whether MSAA is enabled on the canvas.

`Optional`audioEngine

audioEngine?: boolean

Defines if webaudio should be initialized as well

See

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

`Optional`audioEngineOptions

audioEngineOptions?: IAudioEngineOptions

Specifies options for the audio engine

`Optional`deterministicLockstep

deterministicLockstep?: boolean

Defines if animations should run using a deterministic lock step

See

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

`Optional`deviceDescriptor

deviceDescriptor?: GPUDeviceDescriptor

Defines the device descriptor used to create a device once we have retrieved an appropriate adapter

`Optional`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

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`enableAllFeatures

enableAllFeatures?: boolean

When requesting the device, enable all the features supported by the adapter. Default: false Note that this setting is ignored if you explicitely set deviceDescriptor.requiredFeatures

`Optional`enableGPUDebugMarkers

enableGPUDebugMarkers?: boolean

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

`Optional`featureLevel

featureLevel?: string

The featureLevel property of the GPURequestAdapterOptions interface

`Optional`forceFallbackAdapter

forceFallbackAdapter?: boolean

When set to true, indicates that only a fallback adapter may be returned when requesting an adapter. If the user agent does not support a fallback adapter, will cause requestAdapter() to resolve to null. Default: false

`Optional`glslangOptions

glslangOptions?: GlslangOptions

Options to load the associated Glslang library

`Optional`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

lockstepMaxSteps?: number

Defines the maximum steps to use with deterministic lock step mode

`Optional`powerPreference

powerPreference?: GPUPowerPreference

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

`Optional`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`setMaximumLimits

setMaximumLimits?: boolean

When requesting the device, set the required limits to the maximum possible values (the ones from adapter.limits). Default: false Note that this setting is ignored if you explicitely set deviceDescriptor.requiredLimits

`Optional`stencil

stencil?: boolean

Defines whether the stencil buffer should be enabled.

`Optional`swapChainFormat

swapChainFormat?: GPUTextureFormat

Defines the requested Swap Chain Format.

`Optional`timeStep

timeStep?: number

Defines the seconds between each deterministic lock step

`Optional`twgslOptions

twgslOptions?: TwgslOptions

Options to load the associated Twgsl library

`Optional`useExactSrgbConversions

useExactSrgbConversions?: boolean

True if the more expensive but exact conversions should be used for transforming colors to and from linear space within shaders. Otherwise, the default is to use a cheaper approximation.

`Optional`useHighPrecisionMatrix

useHighPrecisionMatrix?: boolean

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

Interface WebGPUEngineOptions

Hierarchy (View Summary)

Index

Properties

Properties

`Optional`adaptToDeviceRatio

`Optional`antialias

`Optional`audioEngine

See

`Optional`audioEngineOptions

`Optional`deterministicLockstep

See

`Optional`deviceDescriptor

`Optional`doNotHandleContextLost

`Optional`doNotHandleTouchAction

`Optional`enableAllFeatures

`Optional`enableGPUDebugMarkers

`Optional`featureLevel

`Optional`forceFallbackAdapter

`Optional`glslangOptions

`Optional`limitDeviceRatio

See

`Optional`lockstepMaxSteps

`Optional`powerPreference

`Optional`premultipliedAlpha

`Optional`setMaximumLimits

`Optional`stencil

`Optional`swapChainFormat

`Optional`timeStep

`Optional`twgslOptions

`Optional`useExactSrgbConversions

`Optional`useHighPrecisionMatrix

Settings

On This Page

Interface WebGPUEngineOptions

Hierarchy (View Summary)

Index

Properties

Properties

OptionaladaptToDeviceRatio

Optionalantialias

OptionalaudioEngine

See

OptionalaudioEngineOptions

OptionaldeterministicLockstep

See

OptionaldeviceDescriptor

OptionaldoNotHandleContextLost

OptionaldoNotHandleTouchAction

OptionalenableAllFeatures

OptionalenableGPUDebugMarkers

OptionalfeatureLevel

OptionalforceFallbackAdapter

OptionalglslangOptions

OptionallimitDeviceRatio

See

OptionallockstepMaxSteps

OptionalpowerPreference

OptionalpremultipliedAlpha

OptionalsetMaximumLimits

Optionalstencil

OptionalswapChainFormat

OptionaltimeStep

OptionaltwgslOptions

OptionaluseExactSrgbConversions

OptionaluseHighPrecisionMatrix

Settings

On This Page

`Optional`adaptToDeviceRatio

`Optional`antialias

`Optional`audioEngine

`Optional`audioEngineOptions

`Optional`deterministicLockstep

`Optional`deviceDescriptor

`Optional`doNotHandleContextLost

`Optional`doNotHandleTouchAction

`Optional`enableAllFeatures

`Optional`enableGPUDebugMarkers

`Optional`featureLevel

`Optional`forceFallbackAdapter

`Optional`glslangOptions

`Optional`limitDeviceRatio

`Optional`lockstepMaxSteps

`Optional`powerPreference

`Optional`premultipliedAlpha

`Optional`setMaximumLimits

`Optional`stencil

`Optional`swapChainFormat

`Optional`timeStep

`Optional`twgslOptions

`Optional`useExactSrgbConversions

`Optional`useHighPrecisionMatrix