View Source Avatarex.Birdy (Avatarex v0.1.1)

This module generates Birdy avatars using images created by David Revoy and used under CC-BY-4.0.

https://www.davidrevoy.com/article591/cat-bird-fenestar-abstract-avatar-generators

Link to this section Summary

Functions

Generates a Elixir.Avatarex.Birdy with the provided name.

Generates a random Elixir.Avatarex.Birdy without a name, that cannot be regenerated based on a given name.

Generates a Elixir.Avatarex.Birdy with the specified name. Renders an image in the output directory.

Writes an image for a provided Elixir.Avatarex.Birdy to the output directory.

Writes an image for a provided %Vix.Vips.Image{} with a given name in the output directory.

Link to this section Functions

Link to this function

generate(string)

View Source (since 0.1.0)

Generates a Elixir.Avatarex.Birdy with the provided name.

Returns %Elixir.Avatarex.Birdy{name: name, ...}.

examples

Examples

iex> Elixir.Avatarex.Birdy.generate("my_birdy")
%Elixir.Avatarex.Birdy{}

Generates a random Elixir.Avatarex.Birdy without a name, that cannot be regenerated based on a given name.

Returns %Elixir.Avatarex.Birdy{}.

examples

Examples

iex> Elixir.Avatarex.Birdy.random()
%Elixir.Avatarex.Birdy{}
Link to this function

render(module_struct)

View Source (since 0.1.0)

Generates a Elixir.Avatarex.Birdy with the specified name. Renders an image in the output directory.

Returns VipsImage.

examples

Examples

iex> Elixir.Avatarex.Birdy.render("my_birdy")
%Elixir.Avatarex.Birdy{}
Link to this function

write(module_struct)

View Source (since 0.1.0)

Writes an image for a provided Elixir.Avatarex.Birdy to the output directory.

Returns VipsImage.

examples

Examples

iex> Elixir.Avatarex.Birdy.write("my_birdy")
%Elixir.Avatarex.Birdy{}
Link to this function

write(image, name)

View Source (since 0.1.0)

Writes an image for a provided %Vix.Vips.Image{} with a given name in the output directory.

Returns VipsImage.

examples

Examples

iex> Elixir.Avatarex.Birdy.write(%Vix.Vips.Image{}, "my_birdy")
%Elixir.Avatarex.Birdy{}