postprocessing

Requires three ≥ 0.102.0 < 0.119.0

This release adds support for automatic effect shader recompilations. It's no longer necessary to call EffectPass.recompile manually after changing certain effect settings or blend functions. Custom effects should be adjusted to use the new getters and setters listed below. If your effect changes defines or extensions dynamically or adds or removes uniforms, please make sure to call setChanged afterwards.

Changelog

Effects

• BlendMode
  • Changed visibility of blendFunction to private.
  • Added getBlendFunction and setBlendFunction methods.
• Effect
  • Added setChanged method. Calling this method schedules a shader recompilation.
  • Changed visibility of attributes, fragmentShader and vertexShader to private.
  • Added getAttributes and setAttributes methods.
  • Added getFragmentShader and setFragmentShader methods.
  • Added getVertexShader and setVertexShader methods.
  • The setter methods automatically request a shader recompilation.
• SSAOEffect
  • Added support for colorized ambient occlusion. See #211.
  • Added depthAwareUpsampling setting for convenience.
• ToneMappingEffect
  • Fixed MIP level update on resolution change.

Passes

• EffectPass
  • Implemented automatic shader recompilation.
  • It is no longer necessary to call recompile manually but it can still be used for optimization purposes.

Requires three ≥ 0.102.0 < 0.119.0

Changelog

Materials

• SSAOMaterial
  • Improved radius scaling curve. See 2328a5e.

Requires three ≥ 0.102.0 < 0.118.0

Changelog

Effects

• SSAOEffect
  • Added minRadiusScale constructor parameter. This setting limits the automatic downscaling of the sampling radius.

Materials

• SSAOMaterial
  • Improved distance-based radius scaling. The scale now relies on depth and is tied to the effect render distance.

Requires three ≥ 0.102.0 < 0.118.0

Changelog

Effects

• SSAOEffect
  • Added fade constructor parameter. This setting influences the contrast of the ambient occlusion.
  • Added distanceScaling constructor parameter. See #207.

Materials

• SSAOMaterial
  • Improved occlusion sampling.

Requires three ≥ 0.102.0 < 0.118.0

Changelog

Core

• Resizer
  • Reintroduced scale as an alternative, relative setting.

Passes

• DepthDownsamplingPass
  • Changed usage requirement to WebGL 2.
  • Fixed type of normalBuffer constructor parameter. See #206.

Effects

• SSAOEffect
  • Fixed support for WebGL 1. See #207.
  • Added resolutionScale constructor option. Using a relative render resolution for this effect helps prevent undesired artifacts.

Images

• NoiseTexture
  • Changed default format to LuminanceFormat.

Requires three ≥ 0.102.0 < 0.118.0

Changelog

Core

• EffectComposer
  • Changed visibility of autoRenderToScreen to public. See #201.
• Added OverrideMaterialManager
  • Provides a workaround for instanced and skinned meshes. See #202 and #194.
    This feature is disabled by default because it can have a negative impact on performance when the scene contains many meshes. Check the wiki to find out how to enable it.

Materials

• Added DepthDownsamplingMaterial.
• Added SSAOMaterial.

Passes

• RenderPass
  • Now uses OverrideMaterialManager to render override materials.
  • Shadow map updates and object sorting will now be disabled for override materials.
• DepthPass & NormalPass
  • Added texture convenience getter.
• Added DepthDownsamplingPass.

Effects

• SSAOEffect
  • Many improvements, see #204 for details.
• TextureEffect
  • Added setTextureSwizzleRGBA method.

Images

• Added NoiseTexture.

Requires three ≥ 0.102.0 < 0.117.0

Changelog

Effects

• SSAOEffect
  • Fixed depth precision issue on mobile devices. See #199.

Materials

• Added conditional highp qualifier to depth texture samplers. Affected shaders:
  • CircleOfConfusionMaterial
  • DepthComparisonMaterial
  • DepthMaskMaterial
  • EdgeDetectionMaterial
  • EffectMaterial
• Added missing depthPacking accessors to CircleOfConfusionMaterial.
• Added Section enum from EffectMaterial to main export list.

Passes

• NormalPass
  • Changed default minFilter and magFilter to NearestFilter.

Requires three ≥ 0.102.0 < 0.117.0

Changelog

Effects

• DepthOfFieldEffect
  • Fixed dark artifacts in far scene blending. See #195.

Materials

• Prevent warning regarding toneMapped property in three < r108. See #193.
• MaskMaterial
  • Added MaskFunction.MULTIPLY_RGB_SET_ALPHA.

Requires three ≥ 0.102.0 < 0.116.0

Changelog

Passes

• Pass
  • Replaced the default OrthographicCamera with a basic Camera.

Effects

• DepthOfFieldEffect
  • Improved background (far scene) blending. See #188.
  • The type of intermediate blur buffers will now always be UnsingedByteType.
  • Made bokeh scaling more robust.
• SelectiveBloomEffect
  • Added information about lights and layers to the documentation. See #185.

Materials

• MaskMaterial
  • Added strength setting for multiplicative masking.

Requires three ≥ 0.102.0 < 0.116.0

Changelog

Passes

• EffectPass
  • Fixed a bug that could cause a shader compilation error after merging compressed shaders with leading preprocessor directives. See #182.

Effects

• TextureEffect
  • Fixed type of uvTransform.

Requires three ≥ 0.102.0 < 0.116.0

Changelog

Effects

• NoiseEffect
  • Colors will now be limited to 1.0 when premultiply is enabled.

Requires three ≥ 0.102.0 < 0.115.0

Changelog

Core

• EffectComposer
  • Added multisampling constructor option. Multisample antialiasing requires WebGL 2. See #178.
  • Added multisampling convenience accessors.

Passes

• Pass
  • Improved renderToScreen setter. See ee2c95d.

Miscellaneous

• The demo now uses WebGL 2 when it's available.

Notes

While the newly added multisampling feature provides high quality antialiasing at low computational cost, it may produce visual artifacts when used with some effects such as SSAO and should not be regarded as a blanket antialiasing solution.

It's currently not possible to use combined depth-stencil attachments in WebGL 2. See https://github.com/mrdoob/three.js/issues/18887 for details.

Requires three ≥ 0.102.0 < 0.115.0

Changelog

Effects

• DepthOfFieldEffect
  • Improved foreground blurring. See #176.

Requires three ≥ 0.102.0 < 0.115.0

Changelog

Core

• EffectComposer
  • Switched to UnsignedIntType for the depth texture to prevent precision issues. See #174.
  • The format of (half) float type frame buffers will no longer be set to RGBFormat. RGB16F and RGB32F buffers are not renderable (Chrome renders them, but FireFox doesn't).
  • WebGL extensions for (half) float buffers will now be enabled explicitly.

Passes

• EffectPass
  • Added support for function-like macros.

Effects

• BloomEffect
  • Added intensity option.
• TextureEffect
  • Added support for UV transformation based on the texture's offset, repeat and center settings.
  • Deprecated aspectCorrection. Enable uvTransform instead and adjust the texture settings manually.
  • Added support for automatic sRGB texel decoding.

Requires three ≥ 0.102.0 < 0.115.0

Changelog

Core

• EffectComposer
  • Improved the automatic render to screen mechanism. See 09eb7ea.

Requires three ≥ 0.102.0 < 0.114.0

Changelog

Core

• EffectComposer
  • Added automatic render-to-screen mechanism. This lets the last pass render to screen unless the user provides a pass that already renders to screen.
  • Added frameBufferType constructor parameter. It's highly recommended to set this to HalfFloatType if WebGLRenderer.outputEncoding is set to sRGBEncoding. See https://blog.demofox.org/2018/03/10/dont-convert-srgb-u8-to-linear-u8/ for details.
• Initializable
  • Changed signature of initialize to (renderer, alpha, frameBufferType).

Materials

• Set toneMapped flag of all materials to false.
• EffectMaterial & CopyMaterial
  • Added support for output encoding. Passes that render to screen will use the outputEncoding of the WebGLRenderer. Passes that render to texture always use LinearEncoding.
• Deprecated ColorEdgesMaterial.
• Added EdgeDetectionMaterial and EdgeDetectionMode.
  • Supports depth, luminance and color edge detection.
• Added CircleOfConfusionMaterial.
• Added MaskMaterial.
• Deprecated OutlineEdgesMaterial.
• Added OutlineMaterial.

Effects

• Deprecated GammaCorrectionEffect. Set WebGLRenderer.outputEncoding to sRGBEncoding or GammaEncoding instead.
• SMAAEffect
  • Added edgeDetectionMode constructor parameter.
  • Fixed potential memory leak in dispose method.
  • Added edgeDetectionMaterial getter.
  • Deprecated colorEdgesMaterial. Use edgeDetectionMaterial instead.
• GodRaysEffect
  • Minor light position calculation improvements.
• ToneMappingEffect
  • Minor performance improvements.
• Added DepthOfFieldEffect. See #160.
• Deprecated BokehEffect and RealisticBokehEffect. Use DepthOfFieldEffect instead.
• Changed shaders of BokehEffect and RealisticBokehEffect to use proper linear depth.

Passes

• Pass
  • Changing renderToScreen will now also update the fullscreen material to use the correct output encoding.
• BlurPass, BloomPass, SelectiveBloomPass, GodRaysPass, OutlinePass
  • Deprecated dithering. Set the frameBufferType of the EffectComposer to HalfFloatType instead.
• ShaderPass
  • Fixed: inputBuffer should only be used if it isn't null.

Image Utilities

• SMAAImageLoader
  • The load method now conforms to the signature of Loader.load. See #169.

Miscellaneous

• Updated the demos.

Requires three ≥ 0.102.0 < 0.113.0

Changelog

Effects

• SMAAEffect
  • Deprecated searchImageDataURL. Use SMAAImageLoader instead.
  • Deprecated areaImageDataURL. Use SMAAImageLoader instead.

Image Utilities

• Added SMAAImageLoader. See #167.

Requires three ≥ 0.102.0 < 0.112.0

Note: Due to a bug in [email protected], it is recommended to use the latest dev version of three instead.
See https://github.com/mrdoob/three.js/issues/18062 for details.

Changelog

Core

• Added Resizer to simplify custom resolution management. See cfa0a29.

Materials

• EffectMaterial
  • Moved getViewZ from SSAOEffect shader to main EffectMaterial shader.

Effects

• SSAOEffect
  • Improved distance and proximity threshold management.
  • Depth will now be linearized. See 78e59fc.
• BloomEffect & SelectiveBloomEffect
  • Deprecated width and height.
  • Added resolution.
• GodRaysEffect
  • Deprecated width and height.
  • Added resolution.
• OutlineEffect
  • Deprecated width and height.
  • Added resolution.

Passes

• BlurPass
  • Deprecated width and height.
  • Added resolution.
• DepthPass
  • Deprecated getResolutionScale and setResolutionScale.
  • Added optional fixed resolution width and height constructor parameters.
  • Added resolution.
• NormalPass
  • Enabled morphNormals.
  • Deprecated getResolutionScale and setResolutionScale.
  • Added optional fixed resolution width and height constructor parameters.
  • Added resolution.

Miscellaneous

• Demos
  • Added info button.
  • Added source code button.
  • Disabled logarithmicDepthBuffer globally and adjusted camera settings.

Requires three ≥ 0.102.0 < 0.111.0

Changelog

Effects

• RealisticBokehEffect
  • Fixed incorrect near DoF calculation and recovered fStop parameter. See #161.

Requires three ≥ 0.102.0 < 0.111.0

Changelog

Effects

• GlitchEffect
  • Changed generatePerturbationMap method to use UnsignedByteType instead of FloatType. This change doesn't affect the visual results and improves compatibility with mobile devices.