Skip to content

Type alias: CanvasConfig

Ƭ CanvasConfig: Object

config data for canvas

Type declaration

NameTypeDescription
canvas?HTMLCanvasElementreference of canvas
alpha?booleanwheter use transparent background To set a transparent background, the SkyRendererSkyRenderer component should be disabled skyRender.enable = false
zIndex?numbercanvas styler zIndex
devicePixelRatio?numbercanvas pixel ratio use window.devicePixelRatio is not provided
backgroundImage?stringcanvas background image a canvas background when skybox is hide/disabled and CanvasConfig.alpha is true

Defined in

src/gfx/graphics/webGpu/CanvasConfig.ts:6