avatars

README

go-avatars

Go library for avatar generation.

Based on @dicebear

Supports SVG and PNG output.

Sample generated by main.go

Documentation

Index

• type Avatar
  • func Generate(name string, opts ...Option) (*Avatar, error)
  • func (a *Avatar) Image(opts ...RenderOption) (image.Image, error)
  • func (a *Avatar) Name() string
  • func (a *Avatar) PNG(opts ...RenderOption) ([]byte, error)
  • func (a *Avatar) SVG() []byte
• type Option
• type Options
• type RenderOption
• type RenderOptions
• type RenderPadding
• type RenderSize

Types

type Avatar

type Avatar struct {
	// contains filtered or unexported fields
}

Avatar that was generated using specified seed.

func Generate

func Generate(name string, opts ...Option) (*Avatar, error)

Generate an avatar using the given name as seed.

func (*Avatar) Image

func (a *Avatar) Image(opts ...RenderOption) (image.Image, error)

Image rendered from the SVG.

func (*Avatar) Name

func (a *Avatar) Name() string

Name of the avatar.

func (*Avatar) PNG

func (a *Avatar) PNG(opts ...RenderOption) ([]byte, error)

PNG encoded image.

func (*Avatar) SVG

func (a *Avatar) SVG() []byte

SVG content of the avatar.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is a function that applies an option to the avatar service.

type Options

type Options struct{}

Options for the avatar service.

type RenderOption

type RenderOption interface {
	// contains filtered or unexported methods
}

Render is a function that applies a render option to the avatar service.

type RenderOptions

type RenderOptions struct {
	// Size of the rendered avatar.
	Size int
	// Padding between the rendered avatar and the border.
	Padding int
}

RenderOptions is a set of options for rendering an avatar.

type RenderPadding

type RenderPadding int

RenderPadding sets the padding between the rendered avatar and the border.

type RenderSize

type RenderSize int

RenderSize sets the size of the rendered avatar in pixels.