// Copyright 2017 The Ebiten Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // 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. package text import ( "image" "image/color" "math" "sync" "golang.org/x/image/font" "golang.org/x/image/math/fixed" "github.com/hajimehoshi/ebiten" "github.com/hajimehoshi/ebiten/internal/colormcache" ) var ( monotonicClock int64 ) func now() int64 { monotonicClock++ return monotonicClock } func fixed26_6ToFloat64(x fixed.Int26_6) float64 { return float64(x>>6) + float64(x&((1<<6)-1))/float64(1<<6) } const ( cacheLimit = 512 // This is an arbitrary number. ) func drawGlyph(dst *ebiten.Image, face font.Face, r rune, img *glyphImage, x, y fixed.Int26_6, clr ebiten.ColorM) { if img == nil { return } b := getGlyphBounds(face, r) op := &ebiten.DrawImageOptions{} op.GeoM.Translate(fixed26_6ToFloat64(x+b.Min.X), fixed26_6ToFloat64(y+b.Min.Y)) op.ColorM = clr _ = dst.DrawImage(img.image.SubImage(image.Rect(img.x, img.y, img.x+img.width, img.y+img.height)).(*ebiten.Image), op) } var ( // Use pointers to avoid copying on browsers. glyphBoundsCache = map[font.Face]map[rune]*fixed.Rectangle26_6{} ) func getGlyphBounds(face font.Face, r rune) *fixed.Rectangle26_6 { if _, ok := glyphBoundsCache[face]; !ok { glyphBoundsCache[face] = map[rune]*fixed.Rectangle26_6{} } if b, ok := glyphBoundsCache[face][r]; ok { return b } b, _, _ := face.GlyphBounds(r) glyphBoundsCache[face][r] = &b return &b } type glyphImage struct { image *ebiten.Image x int y int width int height int } type glyphImageCacheEntry struct { image *glyphImage atime int64 } var ( glyphImageCache = map[font.Face]map[rune]*glyphImageCacheEntry{} emptyGlyphs = map[font.Face]map[rune]struct{}{} ) func getGlyphImages(face font.Face, runes []rune) []*glyphImage { if _, ok := emptyGlyphs[face]; !ok { emptyGlyphs[face] = map[rune]struct{}{} } if _, ok := glyphImageCache[face]; !ok { glyphImageCache[face] = map[rune]*glyphImageCacheEntry{} } imgs := make([]*glyphImage, len(runes)) glyphBounds := map[rune]*fixed.Rectangle26_6{} neededGlyphIndices := map[int]rune{} for i, r := range runes { if _, ok := emptyGlyphs[face][r]; ok { continue } if e, ok := glyphImageCache[face][r]; ok { e.atime = now() imgs[i] = e.image continue } b := getGlyphBounds(face, r) w, h := (b.Max.X - b.Min.X).Ceil(), (b.Max.Y - b.Min.Y).Ceil() if w == 0 || h == 0 { emptyGlyphs[face][r] = struct{}{} continue } // TODO: What if len(runes) > cacheLimit? if len(glyphImageCache[face]) > cacheLimit { oldest := int64(math.MaxInt64) oldestKey := rune(-1) for r, e := range glyphImageCache[face] { if e.atime < oldest { oldestKey = r oldest = e.atime } } delete(glyphImageCache[face], oldestKey) } glyphBounds[r] = b neededGlyphIndices[i] = r } if len(neededGlyphIndices) > 0 { // TODO: What if w2 is too big (e.g. > 4096)? w2 := 0 h2 := 0 for _, b := range glyphBounds { w, h := (b.Max.X - b.Min.X).Ceil(), (b.Max.Y - b.Min.Y).Ceil() w2 += w if h2 < h { h2 = h } } rgba := image.NewRGBA(image.Rect(0, 0, w2, h2)) x := 0 xs := map[rune]int{} for r, b := range glyphBounds { w := (b.Max.X - b.Min.X).Ceil() d := font.Drawer{ Dst: rgba, Src: image.White, Face: face, } d.Dot = fixed.Point26_6{X: fixed.I(x) - b.Min.X, Y: -b.Min.Y} d.DrawString(string(r)) xs[r] = x x += w } img, _ := ebiten.NewImageFromImage(rgba, ebiten.FilterDefault) for i, r := range neededGlyphIndices { b := glyphBounds[r] w, h := (b.Max.X - b.Min.X).Ceil(), (b.Max.Y - b.Min.Y).Ceil() g := &glyphImage{ image: img, x: xs[r], y: 0, width: w, height: h, } if _, ok := glyphImageCache[face][r]; !ok { glyphImageCache[face][r] = &glyphImageCacheEntry{ image: g, atime: now(), } } imgs[i] = g } } return imgs } var textM sync.Mutex // 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. func Draw(dst *ebiten.Image, text string, face font.Face, x, y int, clr color.Color) { textM.Lock() defer textM.Unlock() fx, fy := fixed.I(x), fixed.I(y) prevR := rune(-1) faceHeight := face.Metrics().Height runes := []rune(text) glyphImgs := getGlyphImages(face, runes) colorm := colormcache.ColorToColorM(clr) for i, r := range runes { if prevR >= 0 { fx += face.Kern(prevR, r) } if r == '\n' { fx = fixed.I(x) fy += faceHeight prevR = rune(-1) continue } drawGlyph(dst, face, r, glyphImgs[i], fx, fy, colorm) fx += glyphAdvance(face, r) prevR = r } } // MeasureString returns the measured size of a given string using a given font. // This method will return the exact size in pixels that a string drawn by Draw will be. // text can include multiple lines. // // text is the string that's being measured. // face is the font for text rendering. // // Be careful that the passed font face is held by this package and is never released. // This is a known issue (#498). // // MeasureString is concurrent-safe. func MeasureString(text string, face font.Face) image.Point { textM.Lock() defer textM.Unlock() var w, h fixed.Int26_6 m := face.Metrics() faceHeight := m.Height faceDescent := m.Descent fx, fy := fixed.I(0), fixed.I(0) prevR := rune(-1) runes := []rune(text) for _, r := range runes { if prevR >= 0 { fx += face.Kern(prevR, r) } if r == '\n' { fx = fixed.I(0) fy += faceHeight prevR = rune(-1) continue } fx += glyphAdvance(face, r) if fx > w { w = fx } if (fy + faceHeight) > h { h = fy + faceHeight } prevR = r } bounds := image.Point{ X: int(math.Ceil(fixed26_6ToFloat64(w))), Y: int(math.Ceil(fixed26_6ToFloat64(h + faceDescent))), } return bounds }