View Source Image.Options.Write (image v0.2.0)

Options and option validation for Image.write/3.

Link to this section Summary

compression()

Allowble compression types for heif images.

heif_write_options()

Options for writing an image to a file with Image.write/2.

jpeg_write_options()

png_write_options()

tiff_write_options()

webp_write_options()

@type compression() :: :hevc | :avc | :jpeg | :av1

Allowble compression types for heif images.

@type heif_write_options() :: [
  quality: 1..100,
  background: Image.pixel(),
  compression: compression()
]

@type image_write_options() :: [
  jpeg_write_options()
  | png_write_options()
  | tiff_write_options()
  | webp_write_options()
]

Options for writing an image to a file with Image.write/2.

@type jpeg_write_options() :: [
  quality: 1..100,
  strip_metadata: boolean(),
  icc_profile: Path.t(),
  background: Image.pixel()
]

@type png_write_options() :: [
  quality: 1..100,
  strip_metadata: boolean(),
  icc_profile: Path.t(),
  background: Image.pixel()
]

@type tiff_write_options() :: [
  quality: 1..100,
  icc_profile: Path.t(),
  background: Image.pixel()
]

@type webp_write_options() :: [
  quality: 1..100,
  icc_profile: Path.t(),
  background: Image.pixel(),
  strip_metadata: boolean()
]