postprocessing

Requires three ≥ 0.107.0 < 0.141.0

Changelog

Effects

• BloomEffect
  • Fixed luminanceSmoothing constructor parameter.
  • Output will no longer be clamped to [0.0, 1.0].
• GodRaysEffect
  • Added depthMaskMaterial getter.
• SelectiveBloomEffect
  • Fixed a bug that broke depth masking when the selection was empty.
• ToneMappingEffect
  • Added accessors for whitePoint, middleGrey and averageLuminance.

Materials

• DepthMaskMaterial
  • Changed default value of epsilon to 1e-4.

Passes

• EffectPass
  • Changed visibility of effects to protected.
  • Changed visibility of updateMaterial to protected.
  • Reverted deprecation of dithering.

Special Thanks

Thanks @canadaduane for the continued support!

Requires three ≥ 0.107.0 < 0.140.0

Requires three ≥ 0.107.0 < 0.139.0

Changelog

Effects

• SMAAEffect
  • Fixed load event. See 5aa2d5a.

Requires three ≥ 0.107.0 < 0.139.0

Changelog

Package

Added auto-generated types. Warning: expect errors. Thanks @superguigui.

Effects

• SMAAEffect
  • The effect will now emit a load event when the internal textures have been loaded.
  • Fixed: preloaded images will now be picked up again, if provided.

Requires three ≥ 0.107.0 < 0.139.0

Postprocessing has recently joined the Poimandres organization 🎉 The motivation behind this is to get more eyes on postprocessing and to ensure that the library continues to evolve as part of something bigger. Apart from that, nothing really changes though! — vanruesc

Changelog

Effects

• BlendMode
  • Added blendFunction accessor.
  • Deprecated getBlendFunction and setBlendFunction.
• ColorAverageEffect & SepiaEffect
  • Minor optimizations.
• DepthOfFieldEffect
  • Renamed circleOfConfusionMaterial to cocMaterial. See 110a381.
  • Fixed calculateFocusDistance. See 2e1b6a8, 2fafb76 and 3739f62.
  • Added constructor parameters worldFocusDistance and worldFocusRange. See 660dd2c.
  • Renamed constructor parameter focalLength to focusRange.
• ScanlineEffect
  • Added support for scrolling scanlines.
  • Added scrollSpeed accessor.
• SMAAEffect
  • It's no longer necessary to preload the search and area lookup textures. See 164a927.
  • The constructor now accepts the named parameters preset, edgeDetectionMode and predicationMode. The old signature is still supported.
• SSAOEffect
  • Fixed a bug that prevented the effect from receiving a depth texture. See 5272f55.
  • Added constructor parameters worldDistanceThreshold, worldDistanceFalloff, worldProximityThreshold and worldProximityFalloff. See 397e287.
  • Added luminanceInfluence accessor.
  • Changed default of minRadiusScale constructor parameter to 0.1.
  • Made depthAwareUpsampling setting more robust. See e5f10f2.

Loaders

• Deprecated SMAAImageLoader.

Materials

• CircleOfConfusionMaterial
  • Renamed focalLength to focusRange. See c9c43f1.
  • Added worldFocusDistance and worldFocusRange accessors. See 3868614.
• SSAOMaterial
  • Added worldDistanceThreshold, worldDistanceFalloff, worldProximityThreshold and worldProximityFalloff accessors. See 6777946.

Special Thanks

Thanks @canadaduane for the financial support!

Requires three ≥ 0.107.0 < 0.139.0

Attention: Inheritance of legacy classes such as DataTexture3D is broken in three r138 (https://github.com/mrdoob/three.js/issues/23612) and will be fixed in r139 (https://github.com/mrdoob/three.js/pull/23621). It's recommended to skip r138 if you use LUTEffect.

Changelog

Following #349, the getter and setter methods that were introduced in 6.24.0 have been replaced by accessor properties. Methods of the form getFoo and setFoo are now properties of the form foo with some exceptions listed below. For details see 387d5b0, f98d002, 276ee71, de14746, 07617b6, 87f1083, 55f5d39, d5c91e2.

Core

• EffectComposer
  • It's no longer necessary to use HalfFloatType buffers for sRGB workflows. See 0bf44077.
  • Handled removal of WebGLMultisampleRenderTarget.
  • Timer auto reset behaviour will now be restored on reset.
• Selection
  • Added toggle method.

Effects

• Effect
  • Fixed unintentional disposal of renderer. See #353.
  • Deprecated renderer and setRenderer.
• ChromaticAberrationEffect
  • The offset now respects the aspect ratio.
• GlitchEffect
  • Deprecated generatePerturbationMap.
  • Replaced getGlitchColumns and setGlitchColumns with columns accessor.
  • Replaced getGlitchRatio and setGlitchRatio with ratio accessor.
• NoiseEffect
  • Replaced isPremultiplied and setPremultiplied with premultiply accessor.
• OutlineEffect
  • Added patternScale constructor parameter.
  • Added accessors patternScale, edgeStrength, visibleEdgeColor and hiddenEdgeColor.
• ShockWaveEffect
  • Added accessors amplitude, waveSize and maxRadius.

Materials

• AdaptiveLuminanceMaterial
  • Removed LinearMipMapLinearFilter import and raised minimum version of three to r107.
• DepthComparisonMaterial
  • Changed default depth packing strategy to RGBADepthPacking. See #351.

Passes

• Pass
  • Fixed unintentional disposal of renderer. See #353.
  • Deprecated renderer and setRenderer.
• CopyPass
  • Replaced resize with autoResize.
• EffectMaterial
  • Added encodeOutput and time accessors.
• LuminanceMaterial
  • Replaced getSmoothingFactor and setSmoothingFactor with smoothing accessor.
• SMAAMaterial
  • Replaced setLookupTextures with searchTexture and areaTexture accessors.
  • Replaced setCornerRoundingEnabled with cornerDetection accessor.
• SSAOMaterial
  • Replaced setDistanceCutoff with distanceThreshold and distanceFalloff accessors.
  • Replaced setProximityCutoff with proximityThreshold and proximityFalloff accessors.

Textures

• LookupTexture3D
  • Renamed to LookupTexture.

Miscellaneous

• Updated the manual.

Requires three ≥ 0.102.0 < 0.138.0

Changelog

Package

• Changed main bundle name from postprocessing.mjs to postprocessing.esm.js. See #346.
• Exported postprocessing.mjs bundle as postprocessing/module. See 5293d46a.

Core

• EffectComposer
  • Prepared for removal of WebGLMultisampleRenderTarget.
  • ignoreDepthForMultisampleCopy will now be set to false when using MSAA.

Effects

• GlitchEffect
  • Added methods getGlitchColumns and setGlitchColumns.
• TextureEffect
  • Improved UV transform handling.

Materials

• EffectMaterial
  • Fixed potential breakage when using a dev version of three. See #345.

Miscellaneous

• Fixed a potential null pointer exception in the demo.

Requires three ≥ 0.102.0 < 0.138.0

Changelog

Attention: The changes made in this release are currently being revised. It's recommended to not switch to the newly added methods just yet as there's a chance that they will partly be replaced with accessor properties. See #349.

This release adds accessor methods to consolidate the configuration API. It should no longer be necessary to access undocumented uniforms of materials or effects directly. The demo has not yet been updated to use the new methods because it will be replaced by the manual.

Package

• Changed ESM bundle name from postprocessing.esm.js to postprocessing.mjs.

Core

• EffectComposer
  • Internal frame buffers are now always RGBA. See #338.
  • Deprecated replaceRenderer method.
  • Added setRenderer method. See 009edf8 and #337.
• Selection
  • Deprecated exclusive.
  • Added methods isExclusive, setExclusive.
• Resizer
  • Renamed to Resolution.
  • Deprecated resizable, base, target, scale.
  • Added methods copy, getWidth, getHeight, getScale, setScale, getBaseWidth, setBaseWidth, getBaseHeight, setBaseHeight, setBaseSize, getPreferredWidth, setPreferredWidth, getPreferredHeight, setPreferredHeight, setPreferredSize.
  • Resolution now dispatches "change" events when the base size or preferred size is changed.

Effects

• BlendMode
  • Changed visibility of opacity to private.
  • Added methods getOpacity, setOpacity.
• Effect
  • Changed visibility of name to private.
  • Changed visibility of defines, uniforms, extensions and blendMode to protected.
  • Added methods getName, getDefines, getUniforms, getExtensions, getBlendMode, setRenderer.
• BloomEffect
  • Deprecated intensity, luminancePass, luminanceMaterial, blurPass, texture, resolution.
  • Added methods getBlurPass, getIntensity, setIntensity, getLuminancePass, getLuminanceMaterial, getBlurPass, getTexture, getResolution.
• BrightnessContrastEffect
  • Added methods getBrightness, setBrightness, getContrast, setContrast.
• ChromaticAberrationEffect
  • Deprecated offset.
  • Added methods getOffset, setOffset.
  • Simplified the shader by always handling alpha.
• DepthEffect
  • Deprecated inverted.
  • Added methods isInverted setInverted.
• DepthOfFieldEffect
  • Deprecated bokehScale, blurPass, target, circleOfConfusionMaterial, resolution.
  • Added methods getBokehScale, setBokehScale, getBlurPass, getTarget, setTarget, getCircleOfConfusionMaterial and getResolution.
• DotScreenEffect
  • Added getAngle method .
• GodRaysEffect
  • Deprecated blur, samples.
  • Added methods getSamples, setSamples.
• OutlineEffect
  • Deprecated blur, xRay,
  • Added methods isXRayEnabled, setXRayEnabled
• GlitchEffect
  • Deprecated delay, duration, strength, mode, ratio, chromaticAberrationOffset, active.
  • Added methods getMinDelay, setMinDelay, getMaxDelay, setMaxDelay, getMinDuration, setMinDuration, getMaxDuration, setMaxDuration, getMinStrength, setMinStrength, getMaxStrength, setMaxStrength, getMode, setMode, isActive, getGlitchRatio, setGlitchRatio, getChromaticAberrationOffset, setChromaticAberrationOffset.
  • The generated perturbation map will now be disposed automatically.
  • Renamed uniform seed to seeds.
• GodRaysEffect
  • Deprecated blurPass, texture, resolution, godRaysMaterial.
  • Added methods getBlurPass, getGodRaysMaterial, getResolution, getTexture.
• HueSaturationEffect
  • Added methods getSaturation, setSaturation, getHue.
• NoiseEffect
  • Deprecated premultiply.
  • Added methods isPremultiplied, setPremultiplied.
• OutlineEffect
  • Deprecated blurPass, selection, pulseSpeed, resolution.
  • Added methods getBlurPass, getSelection, getPulseSpeed, setPulseSpeed, getResolution.
• SelectiveBloomEffect
  • Deprecated selection, depthMaskMaterial, inverted, ignoreBackground.
  • Added methods getSelection, getDepthMaskMaterial, isInverted, setInverted, isBackgroundDisabled, setBackgroundDisabled.
• SepiaEffect
  • Added methods getIntensity, setIntensity.
• ShockWaveEffect
  • Deprecated epicenter, speed.
  • Added methods getPosition, setPosition, getSpeed, setSpeed.
• SMAAEffect
  • Deprecated edgeDetectionMaterial, weightsMaterial.
  • Added methods getEdgeDetectionMaterial, getWeightsMaterial, getEdgesTexture, getWeightsTexture.
• SSAOEffect
  • Deprecated resolution, distanceScaling, samples, rings, color, depthAwareUpsampling, setDistanceCutoff, setProximityCutoff.
  • Added methods getResolution, isDepthAwareUpsamplingEnabled, setDepthAwareUpsamplingEnabled, getColor, setColor.
• TextureEffect
  • Deprecated texture, uvTransform.
  • Added methods getTexture setTexture.
  • UV transformations on the texture will now always be respected.
• ToneMappingEffect
  • Removed HalfFloat requirement. See 80089eb.
  • Deprecated resolution, mode, adaptationRate.
  • Added methods getResolution, setResolution, getMode, setMode.
• VignetteEffect
  • Deprecated eskil.
  • Added VignetteTechnique enum.
  • Added methods getTechnique, setTechnique, getOffset, setOffset, getDarkness, setDarkness.

Loaders

• SMAAImageGenerator
  • Deprecated disableCache.
  • Added setCacheEnabled method.

Materials

• AdaptiveLuminanceMaterial
  • Added methods setLuminanceBuffer0, setLuminanceBuffer1, setMipLevel1x1, setDeltaTime, getAdaptationRate, setAdaptationRate, getMinLuminance, setMinLuminance.
• BokehMaterial
  • Deprecated setTexelSize.
  • Added methods setInputBuffer, setCoCBuffer, getScale, setScale, setSize.
• CircleOfConfusionMaterial, DepthDownsamplingMaterial, EdgeDetectionMaterial, EffectMaterial, SSAOMaterial
  • Deprecated depthPacking.
  • Added setDepthBuffer method.
• CircleOfConfusionMaterial
  • Added methods getFocusDistance, setFocusDistance, getFocalLength, setFocalLength.
• CopyMaterial
  • Added methods setInputBuffer, getOpacity, setOpacity.
• ConvolutionMaterial
  • Renamed to KawaseBlurMaterial.
  • Added methods setInputBuffer, getScale, setScale, setKernel.
• DepthComparisonMaterial, DepthCopyMaterial
  • Added setDepthBuffer method.
• DepthCopyMaterial
  • Added methods getTexelPosition, setTexelPosition.
• DepthDownsamplingMaterial
  • Added setNormalBuffer method.
• DepthMaskMaterial
  • Deprecated keepFar.
  • Added methods getDepthTestStrategy, setDepthTestStrategy, setDepthBuffer0 and setDepthBuffer1.
  • Created DepthTestStrategy enum.
  • Removed uniforms bias0 and bias1.
• EdgeDetectionMaterial
  • Added methods getEdgeDetectionMode, setEdgeDetectionMode, getLocalContrastAdaptationFactor, getEdgeDetectionThreshold, getPredicationMode, getPredicationThreshold, getPredicationScale, getPredicationStrength.
• EffectMaterial
  • Section enum is now a static class member.
  • Added methods setInputBuffer, setExtensions, isOutputEncodingEnabled, setOutputEncodingEnabled and setDeltaTime.
• GodRaysMaterial
  • Deprecated samples
  • Added methods getSamples, setSamples, getDensity, setDensity, getDecay, setDecay, getWeight, setWeight, getExposure, setExposure, getMaxIntensity, setMaxIntensity, setInputBuffer, getLightPosition and setLightPosition.
• LuminanceMaterial, MaskMaterial, OutlineMaterial, SMAAWeightsMaterial.
  • Added setInputBuffer method.
• LuminanceMaterial
  • Deprecated colorOutput, threshold, smoothing, useThreshold and useRange.
  • Added methods isColorOutputEnabled, setColorOutputEnabled, getThreshold, setThreshold. getSmoothingFactor, setSmoothingFactor, getLuminanceRange, setLuminanceRange.
• MaskMaterial
  • Deprecated colorChannel, maskFunction, maskTexture, inverted, strength.
  • Added methods getColorChannel, setColorChannel, getMaskFunction, setMaskFunction, setMaskTexture, isInverted, setInverted, getStrength, setStrength.
• SMAAWeightsMaterial
  • Deprecated diagonalDetection, cornerRounding.
  • Added methods isDiagonalDetectionEnabled, setDiagonalDetectionEnabled, isCornerRoundingEnabled, setCornerRoundingEnabled, setLookupTextures.
• SSAOMaterial
  • Deprecated setTexelSize.
  • Added methods setSize, setNormalBuffer, setDepthBuffer, setNormalDepthBuffer, setNoiseTexture, getSamples, setSamples, getRings, setRings, getIntensity, setIntensity, getFade, setFade, getBias, setBias, getMinRadiusScale, setMinRadiusScale, getRadius, setRadius, isDistanceScalingEnabled, setDistanceScalingEnabled, setDistanceCutoff, setProximityCutoff.

Passes

• Pass
  • Added setRenderer method.
• AdaptiveLuminancePass
  • Deprecated adaptationRate, texture, mipLevel1x1.
  • Added getTexture method.
• BlurPass
  • Renamed to KawaseBlurPass.
  • Deprecate resolution.
  • Added getResolution method.
• ClearPass
  • Deprecated color, depth, stencil, overrideColor, overrideAlpha.
  • Added methods setClearFlags, getOverrideClearColor, setOverrideClearColor, getOverrideClearAlpha, setOverrideClearAlpha.
• DepthSavePass
  • Renamed to DepthCopyPass.
  • Maximum depth will now be preserved. See #340.
  • Deprecated texture, depthPacking.
  • Added methods getTexture, setDepthBuffer, getDepthPacking.
• DepthPass, DepthDownsamplingPass, LuminancePass, NormalPass
  • Deprecate texture, resolution.
  • Added methods getTexture, getResolution.
• DepthPickingPass
  • Improved accuracy by fixing conversion from uint8 to float.
• EffectPass
  • Cleaned up effect analysis.
  • Deprecated minTime, maxTime, encodeOutput, dithering. Output encoding and dithering can be controlled via the EffectMaterial instead.
• MaskPass
  • Deprecated clear, inverse.
  • Added methods getClearPass, isInverted, setInverted.
• RenderPass
  • Deprecated overrideMaterial, clear.
  • Added methods getOverrideMaterial, setOverrideMaterial. Clearing can be controlled via getClearPass.
• SavePass
  • Renamed to CopyPass.
  • Deprecated resize, texture.
  • Added methods getTexture, setAutoResizeEnabled.

Textures

• LookupTexture3D
  • Deprecated isLookupTexture3D.

Requires three ≥ 0.102.0 < 0.137.0

Changelog

Core

• Reverted 1d73bd1. See #336.

Requires three ≥ 0.102.0 < 0.137.0

Changelog

Core

• EffectComposer
  • Fixed an issue that prevented the alpha constructor parameter from working. See ae1b1406.
  • Frame buffers will now be properly invalidated when the multisampling value is changed. See b61e1c34.
  • The render info will now be updated manually to make sure the information doesn't get reset between consecutive render calls. See 1d73bd1c.

Effects

• TextureEffect
  • Handle re-enabled usage of SRGB8_ALPHA8 in three r136.
• SSAOEffect & GlitchEffect
  • Changed format of noise textures to RGBFormat to avoid issues with LuminanceFormat.

Materials

• Changed materials to specify name instead of type.

Textures

• LookupTexture3D & NoiseTexture
  • Explicitly set needsUpdate to true.

Miscellaneous

• Created manual. The manual is a work in progress that will eventually replace the demos with simpler examples and accompanying explanations.

Requires three ≥ 0.102.0 < 0.136.0

Changelog

Effects

• TextureEffect
  • Handle disabled usage of SRGB8_ALPHA8 in three r135.

Requires three ≥ 0.102.0 < 0.135.0

Requires three ≥ 0.102.0 < 0.134.0

Changelog

Effects

• TextureEffect
  • Shader-based inline texture decoding will now be disabled for SRGB8_ALPHA8 textures in three ≥ 133.
• OutlineEffect
  • Added inline decoding support for sRGB pattern textures.

Requires three ≥ 0.102.0 < 0.133.0

Changelog

Core

• EffectComposer
  • The deltaTime parameter of the render method is now optional.
• Selection
  • Added getLayer and setLayer methods.
  • Deprecated layer accessor.

Effects

• OutlineEffect & SelectiveBloomEffect
  • Changed default selection layers to avoid collision.

Passes

• Pass
  • Added isEnabled and setEnabled methods.
  • Deprecated direct access to enabled flag.
• RenderPass
  • Added setBackgroundDisabled method.
  • Added setShadowMapDisabled method.
  • Added getSelection and setSelection methods.
• DepthPass & NormalPass
  • The scene background will now be ignored.
  • Automatic shadow map updates will now be avoided.

Requires three ≥ 0.102.0 < 0.133.0

Changelog

NPM Package

• Renamed postprocessing.mjs back to postprocessing.esm.js due to issues with create-react-app. See #312.

Requires three ≥ 0.102.0 < 0.133.0

Changelog

NPM Package

• Renamed postprocessing.esm.js to postprocessing.mjs to support native importing in node.

Demos

• Added smooth camera movement.

Miscellaneous

• Fixed code formatting issues.

Requires three ≥ 0.102.0 < 0.132.0

Changelog

Miscellaneous

• Added engines field to package.json with node set to >= 0.13.2.

Requires three ≥ 0.102.0 < 0.131.0

Changelog

Textures

• LookupTexture3D
  • Changed Uint8ClampedArray to Uint8Array in convertToUint8() to support iOS ≤ 13. See #305.

Miscellaneous

• Changed build target of workers and demo to es6.

Requires three ≥ 0.102.0 < 0.131.0

Changelog

Core

• EffectComposer
  • Added alpha constructor option to force RGBAFormat frame buffers if needed. See 5aa24869d1cb0097cd12f77c6dc6257b3dd80e8f.

Passes

• DepthPickingPass
  • Use proper unpack factor for alpha channel. Values were slightly off prior to this change. See ec7d938318ee1b3f9e54f873792812a30a3d693b.

Requires three ≥ 0.102.0 < 0.130.0

Changelog

Core

• Selection
  • Added exclusive flag. See 504343a.

Materials

• MaskMaterial
  • Fixed a bug in the DISCARD mode. See 31ae8f6.

Demos

• ColorGradingDemo
  • Added check for OES_texture_float_linear. See #298.