@spec apply_filter(String.t(), atom() | String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

Apply visual filters / enhancements.

@spec available?() :: boolean()

Returns true when the optional :image dependency is compiled and loadable.

:image is a native/NIF-backed dependency (Vix/libvips) that cannot be loaded from inside an escript archive, so callers embedding Ragex as a library should check this before relying on image-processing features.

@spec avatar(String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Generate a circular, squircle, or square avatar image.

@spec compare(String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Compare two images for visual diff/similarity.

@spec composite(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

Composite (overlay) an image on top of a base image.

@spec convert(String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Convert image format (e.g. PNG, JPEG, WebP, AVIF, TIFF, GIF).

@spec crop(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Crop an image by bounding box or auto-trim.

@spec draw_text(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

Render text onto an image.

@spec info(String.t()) :: {:ok, map()} | {:error, term()}

Get detailed information and metadata for an image file.

@spec resize(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Resize an image by scale factor, width/height dimensions, or crop focus.

@spec rotate(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Rotate or flip an image.