View Source Image.Options.Embed (image v0.54.4)

Options and option validation for Image.embed/4.

Summary

Types

embed_option()

Options applicable to Image.embed/4.

embed_options()

Options list for Image.embed/4.

extend_mode()

When extending the canvas the generated pixels are determined by this option.

Functions

validate_options(image, width, height, options)

Validate the options for Image.embed/4.

Types

Link to this type

embed_option()

View Source 
@type embed_option() ::
  {:background_color, Image.Color.t() | :average}
  | {:background_transparency, Image.Color.transparency()}
  | {:extend_mode, extend_mode()}
  | {:x, non_neg_integer() | :center}
  | {:y, non_neg_integer() | :center}

Options applicable to Image.embed/4.

Link to this type

embed_options()

View Source 
@type embed_options() :: [embed_option()]

Options list for Image.embed/4.

Link to this type

extend_mode()

View Source 
@type extend_mode() :: :black | :white | :copy | :repeat | :mirror | :background

When extending the canvas the generated pixels are determined by this option.

Functions

Link to this function

validate_options(image, width, height, options)

View Source

Validate the options for Image.embed/4.