iText 8.0.2 API
iText.IO.Util.ImageMagickCompareResult Class Reference

A helper data class, which aggregates true/false result of ImageMagick comparing as well as the number of different pixels. More...

Public Member Functions

  ImageMagickCompareResult (bool result, long diffPixels)
  Creates an instance that contains ImageMagick comparing result information. More...
 
bool  IsComparingResultSuccessful ()
  Returns image compare boolean value. More...
 
long  GetDiffPixels ()
  Getter for a different pixels count. More...
 

Detailed Description

A helper data class, which aggregates true/false result of ImageMagick comparing as well as the number of different pixels.

Constructor & Destructor Documentation

◆ ImageMagickCompareResult()

iText.IO.Util.ImageMagickCompareResult.ImageMagickCompareResult ( bool  result,
long  diffPixels 
)
inline

Creates an instance that contains ImageMagick comparing result information.

Parameters
result true, if the compared images are equal.
diffPixels number of different pixels.

Member Function Documentation

◆ GetDiffPixels()

long iText.IO.Util.ImageMagickCompareResult.GetDiffPixels ( )
inline

Getter for a different pixels count.

Returns
Returns a a different pixels count.

◆ IsComparingResultSuccessful()

bool iText.IO.Util.ImageMagickCompareResult.IsComparingResultSuccessful ( )
inline

Returns image compare boolean value.

Returns
true if the compared images are equal.