# `Image.Options.Embed`
[🔗](https://github.com/elixir-image/image/blob/v0.65.0/lib/image/options/embed.ex#L1)

Options and option validation for `Image.embed/4`.

# `embed_option`

```elixir
@type embed_option() ::
  {:background_color, Image.Pixel.t() | :average}
  | {:background_transparency, Image.Pixel.transparency()}
  | {:extend_mode, extend_mode()}
  | {:x, non_neg_integer() | :center}
  | {:y, non_neg_integer() | :center}
```

Options applicable to `Image.embed/4`.

# `embed_options`

```elixir
@type embed_options() :: [embed_option()]
```

Options list for `Image.embed/4`.

# `extend_mode`

```elixir
@type extend_mode() :: :black | :white | :copy | :repeat | :mirror | :background
```

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

# `validate_options`

Validate the options for `Image.embed/4`.

---

*Consult [api-reference.md](api-reference.md) for complete listing*