Merge pull request #507 from darekbx/darekbx/add-info-about-differ-op…

…tions Add description how to configure Differ
takahirom · Oct 18, 2024 · 0f51a41 · 0f51a41
2 parents 2f78447 + 1912c65
commit 0f51a41
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -957,6 +957,26 @@ data class RoborazziOptions(
 }
 ```
 
+#### Image comparator custom settings
+When comparing images, you may encounter differences due to minor changes related to antialiasing. You can use the options below to avoid this.
+```kotlin
+@get:Rule
+val roborazziRule = RoborazziRule(
+    options = RoborazziRule.Options(
+        roborazziOptions = RoborazziOptions(
+            compareOptions = RoborazziOptions.CompareOptions(
+                changeThreshold = 0.01, // For 1% accepted difference
+                imageComparator = SimpleImageComparator(
+                    maxDistance = 0.007F, // 0.001F is default value from Differ
+                    vShift = 2, // Increasing the shift can help resolve antialiasing issues
+                    hShift = 2 // Increasing the shift can help resolve antialiasing issues
+                )
+            )
+        )
+    )
+)
+```
+
 ### Dump mode
 
 If you are having trouble debugging your test, try Dump mode as follows.

diff --git a/docs/topics/how_to_use.md b/docs/topics/how_to_use.md
@@ -634,6 +634,26 @@ data class RoborazziOptions(
 }
 ```
 
+#### Image comparator custom settings
+When comparing images, you may encounter differences due to minor changes related to antialiasing. You can use the options below to avoid this.
+```kotlin
+@get:Rule
+val roborazziRule = RoborazziRule(
+    options = RoborazziRule.Options(
+        roborazziOptions = RoborazziOptions(
+            compareOptions = RoborazziOptions.CompareOptions(
+                changeThreshold = 0.01, // For 1% accepted difference
+                imageComparator = SimpleImageComparator(
+                    maxDistance = 0.007F, // 0.001F is default value from Differ
+                    vShift = 2, // Increasing the shift can help resolve antialiasing issues
+                    hShift = 2 // Increasing the shift can help resolve antialiasing issues
+                )
+            )
+        )
+    )
+)
+```
+
 ### Dump mode
 
 If you are having trouble debugging your test, try Dump mode as follows.