diff --git a/docs/effects/ascii.mdx b/docs/effects/ascii.mdx
index e338190..f671696 100644
--- a/docs/effects/ascii.mdx
+++ b/docs/effects/ascii.mdx
@@ -26,11 +26,13 @@ return (
## Props
-| Name | Type | Default | Description |
-| ---------- | ------------------- | ----------------------- | --------------------------------------------------------------- |
-| font | String | 'arial' | The font family used to draw the character atlas. |
-| characters | String | ` .:,'-^=*+?!\|0#X%WM@` | The characters to sample from, ordered from "empty" to "dense". |
-| fontSize | Number | 54 | The font size used to draw the character atlas. |
-| cellSize | Number | 16 | The size of each character cell, in pixels. |
-| color | ColorRepresentation | '#ffffff' | The color of the characters. |
-| invert | Boolean | false | Inverts which characters map to bright vs dark pixels. |
+| Name | Type | Default | Description |
+| ------------- | ------------------- | ----------------------- | --------------------------------------------------------------- |
+| font | String | 'arial' | The font family used to draw the character atlas. |
+| characters | String | ` .:,'-^=*+?!\|0#X%WM@` | The characters to sample from, ordered from "empty" to "dense". |
+| fontSize | Number | 54 | The font size used to draw the character atlas. |
+| cellSize | Number | 16 | The size of each character cell, in pixels. |
+| color | ColorRepresentation | '#ffffff' | The color of the characters. |
+| invert | Boolean | false | Inverts which characters map to bright vs dark pixels. |
+| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/bloom.mdx b/docs/effects/bloom.mdx
index db01257..12f6558 100644
--- a/docs/effects/bloom.mdx
+++ b/docs/effects/bloom.mdx
@@ -66,3 +66,4 @@ clamp colors between 0 and 1 again.
| radius | Number | 0.85 | The mipmap blur radius. Only used with mipmapBlur. |
| levels | Number | 8 | The number of mipmap blur levels. Only used with mipmapBlur. |
| opacity | Number | 1 | The opacity of this effect. |
+| resolutionScale | Number | 0.5 | The render resolution scale. Ignored if `mipmapBlur` is enabled. |
diff --git a/docs/effects/brightness-contrast.mdx b/docs/effects/brightness-contrast.mdx
index f43a195..32644d9 100644
--- a/docs/effects/brightness-contrast.mdx
+++ b/docs/effects/brightness-contrast.mdx
@@ -22,7 +22,9 @@ return (
## Props
-| Name | Type | Default | Description |
-| ---------- | ------ | ------- | ---------------------- |
-| brightness | Number | 0 | Scene brightness shift |
-| contrast | Number | 0 | Scene contrast shift |
+| Name | Type | Default | Description |
+| ------------- | ------------- | ----------------- | ---------------------------------- |
+| brightness | Number | 0 | Scene brightness shift |
+| contrast | Number | 0 | Scene contrast shift |
+| blendFunction | BlendFunction | BlendFunction.SRC | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/chromatic-aberration.mdx b/docs/effects/chromatic-aberration.mdx
index 4f9568e..ee8add2 100644
--- a/docs/effects/chromatic-aberration.mdx
+++ b/docs/effects/chromatic-aberration.mdx
@@ -23,7 +23,10 @@ return (
## Props
-| Name | Type | Default | Description |
-| ------------- | ------------- | -------------------- | ---------------------------------- |
-| offset | Vector2 | | The color offset. |
-| blendFunction | BlendFunction | BlendFunction.Normal | The blend function of this effect. |
+| Name | Type | Default | Description |
+| ---------------- | ------------- | -------------------- | ------------------------------------------------------------------------ |
+| offset | Vector2 | [0.001, 0.0005] | The color offset. |
+| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
+| radialModulation | Boolean | false | Scales the offset by the distance from the screen center. |
+| modulationOffset | Number | 0.15 | The radial modulation offset, 0 to 1. Only used with `radialModulation`. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/color-average.mdx b/docs/effects/color-average.mdx
index 76ac1a5..58cfb78 100644
--- a/docs/effects/color-average.mdx
+++ b/docs/effects/color-average.mdx
@@ -25,3 +25,4 @@ return (
| Name | Type | Default | Description |
| ------------- | ------------- | -------------------- | ---------------------------------- |
| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/color-depth.mdx b/docs/effects/color-depth.mdx
index c14558e..fa16074 100644
--- a/docs/effects/color-depth.mdx
+++ b/docs/effects/color-depth.mdx
@@ -25,3 +25,4 @@ return (
| ------------- | ------------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| blendFunction | BlendFunction | | The blend function of this effect. |
| bits | Number | 16 | The virtual amount of color bits. Each color channel effectively uses a fourth of this total; alpha is unaffected. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/depth-of-field.mdx b/docs/effects/depth-of-field.mdx
index 95e3125..2110cbc 100644
--- a/docs/effects/depth-of-field.mdx
+++ b/docs/effects/depth-of-field.mdx
@@ -12,8 +12,8 @@ import { DepthOfField } from '@react-three/postprocessing'
return (
)
@@ -25,11 +25,17 @@ return (
## Props
-| Name | Type | Default | Description |
-| ------------- | ------------- | -------------------- | --------------------------------------------------- |
-| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
-| focusDistance | Number | 0 | The normalized focus distance. Range is [0.0, 1.0]. |
-| focalLength | Number | 0.1 | The focal length. Range is [0.0, 1.0]. |
-| bokehScale | Number | 1.0 | The scale of the bokeh blur. |
-| width | Number | Resizer.width | The render width. |
-| height | Number | Resizer.height | The render height. |
+| Name | Type | Default | Description |
+| --------------- | --------------------------------------- | -------------------- | ------------------------------------------------------------- |
+| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
+| focusDistance | Number | 3 | The focus distance in world units. |
+| focusRange | Number | 2 | The focus range in world units. |
+| bokehScale | Number | 1 | The scale of the bokeh blur. |
+| target | Vector3 | | A world position to keep in focus. Overrides `focusDistance`. |
+| depthTexture | `{ texture: Texture, packing: number }` | | A depth texture to use instead of the composer's own. |
+| resolutionScale | Number | 0.5 | The render resolution scale. |
+| resolutionX | Number | Resolution.AUTO_SIZE | The render width. |
+| resolutionY | Number | Resolution.AUTO_SIZE | The render height. |
+| opacity | Number | 1 | The opacity of this effect. |
+
+`focalLength`, `worldFocusDistance`, `worldFocusRange`, `width`, `height` and `blur` are deprecated.
diff --git a/docs/effects/depth.mdx b/docs/effects/depth.mdx
index dab298b..f1b2e44 100644
--- a/docs/effects/depth.mdx
+++ b/docs/effects/depth.mdx
@@ -27,3 +27,4 @@ return (
| ------------- | ------------- | ----------------- | ------------------------------------- |
| blendFunction | BlendFunction | BlendFunction.SRC | The blend function of this effect. |
| inverted | Boolean | false | Whether the depth should be inverted. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/dot-screen.mdx b/docs/effects/dot-screen.mdx
index ec1e6f4..4e4ff1d 100644
--- a/docs/effects/dot-screen.mdx
+++ b/docs/effects/dot-screen.mdx
@@ -29,3 +29,4 @@ return (
| angle | Number | 1 .57 | The angle of the dot pattern. |
| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
| scale | Number | 1 .57 | The scale of the dot pattern. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/fxaa.mdx b/docs/effects/fxaa.mdx
index d763e36..4c8a2a9 100644
--- a/docs/effects/fxaa.mdx
+++ b/docs/effects/fxaa.mdx
@@ -22,10 +22,11 @@ return (
## Props
-| Name | Type | Default | Description |
-| ----------------- | ------------- | -------------------- | -------------------------------------------------------- |
-| blendFunction | BlendFunction | BlendFunction.SRC | The blend function of this effect. |
-| minEdgeThreshold | Number | 0.0312 | The minimum edge detection threshold. Range [0.0, 1.0]. |
-| maxEdgeThreshold | Number | 0.125 | The maximum edge detection threshold. Range [0.0, 1.0]. |
-| subpixelQuality | Number | 0.75 | The subpixel blend quality. Range [0.0, 1.0]. |
-| samples | Number | 12 | The maximum amount of edge detection samples. |
+| Name | Type | Default | Description |
+| ---------------- | ------------- | ----------------- | ------------------------------------------------------- |
+| blendFunction | BlendFunction | BlendFunction.SRC | The blend function of this effect. |
+| minEdgeThreshold | Number | 0.0312 | The minimum edge detection threshold. Range [0.0, 1.0]. |
+| maxEdgeThreshold | Number | 0.125 | The maximum edge detection threshold. Range [0.0, 1.0]. |
+| subpixelQuality | Number | 0.75 | The subpixel blend quality. Range [0.0, 1.0]. |
+| samples | Number | 12 | The maximum amount of edge detection samples. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/glitch.mdx b/docs/effects/glitch.mdx
index e44e574..853aab2 100644
--- a/docs/effects/glitch.mdx
+++ b/docs/effects/glitch.mdx
@@ -32,10 +32,12 @@ return (
| active | Boolean | true | Turn the effect on and off |
| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
| chromaticAberrationOffset | Vector2 | | A chromatic aberration offset. If provided, the glitch effect will influence this offset. |
-| delay | Vector2 | | The minimum and maximum delay between glitch activations in seconds. |
-| duration | Vector2 | | The minimum and maximum duration of a glitch in seconds. |
-| strength | Vector2 | | The strength of weak and strong glitches. |
+| delay | Vector2 | [1.5, 3.5] | The minimum and maximum delay between glitch activations in seconds. |
+| duration | Vector2 | [0.6, 1.0] | The minimum and maximum duration of a glitch in seconds. |
+| strength | Vector2 | [0.3, 1.0] | The strength of weak and strong glitches. |
| perturbationMap | Texture | | A perturbation map. If none is provided, a noise texture will be created. |
| dtSize | Number | 64 | The size of the generated noise map. Will be ignored if a perturbation map is provided. |
| columns | Number | 0.05 | The scale of the blocky glitch columns. |
| ratio | Number | 0.85 | The threshold for strong glitches. |
+| mode | GlitchMode | GlitchMode.SPORADIC | The glitch mode. Ignored while `active` is false. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/god-rays.mdx b/docs/effects/god-rays.mdx
index aa19f57..2fb2803 100644
--- a/docs/effects/god-rays.mdx
+++ b/docs/effects/god-rays.mdx
@@ -34,17 +34,19 @@ return (
## Props
-| Name | Type | Default | Description |
-| ------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------- | ---------------------------------------------------------------------------- |
-| sun | Ref | | The light source. Must not write depth and has to be flagged as transparent. |
-| blendFunction | BlendFunction | BlendFunction.Screen | The blend function of this effect. |
-| samples | Number | 60 | The number of samples per pixel. |
-| density | Number | 0.96 | The density of the light rays. |
-| decay | Number | 0.9 | An illumination decay factor. |
-| weight | Number | 0.4 | A light ray weight factor. |
-| exposure | Number | 0.6 | A constant attenuation coefficient. |
-| clampMax | Number | 1 | An upper bound for the saturation of the overall effect. |
-| width | Number | Resizer.AUTO_SIZE | The render width. |
-| height | Number | Resizer.AUTO_SIZE | The render height. |
-| kernelSize | [KernelSize](https://vanruesc.github.io/postprocessing/public/docs/variable/index.html#static-variable-KernelSize) | KernelSize.SMALL | The blur kernel size. Has no effect if blur is disabled. |
-| blur | Boolean | true | Whether the god rays should be blurred to reduce artifacts |
+| Name | Type | Default | Description |
+| --------------- | ------------------------------------------------------------------------------------------------------------------ | -------------------- | ---------------------------------------------------------------------------- |
+| sun | Ref | | The light source. Must not write depth and has to be flagged as transparent. |
+| blendFunction | BlendFunction | BlendFunction.SCREEN | The blend function of this effect. |
+| samples | Number | 60 | The number of samples per pixel. |
+| density | Number | 0.96 | The density of the light rays. |
+| decay | Number | 0.9 | An illumination decay factor. |
+| weight | Number | 0.4 | A light ray weight factor. |
+| exposure | Number | 0.6 | A constant attenuation coefficient. |
+| clampMax | Number | 1 | An upper bound for the saturation of the overall effect. |
+| resolutionScale | Number | 0.5 | The render resolution scale. |
+| resolutionX | Number | Resolution.AUTO_SIZE | The render width. |
+| resolutionY | Number | Resolution.AUTO_SIZE | The render height. |
+| kernelSize | [KernelSize](https://vanruesc.github.io/postprocessing/public/docs/variable/index.html#static-variable-KernelSize) | KernelSize.SMALL | The blur kernel size. Has no effect if blur is disabled. |
+| blur | Boolean | true | Whether the god rays should be blurred to reduce artifacts |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/hue-saturation.mdx b/docs/effects/hue-saturation.mdx
index 9e443e2..e6d208c 100644
--- a/docs/effects/hue-saturation.mdx
+++ b/docs/effects/hue-saturation.mdx
@@ -29,3 +29,4 @@ return (
| hue | Number | 0 | Hue shift in radians |
| saturation | Number | 0 | Saturation value in radians |
| blendFunction | BlendFunction | | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/lens-distortion.mdx b/docs/effects/lens-distortion.mdx
index 42ec633..1d12eb0 100644
--- a/docs/effects/lens-distortion.mdx
+++ b/docs/effects/lens-distortion.mdx
@@ -20,9 +20,11 @@ return (
## Props
-| Name | Type | Default | Description |
-| -------------- | ------- | ------- | --------------------------------------- |
-| distortion | Vector2 | [0, 0] | The radial distortion coefficients. |
-| principalPoint | Vector2 | [0, 0] | The center point offset. |
-| focalLength | Vector2 | [1, 1] | The focal length. Lower values zoom in. |
-| skew | Number | 0 | The skew factor in radians. |
+| Name | Type | Default | Description |
+| -------------- | ------------- | -------------------- | --------------------------------------- |
+| distortion | Vector2 | [0, 0] | The radial distortion coefficients. |
+| principalPoint | Vector2 | [0, 0] | The center point offset. |
+| focalLength | Vector2 | [1, 1] | The focal length. Lower values zoom in. |
+| skew | Number | 0 | The skew factor in radians. |
+| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/lut.mdx b/docs/effects/lut.mdx
index 72e1ab6..54db4cf 100644
--- a/docs/effects/lut.mdx
+++ b/docs/effects/lut.mdx
@@ -20,8 +20,9 @@ return (
## Props
-| Name | Type | Default | Description |
-| ------------------------ | ------------- | -------------------- | ----------------------------------------------------- |
-| lut | Texture | | The lookup texture. Required. |
-| blendFunction | BlendFunction | BlendFunction.SRC | The blend function of this effect. |
-| tetrahedralInterpolation | Boolean | false | Enables or disables tetrahedral interpolation. |
+| Name | Type | Default | Description |
+| ------------------------ | ------------- | ----------------- | ---------------------------------------------- |
+| lut | Texture | | The lookup texture. Required. |
+| blendFunction | BlendFunction | BlendFunction.SRC | The blend function of this effect. |
+| tetrahedralInterpolation | Boolean | false | Enables or disables tetrahedral interpolation. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/noise.mdx b/docs/effects/noise.mdx
index 5411f81..f68ea25 100644
--- a/docs/effects/noise.mdx
+++ b/docs/effects/noise.mdx
@@ -27,3 +27,4 @@ return (
| ------------- | ------------- | -------------------- | ------------------------------------------------------------ |
| premultiply | Boolean | false | Whether the noise should be multiplied with the input color. |
| blendFunction | BlendFunction | BlendFunction.SCREEN | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/outline.mdx b/docs/effects/outline.mdx
index 98ee73a..8e7f235 100644
--- a/docs/effects/outline.mdx
+++ b/docs/effects/outline.mdx
@@ -39,23 +39,24 @@ return (
## Props
-| Name | Type | Default | Description |
-| ---------------- | -------------------- | ----------------------- | ------------------------------------------------------------------------------------- |
-| selection | Objects | | Selection of objects that will be outlined |
-| selectionLayer | Number | 10 | The selection layer |
-| blendFunction | BlendFunction | BlendFunction.SCREEN | The blend function of this effect. |
-| patternTexture | THREE.Texture | null | A pattern texture. |
-| patternScale | Number | 1.0 | The pattern texture scale. |
-| edgeStrength | Number | 1.0 | The edge strength. |
-| pulseSpeed | Number | 0 | The pulse speed. A value of zero disables the pulse effect. |
-| visibleEdgeColor | ColorRepresentation | 0xffffff | The color of visible edges. |
-| hiddenEdgeColor | ColorRepresentation | 0x22090a | The color of hidden edges. |
-| multisampling | Number | 0 | The number of samples used for multisample antialiasing. Requires WebGL 2. |
-| resolutionScale | Number | 0.5 | The render resolution scale. Applied at construction only. |
-| resolutionX | Number | Resolution.AUTO_SIZE | The render width. Applied at construction only. |
-| resolutionY | Number | Resolution.AUTO_SIZE | The render height. Applied at construction only. |
-| width | Number | Resizer.AUTO_SIZE | The render width. Unlike `resolutionX`, updates live without reconstructing the effect. |
-| height | Number | Resizer.AUTO_SIZE | The render height. Unlike `resolutionY`, updates live without reconstructing the effect. |
-| kernelSize | KernelSize | KernelSize.VERY_SMALL | The blur kernel size. |
-| blur | Boolean | false | Whether the outline should be blurred. |
-| xRay | Boolean | true | Whether occluded parts of selected objects should be visible. |
+| Name | Type | Default | Description |
+| ---------------- | ------------------- | --------------------- | ---------------------------------------------------------------------------------------- |
+| selection | Objects | | Selection of objects that will be outlined |
+| selectionLayer | Number | 10 | The selection layer |
+| blendFunction | BlendFunction | BlendFunction.SCREEN | The blend function of this effect. |
+| patternTexture | THREE.Texture | null | A pattern texture. |
+| patternScale | Number | 1.0 | The pattern texture scale. |
+| edgeStrength | Number | 1.0 | The edge strength. |
+| pulseSpeed | Number | 0 | The pulse speed. A value of zero disables the pulse effect. |
+| visibleEdgeColor | ColorRepresentation | 0xffffff | The color of visible edges. |
+| hiddenEdgeColor | ColorRepresentation | 0x22090a | The color of hidden edges. |
+| multisampling | Number | 0 | The number of samples used for multisample antialiasing. Requires WebGL 2. |
+| resolutionScale | Number | 0.5 | The render resolution scale. Applied at construction only. |
+| resolutionX | Number | Resolution.AUTO_SIZE | The render width. Applied at construction only. |
+| resolutionY | Number | Resolution.AUTO_SIZE | The render height. Applied at construction only. |
+| width | Number | Resizer.AUTO_SIZE | The render width. Unlike `resolutionX`, updates live without reconstructing the effect. |
+| height | Number | Resizer.AUTO_SIZE | The render height. Unlike `resolutionY`, updates live without reconstructing the effect. |
+| kernelSize | KernelSize | KernelSize.VERY_SMALL | The blur kernel size. |
+| blur | Boolean | false | Whether the outline should be blurred. |
+| xRay | Boolean | true | Whether occluded parts of selected objects should be visible. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/ramp.mdx b/docs/effects/ramp.mdx
index 2e97fd6..268e767 100644
--- a/docs/effects/ramp.mdx
+++ b/docs/effects/ramp.mdx
@@ -29,14 +29,16 @@ return (
## Props
-| Name | Type | Default | Description |
-| ---------- | -------------------------------------------- | --------------- | -------------------------------------------------------------------------------------------------------------- |
-| rampType | RampType | RampType.Linear | Type of ramp gradient. |
-| rampStart | [x: number, y: number] | [0.5, 0.5] | Starting point of the ramp gradient in normalized coordinates. |
-| rampEnd | [x: number, y: number] | [1.0, 1.0] | Ending point of the ramp gradient in normalized coordinates. |
-| startColor | [r: number, g: number, b: number, a: number] | [0, 0, 0, 1] | Color at the starting point of the gradient. |
-| endColor | [r: number, g: number, b: number, a: number] | [1, 1, 1, 1] | Color at the ending point of the gradient. |
-| rampBias | number | 0.5 | Bias for the interpolation curve when both bias and gain are 0.5. |
-| rampGain | number | 0.5 | Gain for the interpolation curve when both bias and gain are 0.5. |
-| rampMask | boolean | false | When enabled, the ramp gradient is used as an effect mask, and colors are ignored. |
-| rampInvert | boolean | false | Controls whether the ramp gradient is inverted. When disabled, rampStart is transparent and rampEnd is opaque. |
+| Name | Type | Default | Description |
+| ------------- | -------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------- |
+| rampType | RampType | RampType.Linear | Type of ramp gradient. |
+| rampStart | [x: number, y: number] | [0.5, 0.5] | Starting point of the ramp gradient in normalized coordinates. |
+| rampEnd | [x: number, y: number] | [1.0, 1.0] | Ending point of the ramp gradient in normalized coordinates. |
+| startColor | [r: number, g: number, b: number, a: number] | [0, 0, 0, 1] | Color at the starting point of the gradient. |
+| endColor | [r: number, g: number, b: number, a: number] | [1, 1, 1, 1] | Color at the ending point of the gradient. |
+| rampBias | number | 0.5 | Bias for the interpolation curve when both bias and gain are 0.5. |
+| rampGain | number | 0.5 | Gain for the interpolation curve when both bias and gain are 0.5. |
+| rampMask | boolean | false | When enabled, the ramp gradient is used as an effect mask, and colors are ignored. |
+| rampInvert | boolean | false | Controls whether the ramp gradient is inverted. When disabled, rampStart is transparent and rampEnd is opaque. |
+| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/scanline.mdx b/docs/effects/scanline.mdx
index 2d13a12..60e759c 100644
--- a/docs/effects/scanline.mdx
+++ b/docs/effects/scanline.mdx
@@ -29,3 +29,4 @@ return (
| ------------- | ------------- | --------------------- | ---------------------------------- |
| density | Number | 1.25 | The scanline density. |
| blendFunction | BlendFunction | BlendFunction.OVERLAY | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/selective-bloom.mdx b/docs/effects/selective-bloom.mdx
index db12711..dcae71f 100644
--- a/docs/effects/selective-bloom.mdx
+++ b/docs/effects/selective-bloom.mdx
@@ -47,7 +47,7 @@ return (
| selectionLayer | Number | 10 | The selection layer |
| inverted | Boolean | false | Consider the selection inverted. |
| ignoreBackground | Boolean | false | Discard the background of the selection. |
-| blendFunction | BlendFunction | BlendFunction.SCREEN | The blend function of this effect. |
+| blendFunction | BlendFunction | BlendFunction.ADD | The blend function of this effect. |
| luminanceThreshold | Number | 1.0 | The luminance threshold. Raise this value to mask out darker elements in the scene. Range is [0, 1]. |
| luminanceSmoothing | Number | 0.03 | Controls the smoothness of the luminance threshold. Range is [0, 1]. |
| mipmapBlur | Boolean | true | Enables or disables mipmap blur. |
@@ -58,3 +58,4 @@ return (
| resolutionScale | Number | 0.5 | The render resolution scale. Ignored if `mipmapBlur` is enabled. |
| resolutionX | Number | Resolution.AUTO_SIZE | The render width. Ignored if `mipmapBlur` is enabled. |
| resolutionY | Number | Resolution.AUTO_SIZE | The render height. Ignored if `mipmapBlur` is enabled. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/sepia.mdx b/docs/effects/sepia.mdx
index 5a01da5..9f68e5d 100644
--- a/docs/effects/sepia.mdx
+++ b/docs/effects/sepia.mdx
@@ -26,3 +26,4 @@ return (
| ------------- | ------------- | -------------------- | ---------------------------------- |
| intensity | Number | 1 | The intensity of the effect |
| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/smaa.mdx b/docs/effects/smaa.mdx
index 503293c..1281fb1 100644
--- a/docs/effects/smaa.mdx
+++ b/docs/effects/smaa.mdx
@@ -21,3 +21,13 @@ return (
)
```
+
+## Props
+
+| Name | Type | Default | Description |
+| ----------------- | ----------------- | ------------------------ | ---------------------------------- |
+| preset | SMAAPreset | SMAAPreset.MEDIUM | The quality preset. |
+| edgeDetectionMode | EdgeDetectionMode | EdgeDetectionMode.COLOR | The edge detection mode. |
+| predicationMode | PredicationMode | PredicationMode.DISABLED | The predication mode. |
+| blendFunction | BlendFunction | BlendFunction.SRC | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/ssao.mdx b/docs/effects/ssao.mdx
index 1bc8e55..2a057c6 100644
--- a/docs/effects/ssao.mdx
+++ b/docs/effects/ssao.mdx
@@ -35,28 +35,29 @@ return (
## Props
-| Name | Type | Default | Description |
-| ----------------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
-| blendFunction | [BlendFunction](https://vanruesc.github.io/postprocessing/public/docs/variable/index.html#static-variable-BlendFunction) | BlendFunction.MULTIPLY | The blend function of this effect. |
-| depthAwareUpsampling | Boolean | true | Enables or disables depth-aware upsampling. Has no effect if WebGL 2 is not supported. |
-| normalDepthBuffer | Texture | null | A texture with downsampled scene normals and depth, supplied automatically from ``. See [DepthDownsamplingPass](https://vanruesc.github.io/postprocessing/public/docs/class/src/passes/DepthDownsamplingPass.js~DepthDownsamplingPass.html). |
-| samples | Number | 30 | The amount of samples per pixel. Should not be a multiple of the ring count. |
-| rings | Number | 4 | The amount of spiral turns in the occlusion sampling pattern. Should be a prime number. |
-| distanceThreshold | Number | 1 | Deprecated in favor of `worldDistanceThreshold`. A global distance threshold at which the occlusion effect starts to fade out. Range [0.0, 1.0]. |
-| distanceFalloff | Number | 0.0 | Deprecated in favor of `worldDistanceFalloff`. The distance falloff. Influences the smoothness of the overall occlusion cutoff. Range [0.0, 1.0]. |
-| worldDistanceThreshold | Number | undefined | The world distance threshold at which the occlusion effect starts to fade out. |
-| worldDistanceFalloff | Number | undefined | The world distance falloff. Influences the smoothness of the occlusion cutoff. |
-| rangeThreshold | Number | 0.5 | Deprecated in favor of `worldProximityThreshold`. A local occlusion range threshold at which the occlusion starts to fade out. Range [0.0, 1.0]. |
-| rangeFalloff | Number | 0.1 | Deprecated in favor of `worldProximityFalloff`. The occlusion range falloff. Influences the smoothness of the proximity cutoff. Range [0.0, 1.0]. |
-| worldProximityThreshold | Number | undefined | The world proximity threshold at which the occlusion starts to fade out. |
-| worldProximityFalloff | Number | undefined | The world proximity falloff. Influences the smoothness of the proximity cutoff. |
-| minRadiusScale | Number | 0.1 | The minimum radius scale. |
-| luminanceInfluence | Number | 0.9 | Determines how much the luminance of the scene influences the ambient occlusion. |
-| radius | Number | 20 | The occlusion sampling radius, expressed as a scale relative to the resolution. Range [1e-6, 1.0]. |
-| intensity | Number | 1.0 | The intensity of the ambient occlusion. |
-| bias | Number | 0.5 | An occlusion bias. Eliminates artifacts caused by depth discontinuities. |
-| fade | Number | 0.01 | Influences the smoothness of the shadows. A lower value results in higher contrast. |
-| color | Color | null | The color of the ambient occlusion. |
-| resolutionScale | Number | 1.0 | The resolution scale. Inherits `` if set. |
-| resolutionX | Number | Resolution.AUTO_SIZE | The render width. |
-| resolutionY | Number | Resolution.AUTO_SIZE | The render height. |
+| Name | Type | Default | Description |
+| ----------------------- | ------------------------------------------------------------------------------------------------------------------------ | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| blendFunction | [BlendFunction](https://vanruesc.github.io/postprocessing/public/docs/variable/index.html#static-variable-BlendFunction) | BlendFunction.MULTIPLY | The blend function of this effect. |
+| depthAwareUpsampling | Boolean | true | Enables or disables depth-aware upsampling. Has no effect if WebGL 2 is not supported. |
+| normalDepthBuffer | Texture | | Deprecated and ignored. Supplied automatically from ``. |
+| samples | Number | 30 | The amount of samples per pixel. Should not be a multiple of the ring count. |
+| rings | Number | 4 | The amount of spiral turns in the occlusion sampling pattern. Should be a prime number. |
+| distanceThreshold | Number | 1 | Deprecated in favor of `worldDistanceThreshold`. A global distance threshold at which the occlusion effect starts to fade out. Range [0.0, 1.0]. |
+| distanceFalloff | Number | 0.0 | Deprecated in favor of `worldDistanceFalloff`. The distance falloff. Influences the smoothness of the overall occlusion cutoff. Range [0.0, 1.0]. |
+| worldDistanceThreshold | Number | undefined | The world distance threshold at which the occlusion effect starts to fade out. |
+| worldDistanceFalloff | Number | undefined | The world distance falloff. Influences the smoothness of the occlusion cutoff. |
+| rangeThreshold | Number | 0.5 | Deprecated in favor of `worldProximityThreshold`. A local occlusion range threshold at which the occlusion starts to fade out. Range [0.0, 1.0]. |
+| rangeFalloff | Number | 0.1 | Deprecated in favor of `worldProximityFalloff`. The occlusion range falloff. Influences the smoothness of the proximity cutoff. Range [0.0, 1.0]. |
+| worldProximityThreshold | Number | undefined | The world proximity threshold at which the occlusion starts to fade out. |
+| worldProximityFalloff | Number | undefined | The world proximity falloff. Influences the smoothness of the proximity cutoff. |
+| minRadiusScale | Number | 0.1 | The minimum radius scale. |
+| luminanceInfluence | Number | 0.9 | Determines how much the luminance of the scene influences the ambient occlusion. |
+| radius | Number | 20 | The occlusion sampling radius, expressed as a scale relative to the resolution. Range [1e-6, 1.0]. |
+| intensity | Number | 1.0 | The intensity of the ambient occlusion. |
+| bias | Number | 0.5 | An occlusion bias. Eliminates artifacts caused by depth discontinuities. |
+| fade | Number | 0.01 | Influences the smoothness of the shadows. A lower value results in higher contrast. |
+| color | ColorRepresentation \| null | null | Tints the ambient occlusion. `null` disables tinting. |
+| resolutionScale | Number | 1.0 | The resolution scale. Inherits `` if set. |
+| resolutionX | Number | Resolution.AUTO_SIZE | The render width. |
+| resolutionY | Number | Resolution.AUTO_SIZE | The render height. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/texture.mdx b/docs/effects/texture.mdx
index 11bc6c0..e0dd7a4 100644
--- a/docs/effects/texture.mdx
+++ b/docs/effects/texture.mdx
@@ -23,10 +23,10 @@ return (
## Props
-| Name | Type | Default | Description |
-| ---------------- | ------------- | ------- | ------------------------------------------------------------------- |
-| textureSrc | String | | URL of the texture to load. |
-| texture | Texture | | An already-loaded texture - alternative to `textureSrc`. |
-| blendFunction | BlendFunction | | The blend function of this effect. |
-| opacity | Number | 1 | The opacity of the texture. |
-| aspectCorrection | Boolean | false | Deprecated. Adjust the texture's offset, repeat and center instead. |
+| Name | Type | Default | Description |
+| ---------------- | ------------- | -------------------- | ------------------------------------------------------------------- |
+| textureSrc | String | | URL of the texture to load. Pass either this or `texture`. |
+| texture | Texture | | An already-loaded texture. Pass either this or `textureSrc`. |
+| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
+| opacity | Number | 1 | The opacity of the texture. |
+| aspectCorrection | Boolean | false | Deprecated. Adjust the texture's offset, repeat and center instead. |
diff --git a/docs/effects/tilt-shift-2.mdx b/docs/effects/tilt-shift-2.mdx
index 0e8aa6b..d716274 100644
--- a/docs/effects/tilt-shift-2.mdx
+++ b/docs/effects/tilt-shift-2.mdx
@@ -37,3 +37,4 @@ return (
| end | [Number, Number] | [0.5, 1.0] | End point of the blur band, in screen-space percent. |
| samples | Number | 10 | The number of blur samples. |
| direction | [Number, Number] | [1, 1] | The direction of the blur. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/tilt-shift.mdx b/docs/effects/tilt-shift.mdx
index fe8391f..c85660e 100644
--- a/docs/effects/tilt-shift.mdx
+++ b/docs/effects/tilt-shift.mdx
@@ -39,3 +39,4 @@ return (
| resolutionScale | Number | 0.5 | The resolution scale. |
| resolutionX | Number | Resolution.AUTO_SIZE | The horizontal resolution. |
| resolutionY | Number | Resolution.AUTO_SIZE | The vertical resolution. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/tone-mapping.mdx b/docs/effects/tone-mapping.mdx
index 556190c..1f93854 100644
--- a/docs/effects/tone-mapping.mdx
+++ b/docs/effects/tone-mapping.mdx
@@ -41,14 +41,16 @@ return (
## Props
-| Name | Type | Default | Description |
-| ---------------- | --------------- | ------- | ------------------------------------------------------------------- |
-| mode | ToneMappingMode | | The tone mapping algorithm |
-| resolution | Number | 256 | The resolution of the luminance texture. Must be a power of two. |
-| adaptive | boolean | true | Toggle adaptive luminance map usage |
-| blendFunction | BlendFunction | | The blend function of this effect. |
-| middleGrey | Number | 0.6 | The middle grey factor. |
-| maxLuminance | Number | 16 | Maximum luminance |
-| minLuminance | Number | 0.01 | The minimum luminance. Prevents very high exposure in dark scenes. |
-| averageLuminance | Number | 1 | The average luminance. Used for the non-adaptive Reinhard operator. |
-| adaptationRate | Number | 1 | The luminance adaptation rate. |
+| Name | Type | Default | Description |
+| ---------------- | --------------- | ------------------- | ------------------------------------------------------------------- |
+| mode | ToneMappingMode | ToneMappingMode.AGX | The tone mapping algorithm. |
+| resolution | Number | 256 | The resolution of the luminance texture. Must be a power of two. |
+| adaptive | Boolean | false | Deprecated. Use `mode` instead. |
+| blendFunction | BlendFunction | BlendFunction.SRC | The blend function of this effect. |
+| middleGrey | Number | 0.6 | The middle grey factor. |
+| maxLuminance | Number | 4 | Deprecated. Use `whitePoint` instead. |
+| minLuminance | Number | 0.01 | The minimum luminance. Prevents very high exposure in dark scenes. |
+| averageLuminance | Number | 1 | The average luminance. Used for the non-adaptive Reinhard operator. |
+| adaptationRate | Number | 1 | The luminance adaptation rate. |
+| whitePoint | Number | 4 | The white point. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/vignette.mdx b/docs/effects/vignette.mdx
index 6a5c02e..35f3482 100644
--- a/docs/effects/vignette.mdx
+++ b/docs/effects/vignette.mdx
@@ -25,9 +25,11 @@ return (
## Props
-| Name | Type | Default | Description |
-| ------------- | ------------- | -------------------- | ----------------------------------- |
-| eskil | Boolean | false | Enables Eskil's vignette technique. |
-| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
-| offset | Number | 0.5 | The vignette offset. |
-| darkness | Number | 0.5 | The vignette darkness. |
+| Name | Type | Default | Description |
+| ------------- | ----------------- | ------------------------- | ------------------------------------ |
+| eskil | Boolean | false | Deprecated. Use `technique` instead. |
+| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
+| offset | Number | 0.5 | The vignette offset. |
+| darkness | Number | 0.5 | The vignette darkness. |
+| technique | VignetteTechnique | VignetteTechnique.DEFAULT | The vignette technique. |
+| opacity | Number | 1 | The opacity of this effect. |
diff --git a/docs/effects/water.mdx b/docs/effects/water.mdx
index be8da90..41becb3 100644
--- a/docs/effects/water.mdx
+++ b/docs/effects/water.mdx
@@ -27,3 +27,4 @@ return (
| ------------- | ------------- | -------------------- | ---------------------------------- |
| blendFunction | BlendFunction | BlendFunction.NORMAL | The blend function of this effect. |
| factor | Number | 0 | The distortion strength. |
+| opacity | Number | 1 | The opacity of this effect. |