@needle-tools/engine 4.13.0 → 4.13.1

package/lib/engine-components/postprocessing/Effects/Antialiasing.js

@@ -19,6 +19,7 @@ export var QualityLevel;
     QualityLevel[QualityLevel["ULTRA"] = 3] = "ULTRA";
 })(QualityLevel || (QualityLevel = {}));
 /**
+ * [Antialiasing](https://engine.needle.tools/docs/api/Antialiasing) provides SMAA (Subpixel Morphological Antialiasing) post-processing effect to smooth edges in the rendered scene.
  * @category Effects
  * @group Components
  */

package/lib/engine-components/postprocessing/Effects/Antialiasing.js.map

@@ -1 +1 @@
-{"version":3,"file":"Antialiasing.js","sourceRoot":"","sources":["../../../../src/engine-components/postprocessing/Effects/Antialiasing.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAA6B,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAG/D,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;AAGpC,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACpB,6CAAO,CAAA;IACP,mDAAU,CAAA;IACV,+CAAQ,CAAA;IACR,iDAAS,CAAA;AACb,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,oBAAoB;IAClD,IAAI,QAAQ;QACR,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED,iCAAiC;IACjC,4CAA4C;IAGnC,MAAM,GAAoB,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;IAC1D,4FAA4F;IAG5F,cAAc;QACV,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC;YACxD,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI;YAC3E,iBAAiB,EAAE,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI;YACvE,iEAAiE;YACjE,wEAAwE;SAC3E,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,CAAC,QAAQ,EAAE,EAAE;YACtC,IAAG,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,QAAQ,CAAC,CAAC;YAClE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC;QACF,qBAAqB;QACrB,sDAAsD;QACtD,WAAW;QAEX,6DAA6D;QAE7D,+DAA+D;QAC/D,6BAA6B;QAC7B,sEAAsE;QACtE,IAAI;QAEJ,OAAO,MAAM,CAAC;IAClB,CAAC;CAGJ;AA/BG;IADC,YAAY,CAAC,eAAe,CAAC;4CAC4B;AAiC9D,wBAAwB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAA"}
+{"version":3,"file":"Antialiasing.js","sourceRoot":"","sources":["../../../../src/engine-components/postprocessing/Effects/Antialiasing.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAA6B,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAG/D,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;AAGpC,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACpB,6CAAO,CAAA;IACP,mDAAU,CAAA;IACV,+CAAQ,CAAA;IACR,iDAAS,CAAA;AACb,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED;;;;GAIG;AACH,MAAM,OAAO,YAAa,SAAQ,oBAAoB;IAClD,IAAI,QAAQ;QACR,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED,iCAAiC;IACjC,4CAA4C;IAGnC,MAAM,GAAoB,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;IAC1D,4FAA4F;IAG5F,cAAc;QACV,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC;YACxD,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI;YAC3E,iBAAiB,EAAE,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI;YACvE,iEAAiE;YACjE,wEAAwE;SAC3E,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,CAAC,QAAQ,EAAE,EAAE;YACtC,IAAG,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,QAAQ,CAAC,CAAC;YAClE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC;QACF,qBAAqB;QACrB,sDAAsD;QACtD,WAAW;QAEX,6DAA6D;QAE7D,+DAA+D;QAC/D,6BAA6B;QAC7B,sEAAsE;QACtE,IAAI;QAEJ,OAAO,MAAM,CAAC;IAClB,CAAC;CAGJ;AA/BG;IADC,YAAY,CAAC,eAAe,CAAC;4CAC4B;AAiC9D,wBAAwB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAA"}

package/lib/engine-components/postprocessing/Effects/BloomEffect.d.ts

@@ -2,7 +2,7 @@ import { BloomEffect as _BloomEffect } from "postprocessing";
 import { PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 /**
- * Bloom can be used to make bright areas in the scene glow.
+ * [BloomEffect](https://engine.needle.tools/docs/api/BloomEffect) can be used to make bright areas in the scene glow.
  * @link Sample https://engine.needle.tools/samples/postprocessing
  * @example
  * ```typescript

package/lib/engine-components/postprocessing/Effects/BloomEffect.js

@@ -11,7 +11,7 @@ import { PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
 /**
- * Bloom can be used to make bright areas in the scene glow.
+ * [BloomEffect](https://engine.needle.tools/docs/api/BloomEffect) can be used to make bright areas in the scene glow.
  * @link Sample https://engine.needle.tools/samples/postprocessing
  * @example
  * ```typescript

package/lib/engine-components/postprocessing/Effects/ChromaticAberration.d.ts

@@ -1,7 +1,7 @@
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 /**
- * Chromatic Aberration effect simulates the color fringing effect seen in real-world cameras.
+ * [ChromaticAberration](https://engine.needle.tools/docs/api/ChromaticAberration) simulates the color fringing effect seen in real-world cameras.
  * It offsets the red, green, and blue color channels to create a distorted, colorful edge around objects.
  * This effect can enhance the visual appeal of scenes by adding a subtle or pronounced chromatic distortion.
  * @summary Chromatic Aberration Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/ChromaticAberration.js

@@ -11,7 +11,7 @@ import { PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
 /**
- * Chromatic Aberration effect simulates the color fringing effect seen in real-world cameras.
+ * [ChromaticAberration](https://engine.needle.tools/docs/api/ChromaticAberration) simulates the color fringing effect seen in real-world cameras.
  * It offsets the red, green, and blue color channels to create a distorted, colorful edge around objects.
  * This effect can enhance the visual appeal of scenes by adding a subtle or pronounced chromatic distortion.
  * @summary Chromatic Aberration Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/ColorAdjustments.d.ts

@@ -1,7 +1,7 @@
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 /**
- * Color Adjustments effect allows you to modify the overall color properties of the rendered scene, including post-exposure, contrast, hue shift, and saturation.
+ * [ColorAdjustments](https://engine.needle.tools/docs/api/ColorAdjustments) allows you to modify the overall color properties of the rendered scene, including post-exposure, contrast, hue shift, and saturation.
  * These adjustments can be used to enhance the visual aesthetics of the scene or to achieve specific artistic effects.
  * @summary Color Adjustments Post-Processing Effect
  * @category Effects

package/lib/engine-components/postprocessing/Effects/ColorAdjustments.js

@@ -11,7 +11,7 @@ import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
 import { ToneMappingEffect } from "./Tonemapping.js";
 /**
- * Color Adjustments effect allows you to modify the overall color properties of the rendered scene, including post-exposure, contrast, hue shift, and saturation.
+ * [ColorAdjustments](https://engine.needle.tools/docs/api/ColorAdjustments) allows you to modify the overall color properties of the rendered scene, including post-exposure, contrast, hue shift, and saturation.
  * These adjustments can be used to enhance the visual aesthetics of the scene or to achieve specific artistic effects.
  * @summary Color Adjustments Post-Processing Effect
  * @category Effects

package/lib/engine-components/postprocessing/Effects/DepthOfField.d.ts

@@ -7,7 +7,7 @@ export declare enum DepthOfFieldMode {
     Bokeh = 2
 }
 /**
- * Depth of Field effect simulates the focusing behavior of real-world cameras by blurring objects that are outside the focal plane.
+ * [DepthOfField](https://engine.needle.tools/docs/api/DepthOfField) simulates the focusing behavior of real-world cameras by blurring objects that are outside the focal plane.
  * This effect enhances the sense of depth in a scene by mimicking how cameras focus on subjects at varying distances, creating a more immersive visual experience.
  * It can be adjusted to achieve different artistic effects, from subtle background blurring to pronounced bokeh effects.
  * @summary Depth of Field Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/DepthOfField.js

@@ -19,7 +19,7 @@ export var DepthOfFieldMode;
 })(DepthOfFieldMode || (DepthOfFieldMode = {}));
 const debug = getParam("debugpost");
 /**
- * Depth of Field effect simulates the focusing behavior of real-world cameras by blurring objects that are outside the focal plane.
+ * [DepthOfField](https://engine.needle.tools/docs/api/DepthOfField) simulates the focusing behavior of real-world cameras by blurring objects that are outside the focal plane.
  * This effect enhances the sense of depth in a scene by mimicking how cameras focus on subjects at varying distances, creating a more immersive visual experience.
  * It can be adjusted to achieve different artistic effects, from subtle background blurring to pronounced bokeh effects.
  * @summary Depth of Field Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/EffectWrapper.d.ts

@@ -1,6 +1,7 @@
 import type { Effect } from "postprocessing";
 import { EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 /**
+ * [EffectWrapper](https://engine.needle.tools/docs/api/EffectWrapper) wraps a custom postprocessing effect to integrate it with the Needle Engine post-processing pipeline.
  *
  * @category Effects
  * @group Components

package/lib/engine-components/postprocessing/Effects/EffectWrapper.js

@@ -1,5 +1,6 @@
 import { PostProcessingEffect } from "../PostProcessingEffect.js";
 /**
+ * [EffectWrapper](https://engine.needle.tools/docs/api/EffectWrapper) wraps a custom postprocessing effect to integrate it with the Needle Engine post-processing pipeline.
  *
  * @category Effects
  * @group Components

package/lib/engine-components/postprocessing/Effects/EffectWrapper.js.map

@@ -1 +1 @@
-{"version":3,"file":"EffectWrapper.js","sourceRoot":"","sources":["../../../../src/engine-components/postprocessing/Effects/EffectWrapper.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAExF;;;;GAIG;AACH,MAAM,OAAO,aAAc,SAAQ,oBAAoB;IAE1C,MAAM,CAAS;IAExB,YAAY,MAAc;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;IACxC,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;CAEJ"}
+{"version":3,"file":"EffectWrapper.js","sourceRoot":"","sources":["../../../../src/engine-components/postprocessing/Effects/EffectWrapper.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAExF;;;;;GAKG;AACH,MAAM,OAAO,aAAc,SAAQ,oBAAoB;IAE1C,MAAM,CAAS;IAExB,YAAY,MAAc;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;IACxC,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;CAEJ"}

package/lib/engine-components/postprocessing/Effects/Pixelation.d.ts

@@ -1,7 +1,7 @@
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 /**
- * Pixelation effect simulates a pixelated look by enlarging pixels in the rendered scene.
+ * [PixelationEffect](https://engine.needle.tools/docs/api/PixelationEffect) Pixelation effect simulates a pixelated look by enlarging pixels in the rendered scene.
  * This effect can be used to achieve a retro or stylized visual aesthetic, reminiscent of early video games or low-resolution graphics.
  * @summary Pixelation Post-Processing Effect
  * @category Effects

package/lib/engine-components/postprocessing/Effects/Pixelation.js

@@ -10,7 +10,7 @@ import { PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
 /**
- * Pixelation effect simulates a pixelated look by enlarging pixels in the rendered scene.
+ * [PixelationEffect](https://engine.needle.tools/docs/api/PixelationEffect) Pixelation effect simulates a pixelated look by enlarging pixels in the rendered scene.
  * This effect can be used to achieve a retro or stylized visual aesthetic, reminiscent of early video games or low-resolution graphics.
  * @summary Pixelation Post-Processing Effect
  * @category Effects

package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.d.ts

@@ -1,6 +1,6 @@
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
-/** Screenspace Ambient Occlusion post-processing effect.
+/** [ScreenSpaceAmbientOcclusion](https://engine.needle.tools/docs/api/ScreenSpaceAmbientOcclusion) is a screenspace ambient occlusion post-processing effect.
  * We recommend using ScreenSpaceAmbientOcclusionN8 instead.
  * @category Effects
  * @group Components

package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.js

@@ -10,7 +10,7 @@ import { serializable } from "../../../engine/engine_serialization.js";
 import { PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
-/** Screenspace Ambient Occlusion post-processing effect.
+/** [ScreenSpaceAmbientOcclusion](https://engine.needle.tools/docs/api/ScreenSpaceAmbientOcclusion) is a screenspace ambient occlusion post-processing effect.
  * We recommend using ScreenSpaceAmbientOcclusionN8 instead.
  * @category Effects
  * @group Components

package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.d.ts

@@ -9,7 +9,7 @@ export declare enum ScreenSpaceAmbientOcclusionN8QualityMode {
     High = 3,
     Ultra = 4
 }
-/** Screen Space Ambient Occlusion (SSAO) effect.
+/** [ScreenSpaceAmbientOcclusionN8](https://engine.needle.tools/docs/api/ScreenSpaceAmbientOcclusionN8) is a screen space ambient occlusion (SSAO) effect.
  * Ambient Occlusion is a shading method used to calculate how exposed each point in a scene is to ambient lighting.
  * The effect enhances the depth and realism of 3D scenes by simulating the soft shadows that occur in crevices, corners, and areas where objects are close to each other.
  * This implementation uses the N8AO library to provide high-quality SSAO with various quality settings.

package/lib/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.js

@@ -23,7 +23,7 @@ export var ScreenSpaceAmbientOcclusionN8QualityMode;
     ScreenSpaceAmbientOcclusionN8QualityMode[ScreenSpaceAmbientOcclusionN8QualityMode["High"] = 3] = "High";
     ScreenSpaceAmbientOcclusionN8QualityMode[ScreenSpaceAmbientOcclusionN8QualityMode["Ultra"] = 4] = "Ultra";
 })(ScreenSpaceAmbientOcclusionN8QualityMode || (ScreenSpaceAmbientOcclusionN8QualityMode = {}));
-/** Screen Space Ambient Occlusion (SSAO) effect.
+/** [ScreenSpaceAmbientOcclusionN8](https://engine.needle.tools/docs/api/ScreenSpaceAmbientOcclusionN8) is a screen space ambient occlusion (SSAO) effect.
  * Ambient Occlusion is a shading method used to calculate how exposed each point in a scene is to ambient lighting.
  * The effect enhances the depth and realism of 3D scenes by simulating the soft shadows that occur in crevices, corners, and areas where objects are close to each other.
  * This implementation uses the N8AO library to provide high-quality SSAO with various quality settings.

package/lib/engine-components/postprocessing/Effects/Sharpening.d.ts

@@ -1,6 +1,6 @@
 import { PostProcessingEffect } from "../PostProcessingEffect.js";
 /**
- * Sharpening effect enhances the details and edges in the rendered scene by increasing the contrast between adjacent pixels.
+ * [SharpeningEffect](https://engine.needle.tools/docs/api/SharpeningEffect) Sharpening effect enhances the details and edges in the rendered scene by increasing the contrast between adjacent pixels.
  * This effect can make textures and fine details appear clearer and more defined, improving the overall visual quality of the scene.
  * It is particularly useful in scenes where details may be lost due to blurriness or low resolution.
  * @summary Sharpening Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/Sharpening.js

@@ -17,7 +17,7 @@ import { PostProcessingEffectOrder } from "../utils.js";
 //     __SHARPENING_MODULE = module;
 // }
 /**
- * Sharpening effect enhances the details and edges in the rendered scene by increasing the contrast between adjacent pixels.
+ * [SharpeningEffect](https://engine.needle.tools/docs/api/SharpeningEffect) Sharpening effect enhances the details and edges in the rendered scene by increasing the contrast between adjacent pixels.
  * This effect can make textures and fine details appear clearer and more defined, improving the overall visual quality of the scene.
  * It is particularly useful in scenes where details may be lost due to blurriness or low resolution.
  * @summary Sharpening Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.d.ts

@@ -1,7 +1,7 @@
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 /**
- * Tilt Shift effect simulates a miniature scene by applying a selective focus blur to the rendered image.
+ * [TiltShiftEffect](https://engine.needle.tools/docs/api/TiltShiftEffect) Tilt Shift effect simulates a miniature scene by applying a selective focus blur to the rendered image.
  * This effect creates a shallow depth of field, making real-world scenes appear as if they are small-scale models.
  * It is often used in photography and cinematography to draw attention to specific areas of the scene while blurring out the rest.
  * @summary Tilt Shift Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/TiltShiftEffect.js

@@ -10,7 +10,7 @@ import { PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
 /**
- * Tilt Shift effect simulates a miniature scene by applying a selective focus blur to the rendered image.
+ * [TiltShiftEffect](https://engine.needle.tools/docs/api/TiltShiftEffect) Tilt Shift effect simulates a miniature scene by applying a selective focus blur to the rendered image.
  * This effect creates a shallow depth of field, making real-world scenes appear as if they are small-scale models.
  * It is often used in photography and cinematography to draw attention to specific areas of the scene while blurring out the rest.
  * @summary Tilt Shift Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/Tonemapping.d.ts

@@ -2,7 +2,7 @@ import { EffectProviderResult, PostProcessingEffect } from "../PostProcessingEff
 import { VolumeParameter } from "../VolumeParameter.js";
 import { NEToneMappingModeNames } from "./Tonemapping.utils.js";
 /**
- * Tonemapping effect adjusts the brightness and contrast of the rendered scene to map high dynamic range (HDR) colors to a displayable range.
+ * [ToneMappingEffect](https://engine.needle.tools/docs/api/ToneMappingEffect) adjusts the brightness and contrast of the rendered scene to map high dynamic range (HDR) colors to a displayable range.
  * This effect is essential for achieving realistic lighting and color representation in 3D scenes, as it helps to preserve details in both bright and dark areas.
  * Various tonemapping algorithms can be applied to achieve different visual styles and effects.
  * @summary Tonemapping Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/Tonemapping.js

@@ -15,7 +15,7 @@ import { registerCustomEffectType } from "../VolumeProfile.js";
 import { NEToneMappingMode, threeToNeedleToneMapping, threeToneMappingToEffectMode, toThreeToneMapping } from "./Tonemapping.utils.js";
 const debug = getParam("debugpost");
 /**
- * Tonemapping effect adjusts the brightness and contrast of the rendered scene to map high dynamic range (HDR) colors to a displayable range.
+ * [ToneMappingEffect](https://engine.needle.tools/docs/api/ToneMappingEffect) adjusts the brightness and contrast of the rendered scene to map high dynamic range (HDR) colors to a displayable range.
  * This effect is essential for achieving realistic lighting and color representation in 3D scenes, as it helps to preserve details in both bright and dark areas.
  * Various tonemapping algorithms can be applied to achieve different visual styles and effects.
  * @summary Tonemapping Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/Vignette.d.ts

@@ -1,7 +1,7 @@
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 /**
- * Vignette effect darkens the edges of the rendered scene to draw attention to the center.
+ * [Vignette](https://engine.needle.tools/docs/api/Vignette) darkens the edges of the rendered scene to draw attention to the center.
  * This effect simulates the natural vignetting that occurs in photography and cinematography, where the corners of an image are darker than the center.
  * It can be used to enhance the visual focus on the main subject of the scene and create a more immersive viewing experience.
  * @summary Vignette Post-Processing Effect

package/lib/engine-components/postprocessing/Effects/Vignette.js

@@ -10,7 +10,7 @@ import { PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
 /**
- * Vignette effect darkens the edges of the rendered scene to draw attention to the center.
+ * [Vignette](https://engine.needle.tools/docs/api/Vignette) darkens the edges of the rendered scene to draw attention to the center.
  * This effect simulates the natural vignetting that occurs in photography and cinematography, where the corners of an image are darker than the center.
  * It can be used to enhance the visual focus on the main subject of the scene and create a more immersive viewing experience.
  * @summary Vignette Post-Processing Effect

package/lib/engine-components/postprocessing/PostProcessingHandler.d.ts

@@ -2,7 +2,7 @@ import type { Effect, EffectComposer } from "postprocessing";
 import { Context } from "../../engine/engine_setup.js";
 import { PostProcessingEffect } from "./PostProcessingEffect.js";
 /**
- * PostProcessingHandler is responsible for applying post processing effects to the scene. It is internally used by the {@link Volume} component
+ * [PostProcessingHandler](https://engine.needle.tools/docs/api/PostProcessingHandler) Is responsible for applying post processing effects to the scene. It is internally used by the {@link Volume} component
  */
 export declare class PostProcessingHandler {
     private _composer;

package/lib/engine-components/postprocessing/PostProcessingHandler.js

@@ -12,7 +12,7 @@ const activeKey = Symbol("needle:postprocessing-handler");
 const autoclearSetting = Symbol("needle:previous-autoclear-state");
 const previousToneMapping = Symbol("needle:previous-tone-mapping");
 /**
- * PostProcessingHandler is responsible for applying post processing effects to the scene. It is internally used by the {@link Volume} component
+ * [PostProcessingHandler](https://engine.needle.tools/docs/api/PostProcessingHandler) Is responsible for applying post processing effects to the scene. It is internally used by the {@link Volume} component
  */
 export class PostProcessingHandler {
     _composer = null;

package/lib/engine-components/postprocessing/Volume.d.ts

@@ -4,7 +4,7 @@ import { Behaviour } from "../Component.js";
 import { PostProcessingEffect } from "./PostProcessingEffect.js";
 import { IPostProcessingManager } from "./utils.js";
 import { VolumeProfile } from "./VolumeProfile.js";
-/** The Volume/PostprocessingManager component is responsible for managing post processing effects.
+/** [Volume](https://engine.needle.tools/docs/api/Volume) The Volume/PostprocessingManager component is responsible for managing post processing effects.
  * Add this component to any object in your scene to enable post processing effects.
  *
  * @example Add bloom

package/lib/engine-components/postprocessing/Volume.js

@@ -15,7 +15,7 @@ import { setPostprocessingManagerType } from "./utils.js";
 import { VolumeParameter } from "./VolumeParameter.js";
 import { VolumeProfile } from "./VolumeProfile.js";
 const debug = getParam("debugpost");
-/** The Volume/PostprocessingManager component is responsible for managing post processing effects.
+/** [Volume](https://engine.needle.tools/docs/api/Volume) The Volume/PostprocessingManager component is responsible for managing post processing effects.
  * Add this component to any object in your scene to enable post processing effects.
  *
  * @example Add bloom