From 88b352f9c82ca88694d6ee12db80fe02a83c425b Mon Sep 17 00:00:00 2001 From: Oceane Patiny Date: Fri, 6 Oct 2023 10:35:06 +0200 Subject: [PATCH] docs: enhance alignMinDiff jsdocs --- src/align/alignMinDifference.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/align/alignMinDifference.ts b/src/align/alignMinDifference.ts index 262a37731..c8b206d74 100644 --- a/src/align/alignMinDifference.ts +++ b/src/align/alignMinDifference.ts @@ -7,6 +7,11 @@ export interface AlignMinDifferenceOptions { * @default `Math.max(Math.round(Math.min(source.width, source.height, Math.max(xSpan, ySpan)) / 10,),1,)` */ startStep?: number; + /** + * Mask specifying the pixels to consider for the similarity calculation. + * The mask must be the same size as the source image. + * @default `undefined` + */ mask?: Mask; }