VolumePass

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

Methods

computeTiming

Decide whether the ray cast pass should render into a reduced viewport, based on the interactor's animation frame rate and the mappers' sample distance settings.

Argument	Type	Required	Description
viewNode	vtkWebGPURenderWindow	Yes

createClearEncoder

Create the encoder that clears the volume color texture before the first group of volumes is ray cast.

Argument	Type	Required	Description
viewNode	vtkWebGPURenderWindow	Yes

createCopyEncoder

Create the encoder that blends the volume color texture back into the render window's color attachment.

Argument	Type	Required	Description
viewNode	vtkWebGPURenderWindow	Yes

createDepthRangeEncoder

Create the encoder that renders the volume bounding boxes into the two min/max depth textures.

Argument	Type	Required	Description
viewNode	vtkWebGPURenderWindow	Yes

createMergeEncoder

Create the encoder that composites a later group of volumes onto the result of the previous groups.

Argument	Type	Required	Description
viewNode	vtkWebGPURenderWindow	Yes

drawDepthRange

Render the bounding box geometry to fill the min and max depth textures the ray cast pass samples between.

Argument	Type	Required	Description
renNode	vtkWebGPURenderer	Yes
viewNode	vtkWebGPURenderWindow	Yes

extend

Method used to decorate a given object (publicAPI+model) with vtkWebGPUVolumePass 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	IWebGPUVolumePassInitialValues	No	(default: {})

getColorTextureView

Get the color texture view this pass composites its result into.

getDepthTextureView

Get the depth texture view geometry has already been rendered into.

initialize

Create the encoders, textures and full screen quads this pass renders with. Anything already created is left alone.

Argument	Type	Required	Description
viewNode	vtkWebGPURenderWindow	Yes

newInstance

Method used to create a new instance of vtkWebGPUVolumePass.

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

rayCastPass

Ray cast one group of volumes into the volume color texture.

Argument	Type	Required	Description
viewNode	vtkWebGPURenderWindow	Yes
renNode	vtkWebGPURenderer	Yes
volumes	Array[vtkWebGPUVolume]	Yes	The group of volumes to render.

releaseGraphicsResources

Free the encoders, textures, quads and buffers this pass holds.

renderDepthBounds

Build the bounding box polydata, upload it and draw it through the depth range encoder.

Argument	Type	Required	Description
renNode	vtkWebGPURenderer	Yes
viewNode	vtkWebGPURenderWindow	Yes

setColorTextureView

Set the color texture view this pass composites its result into.

setDepthTextureView

Set the depth texture view geometry has already been rendered into.

setVolumes

Set the volumes this pass renders, marking the pass modified only when the list actually changed.

Argument	Type	Required	Description
val	Array[vtkWebGPUVolume]	Yes

traverse

Render the volumes of a renderer: depth bounds first, then one ray cast pass per group of volumes, then a copy back into the render window.

Argument	Type	Required	Description
renNode	vtkWebGPURenderer	Yes
viewNode	vtkWebGPURenderWindow	Yes

updateDepthPolyData

Rebuild the polydata holding one cube per volume, clipped against the camera near plane, in stabilized coordinates.

Argument	Type	Required	Description
renNode	vtkWebGPURenderer	Yes