native-image-diff

Index

Interfaces

Variables

__native_imageDiff

Functions

Variables

__native_imageDiff

__native_imageDiff: any

Functions

diffImages

diffImages(args: DiffImagesArguments): DiffResult
diffImages(image1: DiffImage, image2: DiffImage): DiffResult

- Defined in diff-images.ts:116
Compare two images and return the result including meta information and a diff image as a buffer.

Parameters
- args: DiffImagesArguments
Returns DiffResult

The information about the difference between the two images.
- Defined in diff-images.ts:117
Compare two images and return the result including meta information and a diff image as a buffer.

Parameters
- image1: DiffImage
- image2: DiffImage
Returns DiffResult

The information about the difference between the two images.

getBytesPerPixel

getBytesPerPixel(image: DiffImage): number

- Defined in diff-images.ts:53
Returns the amount of bytes per pixels for the given image.

Parameters
- image: DiffImage
  
  The image of which the bytes per pixels should be calculated.
Returns number

The amount of bytes per pixels for the provided image.

getCommonDimensions

getCommonDimensions(image1: DiffImage, image2: DiffImage): Dimensions

- Defined in diff-images.ts:84
Calculate the common dimensions of two images. This will return the maximum width and height of both provided images.

Parameters
- image1: DiffImage
  
  The first image of which to calculate the wdth and height.
- image2: DiffImage
  
  The second image of which to calculate the wdth and height.
Returns Dimensions

The common maximum dimensions of both images.

isDiffImage

isDiffImage(image: any): boolean

- Defined in diff-images.ts:65
Checks that the given object is a valid DiffImage.

see

DiffImage

Parameters
- image: any
Returns boolean

Whether the given image is of type DiffImage.

Generated using TypeDoc