ImageMapper

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

Methods

buildPass

Resolve the ancestors this mapper renders with and, when the renderable slices at the focal point, move its slice to the active camera.

Argument	Type	Required	Description
prepass	Boolean	Yes	Whether the traversal is on its way down.

computeImageState

Compute how the image scalars map onto the texture channels from the property and the image texture currently bound.

ensureTextureSampler

Give the texture view a sampler matching the given options, unless the sampler it already has matches them.

Argument	Type	Required	Description
textureView	vtkWebGPUTextureView	Yes
options	GPUSamplerDescriptor	Yes

extend

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

getCoincidentParameters

Get the polygon offset the renderable asks for, or a zero offset when it does not resolve coincident topology with a polygon offset.

getImageState

Get the image state computed by the last updateBuffers, recomputing it when the buffers have not been updated yet.

newInstance

Method used to create a new instance of vtkWebGPUImageMapper.

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

opaquePass

Render the slice during the opaque pass.

Argument	Type	Required	Description
prepass	Boolean	Yes	Whether the traversal is on its way down.

opaqueZBufferPass

Capture the slice depth during the opaque z-buffer pass.

Argument	Type	Required	Description
prepass	Boolean	Yes	Whether the traversal is on its way down.

render

Render the slice.

replaceShaderClip

Shader replacement, registered under replaceShaderClip, emitting the clipping plane test in stabilized coordinates.

Argument	Type	Required	Description
hash	String	Yes	the pipeline hash
pipeline	vtkWebGPUPipeline	Yes
vertexInput	vtkWebGPUVertexInput	Yes

replaceShaderCoincidentOffset

Shader replacement, registered under replaceShaderCoincidentOffset, emitting the depth offset the renderable's coincident topology resolution asks for.

Argument	Type	Required	Description
hash	String	Yes	the pipeline hash
pipeline	vtkWebGPUPipeline	Yes
vertexInput	vtkWebGPUVertexInput	Yes

replaceShaderImage

Shader replacement, registered under replaceShaderImage, emitting the texture declarations, the transfer function lookups and, for label maps, the label outline code.

Argument	Type	Required	Description
hash	String	Yes	the pipeline hash
pipeline	vtkWebGPUPipeline	Yes
vertexInput	vtkWebGPUVertexInput	Yes

replaceShaderSelect

Shader replacement, registered under replaceShaderSelect, emitting the composite and attribute identifiers the hardware selector reads.

Argument	Type	Required	Description
hash	String	Yes	the pipeline hash
pipeline	vtkWebGPUPipeline	Yes
vertexInput	vtkWebGPUVertexInput	Yes

translucentPass

Render the slice during the translucent pass.

Argument	Type	Required	Description
prepass	Boolean	Yes	Whether the traversal is on its way down.

updateLUTImage

Build or reuse the texture holding the sampled color transfer functions.

updateLabelOutlineOpacityTexture

Build or reuse the texture holding the per-label outline opacities.

updateLabelOutlineThicknessTexture

Build or reuse the texture holding the per-label outline thicknesses.

updateOpacityLUTImage

Build or reuse the texture holding the sampled piecewise opacity functions.

updateUBO

Recompute and send the mapper uniform buffer when the renderable, the property or the clipping planes changed.

useImageMipmaps

Whether the current image can use mipmaps for minification.

zBufferPass

Render the slice depth only, so that a later pass can mix geometry with volumes.

Argument	Type	Required	Description
prepass	Boolean	Yes	Whether the traversal is on its way down.