Options and option validation for Image.embed/4.
Summary
Types
Options applicable to Image.embed/4.
Options list for Image.embed/4.
How the generated border pixels are produced.
Functions
Validate the options for Image.embed/4.
Types
@type embed_option() :: {:background, Image.BackgroundColor.spec() | nil} | {:extend_mode, extend_mode()} | {:x, non_neg_integer() | :center} | {:y, non_neg_integer() | :center}
Options applicable to Image.embed/4.
@type embed_options() :: [embed_option()]
Options list for Image.embed/4.
@type extend_mode() :: :copy | :repeat | :mirror | :background
How the generated border pixels are produced.
:copy,:repeatand:mirrorsynthesize the border from the image content.:backgroundfills the border with the:backgroundcolor. This is the default behavior when no:extend_modeis given, so passing it is only ever explicit documentation of intent. The color still comes from the:backgroundoption.
Functions
Validate the options for Image.embed/4.