Class SectionPlaneRenderer

Index

Constructors

Methods

destroy draw setPlaneColor

Constructors

constructor

new SectionPlaneRenderer(
    device: GPUDevice,
    format: GPUTextureFormat,
    sampleCount?: number,
): SectionPlaneRenderer
Parameters
- device: GPUDevice
- format: GPUTextureFormat
- OptionalsampleCount: number
Returns SectionPlaneRenderer

Methods

destroy

destroy(): void

Destroy all GPU resources held by this section-plane renderer. After calling this method the renderer is no longer usable. Safe to call multiple times.

Returns void

draw

draw(pass: GPURenderPassEncoder, options: SectionPlaneRenderOptions): void
Draw section plane into an existing render pass (preferred - avoids MSAA mismatch)
Parameters
- pass: GPURenderPassEncoder
- options: SectionPlaneRenderOptions
Returns void

setPlaneColor

setPlaneColor(color: readonly [number, number, number, number]): void
Set the accent tint used for the preview plane, every axis alike (#5484). RGBA 0..1.
Parameters
- color: readonly [number, number, number, number]
Returns void