Skybox

Source (.js)Source (.d.ts)

Introduction

The WebGPU backend view node for a vtkSkybox.

Methods

buildPass

Builds myself: resolve the renderer and render window and find the view node of the renderer's active camera.

Argument	Type	Required	Description
prepass		Yes

ensureQuad

Create the full screen quad, its uniform buffer and its shader replacements, if they do not exist yet.

Argument	Type	Required	Description
device	vtkWebGPUDevice	Yes

extend

Method used to decorate a given object (publicAPI+model) with vtkWebGPUSkybox characteristics.

Argument	Type	Required	Description
publicAPI		Yes	object on which methods will be bounds (public)
model		Yes	object on which data structure will be bounds (protected)
initialValues	IWebGPUSkyboxInitialValues	No	(default: {})

getCubeTexture

Get, or build and cache on the device, the cube map texture for the given vtkTexture.

Argument	Type	Required	Description
device	vtkWebGPUDevice	Yes
texture	vtkTexture	Yes

getCubeTextureHash

The cache key of the cube map built from the six inputs of the given texture, or null when one of them is missing.

Argument	Type	Required	Description
texture	vtkTexture	Yes

getTexture

The first texture of the renderable, if any.

newInstance

Method used to create a new instance of vtkWebGPUSkybox.

Argument	Type	Required	Description
initialValues	IWebGPUSkyboxInitialValues	No	for pre-setting some of its content

opaquePass

Renders myself: draw the full screen quad with the skybox shader for the renderable's format.

Argument	Type	Required	Description
prepass		Yes

queryPass

Argument	Type	Required	Description
prepass		Yes
renderPass	vtkRenderPass	Yes

releaseGraphicsResources

Drop the quad, the uniform buffer and the cached texture views.

updateTexture

Bind the texture view matching the renderable's format to the quad. Returns false when no texture is ready to be drawn.

Argument	Type	Required	Description
device	vtkWebGPUDevice	Yes

updateUBO

Update and send the mapper uniform buffer holding the inverse projection matrix and the stabilized camera position.

Argument	Type	Required	Description
device	vtkWebGPUDevice	Yes