image

Documentation

Overview

Package image generates images containing a logo and some text below.

Index

• func Generate(p Params) (image.Image, error)
• type Params

Functions

func Generate

func Generate(p Params) (image.Image, error)

Generate generates a new image given the corresponding parameters.

Types

type Params

type Params struct {
	Logo       string      // Filepath to a logo for the top half of the image.
	Text       string      // Text to display below the logo.
	Font       string      // Filepath to the TrueType font used for the text.
	Foreground color.Color // Color for the text.
	Background color.Color // Color for the background.
	Width      int         // Width of the image in pixels.
	Height     int         // Height of the image in pixels.
}

Params contains the parameters that describe an image. They are all required for image creation.