# Butteraugli v0.1.0 - Table of Contents

> Butteraugli perceptual image-difference metric for Elixir (butteraugli NIF)

## Pages

- [butteraugli](readme.md)
- [Changelog](changelog.md)

## Modules

- [Butteraugli](Butteraugli.md): Butteraugli perceptual image-difference metric for Elixir, backed by the
`butteraugli` Rust crate.
- [Butteraugli.CancelRef](Butteraugli.CancelRef.md): A cancellation handle for aborting an in-flight `Butteraugli.compare/5` or
`Butteraugli.Reference.compare/3`.
- [Butteraugli.Reference](Butteraugli.Reference.md): A precomputed butteraugli reference image for efficient batch comparison.
- [Butteraugli.Result](Butteraugli.Result.md): The outcome of a butteraugli comparison.
- [Butteraugli.Vix](Butteraugli.Vix.md): Convenience wrappers that accept `Vix.Vips.Image` structs.

- Exceptions
  - [Butteraugli.Error](Butteraugli.Error.md): Raised by the `!` variants when a comparison fails.

