@monogrid/gainmap-js / decode / HDRJPGLoader

Defined in: src/decode/webgl/loaders/HDRJPGLoader.ts:59

A Three.js Loader for a JPEG with embedded gainmap metadata.

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

const renderer = new WebGLRenderer()

const loader = new HDRJPGLoader(renderer)
  .setRenderTargetOptions({ mapping: EquirectangularReflectionMapping })

const result = await loader.loadAsync('gainmap.jpeg')
// `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

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

• LoaderBaseWebGL<string>

new HDRJPGLoader(renderer?, manager?): HDRJPGLoader

Defined in: src/decode/webgl/loaders/LoaderBaseWebGL.ts:17

WebGLRenderer

LoadingManager

HDRJPGLoader

LoaderBaseWebGL<string>.constructor

protected _config: LoaderBaseConfig<WebGLRenderer, QuadRenderer<1016, GainMapDecoderMaterial>, GainMapDecoderMaterial>

Defined in: src/decode/shared/Loader.ts:45

LoaderBaseWebGL._config

protected _internalLoadingManager: LoadingManager

Defined in: src/decode/shared/Loader.ts:44

LoaderBaseWebGL._internalLoadingManager

protected createTextures(sdrImage, gainMapImage, needsFlip): object

Defined in: src/decode/shared/Loader.ts:121

HTMLImageElement | ImageBitmap

HTMLImageElement | ImageBitmap | undefined

boolean

object

gainMap: Texture

sdr: Texture

LoaderBaseWebGL.createTextures

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

Defined in: src/decode/webgl/loaders/HDRJPGLoader.ts:70

Loads a JPEG containing gain map metadata Renders a normal SDR image if gainmap data is not found

string

Path to a JPEG file containing embedded gain map metadata

(data) => void

Load complete callback, will receive the result

(event) => void

Progress callback, will receive a ProgressEvent

(err) => void

Error callback

QuadRenderer<1016, GainMapDecoderMaterial>

LoaderBaseWebGL.load

protected prepareQuadRenderer(): QuadRenderer

Defined in: src/decode/shared/Loader.ts:64

QuadRenderer

LoaderBaseWebGL.prepareQuadRenderer

protected processImages(sdrBuffer, gainMapBuffer?, imageOrientation?): Promise<{ gainMapImage: HTMLImageElement | ImageBitmap | undefined; needsFlip: boolean; sdrImage: HTMLImageElement | ImageBitmap; }>

Defined in: src/decode/shared/Loader.ts:93

ArrayBuffer

ArrayBuffer

"flipY" | "from-image"

Promise<{ gainMapImage: HTMLImageElement | ImageBitmap | undefined; needsFlip: boolean; sdrImage: HTMLImageElement | ImageBitmap; }>

LoaderBaseWebGL.processImages

setRenderer(renderer): HDRJPGLoader

Defined in: src/decode/shared/Loader.ts:54

WebGLRenderer

HDRJPGLoader

LoaderBaseWebGL.setRenderer

setRenderTargetOptions(options): HDRJPGLoader

Defined in: src/decode/shared/Loader.ts:59

QuadRendererTextureOptions

HDRJPGLoader

LoaderBaseWebGL.setRenderTargetOptions

protected updateQuadRenderer(quadRenderer, sdrImage, gainMap, sdr, metadata): void

Defined in: src/decode/shared/Loader.ts:155

QuadRenderer<1016, GainMapDecoderMaterial> & object

HTMLImageElement | ImageBitmap

Texture

Texture

GainMapMetadata

void

LoaderBaseWebGL.updateQuadRenderer