Realism Effects

https://github.com/0beqz/realism-effects
Admin
Realism Effects is a collection of advanced graphical post-processing effects, including SSGI,...
Tokens:74,753
Snippets:515
Trust Score:8.7
License:MIT
Update:1 day ago
Show doc for...
Tokens:
Raw
### Run the project locally

Source: https://github.com/0beqz/realism-effects/blob/main/readme.md

Clone the repository, install dependencies with the --force flag, and start the development server. Run these commands in order from the project root.

```shell
git clone https://github.com/0beqz/realism-effects
cd realism-effects/example
npm i --force
npm run dev
```

--------------------------------

### Install tweakpane with npm

Source: https://github.com/0beqz/realism-effects/blob/main/readme.md

Install the tweakpane npm package, which is required by the SSGIDebugGUI.

```shell
npm i tweakpane
```

--------------------------------

### Install realism-effects package

Source: https://github.com/0beqz/realism-effects/blob/main/readme.md

Install the realism-effects package.

```shell
npm i realism-effects
```

--------------------------------

### Install postprocessing package

Source: https://github.com/0beqz/realism-effects/blob/main/readme.md

Install the postprocessing package required by realism-effects.

```shell
npm i postprocessing
```

--------------------------------

### Basic usage example

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/TRAAEffect.md

Basic setup for TRAAEffect with postprocessing EffectComposer, VelocityDepthNormalPass, and EffectPass. Requires a renderer, scene, and camera.

```javascript
import * as POSTPROCESSING from "postprocessing"
import { TRAAEffect, VelocityDepthNormalPass } from "realism-effects"

const composer = new POSTPROCESSING.EffectComposer(renderer)
const velocityDepthNormalPass = new VelocityDepthNormalPass(scene, camera)
composer.addPass(velocityDepthNormalPass)

const traaEffect = new TRAAEffect(scene, camera, velocityDepthNormalPass, {
  fullAccumulate: true
})

composer.addPass(new POSTPROCESSING.EffectPass(camera, traaEffect))
composer.render()
```

--------------------------------

### Setup SSGI, TRAA, Motion Blur, and HBAO effects

Source: https://github.com/0beqz/realism-effects/blob/main/readme.md

Imports and sets up the effects with the EffectComposer. Requires a PerspectiveCamera; OrthographicCamera is not supported.

```javascript
import * as POSTPROCESSING from "postprocessing"
import { SSGIEffect, TRAAEffect, MotionBlurEffect, VelocityDepthNormalPass } from "realism-effects"

const composer = new POSTPROCESSING.EffectComposer(renderer)

const velocityDepthNormalPass = new VelocityDepthNormalPass(scene, camera)
composer.addPass(velocityDepthNormalPass)

// SSGI
const ssgiEffect = new SSGIEffect(scene, camera, velocityDepthNormalPass, options?)

// TRAA
const traaEffect = new TRAAEffect(scene, camera, velocityDepthNormalPass)

// Motion Blur
const motionBlurEffect = new MotionBlurEffect(velocityDepthNormalPass)

// HBAO
const hbaoEffect = new HBAOEffect(composer, camera, scene)

const effectPass = new POSTPROCESSING.EffectPass(camera, ssgiEffect, hbaoEffect, traaEffect, motionBlur)

composer.addPass(effectPass)
```

--------------------------------

### SSREffect basic usage example

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SSREffect.md

Basic usage example showing how to create an SSREffect with a VelocityDepthNormalPass and add it to the composer.

```javascript
import * as POSTPROCESSING from "postprocessing"
import { SSREffect, VelocityDepthNormalPass } from "realism-effects"

const composer = new POSTPROCESSING.EffectComposer(renderer)

const velocityDepthNormalPass = new VelocityDepthNormalPass(scene, camera)
composer.addPass(velocityDepthNormalPass)

const ssrEffect = new SSREffect(composer, scene, camera, {
  velocityDepthNormalPass,
  denoiseMode: "full_temporal"
})

composer.addPass(new POSTPROCESSING.EffectPass(camera, ssrEffect))
composer.render()
```

--------------------------------

### Usage example (subclass pattern)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/AOEffect.md

Shows how to extend AOEffect with a custom AOPass and fragment shader. The constructor passes a new AOPass(camera, scene, myAOFragment) as the pass argument. The example then instantiates MyAOEffect with options { spp: 16, iterations: 2 } and adds it as an EffectPass.

```javascript
import { AOEffect } from "realism-effects/src/ao/AOEffect"
import { AOPass } from "realism-effects/src/ao/AOPass"
import myAOFragment from "./my_ao.frag"

class MyAOEffect extends AOEffect {
  constructor(composer, camera, scene, options = AOEffect.DefaultOptions) {
    super(composer, camera, scene, new AOPass(camera, scene, myAOFragment), options)
  }
}

const aoEffect = new MyAOEffect(composer, camera, scene, { spp: 16, iterations: 2 })
composer.addPass(new POSTPROCESSING.EffectPass(camera, aoEffect))
```

--------------------------------

### Usage example (basic)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/TemporalReprojectPass.md

Creates a TemporalReprojectPass with options for full accumulation, neighborhood clamping, and log transform, then adds it to a composer.

```javascript
import { TemporalReprojectPass } from "realism-effects"

const temporalReprojectPass = new TemporalReprojectPass(
  scene,
  camera,
  velocityDepthNormalPass,
  someInputTexture,
  1,
  { fullAccumulate: true, neighborhoodClamp: true, logTransform: true }
)
composer.addPass(temporalReprojectPass)
```

--------------------------------

### Denoiser usage example

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/Denoiser.md

Shows how to instantiate Denoiser with options and render to obtain the final texture. Requires a scene, camera, rayTracedTexture, and optional gBufferPass and velocityDepthNormalPass.

```javascript
import Denoiser from "realism-effects/src/denoise/Denoiser"

const denoiser = new Denoiser(scene, camera, rayTracedTexture, {
  denoiseMode: "full_temporal",
  inputType: "diffuseSpecular",
  gBufferPass: myGBufferPass,
  velocityDepthNormalPass
})

denoiser.render(renderer, composerBuffer)
const finalTexture = denoiser.texture
```

--------------------------------

### Usage example (basic)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/PoissonDenoisePass.md

Shows how to instantiate `PoissonDenoisePass` with options, set the G-buffer pass, add it to a composer, and access the blurred output via the `texture` getter.

```javascript
import { PoissonDenoisePass } from "realism-effects"

const denoisePass = new PoissonDenoisePass(camera, [myRenderTarget.texture], {
  iterations: 2,
  radius: 3,
  depthPhi: 2,
  normalPhi: 50
})
denoisePass.setGBufferPass(gBufferPass)
composer.addPass(denoisePass)   // or render manually in a pipeline
// blurred output:
const blurredTexture = denoisePass.texture
```

--------------------------------

### Usage example (reactive tuning)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/AOEffect.md

Shows how to tune AOEffect options reactively after creation by assigning properties like spp, distance, and power.

```javascript
aoEffect.spp = 32
aoEffect.distance = 4
aoEffect.power = 1.5
```

--------------------------------

### Basic usage example

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/LensDistortionEffect.md

Imports and instantiates LensDistortionEffect, then adds it to a composer via an EffectPass. Requires a camera and composer.

```javascript
import * as POSTPROCESSING from "postprocessing"
import { LensDistortionEffect } from "realism-effects"

const lensDistortionEffect = new LensDistortionEffect({
  alphax: -0.05,
  alphay: -0.05,
  aberration: 1
})

composer.addPass(new POSTPROCESSING.EffectPass(camera, lensDistortionEffect))
```

--------------------------------

### Basic usage example for SparkleEffect

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SparkleEffect.md

Shows how to set up SparkleEffect with a VelocityDepthNormalPass and add it to a composer via an EffectPass. Includes setting spread to 0.25 and intensity to 1.

```js
import * as POSTPROCESSING from "postprocessing"
import { SparkleEffect, VelocityDepthNormalPass } from "realism-effects"

const velocityDepthNormalPass = new VelocityDepthNormalPass(scene, camera)
composer.addPass(velocityDepthNormalPass)

const sparkleEffect = new SparkleEffect(camera, velocityDepthNormalPass)
sparkleEffect.setSpread(0.25)
sparkleEffect.setIntensity(1)

composer.addPass(new POSTPROCESSING.EffectPass(camera, sparkleEffect))
```

--------------------------------

### Usage example (runtime iteration change)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/PoissonDenoisePass.md

Shows how to change the `iterations` instance property at runtime and adjust edge-stop weight uniforms (`lumaPhi`, `depthPhi`) directly on the fullscreen material.

```javascript
denoisePass.iterations = 4   // instance property, consumed by render()

// edge-stop weights are uniforms:
denoisePass.fullscreenMaterial.uniforms.lumaPhi.value = 8
denoisePass.fullscreenMaterial.uniforms.depthPhi.value = 3
```

--------------------------------

### General usage pattern with SSGI, TRAA, Motion Blur, HBAO

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/index.md

Shows the standard setup for realism-effects with postprocessing. Requires a renderer, scene, and camera. Adds VelocityDepthNormalPass and an EffectPass containing SSGI, HBAO, TRAA, and Motion Blur effects. If SSGI is used without a RenderPass, it renders the scene itself and TRAA/Motion Blur must be in a separate EffectPass.

```javascript
import * as POSTPROCESSING from "postprocessing"
import {
  SSGIEffect, TRAAEffect, MotionBlurEffect, VelocityDepthNormalPass, HBAOEffect
} from "realism-effects"

const composer = new POSTPROCESSING.EffectComposer(renderer)

const velocityDepthNormalPass = new VelocityDepthNormalPass(scene, camera)
composer.addPass(velocityDepthNormalPass)

const ssgiEffect = new SSGIEffect(composer, scene, camera, { velocityDepthNormalPass })
const traaEffect = new TRAAEffect(scene, camera, velocityDepthNormalPass)
const motionBlurEffect = new MotionBlurEffect(velocityDepthNormalPass)
const hbaoEffect = new HBAOEffect(composer, camera, scene)

const effectPass = new POSTPROCESSING.EffectPass(camera, ssgiEffect, hbaoEffect, traaEffect, motionBlurEffect)
composer.addPass(effectPass)
```

--------------------------------

### Runtime tuning example

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/LensDistortionEffect.md

Adjusts the distortion coefficients at runtime using setAlphaX and setAlphaY.

```javascript
lensDistortionEffect.setAlphaX(-0.08)
lensDistortionEffect.setAlphaY(0.03)
```

--------------------------------

### Basic HBAOEffect usage with postprocessing

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/HBAOEffect.md

Basic usage example showing how to create an HBAOEffect, configure it with options like resolutionScale, spp, distance, power, bias, thickness, and iterations, and add it to an EffectComposer via an EffectPass.

```js
import * as POSTPROCESSING from "postprocessing"
import { HBAOEffect } from "realism-effects"

const composer = new POSTPROCESSING.EffectComposer(renderer)

const hbaoEffect = new HBAOEffect(composer, camera, scene, {
  resolutionScale: 0.5,
  spp: 16,
  distance: 2,
  power: 2,
  bias: 40,
  thickness: 0.075,
  iterations: 2
})

composer.addPass(new POSTPROCESSING.EffectPass(camera, hbaoEffect))
composer.render()
```

--------------------------------

### Usage example (with jittered camera — TRAA pattern)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/TemporalReprojectPass.md

Shows the sequence of unjitter, jitter, and render calls for a jittered camera reprojection pattern.

```javascript
temporalReprojectPass.unjitter()
temporalReprojectPass.jitter()           // jitter the camera projection for this frame
temporalReprojectPass.render(renderer)   // reproject with the jittered camera
```

--------------------------------

### SSREffect usage with preset and reflection-only tuning

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SSREffect.md

Usage example with a preset and reflection-only tuning options. Note that the 'high' preset is not handled by SSGIEffect's preset switch and is a no-op.

```javascript
const ssrEffect = new SSREffect(composer, scene, camera, {
  velocityDepthNormalPass,
  preset: "high",          // NOTE: "high" is not handled by SSGIEffect's preset switch — no-op
  distance: 15,
  thickness: 4,
  steps: 32,
  refineSteps: 8,
  resolutionScale: 0.75
})
```

--------------------------------

### Usage example (basic)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/VelocityDepthNormalPass.md

Shows how to integrate VelocityDepthNormalPass with TRAAEffect and MotionBlurEffect in a postprocessing EffectComposer. Requires importing from 'realism-effects' and 'postprocessing'.

```javascript
import * as POSTPROCESSING from "postprocessing"
import { VelocityDepthNormalPass, TRAAEffect, MotionBlurEffect } from "realism-effects"

const composer = new POSTPROCESSING.EffectComposer(renderer)

const velocityDepthNormalPass = new VelocityDepthNormalPass(scene, camera)
composer.addPass(velocityDepthNormalPass)

composer.addPass(new POSTPROCESSING.EffectPass(camera,
  new TRAAEffect(scene, camera, velocityDepthNormalPass),
  new MotionBlurEffect(velocityDepthNormalPass)
))
```

--------------------------------

### get texture

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/Denoiser.md

Returns the output texture based on the denoise mode. May be undefined if a stage was not built.

```APIDOC
## get texture

### Description
Returns the output texture based on the denoise mode. May be undefined if a stage was not built.

### Method
get texture

### Returns
- `texture` (Texture) - The output texture. May be `undefined` if a stage was not built.

### Mode Mapping
- `"full"` / `"full_temporal"` → `denoiserComposePass.texture`
- `"denoised"` → `denoisePass.texture`
- `"temporal"` → `temporalReprojectPass.texture`
```

--------------------------------

### SSGIEffect basic usage with VelocityDepthNormalPass

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SSGIEffect.md

Basic usage example: creates an EffectComposer, adds a VelocityDepthNormalPass, creates an SSGIEffect with custom options, wraps it in an EffectPass, and renders. Requires importing POSTPROCESSING from 'postprocessing' and SSGIEffect and VelocityDepthNormalPass from 'realism-effects'.

```javascript
import * as POSTPROCESSING from "postprocessing"
import { SSGIEffect, VelocityDepthNormalPass } from "realism-effects"

const composer = new POSTPROCESSING.EffectComposer(renderer)

const velocityDepthNormalPass = new VelocityDepthNormalPass(scene, camera)
composer.addPass(velocityDepthNormalPass)

const ssgiEffect = new SSGIEffect(composer, scene, camera, {
  distance: 10,
  thickness: 10,
  steps: 20,
  refineSteps: 5,
  resolutionScale: 1
})

composer.addPass(new POSTPROCESSING.EffectPass(camera, ssgiEffect))
composer.render()
```

--------------------------------

### Initialize SSGIDebugGUI 

Source: https://github.com/0beqz/realism-effects/blob/main/readme.md

Import and initialize the SSGIDebugGUI in your scene, passing the ssgiEffect and optionally the options parameter.

```javascript
import { SSGIDebugGUI } from "./SSGIDebugGUI"

const gui = new SSGIDebugGUI(ssgiEffect, options)
```

--------------------------------

### initialize(renderer, ...args)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SSGIEffect.md

Calls `super.initialize` and then `this.ssgiPass.initialize(renderer, ...args)`. Called by the postprocessing pipeline when the composer is first rendered.

```APIDOC
## initialize(renderer, ...args)

### Description
Calls `super.initialize` and then `this.ssgiPass.initialize(renderer, ...args)`. Called by the postprocessing pipeline when the composer is first rendered.

### Method
initialize(renderer, ...args)

### Parameters
- **renderer** (`THREE.WebGLRenderer`) - Required - The renderer.
- **...args** - Optional - Forwarded to `Effect.initialize`.

### Returns
`undefined`
```

--------------------------------

### get texture

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/VelocityDepthNormalPass.md

Returns the velocity/normal/depth texture used by downstream effects.

```APIDOC
## GET texture

### Description
Returns `this.renderTarget.texture` — the velocity/normal/depth texture consumed by `TemporalReprojectPass`, `MotionBlurEffect`, `SparkleEffect` and `TRAAEffect`.

### Method
GET

### Endpoint
`texture`

### Response
#### Success Response
- **texture** (THREE.Texture) - The velocity/normal/depth texture.
```

--------------------------------

### get texture

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/TemporalReprojectPass.md

Returns the accumulated output texture from the render target.

```APIDOC
## get texture

### Description
Returns `this.renderTarget.texture[0]` — the accumulated output texture.

### Method
`get texture`

### Parameters
None

### Returns
`THREE.Texture` - The accumulated output texture.
```

--------------------------------

### get texture

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/AOEffect.md

Getter that returns the texture from PoissonDenoisePass when iterations > 0, otherwise returns aoPass.texture.

```APIDOC
## get texture

### Description
Returns `PoissonDenoisePass.texture` when `iterations > 0`, else `aoPass.texture`.

### Method
get texture

### Returns
- **texture** (THREE.Texture) - The current AO texture.
```

--------------------------------

### MotionBlurEffect basic usage

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/MotionBlurEffect.md

Basic usage example showing how to create a MotionBlurEffect with a VelocityDepthNormalPass and add it to an EffectComposer.

```javascript
import * as POSTPROCESSING from "postprocessing"
import { MotionBlurEffect, VelocityDepthNormalPass } from "realism-effects"

const composer = new POSTPROCESSING.EffectComposer(renderer)
const velocityDepthNormalPass = new VelocityDepthNormalPass(scene, camera)
composer.addPass(velocityDepthNormalPass)

const motionBlurEffect = new MotionBlurEffect(velocityDepthNormalPass, {
  intensity: 1,
  jitter: 1,
  samples: 24
})

composer.addPass(new POSTPROCESSING.EffectPass(camera, motionBlurEffect))
```

--------------------------------

### get depthTexture

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/GBufferPass.md

Returns the depth texture from the render target. This texture stores depth information for the G-buffer.

```APIDOC
## Getter: depthTexture

### Description
Returns the depth texture from the render target.

### Returns
- **depthTexture** (THREE.DepthTexture) - The depth texture.
```

--------------------------------

### constructor(options = defaultOptions)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SharpnessEffect.md

Creates a new SharpnessEffect instance with optional sharpness options. The sharpness uniform is initialized from the option and reapplied via setSharpness.

```APIDOC
## Constructor

### Description
Creates a new SharpnessEffect instance with optional sharpness options.

### Parameters
- **options** (`{ sharpness?: number }`) - Optional - Sharpness factor. Default: `{ sharpness: 1 }`.

### Return Value
A `SharpnessEffect` instance. Wrap in a `POSTPROCESSING.EffectPass`.

### Example
```js
import * as POSTPROCESSING from "postprocessing"
import { SharpnessEffect } from "realism-effects"

const sharpnessEffect = new SharpnessEffect({ sharpness: 0.75 })
composer.addPass(new POSTPROCESSING.EffectPass(camera, sharpnessEffect))
```
```

--------------------------------

### get texture

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/PoissonDenoisePass.md

Returns the freshest blurred output texture from renderTargetB. When inputType is 'diffuseSpecular', returns an array of textures.

```APIDOC
## get texture

### Description
Returns `this.renderTargetB.texture` — the freshest blurred output (array of textures when `inputType === "diffuseSpecular"`).

### Returns
`THREE.Texture` or `THREE.Texture[]`
```

--------------------------------

### GBufferPass initGBufferRenderTarget method

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/GBufferPass.md

(Re)creates the render target as described in the constructor. Returns undefined.

```javascript
initGBufferRenderTarget()
```

--------------------------------

### get depthTexture

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SSGIEffect.md

Getter that returns the G-buffer depth texture from the SSGI pass, usable by other effects like GradualBackgroundEffect.

```APIDOC
## get depthTexture

### Description
Returns `this.ssgiPass.gBufferPass.depthTexture` — the G-buffer depth texture (usable, e.g., by `GradualBackgroundEffect`).

### Method
get depthTexture

### Returns
The G-buffer depth texture.
```

--------------------------------

### constructor(composer, camera, scene, aoPass, options = defaultAOOptions)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/AOEffect.md

Creates an AOEffect instance. It sets up the ambient occlusion pipeline by running an AOPass-derived shader, denoising with PoissonDenoisePass, and composing the AO over the input color with optional tinting.

```APIDOC
## Constructor

### Description
Creates an AOEffect instance. It sets up the ambient occlusion pipeline by running an AOPass-derived shader, denoising with PoissonDenoisePass, and composing the AO over the input color with optional tinting.

### Signature
```js
constructor(composer, camera, scene, aoPass, options = defaultAOOptions)
```

### Parameters
- **composer** (`POSTPROCESSING.EffectComposer`) - Required - Composer; `composer.createDepthTexture()` is called if no depth texture exists, and `composer.passes` is scanned for TRAA.
- **camera** (`THREE.PerspectiveCamera`) - Required - Camera.
- **scene** (`THREE.Scene`) - Required - Scene (used for `NormalPass` and specialized AO shaders).
- **aoPass** (`AOPass` subclass, e.g. `HBAOPass`) - Required - The AO algorithm pass.
- **options** (`AOOptions`) - Optional, default `defaultAOOptions` - See options table below.

### Options (`AOOptions`)
- **resolutionScale** (`number`) - Default `1` - Render scale of the AO pass (0.5 = half resolution).
- **spp** (`number`) - Default `8` - Samples per pixel; compiled into the `spp` shader define (`toFixed(0)`).
- **distance** (`number`) - Default `2` - AO ray distance (`aoDistance` uniform).
- **distancePower** (`number`) - Default `1` - Distance falloff exponent (`distancePower` uniform).
- **power** (`number`) - Default `2` - AO strength used in the compose step (`power` uniform).
- **bias** (`number`) - Default `40` - Self-occlusion bias (`bias` uniform).
- **thickness** (`number`) - Default `0.075` - Occluder thickness heuristic (`thickness` uniform).
- **color** (`THREE.Color` or convertable) - Default `black` - AO tint color multiplied in the compose step.
- **useNormalPass** (`boolean`) - Default `false` - Create a `postprocessing.NormalPass` and feed its normals to the AO pass (`useNormalTexture` define).
- **normalTexture** (`THREE.Texture`) - Default `null` - Alternative normal source (used instead of `NormalPass`).
- **velocityDepthNormalPass** (`VelocityDepthNormalPass`) - Default `null` - Accepted; forwarded only into the merged options (the base constructor as written does not consume it beyond the merge).
- **iterations** (`number`) - Default `1` - `PoissonDenoisePass.iterations`.
- **radius** (`number`) - Default `3` - Denoiser blur radius (also sets `PoissonDenoisePass.radius`).
- **phi** (`number`) - Default `0.5` - Denoiser base edge-stop.
- **lumaPhi** (`number`) - Default `5` - Denoiser luminance edge-stop (clamped to ≥ `0.0001` on assignment).
- **depthPhi** (`number`) - Default `2` - Denoiser depth edge-stop (clamped to ≥ `0.0001`).
- **normalPhi** (`number`) - Default `3.25` - Denoiser normal edge-stop (clamped to ≥ `0.0001`).
- **inputType** (`"diffuseSpecular"` \| ...) - Default `"diffuseSpecular"` - Forwarded to `PoissonDenoisePass` (with `textureCount` semantics).

### Return Value
An `AOEffect` instance (abstract in practice; use a subclass such as `HBAOEffect`).
```

--------------------------------

### initialize(renderer, ...args)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/MotionBlurEffect.md

Initializes the effect by calling super.initialize and asynchronously loading the blue-noise sprite into the blueNoiseTexture uniform.

```APIDOC
## Method: initialize

### Description
Calls `super.initialize` and asynchronously loads the bundled blue-noise sprite into the `blueNoiseTexture` uniform.

### Signature
```js
initialize(renderer, ...args)
```

### Parameters
- **renderer** (`THREE.WebGLRenderer`) - Required - The renderer.
- **...args** - Required - Forwarded to `Effect.initialize`.

### Returns
`undefined`
```

--------------------------------

### constructor(composer, scene, camera, options)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SSGIEffect.md

Creates a new SSGIEffect instance. The constructor merges the provided options with the default options and sets up the internal SSGI pass, denoiser, and render pass. The effect must be wrapped in an EffectPass and added to the composer.

```APIDOC
## constructor(composer, scene, camera, options)

### Description
Creates a new SSGIEffect instance. The constructor merges the provided options with the default options and sets up the internal SSGI pass, denoiser, and render pass. The effect must be wrapped in an EffectPass and added to the composer.

### Parameters
- **composer** (`POSTPROCESSING.EffectComposer`) - Required - The composer the effect will be used with. Used to look up render-pass state and to size the internal targets.
- **scene** (`THREE.Scene`) - Required - The scene to trace against and (optionally) render.
- **camera** (`THREE.PerspectiveCamera`) - Required - The camera. `OrthographicCamera` is not supported.
- **options** (`SSGIOptions`) - Optional - Effect configuration; every key becomes a reactive instance property. Defaults to `{}` (merged over `SSGIEffect.DefaultOptions`).

### Return Value
An `SSGIEffect` instance. The class is an `Effect`, so it must be wrapped in a `POSTPROCESSING.EffectPass` (or pass list) added to the composer.

### Usage Example (basic)
```js
import * as POSTPROCESSING from "postprocessing"
import { SSGIEffect, VelocityDepthNormalPass } from "realism-effects"

const composer = new POSTPROCESSING.EffectComposer(renderer)

const velocityDepthNormalPass = new VelocityDepthNormalPass(scene, camera)
composer.addPass(velocityDepthNormalPass)

const ssgiEffect = new SSGIEffect(composer, scene, camera, {
  distance: 10,
  thickness: 10,
  steps: 20,
  refineSteps: 5,
  resolutionScale: 1
})

composer.addPass(new POSTPROCESSING.EffectPass(camera, ssgiEffect))
composer.render()
```

### Usage Example (SSGI without a RenderPass + TRAA in a separate pass)
```js
const ssgiEffect = new SSGIEffect(composer, scene, camera, { velocityDepthNormalPass })
const traaEffect = new TRAAEffect(scene, camera, velocityDepthNormalPass)
const motionBlurEffect = new MotionBlurEffect(velocityDepthNormalPass)

// SSGI renders the scene itself when no RenderPass is present
composer.addPass(new POSTPROCESSING.EffectPass(camera, ssgiEffect))
// TRAA and MotionBlur must run in a separate pass in that case
composer.addPass(new POSTPROCESSING.EffectPass(camera, traaEffect, motionBlurEffect))
```
```

--------------------------------

### Reset on demand to avoid ghosting

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/TRAAEffect.md

Usage example showing how to discard temporal history after a teleport or large scene change by calling traaEffect.reset().

```javascript
const traaEffect = new TRAAEffect(scene, camera, velocityDepthNormalPass)

// after a teleport or large scene change, discard the temporal history:
traaEffect.reset()
```

--------------------------------

### AOEffect / HBAOEffect Options

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/configuration.md

Configuration options for AOEffect and HBAOEffect, including ambient occlusion parameters and denoiser settings.

```APIDOC
## AOEffect / HBAOEffect Options

### Description
Configuration options for AOEffect and HBAOEffect, including ambient occlusion parameters and denoiser settings.

### Parameters

| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| `resolutionScale` | `number` | no | `1` | AO pass render scale. |
| `spp` | `number` | no | `8` | Samples per pixel (define). |
| `distance` | `number` | no | `2` | AO ray distance (`aoDistance` uniform). |
| `distancePower` | `number` | no | `1` | Distance falloff. |
| `power` | `number` | no | `2` | Compose AO strength. |
| `bias` | `number` | no | `40` | Self-occlusion bias. |
| `thickness` | `number` | no | `0.075` | Occluder thickness. |
| `color` | `THREE.Color` input | no | `new Color("black")` | AO tint (converted via `new Color(value)` on assignment). |
| `useNormalPass` | `boolean` | no | `false` | Use `postprocessing.NormalPass` normals. |
| `normalTexture` | `THREE.Texture` | no | `null` | Alternative normal source. |
| `velocityDepthNormalPass` | `VelocityDepthNormalPass` | no | `null` | Accepted; merged only. |
| `iterations` | `number` | no | `1` | Denoiser iterations. |
| `radius` | `number` | no | `3` | Denoiser radius. |
| `phi` | `number` | no | `0.5` | Denoiser base edge-stop. |
| `lumaPhi` | `number` | no | `5` | Denoiser luminance edge-stop (≥ `0.0001` clamp). |
| `depthPhi` | `number` | no | `2` | Denoiser depth edge-stop (≥ `0.0001` clamp). |
| `normalPhi` | `number` | no | `3.25` | Denoiser normal edge-stop (≥ `0.0001` clamp). |
| `inputType` | `"diffuseSpecular"` \| ... | no | `"diffuseSpecular"` | Forwarded to `PoissonDenoisePass`. |
```

--------------------------------

### Constructor options without option objects

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/configuration.md

Classes that accept positional parameters instead of an options object. Each class has a specific set of required parameters.

```APIDOC
## Constructor options without option objects

### Description
Classes that accept positional parameters instead of an options object. Each class has a specific set of required parameters.

### Classes
- **VelocityDepthNormalPass** / **VelocityPass** - `(scene, camera)`
- **TAAPass** - `(camera)`
- **GradualBackgroundEffect** - `(camera, depthTexture, backgroundColor, maxDistance = 5)`
- **SparkleEffect** - `(camera, velocityDepthNormalPass)`
- **GBufferPass** - `(scene, camera)`
- **Denoiser** - `(scene, camera, texture, options = defaultDenosierOptions)`
- **TemporalReprojectPass** - `(scene, camera, velocityDepthNormalPass, texture, textureCount, options)`
- **SSGIPass** / **DenoiserComposePass** / **CubeToEquirectEnvPass** / **CopyPass** / **GBufferDebugPass** - see [InternalModules.md](./api-reference/InternalModules.md)

```

--------------------------------

### get texture

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/GBufferPass.md

Returns the packed G-buffer texture from the render target. This texture contains diffuse color/alpha, world normal, roughness, metalness, and emissive data.

```APIDOC
## Getter: texture

### Description
Returns the packed G-buffer texture from the render target.

### Returns
- **texture** (THREE.Texture) - The G-buffer texture.
```

--------------------------------

### initialize method signature

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/MotionBlurEffect.md

Method signature for initialize. Calls super.initialize and loads the blue-noise sprite asynchronously.

```javascript
initialize(renderer, ...args)
```

--------------------------------

### SSREffect

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/index.md

Class extending SSGIEffect for screen-space reflections. Re-exported from the package entry point.

```APIDOC
## SSREffect

### Description
Class extending SSGIEffect for screen-space reflections. Re-exported from the package entry point.

### Source
`src/ssgi/SSREffect.js`

### Kind
class (`SSGIEffect`)
```

--------------------------------

### DenoiserOptions

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/types.md

Options object for the Denoiser constructor. Configures denoising pipeline mode, input channel layout, and optional passes.

```APIDOC
## DenoiserOptions

### Description
Options object for the Denoiser constructor. Configures denoising pipeline mode, input channel layout, and optional passes.

### Fields
- **denoiseMode** ("full" | "full_temporal" | "denoised" | "temporal") - Default: "full" - Pipeline selection.
- **inputType** ("diffuseSpecular" | "diffuse" | "specular") - Default: "diffuseSpecular" - Channel layout (texture count).
- **gBufferPass** (GBufferPass) - Default: null - G-buffer for denoise/compose.
- **velocityDepthNormalPass** (VelocityDepthNormalPass) - Default: null - External velocity pass.

### Accepted By
Denoiser constructor (default export of `src/denoise/Denoiser.js`); constructed internally by `SSGIEffect` with `{ gBufferPass, velocityDepthNormalPass, ...ssgiOptions }`.
```

--------------------------------

### EquirectHdrInfoUniform constructor()

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/InternalModules.md

A uniform-like class that stores an equirectangular environment map for importance sampling along with marginal and conditional CDF weight textures. It provides methods to dispose resources and update the map asynchronously using a Web Worker.

```APIDOC
## EquirectHdrInfoUniform constructor()

### Description
A uniform-like class that stores an equirectangular environment map for importance sampling along with marginal and conditional CDF weight textures. It provides methods to dispose resources and update the map asynchronously using a Web Worker.

### Method
constructor

### Endpoint
`new EquirectHdrInfoUniform()`

### Properties
- **map** - The equirectangular environment map.
- **marginalWeights** - Marginal CDF weight texture.
- **conditionalWeights** - Conditional CDF weight texture.
- **totalSumWhole** - Total sum (whole part).
- **totalSumDecimal** - Total sum (decimal part).
- **size** - Size of the map.

### Methods

#### dispose()
Disposes the resources held by the instance.

#### updateFrom(map) → Promise<map>
Clones the provided map, transfers its pixel data to a Web Worker, and resolves with the map after CDF tables are computed.

##### Parameters
- **map** (Texture) - Required - The equirectangular environment map to process.

##### Returns
- **Promise<map>** - Resolves with the original map after processing.

### Source
`src/ssgi/utils/EquirectHdrInfoUniform.js`
```

--------------------------------

### SSGI without RenderPass plus TRAA and MotionBlur in separate pass

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SSGIEffect.md

Usage example for SSGI without a RenderPass, where SSGI renders the scene itself. TRAAEffect and MotionBlurEffect must run in a separate pass in that case. Uses an existing velocityDepthNormalPass.

```javascript
const ssgiEffect = new SSGIEffect(composer, scene, camera, { velocityDepthNormalPass })
const traaEffect = new TRAAEffect(scene, camera, velocityDepthNormalPass)
const motionBlurEffect = new MotionBlurEffect(velocityDepthNormalPass)

// SSGI renders the scene itself when no RenderPass is present
composer.addPass(new POSTPROCESSING.EffectPass(camera, ssgiEffect))
// TRAA and MotionBlur must run in a separate pass in that case
composer.addPass(new POSTPROCESSING.EffectPass(camera, traaEffect, motionBlurEffect))
```

--------------------------------

### constructor(scene, camera)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/GBufferPass.md

Creates a new GBufferPass instance that renders the scene's G-buffer into a FloatType RGBA texture and a depth texture. The constructor initializes the render target with the provided scene and camera.

```APIDOC
## Constructor

### Description
Creates a new GBufferPass instance that renders the scene's G-buffer into a FloatType RGBA texture and a depth texture.

### Parameters
- **scene** (THREE.Scene) - Required - Scene to render into the G-buffer.
- **camera** (THREE.PerspectiveCamera) - Required - Camera to render with.

### Return Value
A GBufferPass instance.
```

--------------------------------

### Default Denoiser Options

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/Denoiser.md

Internal defaults for the Denoiser constructor options. `denoiseMode` selects the pipeline: `"full"`/`"full_temporal"` builds temporal reproject + poisson denoise + compose, `"denoised"` only poisson denoise, `"temporal"` only temporal reproject. `inputType` controls texture count (2 vs 1) and compose behavior. `gBufferPass` defaults to the velocity pass when null; `velocityDepthNormalPass` is created internally when null.

```javascript
const defaultDenosierOptions = {
	denoiseMode: "full", // can be "full" | "full_temporal" | "denoised" | "temporal"
	inputType: "diffuseSpecular", // can be "diffuseSpecular" | "diffuse" | "specular"
	gBufferPass: null,
	velocityDepthNormalPass: null
}
```

--------------------------------

### TemporalReprojectPassOptions

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/types.md

Options object for configuring the TemporalReprojectPass and related effects. Accepted by the TemporalReprojectPass constructor, TRAAEffect constructor (with forced overrides), and via Denoiser by SSGIEffect options. TRAAEffect.DefaultOptions equals this object.

```APIDOC
## TemporalReprojectPassOptions

### Description
Options object for configuring the TemporalReprojectPass and related effects. Accepted by the TemporalReprojectPass constructor, TRAAEffect constructor (with forced overrides), and via Denoiser by SSGIEffect options. TRAAEffect.DefaultOptions equals this object.

### Fields

| Field | Type | Default | Description |
|---|---|---|---|
| `dilation` | `boolean` | `false` | Velocity dilation define. |
| `fullAccumulate` | `boolean` | `false` | Full accumulation while camera static. |
| `neighborhoodClamp` | `boolean` \| `boolean[]` | `false` | History neighborhood clamping (per-texture array allowed). |
| `neighborhoodClampRadius` | `number` | `1` | Clamp kernel radius (define). |
| `neighborhoodClampIntensity` | `number` | `1` | Clamp intensity uniform. |
| `maxBlend` | `number` | `1` | Max blend uniform. |
| `logTransform` | `boolean` | `false` | Blend in log space. |
| `depthDistance` | `number` | `2` | Depth threshold define. |
| `worldDistance` | `number` | `4` | World-space threshold define. |
| `reprojectSpecular` | `boolean` \| `boolean[]` | `false` | Per-texture reprojection flags (expanded to an array — see note on the `typeof value !== "array"` check in `src/temporal-reproject/TemporalReprojectPass.js:113`). |
| `renderTarget` | `WebGLMultipleRenderTargets` | `null` | Accepted; unused by the current constructor. |
| `copyTextures` | `boolean` | `true` | Controls framebuffer history copy elsewhere in the pipeline. |
| `confidencePower` | `number` | `0.75` | Confidence exponent define. |
| `inputType` | `"diffuseSpecular"` \| `"diffuse"` \| `"specular"` | `"diffuse"` | Input layout define. |

### Default Options Object

```js
export const defaultTemporalReprojectPassOptions = {
	dilation: false,
	fullAccumulate: false,
	neighborhoodClamp: false,
	neighborhoodClampRadius: 1,
	neighborhoodClampIntensity: 1,
	maxBlend: 1,
	logTransform: false,
	depthDistance: 2,
	worldDistance: 4,
	reprojectSpecular: false,
	renderTarget: null,
	copyTextures: true,
	confidencePower: 0.75,
	inputType: "diffuse"
}
```
```

--------------------------------

### External usage with PoissonDenoisePass

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/GBufferPass.md

Shows how to create a GBufferPass, render it manually, and pass it to a PoissonDenoisePass for denoising.

```javascript
import { GBufferPass } from "realism-effects/src/gbuffer/GBufferPass"
import { PoissonDenoisePass } from "realism-effects"

const gBufferPass = new GBufferPass(scene, camera)
// add to composer or render manually before the denoise pass:
gBufferPass.render(renderer)

const denoisePass = new PoissonDenoisePass(camera, [someTexture], { inputType: "diffuse" })
denoisePass.setGBufferPass(gBufferPass)
```

--------------------------------

### GBufferPass setGBufferMaterialInScene method

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/GBufferPass.md

Swaps mesh materials to cloned GBufferMaterial instances, tracks camera movement, and hides non-renderable meshes. Returns undefined.

```javascript
setGBufferMaterialInScene()
```

--------------------------------

### VelocityDepthNormalMaterial constructor(camera)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/InternalModules.md

Creates a velocity buffer shader material that outputs screen-space velocity, octahedron-packed world normal, and fragment depth. It extends three.js ShaderMaterial and supports a second previous-frame bone set via exported GLSL constants and uniforms.

```APIDOC
## VelocityDepthNormalMaterial constructor(camera)

### Description
Creates a velocity buffer shader material that outputs screen-space velocity, octahedron-packed world normal, and fragment depth. It extends three.js ShaderMaterial and supports a second previous-frame bone set via exported GLSL constants and uniforms.

### Method
constructor

### Endpoint
`new VelocityDepthNormalMaterial(camera)`

### Parameters
#### Constructor Parameters
- **camera** (Camera) - Required - The camera used for the velocity calculation.

### Source
`src/temporal-reproject/material/VelocityDepthNormalMaterial.js`

### Exports
- `VelocityDepthNormalMaterial`
- `velocity_vertex_pars`
- `velocity_vertex_main`
- `velocity_fragment_pars`
- `velocity_fragment_main`
- `velocity_uniforms`

### Outputs
- `gl_FragColor.rg` - screen-space velocity
- `gl_FragColor.b` - octahedron-packed world normal via `packNormal` (`packHalf2x16`)
- `gl_FragColor.a` - `fragCoordZ`

### Uniforms
- `prevVelocityMatrix`
- `velocityMatrix`
- `prevBoneTexture`
- `boneTexture`
- `normalMap`
- `normalScale`
- `uvTransform`
```

--------------------------------

### constructor(camera, velocityDepthNormalPass)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SparkleEffect.md

Creates a new SparkleEffect instance. The camera provides projection matrices, and the velocityDepthNormalPass supplies the velocity/normal/depth texture used by the effect.

```APIDOC
## Constructor

### Description
Creates a new SparkleEffect instance.

### Parameters
- **camera** (THREE.PerspectiveCamera) - Required - Camera; projection uniforms are copied at construction and refreshed in `update()`.
- **velocityDepthNormalPass** (VelocityDepthNormalPass) - Required - Provides the velocity/normal/depth texture consumed via the `velocityTexture` uniform.

### Return Value
A `SparkleEffect` instance. Wrap in a `POSTPROCESSING.EffectPass`.
```

--------------------------------

### GBufferPass constructor

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/GBufferPass.md

Creates a GBufferPass instance with the given scene and camera. The render target is initialized with FloatType, nearest filtering, and a depth buffer.

```javascript
constructor(scene, camera)
```

--------------------------------

### makeOptionsReactive(options)

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/AOEffect.md

Binds every option key as a reactive instance property (getter/setter, configurable: true). Setter dispatch handles specific keys like spp, distance, resolutionScale, power, color, iterations/radius/rings/samples, lumaPhi/depthPhi/normalPhi, and any other key present in aoPass.fullscreenMaterial.uniforms. Assignments with null/undefined values are ignored. Returns undefined.

```APIDOC
## makeOptionsReactive(options)

### Description
Binds every option key as a reactive instance property (getter/setter, `configurable: true`). Setter dispatch:

| Key(s) | Behavior on assignment |
|---|---|
| `spp` | `aoPass.fullscreenMaterial.defines.spp = value.toFixed(0)`; `needsUpdate = true` |
| `distance` | Sets the `aoDistance` uniform |
| `resolutionScale` | Calls `setSize(this.lastSize.width, this.lastSize.height)` |
| `power` | Sets the compose `power` uniform |
| `color` | `uniforms.color.value.copy(new Color(value))` |
| `iterations` / `radius` / `rings` / `samples` | Assigned onto `this.PoissonDenoisePass` (note: `rings`/`samples` are not used by `PoissonDenoisePass` as written) |
| `lumaPhi` / `depthPhi` / `normalPhi` | Sets the denoiser uniform with `Math.max(value, 0.0001)` |
| any other key | If present in `aoPass.fullscreenMaterial.uniforms`, sets the uniform value |

Assignments with `null`/`undefined` values are ignored. Returns `undefined`.

### Method
makeOptionsReactive(options)

### Parameters
- **options** (object) - Required - The options object to bind reactively.

### Returns
undefined
```

--------------------------------

### SSGIEffect

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/index.md

Class extending Effect for screen-space global illumination. Re-exported from the package entry point.

```APIDOC
## SSGIEffect

### Description
Class extending Effect for screen-space global illumination. Re-exported from the package entry point.

### Source
`src/ssgi/SSGIEffect.js`

### Kind
class (`Effect`)
```

--------------------------------

### SharpnessEffect constructor signature

Source: https://github.com/0beqz/realism-effects/blob/main/_autodocs/api-reference/SharpnessEffect.md

Constructor signature for SharpnessEffect. Accepts an options object with an optional sharpness factor.

```javascript
constructor(options = defaultOptions)
```
Tokens:
Raw