angular-three-postprocessing 4.0.0-next.116 → 4.0.0-next.118

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "angular-three-postprocessing",
-	"version": "4.0.0-next.116",
+	"version": "4.0.0-next.118",
 	"publishConfig": {
 		"access": "public"
 	},

package/types/angular-three-postprocessing-n8ao.d.ts

@@ -1,35 +1,163 @@
 import * as _angular_core from '@angular/core';
 import * as THREE from 'three';
 
+/**
+ * Configuration options for the N8AO (N8 Ambient Occlusion) effect.
+ *
+ * N8AO is a high-quality, screen-space ambient occlusion implementation
+ * that provides realistic shadowing in crevices and corners.
+ */
 interface NgtpN8AOOptions {
+    /**
+     * Radius of the ambient occlusion effect in world units.
+     * @default 5.0
+     */
     aoRadius: number;
+    /**
+     * Number of tones for AO gradient.
+     * @default 0.0
+     */
     aoTones: number;
+    /**
+     * How quickly the AO effect falls off with distance.
+     * @default 1.0
+     */
     distanceFalloff: number;
+    /**
+     * Intensity/strength of the ambient occlusion effect.
+     * @default 5
+     */
     intensity: number;
+    /**
+     * Bias offset for depth comparison.
+     * @default 0.0
+     */
     biasOffset: number;
+    /**
+     * Bias multiplier for depth comparison.
+     * @default 0.0
+     */
     biasMultiplier: number;
+    /**
+     * Number of samples for ambient occlusion calculation.
+     * Higher values = better quality but slower.
+     * @default 16
+     */
     aoSamples: number;
+    /**
+     * Number of samples for denoising.
+     * @default 8
+     */
     denoiseSamples: number;
+    /**
+     * Radius of the denoising filter.
+     * @default 12
+     */
     denoiseRadius: number;
+    /**
+     * Color of the ambient occlusion shadows.
+     * @default 'black'
+     */
     color: THREE.ColorRepresentation;
+    /**
+     * Whether to render at half resolution for better performance.
+     * @default false
+     */
     halfRes: boolean;
+    /**
+     * Whether to use depth-aware upsampling when using half resolution.
+     * @default true
+     */
     depthAwareUpsampling: boolean;
+    /**
+     * Whether to use screen-space radius instead of world-space.
+     * @default false
+     */
     screenSpaceRadius: boolean;
+    /**
+     * Render mode for debugging and visualization.
+     * 0: Combined, 1: AO only, 2: Normals, 3: Depth, 4: Denoise
+     * @default 0
+     */
     renderMode: 0 | 1 | 2 | 3 | 4;
+    /**
+     * Number of iterations for the denoising filter.
+     * @default 2.0
+     */
     denoiseIterations: number;
+    /**
+     * Whether to handle transparent objects correctly.
+     * @default false
+     */
     transparencyAware: boolean;
+    /**
+     * Whether to apply gamma correction.
+     * @default true
+     */
     gammaCorrection: boolean;
+    /**
+     * Whether to use logarithmic depth buffer.
+     * @default false
+     */
     logarithmicDepthBuffer: boolean;
+    /**
+     * Whether to multiply the color instead of darkening.
+     * @default true
+     */
     colorMultiply: boolean;
+    /**
+     * Whether to accumulate samples over frames for better quality.
+     * @default false
+     */
     accumulate: boolean;
+    /**
+     * Quality preset that overrides individual settings.
+     * Options: 'performance', 'low', 'medium', 'high', 'ultra'
+     * @default undefined
+     */
     quality?: 'performance' | 'low' | 'medium' | 'high' | 'ultra';
 }
+/**
+ * Angular component that applies N8AO (N8 Ambient Occlusion) to the scene.
+ *
+ * N8AO is a high-quality screen-space ambient occlusion effect that adds
+ * realistic shadowing to crevices, corners, and areas where objects meet.
+ * It provides various quality presets and fine-grained control over the
+ * AO appearance.
+ *
+ * @example
+ * ```html
+ * <ngtp-effect-composer>
+ *   <ngtp-n8ao [options]="{ intensity: 3, aoRadius: 2 }" />
+ * </ngtp-effect-composer>
+ * ```
+ *
+ * @example
+ * ```html
+ * <!-- Using quality preset -->
+ * <ngtp-effect-composer>
+ *   <ngtp-n8ao [options]="{ quality: 'high' }" />
+ * </ngtp-effect-composer>
+ * ```
+ */
 declare class NgtpN8AO {
+    /**
+     * Configuration options for the N8AO effect.
+     * @see NgtpN8AOOptions
+     */
     options: _angular_core.InputSignalWithTransform<NgtpN8AOOptions, "" | Partial<NgtpN8AOOptions>>;
     private quality;
     private effectComposer;
+    /**
+     * The underlying N8AOPostPass instance.
+     * Created with the scene and camera from the effect composer.
+     */
     protected effect: _angular_core.Signal<any>;
     constructor();
+    /**
+     * Applies a quality preset to the effect.
+     * Converts the quality string to title case and calls the effect's setQuality method.
+     */
     private setQualityEffect;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgtpN8AO, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<NgtpN8AO, "ngtp-n8ao", never, { "options": { "alias": "options"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;