@needle-tools/engine
Version:
Needle Engine is a web-based runtime for 3D apps. It runs on your machine for development with great integrations into editors like Unity or Blender - and can be deployed onto any device! It is flexible, extensible and networking and XR are built-in.
27 lines (26 loc) • 1.4 kB
TypeScript
import type { ToneMapping } from "three";
import { EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
import { VolumeParameter } from "../VolumeParameter.js";
import { NEToneMappingModeNames } from "./Tonemapping.utils.js";
/**
* [ToneMappingEffect](https://engine.needle.tools/docs/api/ToneMappingEffect) adjusts the brightness and contrast of the rendered scene to map high dynamic range (HDR) colors to a displayable range.
* This effect is essential for achieving realistic lighting and color representation in 3D scenes, as it helps to preserve details in both bright and dark areas.
* Various tonemapping algorithms can be applied to achieve different visual styles and effects.
* @summary Tonemapping Post-Processing Effect
* @category Effects
* @group Components
*/
export declare class ToneMappingEffect extends PostProcessingEffect {
get typeName(): string;
readonly mode: VolumeParameter;
readonly exposure: VolumeParameter;
/** Set the tonemapping mode to e.g. "agx" */
setMode(mode: NEToneMappingModeNames): this;
get isToneMapping(): boolean;
/** The three.js ToneMapping enum value resolved from the current mode */
get threeToneMapping(): ToneMapping;
/** The exposure value to apply */
get toneMappingExposure(): number;
private _tonemappingEffect;
onCreateEffect(): EffectProviderResult | undefined;
}