@photivra/engine 2.19.0 → 2.21.0

package/docs/api/exports.json

@@ -1,6 +1,6 @@
 {
-  "packageVersion": "2.19.0",
-  "engineApiVersion": "2.19.0",
+  "packageVersion": "2.21.0",
+  "engineApiVersion": "2.21.0",
   "exports": [
     {
       "name": "AbsoluteUncertaintyEstimate",
@@ -77,6 +77,11 @@
       "source": "src/sensor/optical-stack.ts",
       "kind": "type"
     },
+    {
+      "name": "ApertureDiameter",
+      "source": "src/optics/aperture-diameter.ts",
+      "kind": "type"
+    },
     {
       "name": "AperturePriorityAutoIsoExposureModeResolution",
       "source": "src/exposure/exposure-mode-resolver.ts",
@@ -362,6 +367,16 @@
       "source": "src/optics/diffraction.ts",
       "kind": "type"
     },
+    {
+      "name": "calculateApertureDiameter",
+      "source": "src/optics/aperture-diameter.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "CalculateApertureDiameterInput",
+      "source": "src/optics/aperture-diameter.ts",
+      "kind": "type"
+    },
     {
       "name": "calculateAtmosphericHaze",
       "source": "src/optics/atmospheric-haze.ts",
@@ -497,6 +512,16 @@
       "source": "src/output/crop.ts",
       "kind": "type"
     },
+    {
+      "name": "calculateChannelEffectiveDispersion",
+      "source": "src/output/generic-lens-corrections.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "CalculateChannelEffectiveDispersionInput",
+      "source": "src/output/generic-lens-corrections.ts",
+      "kind": "type"
+    },
     {
       "name": "calculateChartFraming",
       "source": "src/facade/subject-framing.ts",
@@ -582,6 +607,16 @@
       "source": "src/color/illuminants.ts",
       "kind": "runtime"
     },
+    {
+      "name": "calculateCropToMatchFocalLength",
+      "source": "src/output/crop-to-match-focal-length.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "CalculateCropToMatchFocalLengthInput",
+      "source": "src/output/crop-to-match-focal-length.ts",
+      "kind": "type"
+    },
     {
       "name": "calculateDefocusBokehKernel",
       "source": "src/optics/defocus-bokeh-kernel.ts",
@@ -632,6 +667,16 @@
       "source": "src/optics/depth-of-field.ts",
       "kind": "type"
     },
+    {
+      "name": "calculateDetailLimit",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "CalculateDetailLimitInput",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "type"
+    },
     {
       "name": "calculatedResult",
       "source": "src/core/calculation-result.ts",
@@ -937,6 +982,16 @@
       "source": "src/optics/lateral-chromatic-aberration.ts",
       "kind": "type"
     },
+    {
+      "name": "calculateLateralColorFringe",
+      "source": "src/optics/generic-lens-lateral-color.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "CalculateLateralColorFringeInput",
+      "source": "src/optics/generic-lens-lateral-color.ts",
+      "kind": "type"
+    },
     {
       "name": "calculateLensComplexPupilPsf",
       "source": "src/optics/complex-pupil-psf.ts",
@@ -1152,6 +1207,11 @@
       "source": "src/output/print-plan.ts",
       "kind": "runtime"
     },
+    {
+      "name": "calculatePrintSizeLimitWithBlurAndNoise",
+      "source": "src/output/print-size-blur-noise.ts",
+      "kind": "runtime"
+    },
     {
       "name": "calculateProcessedSensorRaw",
       "source": "src/capture/photographic-export.ts",
@@ -1912,6 +1972,11 @@
       "source": "src/processing/demosaic.ts",
       "kind": "type"
     },
+    {
+      "name": "ChannelDispersion",
+      "source": "src/output/developed-lens-corrections.ts",
+      "kind": "type"
+    },
     {
       "name": "ChannelSeparationVectorMm",
       "source": "src/optics/lateral-chromatic-aberration.ts",
@@ -2652,6 +2717,16 @@
       "source": "src/processing/tone-mapping.ts",
       "kind": "runtime"
     },
+    {
+      "name": "createRepresentativeLightSourceIlluminant",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "createRepresentativeLightSourceSpectrum",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "runtime"
+    },
     {
       "name": "createRollingShutterCaptureExposureSchedule",
       "source": "src/sensor/readout-exposure-linkage.ts",
@@ -2752,6 +2827,11 @@
       "source": "src/optics/zernike-wavefront.ts",
       "kind": "type"
     },
+    {
+      "name": "CropToMatchFocalLength",
+      "source": "src/output/crop-to-match-focal-length.ts",
+      "kind": "type"
+    },
     {
       "name": "DeadLeavesChartScene",
       "source": "src/facade/chart-scenes.ts",
@@ -2822,6 +2902,56 @@
       "source": "src/optics/depth-of-field.ts",
       "kind": "type"
     },
+    {
+      "name": "DETAIL_LIMIT_LIMITS",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "DetailLimit",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "type"
+    },
+    {
+      "name": "DetailLimitBasis",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "type"
+    },
+    {
+      "name": "DetailLimitCatalogueLens",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "type"
+    },
+    {
+      "name": "DetailLimitedBy",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "type"
+    },
+    {
+      "name": "DetailLimitIdealLens",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "type"
+    },
+    {
+      "name": "DetailLimitingFactor",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "type"
+    },
+    {
+      "name": "DetailLimitOptics",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "type"
+    },
+    {
+      "name": "DetailLimitSampling",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "type"
+    },
+    {
+      "name": "DetailLimitSystem",
+      "source": "src/optics/detail-limit.ts",
+      "kind": "type"
+    },
     {
       "name": "DIFFRACTION_LIMITED_PSF_PROFILE_LIMITS",
       "source": "src/optics/diffraction-psf-profile.ts",
@@ -3152,6 +3282,16 @@
       "source": "src/capture/photographic-export.ts",
       "kind": "type"
     },
+    {
+      "name": "EXPOSURE_BUILD_UP_MAXIMUM_FRACTIONS",
+      "source": "src/facade/exposure-build-up.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "EXPOSURE_BUILD_UP_STREAM_BASE",
+      "source": "src/facade/exposure-build-up.ts",
+      "kind": "runtime"
+    },
     {
       "name": "EXPOSURE_DURATION_CONTROL_VERSION",
       "source": "src/exposure/exposure-duration-control.ts",
@@ -3902,6 +4042,11 @@
       "source": "src/optics/psf-foundation.ts",
       "kind": "runtime"
     },
+    {
+      "name": "getRepresentativeLightSourceSet",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "runtime"
+    },
     {
       "name": "getWebGpuEnabled",
       "source": "src/gpu/webgpu-switch.ts",
@@ -4152,6 +4297,11 @@
       "source": "src/gpu/image-kernel-execution.ts",
       "kind": "type"
     },
+    {
+      "name": "ImagePlaneImage",
+      "source": "src/facade/scene-radiance.ts",
+      "kind": "type"
+    },
     {
       "name": "ImagePlaneMetricPointMm",
       "source": "src/output/capture-geometry.ts",
@@ -4162,6 +4312,11 @@
       "source": "src/motion/camera-rotation.ts",
       "kind": "type"
     },
+    {
+      "name": "ImagePlaneScene",
+      "source": "src/facade/scene-radiance.ts",
+      "kind": "type"
+    },
     {
       "name": "ImagingAreaMetrics",
       "source": "src/sensor/sensor-geometry.ts",
@@ -4392,6 +4547,16 @@
       "source": "src/optics/lateral-chromatic-aberration.ts",
       "kind": "type"
     },
+    {
+      "name": "LateralColorDisplacement",
+      "source": "src/optics/generic-lens-lateral-color.ts",
+      "kind": "type"
+    },
+    {
+      "name": "LateralColorFringe",
+      "source": "src/optics/generic-lens-lateral-color.ts",
+      "kind": "type"
+    },
     {
       "name": "LayeredColorSamplingLayout",
       "source": "src/sensor/color-sampling.ts",
@@ -4752,6 +4917,31 @@
       "source": "src/exposure/metering-temporal.ts",
       "kind": "type"
     },
+    {
+      "name": "MixedIllumination",
+      "source": "src/facade/mixed-illumination.ts",
+      "kind": "type"
+    },
+    {
+      "name": "MixedIlluminationBlend",
+      "source": "src/facade/mixed-illumination.ts",
+      "kind": "type"
+    },
+    {
+      "name": "MixedIlluminationPoint",
+      "source": "src/facade/mixed-illumination.ts",
+      "kind": "type"
+    },
+    {
+      "name": "MixedIlluminationPointSource",
+      "source": "src/facade/mixed-illumination.ts",
+      "kind": "type"
+    },
+    {
+      "name": "MixedIlluminationSource",
+      "source": "src/facade/mixed-illumination.ts",
+      "kind": "type"
+    },
     {
       "name": "MonochromeColorSamplingLayout",
       "source": "src/sensor/color-sampling.ts",
@@ -5917,6 +6107,11 @@
       "source": "src/composition/image-formation-plan.ts",
       "kind": "type"
     },
+    {
+      "name": "prepareImagePlaneScenes",
+      "source": "src/facade/image-plane-enable.ts",
+      "kind": "runtime"
+    },
     {
       "name": "prepareRgbGamutMapping",
       "source": "src/color/gamut-mapping.ts",
@@ -5967,6 +6162,16 @@
       "source": "src/output/print-region-statistics.ts",
       "kind": "runtime"
     },
+    {
+      "name": "PrintBlurInput",
+      "source": "src/output/print-size-blur-noise.ts",
+      "kind": "type"
+    },
+    {
+      "name": "PrintContainLayout",
+      "source": "src/output/print-plan.ts",
+      "kind": "type"
+    },
     {
       "name": "PrintContrastReference",
       "source": "src/output/print-contrast-reference.ts",
@@ -5992,6 +6197,16 @@
       "source": "src/output/print-plan.ts",
       "kind": "type"
     },
+    {
+      "name": "PrintFit",
+      "source": "src/output/print-plan.ts",
+      "kind": "type"
+    },
+    {
+      "name": "PrintImageMm",
+      "source": "src/output/print-size-blur-noise.ts",
+      "kind": "type"
+    },
     {
       "name": "PrintJpegInput",
       "source": "src/output/print-jpeg.ts",
@@ -6047,6 +6262,11 @@
       "source": "src/output/print-plan.ts",
       "kind": "type"
     },
+    {
+      "name": "PrintNoiseInput",
+      "source": "src/output/print-size-blur-noise.ts",
+      "kind": "type"
+    },
     {
       "name": "PrintPlan",
       "source": "src/output/print-plan.ts",
@@ -6112,6 +6332,11 @@
       "source": "src/output/print-plan.ts",
       "kind": "type"
     },
+    {
+      "name": "PrintSharpCleanCriterion",
+      "source": "src/output/print-size-blur-noise.ts",
+      "kind": "type"
+    },
     {
       "name": "PrintSinusoidalMeasurement",
       "source": "src/output/print-detail.ts",
@@ -6132,6 +6357,16 @@
       "source": "src/output/print-plan.ts",
       "kind": "type"
     },
+    {
+      "name": "PrintSizeLimitWithBlurAndNoise",
+      "source": "src/output/print-size-blur-noise.ts",
+      "kind": "type"
+    },
+    {
+      "name": "PrintSizeLimitWithBlurAndNoiseInput",
+      "source": "src/output/print-size-blur-noise.ts",
+      "kind": "type"
+    },
     {
       "name": "PROCESSED_SENSOR_RAW_MODEL_VERSION",
       "source": "src/capture/photographic-export.ts",
@@ -6602,6 +6837,46 @@
       "source": "src/composition/image-formation-plan.ts",
       "kind": "type"
     },
+    {
+      "name": "REPRESENTATIVE_LIGHT_SOURCE_IDS",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "REPRESENTATIVE_LIGHT_SOURCE_SET_ID",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "REPRESENTATIVE_LIGHT_SOURCE_SET_VERSION",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "REPRESENTATIVE_LIGHT_SOURCE_WAVELENGTH_RANGE_NANOMETERS",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "RepresentativeLightSource",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "type"
+    },
+    {
+      "name": "RepresentativeLightSourceBand",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "type"
+    },
+    {
+      "name": "RepresentativeLightSourceId",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "type"
+    },
+    {
+      "name": "RepresentativeLightSourceSet",
+      "source": "src/facade/representative-light-sources.ts",
+      "kind": "type"
+    },
     {
       "name": "RequestedFlashSyncMode",
       "source": "src/exposure/flash.ts",
@@ -7117,6 +7392,11 @@
       "source": "src/schema/illumination-spectral.ts",
       "kind": "runtime"
     },
+    {
+      "name": "resolveSensorProfile",
+      "source": "src/equipment/sensor-profiles.ts",
+      "kind": "runtime"
+    },
     {
       "name": "resolveSensorRawReconstruction",
       "source": "src/sensor/raw-reconstruction.ts",
@@ -7662,6 +7942,21 @@
       "source": "src/sensor/fixed-pattern-noise.ts",
       "kind": "runtime"
     },
+    {
+      "name": "SENSOR_PROFILE_IDS",
+      "source": "src/equipment/sensor-profiles.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "SENSOR_PROFILE_ISO_ANCHOR",
+      "source": "src/equipment/sensor-profile-body.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "SENSOR_PROFILES",
+      "source": "src/equipment/sensor-profiles.ts",
+      "kind": "runtime"
+    },
     {
       "name": "SENSOR_RAW_CAPTURE_SAMPLE_VERSION",
       "source": "src/sensor/raw-reconstruction.ts",
@@ -8022,6 +8317,16 @@
       "source": "src/sensor/physical-charge-capacity.ts",
       "kind": "type"
     },
+    {
+      "name": "SensorProfile",
+      "source": "src/equipment/sensor-profile-body.ts",
+      "kind": "type"
+    },
+    {
+      "name": "SensorProfileValueKind",
+      "source": "src/equipment/sensor-profile-body.ts",
+      "kind": "type"
+    },
     {
       "name": "SensorPsfIrradianceQuadrature",
       "source": "src/optics/sensor-psf-quadrature.ts",
@@ -8512,6 +8817,11 @@
       "source": "src/facade/simulate-capture.ts",
       "kind": "runtime"
     },
+    {
+      "name": "SIMULATE_CAPTURE_FAST_METHODS",
+      "source": "src/facade/fast-methods.ts",
+      "kind": "runtime"
+    },
     {
       "name": "SIMULATE_CAPTURE_FAST_OPTIONS",
       "source": "src/facade/simulate-capture.ts",
@@ -8602,6 +8912,11 @@
       "source": "src/facade/simulate-capture.ts",
       "kind": "type"
     },
+    {
+      "name": "SimulateCaptureFastMethod",
+      "source": "src/facade/fast-methods.ts",
+      "kind": "type"
+    },
     {
       "name": "SimulateCaptureFastOption",
       "source": "src/facade/simulate-capture.ts",
@@ -8642,6 +8957,11 @@
       "source": "src/facade/simulate-capture.ts",
       "kind": "type"
     },
+    {
+      "name": "SimulateCaptureNoiseComponents",
+      "source": "src/sensor/sensor-characteristics.ts",
+      "kind": "type"
+    },
     {
       "name": "SimulateCaptureOptions",
       "source": "src/facade/simulate-capture.ts",
@@ -8672,11 +8992,26 @@
       "source": "src/facade/simulate-capture.ts",
       "kind": "type"
     },
+    {
+      "name": "SimulateCaptureSensorCharacteristics",
+      "source": "src/sensor/sensor-characteristics.ts",
+      "kind": "type"
+    },
+    {
+      "name": "SimulateCaptureSensorReport",
+      "source": "src/sensor/sensor-characteristics.ts",
+      "kind": "type"
+    },
     {
       "name": "SimulateCaptureSharpening",
       "source": "src/facade/simulate-capture.ts",
       "kind": "type"
     },
+    {
+      "name": "SimulateCaptureSubjectMotion",
+      "source": "src/motion/subject-motion.ts",
+      "kind": "type"
+    },
     {
       "name": "SimulateCaptureWhiteBalance",
       "source": "src/facade/simulate-capture.ts",
@@ -8717,6 +9052,26 @@
       "source": "src/capture/environment-raw-producer.ts",
       "kind": "type"
     },
+    {
+      "name": "simulateExposureBuildUp",
+      "source": "src/facade/exposure-build-up.ts",
+      "kind": "runtime"
+    },
+    {
+      "name": "SimulateExposureBuildUpFrame",
+      "source": "src/facade/exposure-build-up.ts",
+      "kind": "type"
+    },
+    {
+      "name": "SimulateExposureBuildUpOptions",
+      "source": "src/facade/exposure-build-up.ts",
+      "kind": "type"
+    },
+    {
+      "name": "SimulateExposureBuildUpResult",
+      "source": "src/facade/exposure-build-up.ts",
+      "kind": "type"
+    },
     {
       "name": "simulateGenericLensFocusError",
       "source": "src/equipment/generic-lens-catalogue.ts",

package/docs/api/facade-display-view-gpu.md

@@ -81,13 +81,16 @@ export type DisplayViewGpuMode = "off" | "auto" | "require";
 
 ```ts
 export interface PrepareDisplayViewOptions {
-  /** See {@link DisplayViewGpuMode}. Default `"off"`. */
+  /**
+   * See {@link DisplayViewGpuMode}. 2.20.0: default `"auto"` when the request resolves to fast (`fast` omitted or true: the
+   * display view's default) and `"off"` when it is exact (`fast: false`); an explicit value wins.
+   */
   gpu?: DisplayViewGpuMode;
   /**
    * Where the device comes from, with `gpu: "auto"` or `"require"`: a WebGPU entry point (a worker's `navigator.gpu`), or an
    * `ImageKernelAccelerator` whose device the view shares (the accelerator keeps ownership; `dispose()` of the prepared view
    * leaves it alone). Without it the engine acquires a device from `globalThis.navigator.gpu` and owns it until `dispose()`.
-   * Refused with `gpu: "off"`.
+   * Refused when `gpu` is or defaults to `"off"`.
    */
   gpuDevice?: unknown;
 }