Back to / text

package text

Latest Go to latest
Published: Jun 14, 2020 | License: Apache-2.0 | Module:


Package text offers functions to draw texts on an Ebiten's image.

For the example using a TTF font, see font package in the examples.


func Draw

func Draw(dst *ebiten.Image, text string, face font.Face, x, y int, clr color.Color)

Draw draws a given text on a given destination image dst.

face is the font for text rendering. (x, y) represents a 'dot' (period) position. Be careful that this doesn't represent left-upper corner position. clr is the color for text rendering.

The '\n' newline character puts the following text on the next line. Line height is based on Metrics().Height of the font.

Glyphs used for rendering are cached in least-recently-used way. It is OK to call Draw with a same text and a same face at every frame in terms of performance.

Be careful that the passed font face is held by this package and is never released. This is a known issue (#498).

Draw is concurrent-safe.

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier