@monogrid/gainmap-js/dist/decode/types.d.ts

A Javascript (TypeScript) Port of Adobe Gainmap Technology for storing HDR Images using an SDR Image + a gain map

import { type Texture, type WebGLRenderer } from 'three';
import { type GainMapMetadata, type QuadRendererTextureOptions } from '../core/types';
/**
 * Necessary parameters for decoding a Gainmap
 *
 * @category Specs
 * @group Specs
 */
export type GainmapDecodingParameters = {
    /**
     * The maximum available boost supported by a display, at a given point in time.
     *
     * @remarks
     * This value can change over time based on device settings and other factors,
     * such as ambient light conditions, or how many bright pixels are on the screen.
     *
     * Non Logarithmic space
     */
    maxDisplayBoost: number;
};
/**
 * @category Decoding Functions
 * @group Decoding Functions
 */
export type DecodeParameters = {
    /**
     * An Texture containing the SDR Rendition
     */
    sdr: Texture;
    /**
     * An Texture containing the GainMap recovery image
     */
    gainMap: Texture;
    /**
     * WebGLRenderer used to decode the GainMap
     */
    renderer?: WebGLRenderer;
    /**
     * Options to use when creating the output renderTarget
     */
    renderTargetOptions?: QuadRendererTextureOptions;
} & GainmapDecodingParameters & GainMapMetadata;