v6.24.0
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
topostprocessing.mjs
.
Core
- EffectComposer
- Selection
- Deprecated
exclusive
. - Added methods
isExclusive
,setExclusive
.
- Deprecated
- 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.
- Renamed to
Effects
- BlendMode
- Changed visibility of
opacity
to private. - Added methods
getOpacity
,setOpacity
.
- Changed visibility of
- Effect
- Changed visibility of
name
to private. - Changed visibility of
defines
,uniforms
,extensions
andblendMode
to protected. - Added methods
getName
,getDefines
,getUniforms
,getExtensions
,getBlendMode
,setRenderer
.
- Changed visibility of
- BloomEffect
- Deprecated
intensity
,luminancePass
,luminanceMaterial
,blurPass
,texture
,resolution
. - Added methods
getBlurPass
,getIntensity
,setIntensity
,getLuminancePass
,getLuminanceMaterial
,getBlurPass
,getTexture
,getResolution
.
- Deprecated
- BrightnessContrastEffect
- Added methods
getBrightness
,setBrightness
,getContrast
,setContrast
.
- Added methods
- ChromaticAberrationEffect
- Deprecated
offset
. - Added methods
getOffset
,setOffset
. - Simplified the shader by always handling alpha.
- Deprecated
- DepthEffect
- Deprecated
inverted
. - Added methods
isInverted
setInverted
.
- Deprecated
- DepthOfFieldEffect
- Deprecated
bokehScale
,blurPass
,target
,circleOfConfusionMaterial
,resolution
. - Added methods
getBokehScale
,setBokehScale
,getBlurPass
,getTarget
,setTarget
,getCircleOfConfusionMaterial
andgetResolution
.
- Deprecated
- DotScreenEffect
- Added
getAngle
method .
- Added
- GodRaysEffect
- Deprecated
blur
,samples
. - Added methods
getSamples
,setSamples
.
- Deprecated
- OutlineEffect
- Deprecated
blur
,xRay
, - Added methods
isXRayEnabled
,setXRayEnabled
- Deprecated
- 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
toseeds
.
- Deprecated
- GodRaysEffect
- Deprecated
blurPass
,texture
,resolution
,godRaysMaterial
. - Added methods
getBlurPass
,getGodRaysMaterial
,getResolution
,getTexture
.
- Deprecated
- HueSaturationEffect
- Added methods
getSaturation
,setSaturation
,getHue
.
- Added methods
- NoiseEffect
- Deprecated
premultiply
. - Added methods
isPremultiplied
,setPremultiplied
.
- Deprecated
- OutlineEffect
- Deprecated
blurPass
,selection
,pulseSpeed
,resolution
. - Added methods
getBlurPass
,getSelection
,getPulseSpeed
,setPulseSpeed
,getResolution
.
- Deprecated
- SelectiveBloomEffect
- Deprecated
selection
,depthMaskMaterial
,inverted
,ignoreBackground
. - Added methods
getSelection
,getDepthMaskMaterial
,isInverted
,setInverted
,isBackgroundDisabled
,setBackgroundDisabled
.
- Deprecated
- SepiaEffect
- Added methods
getIntensity
,setIntensity
.
- Added methods
- ShockWaveEffect
- Deprecated
epicenter
,speed
. - Added methods
getPosition
,setPosition
,getSpeed
,setSpeed
.
- Deprecated
- SMAAEffect
- Deprecated
edgeDetectionMaterial
,weightsMaterial
. - Added methods
getEdgeDetectionMaterial
,getWeightsMaterial
,getEdgesTexture
,getWeightsTexture
.
- Deprecated
- SSAOEffect
- Deprecated
resolution
,distanceScaling
,samples
,rings
,color
,depthAwareUpsampling
,setDistanceCutoff
,setProximityCutoff
. - Added methods
getResolution
,isDepthAwareUpsamplingEnabled
,setDepthAwareUpsamplingEnabled
,getColor
,setColor
.
- Deprecated
- TextureEffect
- Deprecated
texture
,uvTransform
. - Added methods
getTexture
setTexture
. - UV transformations on the texture will now always be respected.
- Deprecated
- ToneMappingEffect
- Removed
HalfFloat
requirement. See 80089eb. - Deprecated
resolution
,mode
,adaptationRate
. - Added methods
getResolution
,setResolution
,getMode
,setMode
.
- Removed
- VignetteEffect
- Deprecated
eskil
. - Added
VignetteTechnique
enum. - Added methods
getTechnique
,setTechnique
,getOffset
,setOffset
,getDarkness
,setDarkness
.
- Deprecated
Loaders
- SMAAImageGenerator
- Deprecated
disableCache
. - Added
setCacheEnabled
method.
- Deprecated
Materials
- AdaptiveLuminanceMaterial
- Added methods
setLuminanceBuffer0
,setLuminanceBuffer1
,setMipLevel1x1
,setDeltaTime
,getAdaptationRate
,setAdaptationRate
,getMinLuminance
,setMinLuminance
.
- Added methods
- BokehMaterial
- Deprecated
setTexelSize
. - Added methods
setInputBuffer
,setCoCBuffer
,getScale
,setScale
,setSize
.
- Deprecated
- CircleOfConfusionMaterial, DepthDownsamplingMaterial, EdgeDetectionMaterial, EffectMaterial, SSAOMaterial
- Deprecated
depthPacking
. - Added
setDepthBuffer
method.
- Deprecated
- CircleOfConfusionMaterial
- Added methods
getFocusDistance
,setFocusDistance
,getFocalLength
,setFocalLength
.
- Added methods
- CopyMaterial
- Added methods
setInputBuffer
,getOpacity
,setOpacity
.
- Added methods
- ConvolutionMaterial
- Renamed to
KawaseBlurMaterial
. - Added methods
setInputBuffer
,getScale
,setScale
,setKernel
.
- Renamed to
- DepthComparisonMaterial, DepthCopyMaterial
- Added
setDepthBuffer
method.
- Added
- DepthCopyMaterial
- Added methods
getTexelPosition
,setTexelPosition
.
- Added methods
- DepthDownsamplingMaterial
- Added
setNormalBuffer
method.
- Added
- DepthMaskMaterial
- Deprecated
keepFar
. - Added methods
getDepthTestStrategy
,setDepthTestStrategy
,setDepthBuffer0
andsetDepthBuffer1
. - Created
DepthTestStrategy
enum. - Removed uniforms
bias0
andbias1
.
- Deprecated
- EdgeDetectionMaterial
- Added methods
getEdgeDetectionMode
,setEdgeDetectionMode
,getLocalContrastAdaptationFactor
,getEdgeDetectionThreshold
,getPredicationMode
,getPredicationThreshold
,getPredicationScale
,getPredicationStrength
.
- Added methods
- EffectMaterial
Section
enum is now a static class member.- Added methods
setInputBuffer
,setExtensions
,isOutputEncodingEnabled
,setOutputEncodingEnabled
andsetDeltaTime
.
- GodRaysMaterial
- Deprecated
samples
- Added methods
getSamples
,setSamples
,getDensity
,setDensity
,getDecay
,setDecay
,getWeight
,setWeight
,getExposure
,setExposure
,getMaxIntensity
,setMaxIntensity
,setInputBuffer
,getLightPosition
andsetLightPosition
.
- Deprecated
- LuminanceMaterial, MaskMaterial, OutlineMaterial, SMAAWeightsMaterial.
- Added
setInputBuffer
method.
- Added
- LuminanceMaterial
- Deprecated
colorOutput
,threshold
,smoothing
,useThreshold
anduseRange
. - Added methods
isColorOutputEnabled
,setColorOutputEnabled
,getThreshold
,setThreshold
.getSmoothingFactor
,setSmoothingFactor
,getLuminanceRange
,setLuminanceRange
.
- Deprecated
- MaskMaterial
- Deprecated
colorChannel
,maskFunction
,maskTexture
,inverted
,strength
. - Added methods
getColorChannel
,setColorChannel
,getMaskFunction
,setMaskFunction
,setMaskTexture
,isInverted
,setInverted
,getStrength
,setStrength
.
- Deprecated
- SMAAWeightsMaterial
- Deprecated
diagonalDetection
,cornerRounding
. - Added methods
isDiagonalDetectionEnabled
,setDiagonalDetectionEnabled
,isCornerRoundingEnabled
,setCornerRoundingEnabled
,setLookupTextures
.
- Deprecated
- 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
.
- Deprecated
Passes
- Pass
- Added
setRenderer
method.
- Added
- AdaptiveLuminancePass
- Deprecated
adaptationRate
,texture
,mipLevel1x1
. - Added
getTexture
method.
- Deprecated
- BlurPass
- Renamed to
KawaseBlurPass
. - Deprecate
resolution
. - Added
getResolution
method.
- Renamed to
- ClearPass
- Deprecated
color
,depth
,stencil
,overrideColor
,overrideAlpha
. - Added methods
setClearFlags
,getOverrideClearColor
,setOverrideClearColor
,getOverrideClearAlpha
,setOverrideClearAlpha
.
- Deprecated
- DepthSavePass
- Renamed to
DepthCopyPass
. - Maximum depth will now be preserved. See #340.
- Deprecated
texture
,depthPacking
. - Added methods
getTexture
,setDepthBuffer
,getDepthPacking
.
- Renamed to
- DepthPass, DepthDownsamplingPass, LuminancePass, NormalPass
- Deprecate
texture
,resolution
. - Added methods
getTexture
,getResolution
.
- Deprecate
- 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 theEffectMaterial
instead.
- MaskPass
- Deprecated
clear
,inverse
. - Added methods
getClearPass
,isInverted
,setInverted
.
- Deprecated
- RenderPass
- Deprecated
overrideMaterial
,clear
. - Added methods
getOverrideMaterial
,setOverrideMaterial
. Clearing can be controlled viagetClearPass
.
- Deprecated
- SavePass
- Renamed to
CopyPass
. - Deprecated
resize
,texture
. - Added methods
getTexture
,setAutoResizeEnabled
.
- Renamed to
Textures
- LookupTexture3D
- Deprecated
isLookupTexture3D
.
- Deprecated