Skip to content

v6.24.0

Compare
Choose a tag to compare
@vanruesc vanruesc released this 07 Feb 01:50
· 823 commits to main since this release
fbc246e

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.

more-kylo-ren

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.