@monogrid/gainmap-js / decode/webgpu / QuadRenderer

Defined in: src/decode/webgpu/core/QuadRenderer.ts:95

Utility class used for rendering a texture with a material (WebGPU version)

TType extends TextureDataType

TMaterial extends Material

new QuadRenderer<TType, TMaterial>(options): QuadRenderer<TType, TMaterial>

Defined in: src/decode/webgpu/core/QuadRenderer.ts:113

Constructs a new QuadRenderer

QuadRendererOptions<TType, TMaterial>

Parameters for this QuadRenderer

QuadRenderer<TType, TMaterial>

get colorSpace(): ColorSpace

Defined in: src/decode/webgpu/core/QuadRenderer.ts:336

ColorSpace

get height(): number

Defined in: src/decode/webgpu/core/QuadRenderer.ts:307

Height of the texture

number

set height(value): void

Defined in: src/decode/webgpu/core/QuadRenderer.ts:308

number

void

get material(): TMaterial

Defined in: src/decode/webgpu/core/QuadRenderer.ts:331

The Material used.

TMaterial

get renderer(): WebGPURenderer

Defined in: src/decode/webgpu/core/QuadRenderer.ts:316

The renderer used

WebGPURenderer

get renderTarget(): RenderTarget<Texture<unknown>>

Defined in: src/decode/webgpu/core/QuadRenderer.ts:321

The RenderTarget used.

RenderTarget<Texture<unknown>>

set renderTarget(value): void

Defined in: src/decode/webgpu/core/QuadRenderer.ts:322

RenderTarget

void

get type(): TType

Defined in: src/decode/webgpu/core/QuadRenderer.ts:335

TType

get width(): number

Defined in: src/decode/webgpu/core/QuadRenderer.ts:298

Width of the texture

number

set width(value): void

Defined in: src/decode/webgpu/core/QuadRenderer.ts:299

number

void

dispose(disposeRenderTarget?): void

Defined in: src/decode/webgpu/core/QuadRenderer.ts:274

Will dispose of all assets used by this renderer.

boolean

will dispose of the renderTarget which will not be usable later set this to true if you passed the renderTarget.texture to a PMREMGenerator or are otherwise done with it.

void

const loader = new HDRJPGLoader(renderer)
const result = await loader.loadAsync('gainmap.jpeg')
const mesh = new Mesh(geometry, new MeshBasicMaterial({ map: result.renderTarget.texture }) )
// DO NOT dispose the renderTarget here,
// it is used directly in the material
result.dispose()

const loader = new HDRJPGLoader(renderer)
const pmremGenerator = new PMREMGenerator( renderer );
const result = await loader.loadAsync('gainmap.jpeg')
const envMap = pmremGenerator.fromEquirectangular(result.renderTarget.texture)
const mesh = new Mesh(geometry, new MeshStandardMaterial({ envMap }) )
// renderTarget can be disposed here
// because it was used to generate a PMREM texture
result.dispose(true)

disposeOnDemandRenderer(): void

Defined in: src/decode/webgpu/core/QuadRenderer.ts:237

If using a disposable renderer, it will dispose it.

void

render(): Promise<void>

Defined in: src/decode/webgpu/core/QuadRenderer.ts:176

Renders the input texture using the specified material

Promise<void>

toArray(): Promise<TextureDataTypeToBufferType<TType>>

Defined in: src/decode/webgpu/core/QuadRenderer.ts:196

Obtains a Buffer containing the rendered texture.

Promise<TextureDataTypeToBufferType<TType>>

a TypedArray containing RGBA values from this renderer

Error if the browser cannot read pixels from this RenderTarget type.

toDataTexture(options?): Promise<DataTexture>

Defined in: src/decode/webgpu/core/QuadRenderer.ts:209

Performs a readPixel operation in the renderTarget and returns a DataTexture containing the read data

QuadRendererTextureOptions

options

Promise<DataTexture>

static instantiateRenderer(): WebGPURenderer

Defined in: src/decode/webgpu/core/QuadRenderer.ts:167

Instantiates a temporary renderer

WebGPURenderer