Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebGPUEngineOptions

Options to create the WebGPU engine

Hierarchy

Index

Properties

Optional adaptToDeviceRatioSearch playground for adaptToDeviceRatio

adaptToDeviceRatio: boolean

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

Optional antialiasingSearch playground for antialiasing

antialiasing: boolean

Defines whether MSAA is enabled on the canvas.

Optional audioEngineSearch playground for audioEngine

audioEngine: boolean

Defines if webaudio should be initialized as well

see

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

Optional deterministicLockstepSearch playground for deterministicLockstep

deterministicLockstep: boolean

If delta time between frames should be constant

see

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

Optional deviceDescriptorSearch playground for deviceDescriptor

deviceDescriptor: GPUDeviceDescriptor

Defines the device descriptor used to create a device.

Optional disableCopyForInvertYFinalFramebufferSearch playground for disableCopyForInvertYFinalFramebuffer

disableCopyForInvertYFinalFramebuffer: boolean

Defines if the final copy pass doing the Y inversion should be disabled (default: false). This setting takes precedence over forceCopyForInvertYFinalFramebuffer. If true and if using an offscreen canvas, you should set something like canvas.style.transform = "scaleY(-1)" on the canvas from which you get the offscreen canvas, else the rendering will be Y inverted! Setting it to true allows to use the browser compositing to perform the Y inversion even when using an offscreen canvas, which leads to better performances

Optional doNotHandleContextLostSearch 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 doNotHandleTouchActionSearch 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 enableGPUDebugMarkersSearch 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 forceCopyForInvertYFinalFramebufferSearch playground for forceCopyForInvertYFinalFramebuffer

forceCopyForInvertYFinalFramebuffer: boolean

Defines if the final framebuffer Y inversion should always be done by a texture copy (default: false). If false (and if not using an offscreen canvas), the inversion will be done by the browser during compositing

Optional glslangOptionsSearch playground for glslangOptions

glslangOptions: GlslangOptions

Options to load the associated Glslang library

Optional limitDeviceRatioSearch 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 lockstepMaxStepsSearch playground for lockstepMaxSteps

lockstepMaxSteps: number

Maximum about of steps between frames (Default: 4)

see

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

Optional powerPreferenceSearch playground for powerPreference

powerPreference: GPUPowerPreference

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

Optional premultipliedAlphaSearch 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 stencilSearch playground for stencil

stencil: boolean

Defines whether the stencil buffer should be enabled.

Optional swapChainFormatSearch playground for swapChainFormat

swapChainFormat: GPUTextureFormat

Defines the requested Swap Chain Format.

Optional timeStepSearch playground for timeStep

timeStep: number

Defines the seconds between each deterministic lock step

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method