Image.ExtendMode (image v0.59.0)

Defines the known modes by which an image can be extended.

Summary

Types

t()

Defines the known extend strategies.

Functions

known_extend_modes()

Returns the known extend modes.

validate_extend(extend)

Normalizes and validates an extend mode.

Types

t()

@type t() :: :mirror | :background | :repeat | :white | :black | :copy

Defines the known extend strategies.

Functions

known_extend_modes()

Returns the known extend modes.

validate_extend(extend)

Normalizes and validates an extend mode.

Arguments

extend is any atom or string value in Image.ExtendMode.known_extend_modes/0.

Returns

{:error, normalized_extend_mode} or
{:error, reason}.

Examples

iex> Image.Kernel.validate_extend(:black)
{:ok, :VIPS_EXTEND_BLACK}

iex> Image.Kernel.validate_extend(:VIPS_EXTEND_REPEAT)
{:ok, :VIPS_EXTEND_REPEAT}

iex> Image.Kernel.validate_extend(:unknown)
{:error, "Unknown extend mode. Found :unknown"}