ImageDiff 1.71.5 API


public class ImageDiff

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`ImageDiff.Mode`
`public enum`	`ImageDiff.Swizzle`
`public class`	`ImageDiff.Config`
`public class`	`ImageDiff.Result`

Method Summary

Modifier and Type	Method	Description
`static ImageDiff.Result`	`compareBasic(@NonNull() Bitmap reference, @NonNull() Bitmap candidate, @NonNull() ImageDiff.Config config, @Nullable() Bitmap mask)`	Compares two bitmaps using a configuration object.
`static ImageDiff.Result`	`compare(@NonNull() Bitmap reference, @NonNull() Bitmap candidate, @NonNull() String jsonConfig, @Nullable() Bitmap mask)`	Compares two bitmaps using a JSON configuration string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - compareBasic
```
@NonNull() static ImageDiff.Result compareBasic(@NonNull() Bitmap reference, @NonNull() Bitmap candidate, @NonNull() ImageDiff.Config config, @Nullable() Bitmap mask)
```
    Compares two bitmaps using a configuration object.
    
    Parameters:
    
    reference - Golden image
    
    candidate - Actual image
    
    config - Comparison configuration
    
    mask - Optional mask (grayscale)
  - compare
```
@NonNull() static ImageDiff.Result compare(@NonNull() Bitmap reference, @NonNull() Bitmap candidate, @NonNull() String jsonConfig, @Nullable() Bitmap mask)
```
    Compares two bitmaps using a JSON configuration string.
    
    Parameters:
    
    reference - Golden image
    
    candidate - Actual image
    
    jsonConfig - Comparison configuration in JSON format
    
    mask - Optional mask (grayscale)