image
image
v0.33.0

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

Options and option validation for Image.embed/4.

Link to this section Summary

Types

embed_options()

Options applicable to 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.

Link to this section Types

Link to this type

embed_options()

View Source 
@type embed_options() :: [
  background: Image.Color.t() | :average,
  extend_mode: extend_mode(),
  x: non_neg_integer() | :center,
  y: non_neg_integer() | :center
]

Options applicable to 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.

Link to this section Functions

Link to this function

validate_options(image, width, height, options)

View Source

Validate the options for Image.embed/4.