Interface WebGPUEngineOptions
Hierarchy
-
GPURequestAdapterOptions
- WebGPUEngineOptions
Index
Properties
- adapt
ToDevice Ratio - antialiasing
- audio
Engine - deterministic
Lockstep - device
Descriptor - disable
Copy For InvertYFinal Framebuffer - do
Not Handle Context Lost - do
Not Handle Touch Action - enableGPUDebug
Markers - force
Copy For InvertYFinal Framebuffer - force
Fallback Adapter - glslang
Options - limit
Device Ratio - lockstep
Max Steps - power
Preference - premultiplied
Alpha - stencil
- swap
Chain Format - time
Step - twgsl
Options
Properties
Optional adapt ToDevice RatioSearch playground for adaptToDeviceRatio
Defines whether to adapt to the device's viewport characteristics (default: false)
Optional antialiasingSearch playground for antialiasing
Defines whether MSAA is enabled on the canvas.
Optional audio EngineSearch playground for audioEngine
Defines if webaudio should be initialized as well
Optional deterministic LockstepSearch playground for deterministicLockstep
If delta time between frames should be constant
Optional device DescriptorSearch playground for deviceDescriptor
Defines the device descriptor used to create a device.
Optional disable Copy For InvertYFinal FramebufferSearch playground for disableCopyForInvertYFinalFramebuffer
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 do Not Handle Context LostSearch playground for doNotHandleContextLost
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 do Not Handle Touch ActionSearch playground for doNotHandleTouchAction
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 enableGPUDebug MarkersSearch playground for enableGPUDebugMarkers
Defines whether we should generate debug markers in the gpu command lists (can be seen with PIX for eg)
Optional force Copy For InvertYFinal FramebufferSearch playground for forceCopyForInvertYFinalFramebuffer
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 force Fallback AdapterSearch playground for forceFallbackAdapter
Optional glslang OptionsSearch playground for glslangOptions
Options to load the associated Glslang library
Optional limit Device RatioSearch playground for limitDeviceRatio
Defines if the engine should no exceed a specified device ratio
Optional lockstep Max StepsSearch playground for lockstepMaxSteps
Maximum about of steps between frames (Default: 4)
Optional power PreferenceSearch playground for powerPreference
Defines the category of adapter to use. Is it the discrete or integrated device.
Optional premultiplied AlphaSearch playground for premultipliedAlpha
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
Defines whether the stencil buffer should be enabled.
Optional swap Chain FormatSearch playground for swapChainFormat
Defines the requested Swap Chain Format.
Optional time StepSearch playground for timeStep
Defines the seconds between each deterministic lock step
Optional twgsl OptionsSearch playground for twgslOptions
Options to load the associated Twgsl library
Options to create the WebGPU engine