Class SymbolicTextPipeline

Index

Constructors

Methods

destroy getAtlas hasGeometry render upload

Constructors

constructor

new SymbolicTextPipeline(
    device: GPUDevice,
    presentationFormat: GPUTextureFormat,
    sampleCount?: number,
    atlas?: SymbolicTextAtlas,
): SymbolicTextPipeline
Parameters
- device: GPUDevice
- presentationFormat: GPUTextureFormat
- OptionalsampleCount: number
- Optionalatlas: SymbolicTextAtlas
Returns SymbolicTextPipeline

Methods

destroy

destroy(): void

Returns void

getAtlas

getAtlas(): SymbolicTextAtlas

Expose the atlas so the upload pre-warms glyphs before instance encoding.

Returns SymbolicTextAtlas

hasGeometry

hasGeometry(): boolean

Returns boolean

render

render(
    pass: GPURenderPassEncoder,
    viewProj: Float32Array,
    viewportPxWidth: number,
    viewportPxHeight: number,
    cameraRight: readonly [number, number, number],
    cameraUp: readonly [number, number, number],
    targetGlyphPx?: number,
    rteViewProj?: Float32Array<ArrayBufferLike>,
    rteCamera?: readonly [number, number, number],
): void
Parameters
- pass: GPURenderPassEncoder
- viewProj: Float32Array
- viewportPxWidth: number
- viewportPxHeight: number
- cameraRight: readonly [number, number, number]
- cameraUp: readonly [number, number, number]
- OptionaltargetGlyphPx: number
- OptionalrteViewProj: Float32Array<ArrayBufferLike>
- OptionalrteCamera: readonly [number, number, number]
Returns void

upload

upload(texts: readonly SymbolicTextInput[]): void
Lay out the given text labels into the atlas, encode an instance buffer, and upload to the GPU. Pass an empty array to clear.
Parameters
- texts: readonly SymbolicTextInput[]
Returns void