render

package

v0.0.0-...-42d8158 Latest Latest Go to latest Published: Nov 24, 2020 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Text(text string, opts ...Option) (image.Image, error)

Text renders text as large as possible, without exceeding the maximum size.

type FontFunc func(size float64) (font.Face, error)

FontFunc returns a new font face of the given point size.

type ImageFunc func(image.Rectangle) draw.Image

type Option option

func WithFont(fn FontFunc) Option

WithFont sets the font used.

By default, the Go Regular font is used.

func WithFontOpenType(f *opentype.Font, opts *opentype.FaceOptions) Option

WithFontOpenType is a convenience helper for WithFont that uses an OpenType font.

Unlike opentype.NewFace, a FaceOptions value must be provided. FaceOptions.Size is overwritten by this function.

func WithImageFunc(fn ImageFunc) Option

WithImageFunc sets the function used to create an image of the desired size.

By default, image.NewGray is used.

func WithMaxHeight(h int) Option

WithMaxHeight sets maximum height for rendered text, in pixels.

This option is mandatory.