decode.Class.GainMapLoader

@monogrid/gainmap-js / decode / GainMapLoader

Class: GainMapLoader

A Three.js Loader for the gain map format.

Example

import { GainMapLoader } from '@monogrid/gainmap-js'
import {
  EquirectangularReflectionMapping,
  LinearFilter,
  Mesh,
  MeshBasicMaterial,
  PerspectiveCamera,
  PlaneGeometry,
  Scene,
  WebGLRenderer
} from 'three'

const renderer = new WebGLRenderer()

const loader = new GainMapLoader(renderer)

const result = await loader.loadAsync(['sdr.jpeg', 'gainmap.jpeg', 'metadata.json'])
// `result` can be used to populate a Texture

const scene = new Scene()
const mesh = new Mesh(
  new PlaneGeometry(),
  new MeshBasicMaterial({ map: result.renderTarget.texture })
)
scene.add(mesh)
renderer.render(scene, new PerspectiveCamera())

// Starting from three.js r159
// `result.renderTarget.texture` can
// also be used as Equirectangular scene background
//
// it was previously needed to convert it
// to a DataTexture with `result.toDataTexture()`
scene.background = result.renderTarget.texture
scene.background.mapping = EquirectangularReflectionMapping

// result must be manually disposed
// when you are done using it
result.dispose()

Extends

• LoaderBase<[string, string, string]>

Constructors

new GainMapLoader()

new GainMapLoader(renderer?, manager?): GainMapLoader

Parameters

• renderer?: WebGLRenderer

• manager?: LoadingManager

Returns

GainMapLoader

Inherited from

LoaderBase<[string, string, string]>.constructor

Defined in

src/decode/loaders/LoaderBase.ts:34

Methods

load()

load(urls, onLoad?, onProgress?, onError?): QuadRenderer<1016, GainMapDecoderMaterial>

Loads a gainmap using separate data

• sdr image
• gain map image
• metadata json

useful for webp gain maps

Parameters

• urls: [string, string, string]

An array in the form of [sdr.jpg, gainmap.jpg, metadata.json]

• onLoad?

Load complete callback, will receive the result

• onProgress?

Progress callback, will receive a ProgressEvent

• onError?

Error callback

Returns

QuadRenderer<1016, GainMapDecoderMaterial>

Overrides

LoaderBase.load

Defined in

src/decode/loaders/GainMapLoader.ts:73

---

setRenderTargetOptions()

setRenderTargetOptions(options): GainMapLoader

Specify the renderTarget options to use when rendering the gain map

Parameters

• options: QuadRendererTextureOptions

Returns

GainMapLoader

Inherited from

LoaderBase.setRenderTargetOptions

Defined in

src/decode/loaders/LoaderBase.ts:57

---

setRenderer()

setRenderer(renderer): GainMapLoader

Specify the renderer to use when rendering the gain map

Parameters

• renderer: WebGLRenderer

Returns

GainMapLoader

Inherited from

LoaderBase.setRenderer

Defined in

src/decode/loaders/LoaderBase.ts:46