Postprocessing

https://pmndrs.github.io/postprocessing/public/docs
Admin
Postprocessing is a post-processing library for three.js that provides passes and effects for...
Tokens:330,847
Snippets:3,532
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### constructor()

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/AdaptiveLuminanceMaterial.js~AdaptiveLuminanceMaterial.html

Constructs a new adaptive luminance material.

```APIDOC
## constructor()

### Description
Constructs a new adaptive luminance material.

### Method
constructor

### Signature
`constructor()`

### Parameters
None.

### Returns
A new AdaptiveLuminanceMaterial instance.
```

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

### readDepth example: convert pointer event to NDC and unproject

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/passes/DepthPickingPass.js~DepthPickingPass.html

Shows how to use readDepth to get depth at a pointer position. Converts client coordinates to normalized device coordinates, awaits the depth, then unprojects to world position. Only one depth value can be picked per frame; calling multiple times overwrites coordinates.

```javascript
const ndc = new Vector3();
const clientRect = myViewport.getBoundingClientRect();
const clientX = pointerEvent.clientX - clientRect.left;
const clientY = pointerEvent.clientY - clientRect.top;
ndc.x = (clientX / myViewport.clientWidth) * 2.0 - 1.0;
ndc.y = -(clientY / myViewport.clientHeight) * 2.0 + 1.0;
const depth = await depthPickingPass.readDepth(ndc);
ndc.z = depth * 2.0 - 1.0;

const worldPosition = ndc.unproject(camera);
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/ToneMappingEffect.js~ToneMappingEffect.html

Constructs a new tone mapping effect with the given options.

```APIDOC
## constructor(options: Object)

### Description
Constructs a new tone mapping effect.

### Parameters
- **options** (Object) - Required - The options for the tone mapping effect.

### Example
```js
import {ToneMappingEffect} from 'postprocessing';
const effect = new ToneMappingEffect(options);
```
```

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

### get texture()

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/passes/NormalPass.js~NormalPass.html

Gets the normal texture.

```APIDOC
## [GETTER] NormalPass.texture

### Description
The normal texture.

### Method
get

### Endpoint
NormalPass.texture

### Response
#### Success Response (200)
- **texture** (Texture) - The normal texture.

#### Response Example
{
  "texture": "Texture"
}
```

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

### constructor(camera, lightSource, options)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/GodRaysEffect.js~GodRaysEffect.html

Constructs a new god rays effect with the given camera, light source, and options.

```APIDOC
## constructor(camera: Camera, lightSource: Mesh | Points, options: Object)

### Description
Constructs a new god rays effect.

### Parameters
- **camera** (Camera) - Required - The camera used for rendering.
- **lightSource** (Mesh | Points) - Required - The mesh or points representing the light source.
- **options** (Object) - Required - Configuration options for the effect.

### Example
```js
const effect = new GodRaysEffect(camera, lightSource, options);
```
```

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

### get blendFunction()

Source: https://pmndrs.github.io/postprocessing/public/docs/file/src/effects/blending/BlendMode.js.html

Gets the current blend function.

```APIDOC
## [GET] blendFunction

### Description
Returns the current blend function.

### Method
GET

### Endpoint
blendFunction

### Response
#### Success Response (200)
- **value** (BlendFunction) - The current blend function.

#### Response Example
```json
{
  "value": "BlendFunction"
}
```
```

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

### get technique(): VignetteTechnique

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/VignetteEffect.js~VignetteEffect.html

Gets the Vignette technique.

```APIDOC
## get technique(): VignetteTechnique

### Description
Gets the Vignette technique.

### Returns
- **VignetteTechnique** - The Vignette technique.
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/HueSaturationEffect.js~HueSaturationEffect.html

Constructs a new hue/saturation effect with the given options.

```APIDOC
## Constructor

### Description
Constructs a new hue/saturation effect.

### Method
constructor

### Parameters
- **options** (Object) - Required - The options for the effect.

### Example
```js
const effect = new HueSaturationEffect({ hue: 0.5, saturation: 1.2 });
```
```

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

### initialize(renderer, alpha, frameBufferType)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/TiltShiftEffect.js~TiltShiftEffect.html

Performs initialization tasks for the tilt shift effect.

```APIDOC
## Method: initialize(renderer, alpha, frameBufferType)

### Description
Performs initialization tasks.

### Parameters
- **renderer** (WebGLRenderer) - Required - The renderer.
- **alpha** (Boolean) - Required - Whether the renderer uses alpha.
- **frameBufferType** (Number) - Required - The frame buffer type.
```

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

### get offset(): Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/VignetteEffect.js~VignetteEffect.html

Gets the Vignette offset.

```APIDOC
## get offset(): Number

### Description
Gets the Vignette offset.

### Returns
- **Number** - The Vignette offset.
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/textures/ASCIITexture.js~ASCIITexture.html

Constructs a new ASCII texture. Accepts an options object to customize the character set, font, font size, texture size, and cell count.

```APIDOC
## constructor(options: Object)

### Description
Constructs a new ASCII texture.

### Parameters
- **options** (Object) - Optional - The options.
- **options.characters** (String) - Optional - The character set to render. Defaults to a common ASCII art charset.
- **options.font** (String) - Optional - The font. Default: "Arial".
- **options.fontSize** (Number) - Optional - The font size in pixels. Default: 54.
- **options.size** (Number) - Optional - The texture size. Default: 1024.
- **options.cellCount** (Number) - Optional - The cell count along each side of the texture. Default: 16.

### Returns
No return value specified.
```

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

### get darkness(): Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/VignetteEffect.js~VignetteEffect.html

Gets the Vignette darkness.

```APIDOC
## get darkness(): Number

### Description
Gets the Vignette darkness.

### Returns
- **Number** - The Vignette darkness.
```

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

### get predicationThreshold: Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/EdgeDetectionMaterial.js~EdgeDetectionMaterial.html

Gets the predication threshold.

```APIDOC
## get predicationThreshold: Number

### Description
Gets the predication threshold.

### Returns
- **Number** - The current predication threshold.

```

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

### initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/DepthOfFieldEffect.js~DepthOfFieldEffect.html

Performs initialization tasks for the effect.

```APIDOC
## initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

### Description
Performs initialization tasks.

### Parameters
- **renderer** (WebGLRenderer) - Required - The WebGL renderer.
- **alpha** (Boolean) - Required - Whether alpha is enabled.
- **frameBufferType** (Number) - Required - The framebuffer type.
```

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

### Import getSafeSamples from 'postprocessing'

Source: https://pmndrs.github.io/postprocessing/public/docs/function

Import the getSafeSamples function from the postprocessing package. This is the only code example on the page.

```javascript
import {getSafeSamples} from 'postprocessing'
```

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

### get weightsR

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/SepiaEffect.js~SepiaEffect.html

Gets the weights for the red channel.

```APIDOC
## Property: weightsR (get)

### Description
Gets the weights for the red channel. Default is `(0.393, 0.769, 0.189)`.

### Returns
- **Vector3** - The weights for the red channel.
```

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

### Import KawaseBlurPass from 'postprocessing'

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/passes/KawaseBlurPass.js~KawaseBlurPass.html

Import the KawaseBlurPass class from the 'postprocessing' package.

```javascript
import {KawaseBlurPass} from 'postprocessing'
```

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

### get weightsG

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/SepiaEffect.js~SepiaEffect.html

Gets the weights for the green channel.

```APIDOC
## Property: weightsG (get)

### Description
Gets the weights for the green channel. Default is `(0.349, 0.686, 0.168)`.

### Returns
- **Vector3** - The weights for the green channel.
```

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

### constructor(renderer: WebGLRenderer, options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/core/EffectComposer.js~EffectComposer.html

Constructs a new effect composer with the given renderer and options.

```APIDOC
## constructor(renderer: WebGLRenderer, options: Object)

### Description
Constructs a new effect composer.

### Parameters
- **renderer** (WebGLRenderer) - Required - The renderer to use.
- **options** (Object) - Optional - Configuration options for the composer.

### Returns
- EffectComposer - The new composer instance.
```

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

### get weightsB

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/SepiaEffect.js~SepiaEffect.html

Gets the weights for the blue channel.

```APIDOC
## Property: weightsB (get)

### Description
Gets the weights for the blue channel. Default is `(0.272, 0.534, 0.131)`.

### Returns
- **Vector3** - The weights for the blue channel.
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/ASCIIEffect.js~ASCIIEffect.html

Constructs a new ASCII effect with the given options.

```APIDOC
## constructor(options: Object)

### Description
Constructs a new ASCII effect.

### Parameters
- **options** (Object) - Required - The options for the effect.

### Example
```js
const effect = new ASCIIEffect({ /* options */ });
```
```

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

### get density(): Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/ScanlineEffect.js~ScanlineEffect.html

Gets the scanline density.

```APIDOC
## get density(): Number

### Description
Gets the scanline density.

### Returns
- **Number** - The scanline density.
```

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

### get density(): Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/ScanlineEffect.js~ScanlineEffect.html

Gets the scanline density.

```APIDOC
## Getter: density

### Description
Returns the scanline density.

### Returns
- **Number** - The current scanline density.

### Example
```js
const density = effect.density;
```
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/ASCIIEffect.js~ASCIIEffect.html

Constructs a new ASCII effect with the given options.

```APIDOC
## constructor(options: Object)

### Description
Constructs a new ASCII effect.

### Method
constructor

### Parameters
#### options (Object) - Optional
- **asciiTexture** (ASCIITexture) - Optional - An ASCII character lookup texture.
- **cellSize** (Number) - Optional, default: 16 - The cell size. It's recommended to use even numbers.
- **color** (Number) - Optional, default: null - A color to use instead of the scene colors.
- **inverted** (Boolean) - Optional, default: false - Inverts the effect.

### Override
Effect#constructor
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/BrightnessContrastEffect.js~BrightnessContrastEffect.html

Creates a new BrightnessContrastEffect instance with the given options.

```APIDOC
## Constructor

### `constructor(options: Object)`

Constructs a new brightness/contrast effect.

#### Parameters
- **options** (Object) - Required - The options object.

```

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

### get offset(): Vector2

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/ChromaticAberrationEffect.js~ChromaticAberrationEffect.html

Gets the color offset.

```APIDOC
## get offset(): Vector2

### Description
Gets the color offset.

### Returns
- **Vector2** - The color offset.
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/TextureEffect.js~TextureEffect.html

Constructs a new texture effect with the given options.

```APIDOC
## constructor(options: Object)

### Description
Constructs a new texture effect.

### Parameters
- **options** (Object) - Required - The options for the texture effect.

### Returns
- **TextureEffect** - The newly constructed texture effect.

```

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

### get modulationOffset(): Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/ChromaticAberrationEffect.js~ChromaticAberrationEffect.html

Gets the modulation offset.

```APIDOC
## get modulationOffset(): Number

### Description
Gets the modulation offset.

### Returns
- **Number** - The modulation offset.
```

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

### get texture(): Texture

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/passes/AdaptiveLuminancePass.js~AdaptiveLuminancePass.html

Gets the adaptive luminance texture.

```APIDOC
## get texture(): Texture

### Description
Gets the adaptive luminance texture.

### Returns
- **Texture** - The adaptive luminance texture.

### Example
```js
const tex = pass.texture;
```
```

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

### initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/passes/LuminancePass.js~LuminancePass.html

Performs initialization tasks for the pass. Overrides Pass#initialize.

```APIDOC
## initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

### Description
Performs initialization tasks for the pass. Overrides Pass#initialize.

### Method
POST

### Endpoint
N/A (SDK method)

### Parameters
#### Request Body
- **renderer** (WebGLRenderer) - Required - A renderer.
- **alpha** (Boolean) - Required - Whether the renderer uses the alpha channel.
- **frameBufferType** (Number) - Required - The type of the main frame buffers.

### Request Example
```json
{
  "renderer": {},
  "alpha": true,
  "frameBufferType": 0
}
```

### Response
#### Success Response
No return value.
```

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

### get texture: Texture

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/TextureEffect.js~TextureEffect.html

Gets the texture used by this effect.

```APIDOC
## get texture: Texture

### Description
Gets the texture used by this effect.

### Returns
- **Texture** - The texture.

```

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

### initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/passes/BoxBlurPass.js~BoxBlurPass.html

Performs initialization tasks for the box blur pass.

```APIDOC
## initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

### Description
Performs initialization tasks.

### Parameters
- **renderer** (WebGLRenderer) - Required - The WebGL renderer.
- **alpha** (Boolean) - Required - Whether alpha is enabled.
- **frameBufferType** (Number) - Required - The frame buffer type.

### Example
```js
pass.initialize(renderer, alpha, frameBufferType);
```
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/RealisticBokehEffect.js~RealisticBokehEffect.html

Documentation for the RealisticBokehEffect constructor, which initializes a new bokeh effect with configurable options.

```APIDOC
## constructor(options: Object)

### Description
Constructs a new bokeh effect with the given options.

### Method
constructor

### Parameters
#### options (Object) - Optional
- **options.blendFunction** (BlendFunction) - Optional - The blend function of this effect.
- **options.focus** (Number) - Optional, default: 1.0 - The focus distance in world units.
- **options.focalLength** (Number) - Optional, default: 24.0 - The focal length of the main camera.
- **options.fStop** (Number) - Optional, default: 0.9 - The ratio of the lens focal length to the diameter of the entrance pupil (aperture).
- **options.luminanceThreshold** (Number) - Optional, default: 0.5 - A luminance threshold.
- **options.luminanceGain** (Number) - Optional, default: 2.0 - A luminance gain factor.
- **options.bias** (Number) - Optional, default: 0.5 - A blur bias.
- **options.fringe** (Number) - Optional, default: 0.7 - A blur offset.
- **options.maxBlur** (Number) - Optional, default: 1.0 - The maximum blur strength.
- **options.rings** (Boolean) - Optional, default: 3 - The number of blur iterations.
- **options.samples** (Boolean) - Optional, default: 2 - The amount of samples taken per ring.
- **options.showFocus** (Boolean) - Optional, default: false - Whether the focal point should be highlighted. Useful for debugging.
- **options.manualDoF** (Boolean) - Optional, default: false - Enables manual control over the depth of field.
- **options.pentagon** (Boolean) - Optional, default: false - Enables pentagonal blur shapes. Requires a high number of rings and samples.

### Override
Effect#constructor
```

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

### get adaptationRate: Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/AdaptiveLuminanceMaterial.js~AdaptiveLuminanceMaterial.html

Gets the luminance adaptation rate.

```APIDOC
## get adaptationRate: Number

### Description
Gets the luminance adaptation rate.

### Property
`adaptationRate` (Number) - The luminance adaptation rate.
```

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

### samples (getter/setter)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/RealisticBokehEffect.js~RealisticBokehEffect.html

The amount of blur samples per ring.

```APIDOC
## samples (getter/setter)

### Description
The amount of blur samples per ring.

### Property
- **Type**: Number
- **Access**: Read/Write

### Getter
Returns the current value of `samples`.

### Setter
Sets the value of `samples`.

### Parameters (Setter)
- **value** (Number) - Required - The new value for `samples`.

### Returns (Getter)
- **Number** - The current value of `samples`.
```

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

### get mode(): DepthCopyMode

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/DepthCopyMaterial.js~DepthCopyMaterial.html

Gets the depth copy mode.

```APIDOC
## get mode(): DepthCopyMode

### Description
Gets the depth copy mode.

### Method
get

### Property
mode

### Returns
- **DepthCopyMode** - The depth copy mode.
```

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

### constructor(camera: Camera)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/SSAOMaterial.js~SSAOMaterial.html

Constructs a new SSAO material with the given camera.

```APIDOC
## Constructor

### constructor(camera: Camera)

Constructs a new SSAO material.

#### Parameters
- **camera** (Camera) - Required - The camera used for the SSAO effect.

```

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

### get depthBuffer(): Texture

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/DepthCopyMaterial.js~DepthCopyMaterial.html

Gets the input depth buffer.

```APIDOC
## get depthBuffer(): Texture

### Description
Gets the input depth buffer.

### Method
get

### Property
depthBuffer

### Returns
- **Texture** - The input depth buffer.
```

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

### constructor(camera: Camera)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/SSAOMaterial.js~SSAOMaterial.html

Constructs a new SSAO material with the given camera.

```APIDOC
## constructor(camera: Camera)

### Description
Constructs a new SSAO material.

### Parameters
- **camera** (Camera) - Required - A camera.

```

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

### get scrollSpeed(): Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/ScanlineEffect.js~ScanlineEffect.html

Gets the scanline scroll speed.

```APIDOC
## Getter: scrollSpeed

### Description
Returns the scanline scroll speed.

### Returns
- **Number** - The current scroll speed.

### Example
```js
const speed = effect.scrollSpeed;
```
```

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

### constructor(renderer, options)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/core/EffectComposer.js~EffectComposer.html

Constructs a new effect composer with the given renderer and optional configuration.

```APIDOC
## EffectComposer Constructor

### Description
Constructs a new effect composer with the specified renderer and options.

### Method
constructor

### Parameters
- **renderer** (WebGLRenderer) - Required - The renderer that should be used.
- **options** (Object) - Optional - The options.
  - **options.depthBuffer** (Boolean) - Optional, default: true - Whether the main render targets should have a depth buffer.
  - **options.stencilBuffer** (Boolean) - Optional, default: false - Whether the main render targets should have a stencil buffer.
  - **options.multisampling** (Number) - Optional, default: 0 - The number of samples used for multisample antialiasing. Requires WebGL 2.
  - **options.frameBufferType** (TextureDataType) - Optional, default: UnsignedByteType - The type of the internal frame buffers. It's recommended to use HalfFloatType if possible.
```

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

### get lightPosition

Source: https://pmndrs.github.io/postprocessing/public/docs/file/src/materials/GodRaysMaterial.js.html

Gets the screen space position of the light source.

```APIDOC
## GET lightPosition

### Description
Gets the screen space position of the light source.

### Returns
- **Vector2** - The screen space position of the light source.
```

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

### initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/passes/GaussianBlurPass.js~GaussianBlurPass.html

Performs initialization tasks for the Gaussian blur pass.

```APIDOC
## initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

### Description
Performs initialization tasks.

### Method
initialize

### Parameters
- **renderer** (WebGLRenderer) - Required - The renderer.
- **alpha** (Boolean) - Required - Whether the renderer uses the alpha channel or not.
- **frameBufferType** (Number) - Required - The type of the main frame buffers.

### Override
Pass#initialize
```

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

### get edgeDetectionMode: EdgeDetectionMode

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/EdgeDetectionMaterial.js~EdgeDetectionMaterial.html

Gets the current edge detection mode.

```APIDOC
## get edgeDetectionMode: EdgeDetectionMode

### Description
Gets the edge detection mode.

### Returns
- **EdgeDetectionMode** - The current edge detection mode.

```

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

### get minLuminance: Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/AdaptiveLuminanceMaterial.js~AdaptiveLuminanceMaterial.html

Gets the lowest possible luminance value.

```APIDOC
## get minLuminance: Number

### Description
Gets the lowest possible luminance value.

### Property
`minLuminance` (Number) - The lowest possible luminance value.
```

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

### Import GaussianBlurMaterial

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/GaussianBlurMaterial.js~GaussianBlurMaterial.html

Import the GaussianBlurMaterial class from the 'postprocessing' package.

```javascript
import {GaussianBlurMaterial} from 'postprocessing'
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/DotScreenEffect.js~DotScreenEffect.html

Constructs a new dot screen effect with configurable options for blend function, angle, and scale.

```APIDOC
## DotScreenEffect Constructor

### Description
Constructs a new dot screen effect.

### Method
constructor

### Signature
constructor(options: Object)

### Parameters
#### options (Object) - Optional
- **options.blendFunction** (BlendFunction) - Optional - The blend function of this effect.
- **options.angle** (Number) - Optional, default: 1.57 - The angle of the dot pattern.
- **options.scale** (Number) - Optional, default: 1.0 - The scale of the dot pattern.

### Override
Effect#constructor
```

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

### get outputDepthPacking: DepthPackingStrategies

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/DepthCopyMaterial.js~DepthCopyMaterial.html

Gets the output depth packing strategy.

```APIDOC
## get outputDepthPacking: DepthPackingStrategies

### Description
Gets the output depth packing strategy.

### Method
get

### Property
outputDepthPacking

### Returns
- **DepthPackingStrategies** - The output depth packing strategy.
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/TiltShiftEffect.js~TiltShiftEffect.html

Constructs a new tilt shift effect.

```APIDOC
## Constructor

### Description
Constructs a new tilt shift effect.

### Method
constructor

### Signature
constructor(options: Object)

### Parameters
- **options** (Object) - Required - The options for the tilt shift effect.
```

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

### get intensity

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/SepiaEffect.js~SepiaEffect.html

Gets the intensity of the effect. Deprecated: use blendMode.opacity instead.

```APIDOC
## Property: intensity (get)

### Description
Gets the intensity of the effect. Deprecated: use blendMode.opacity instead.

### Returns
- **Number** - The intensity.
```

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

### get scrollSpeed(): Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/ScanlineEffect.js~ScanlineEffect.html

Gets the scanline scroll speed. Default is 0 (disabled).

```APIDOC
## get scrollSpeed(): Number

### Description
Gets the scanline scroll speed. Default is 0 (disabled).

### Returns
- **Number** - The scanline scroll speed.
```

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

### constructor(options: Object)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/TiltShiftEffect.js~TiltShiftEffect.html

Constructs a new tilt shift effect.

```APIDOC
## Constructor: TiltShiftEffect

### Description
Constructs a new tilt shift effect.

### Parameters
- **options** (Object) - Required - The options for the tilt shift effect.
```

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

### initialize method example: conditionally set render target format

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/effects/Effect.js~Effect.html

Shown in the initialize method documentation. Checks if alpha is false and frameBufferType is UnsignedByteType, then sets the texture format to RGBFormat. This is a typical pattern for handling legacy RGB format in WebGL render targets.

```javascript
if(!alpha && frameBufferType === UnsignedByteType) { this.myRenderTarget.texture.format = RGBFormat; }
```

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

### get texelPosition: Vector2

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/DepthCopyMaterial.js~DepthCopyMaterial.html

Gets the screen space position used for single-texel copy operations.

```APIDOC
## get texelPosition: Vector2

### Description
Gets the screen space position used for single-texel copy operations.

### Method
get

### Property
texelPosition

### Returns
- **Vector2** - The screen space position used for single-texel copy operations.
```

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

### Install postprocessing with npm

Source: https://pmndrs.github.io/postprocessing/public/docs

Install the postprocessing library and its peer dependency three using npm.

```bash
npm install three postprocessing

```

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

### constructor(resizable, width, height, scale)

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/core/Resolution.js~Resolution.html

Constructs a new resolution with the given resizable, width, height, and scale.

```APIDOC
## Resolution Constructor

### Description
Constructs a new resolution.

### Signature
`constructor(resizable: Resizable, width: Number, height: Number, scale: Number)`

### Parameters
- **resizable** (Resizable) - Required - The resizable object.
- **width** (Number) - Required - The base width.
- **height** (Number) - Required - The base height.
- **scale** (Number) - Required - The resolution scale.
```

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

### get edgeDetectionThreshold: Number

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/EdgeDetectionMaterial.js~EdgeDetectionMaterial.html

Gets the edge detection threshold. Range: [0.0, 0.5]. A lower value results in more edges being detected.

```APIDOC
## get edgeDetectionThreshold: Number

### Description
Gets the edge detection threshold. Range: [0.0, 0.5].
A lower value results in more edges being detected at the expense of performance.
For luma- and chroma-based edge detection, 0.1 is a reasonable value and allows to catch most visible edges. 0.05 is a rather overkill value that allows to catch 'em all. Darker scenes may require an even lower threshold.
If depth-based edge detection is used, the threshold will depend on the scene depth.

### Returns
- **Number** - The current edge detection threshold.

```

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

### Import KawaseBlurMaterial from 'postprocessing'

Source: https://pmndrs.github.io/postprocessing/public/docs/class/src/materials/KawaseBlurMaterial.js~KawaseBlurMaterial.html

Import the KawaseBlurMaterial class from the postprocessing package.

```javascript
import {KawaseBlurMaterial} from 'postprocessing'
```
Tokens:
Raw