mirror of
https://github.com/hajimehoshi/ebiten.git
synced 2024-11-15 07:27:32 +01:00
402 lines
11 KiB
Go
402 lines
11 KiB
Go
// Copyright 2023 The Ebitengine 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
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/binary"
|
|
"fmt"
|
|
|
|
"github.com/go-text/typesetting/di"
|
|
"github.com/go-text/typesetting/font"
|
|
glanguage "github.com/go-text/typesetting/language"
|
|
"github.com/go-text/typesetting/shaping"
|
|
"golang.org/x/image/math/fixed"
|
|
"golang.org/x/text/language"
|
|
|
|
"github.com/hajimehoshi/ebiten/v2"
|
|
"github.com/hajimehoshi/ebiten/v2/vector"
|
|
)
|
|
|
|
var _ Face = (*GoTextFace)(nil)
|
|
|
|
// GoTextFace is a Face implementation for go-text's font.Face (github.com/go-text/typesetting).
|
|
// With a GoTextFace, shaping.HarfBuzzShaper is always used as a shaper internally.
|
|
// GoTextFace includes the source and various options.
|
|
//
|
|
// Unlike GoXFace, one GoTextFace instance doesn't have its own glyph image cache.
|
|
// Instead, a GoTextFaceSource has a glyph image cache.
|
|
// You can casually create multiple GoTextFace instances from the same GoTextFaceSource.
|
|
type GoTextFace struct {
|
|
// Source is the font face source.
|
|
Source *GoTextFaceSource
|
|
|
|
// Direction is the rendering direction.
|
|
// The default (zero) value is left-to-right horizontal.
|
|
Direction Direction
|
|
|
|
// Size is the font size in pixels.
|
|
Size float64
|
|
|
|
// Language is a hint for a language (BCP 47).
|
|
Language language.Tag
|
|
|
|
// Script is a hint for a script code hint of (ISO 15924).
|
|
// If this is empty, the script is guessed from the specified language.
|
|
Script language.Script
|
|
|
|
variations []font.Variation
|
|
features []shaping.FontFeature
|
|
|
|
variationsString string
|
|
featuresString string
|
|
}
|
|
|
|
// SetVariation sets a variation value.
|
|
// For font variations, see https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_fonts/Variable_fonts_guide for more details.
|
|
func (g *GoTextFace) SetVariation(tag Tag, value float32) {
|
|
idx := len(g.variations)
|
|
for i, v := range g.variations {
|
|
if uint32(v.Tag) < uint32(tag) {
|
|
continue
|
|
}
|
|
if uint32(v.Tag) > uint32(tag) {
|
|
idx = i
|
|
break
|
|
}
|
|
if v.Value == value {
|
|
return
|
|
}
|
|
g.variations[i].Value = value
|
|
g.variationsString = ""
|
|
return
|
|
}
|
|
|
|
// Keep the alphabetical order in order to make the cache key deterministic.
|
|
g.variations = append(g.variations, font.Variation{})
|
|
copy(g.variations[idx+1:], g.variations[idx:])
|
|
g.variations[idx] = font.Variation{
|
|
Tag: font.Tag(tag),
|
|
Value: value,
|
|
}
|
|
g.variationsString = ""
|
|
}
|
|
|
|
// RemoveVariation removes a variation value.
|
|
func (g *GoTextFace) RemoveVariation(tag Tag) {
|
|
for i, v := range g.variations {
|
|
if uint32(v.Tag) < uint32(tag) {
|
|
continue
|
|
}
|
|
if uint32(v.Tag) > uint32(tag) {
|
|
return
|
|
}
|
|
|
|
copy(g.variations[i:], g.variations[i+1:])
|
|
g.variations = g.variations[:len(g.variations)-1]
|
|
g.variationsString = ""
|
|
return
|
|
}
|
|
}
|
|
|
|
// SetFeature sets a feature value.
|
|
// For font features, see https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_fonts/OpenType_fonts_guide for more details.
|
|
func (g *GoTextFace) SetFeature(tag Tag, value uint32) {
|
|
idx := len(g.features)
|
|
for i, f := range g.features {
|
|
if uint32(f.Tag) < uint32(tag) {
|
|
continue
|
|
}
|
|
if uint32(f.Tag) > uint32(tag) {
|
|
idx = i
|
|
break
|
|
}
|
|
if f.Value == value {
|
|
return
|
|
}
|
|
g.features[i].Value = value
|
|
g.featuresString = ""
|
|
return
|
|
}
|
|
|
|
// Keep the alphabetical order in order to make the cache key deterministic.
|
|
g.features = append(g.features, shaping.FontFeature{})
|
|
copy(g.features[idx+1:], g.features[idx:])
|
|
g.features[idx] = shaping.FontFeature{
|
|
Tag: font.Tag(tag),
|
|
Value: value,
|
|
}
|
|
g.featuresString = ""
|
|
}
|
|
|
|
// RemoveFeature removes a feature value.
|
|
func (g *GoTextFace) RemoveFeature(tag Tag) {
|
|
for i, v := range g.features {
|
|
if uint32(v.Tag) < uint32(tag) {
|
|
continue
|
|
}
|
|
if uint32(v.Tag) > uint32(tag) {
|
|
return
|
|
}
|
|
|
|
copy(g.features[i:], g.features[i+1:])
|
|
g.features = g.features[:len(g.features)-1]
|
|
g.featuresString = ""
|
|
return
|
|
}
|
|
}
|
|
|
|
// Tag is a tag for font variations and features.
|
|
// Tag is a 4-byte value like 'cmap'.
|
|
type Tag uint32
|
|
|
|
// String returns the Tag's string representation.
|
|
func (t Tag) String() string {
|
|
return string([]byte{byte(t >> 24), byte(t >> 16), byte(t >> 8), byte(t)})
|
|
}
|
|
|
|
// ParseTag converts a string to Tag.
|
|
func ParseTag(str string) (Tag, error) {
|
|
if len(str) != 4 {
|
|
return 0, fmt.Errorf("text: a string's length must be 4 but was %d at ParseTag", len(str))
|
|
}
|
|
return Tag((uint32(str[0]) << 24) | (uint32(str[1]) << 16) | (uint32(str[2]) << 8) | uint32(str[3])), nil
|
|
}
|
|
|
|
// MustParseTag converts a string to Tag.
|
|
// If parsing fails, MustParseTag panics.
|
|
func MustParseTag(str string) Tag {
|
|
t, err := ParseTag(str)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return t
|
|
}
|
|
|
|
// Metrics implements Face.
|
|
func (g *GoTextFace) Metrics() Metrics {
|
|
scale := g.Source.scale(g.Size)
|
|
|
|
var m Metrics
|
|
if h, ok := g.Source.f.FontHExtents(); ok {
|
|
m.HLineGap = float64(h.LineGap) * scale
|
|
m.HAscent = float64(h.Ascender) * scale
|
|
m.HDescent = float64(-h.Descender) * scale
|
|
}
|
|
if v, ok := g.Source.f.FontVExtents(); ok {
|
|
m.VLineGap = float64(v.LineGap) * scale
|
|
m.VAscent = float64(v.Ascender) * scale
|
|
m.VDescent = float64(-v.Descender) * scale
|
|
}
|
|
|
|
m.XHeight = float64(g.Source.f.LineMetric(font.XHeight)) * scale
|
|
m.CapHeight = float64(g.Source.f.LineMetric(font.CapHeight)) * scale
|
|
|
|
// XHeight and CapHeight might not be correct for some old fonts (go-text/typesetting#169).
|
|
if m.XHeight <= 0 {
|
|
if _, gs := g.Source.shape("x", g); len(gs) > 0 {
|
|
m.XHeight = fixed26_6ToFloat64(-gs[0].bounds.Min.Y)
|
|
}
|
|
}
|
|
if m.CapHeight <= 0 {
|
|
if _, gs := g.Source.shape("H", g); len(gs) > 0 {
|
|
m.CapHeight = fixed26_6ToFloat64(-gs[0].bounds.Min.Y)
|
|
}
|
|
}
|
|
|
|
return m
|
|
}
|
|
|
|
func (g *GoTextFace) ensureVariationsString() string {
|
|
if g.variationsString != "" {
|
|
return g.variationsString
|
|
}
|
|
if len(g.variations) == 0 {
|
|
return ""
|
|
}
|
|
var buf bytes.Buffer
|
|
for _, t := range g.variations {
|
|
_ = binary.Write(&buf, binary.LittleEndian, t.Tag)
|
|
_ = binary.Write(&buf, binary.LittleEndian, t.Value)
|
|
}
|
|
g.variationsString = buf.String()
|
|
return g.variationsString
|
|
}
|
|
|
|
func (g *GoTextFace) ensureFeaturesString() string {
|
|
if g.featuresString != "" {
|
|
return g.featuresString
|
|
}
|
|
if len(g.features) == 0 {
|
|
return ""
|
|
}
|
|
var buf bytes.Buffer
|
|
for _, t := range g.features {
|
|
_ = binary.Write(&buf, binary.LittleEndian, t.Tag)
|
|
_ = binary.Write(&buf, binary.LittleEndian, t.Value)
|
|
}
|
|
g.featuresString = buf.String()
|
|
return g.featuresString
|
|
}
|
|
|
|
func (g *GoTextFace) outputCacheKey(text string) goTextOutputCacheKey {
|
|
return goTextOutputCacheKey{
|
|
text: text,
|
|
direction: g.Direction,
|
|
size: g.Size,
|
|
language: g.Language.String(),
|
|
script: g.Script.String(),
|
|
variations: g.ensureVariationsString(),
|
|
features: g.ensureFeaturesString(),
|
|
}
|
|
}
|
|
|
|
func (g *GoTextFace) diDirection() di.Direction {
|
|
switch g.Direction {
|
|
case DirectionLeftToRight:
|
|
return di.DirectionLTR
|
|
case DirectionRightToLeft:
|
|
return di.DirectionRTL
|
|
default:
|
|
return di.DirectionTTB
|
|
}
|
|
}
|
|
|
|
func (g *GoTextFace) gScript() glanguage.Script {
|
|
var str string
|
|
if g.Script != (language.Script{}) {
|
|
str = g.Script.String()
|
|
} else {
|
|
s, _ := g.Language.Script()
|
|
str = s.String()
|
|
}
|
|
s, err := glanguage.ParseScript(str)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return s
|
|
}
|
|
|
|
// advance implements Face.
|
|
func (g *GoTextFace) advance(text string) float64 {
|
|
outputs, _ := g.Source.shape(text, g)
|
|
|
|
var a fixed.Int26_6
|
|
for _, output := range outputs {
|
|
a += output.Advance
|
|
}
|
|
|
|
if g.direction().isHorizontal() {
|
|
return fixed26_6ToFloat64(a)
|
|
}
|
|
return -fixed26_6ToFloat64(a)
|
|
}
|
|
|
|
// hasGlyph implements Face.
|
|
func (g *GoTextFace) hasGlyph(r rune) bool {
|
|
_, ok := g.Source.f.Cmap.Lookup(r)
|
|
return ok
|
|
}
|
|
|
|
// appendGlyphsForLine implements Face.
|
|
func (g *GoTextFace) appendGlyphsForLine(glyphs []Glyph, line string, indexOffset int, originX, originY float64) []Glyph {
|
|
origin := fixed.Point26_6{
|
|
X: float64ToFixed26_6(originX),
|
|
Y: float64ToFixed26_6(originY),
|
|
}
|
|
_, gs := g.Source.shape(line, g)
|
|
for _, glyph := range gs {
|
|
o := origin.Add(fixed.Point26_6{
|
|
X: glyph.shapingGlyph.XOffset,
|
|
Y: -glyph.shapingGlyph.YOffset,
|
|
})
|
|
img, imgX, imgY := g.glyphImage(glyph, o)
|
|
// Append a glyph even if img is nil.
|
|
// This is necessary to return index information for control characters.
|
|
glyphs = append(glyphs, Glyph{
|
|
StartIndexInBytes: indexOffset + glyph.startIndex,
|
|
EndIndexInBytes: indexOffset + glyph.endIndex,
|
|
GID: uint32(glyph.shapingGlyph.GlyphID),
|
|
Image: img,
|
|
X: float64(imgX),
|
|
Y: float64(imgY),
|
|
OriginX: fixed26_6ToFloat64(origin.X),
|
|
OriginY: fixed26_6ToFloat64(origin.Y),
|
|
OriginOffsetX: fixed26_6ToFloat64(glyph.shapingGlyph.XOffset),
|
|
OriginOffsetY: fixed26_6ToFloat64(-glyph.shapingGlyph.YOffset),
|
|
})
|
|
origin = origin.Add(fixed.Point26_6{
|
|
X: glyph.shapingGlyph.XAdvance,
|
|
Y: -glyph.shapingGlyph.YAdvance,
|
|
})
|
|
}
|
|
|
|
return glyphs
|
|
}
|
|
|
|
func (g *GoTextFace) glyphImage(glyph glyph, origin fixed.Point26_6) (*ebiten.Image, int, int) {
|
|
if g.direction().isHorizontal() {
|
|
origin.X = adjustGranularity(origin.X, g)
|
|
origin.Y &^= ((1 << 6) - 1)
|
|
} else {
|
|
origin.X &^= ((1 << 6) - 1)
|
|
origin.Y = adjustGranularity(origin.Y, g)
|
|
}
|
|
|
|
b := glyph.bounds
|
|
subpixelOffset := fixed.Point26_6{
|
|
X: (origin.X + b.Min.X) & ((1 << 6) - 1),
|
|
Y: (origin.Y + b.Min.Y) & ((1 << 6) - 1),
|
|
}
|
|
key := goTextGlyphImageCacheKey{
|
|
gid: glyph.shapingGlyph.GlyphID,
|
|
xoffset: subpixelOffset.X,
|
|
yoffset: subpixelOffset.Y,
|
|
variations: g.ensureVariationsString(),
|
|
}
|
|
img := g.Source.getOrCreateGlyphImage(g, key, func() *ebiten.Image {
|
|
return segmentsToImage(glyph.scaledSegments, subpixelOffset, b)
|
|
})
|
|
|
|
imgX := (origin.X + b.Min.X).Floor()
|
|
imgY := (origin.Y + b.Min.Y).Floor()
|
|
return img, imgX, imgY
|
|
}
|
|
|
|
// appendVectorPathForLine implements Face.
|
|
func (g *GoTextFace) appendVectorPathForLine(path *vector.Path, line string, originX, originY float64) {
|
|
origin := fixed.Point26_6{
|
|
X: float64ToFixed26_6(originX),
|
|
Y: float64ToFixed26_6(originY),
|
|
}
|
|
_, gs := g.Source.shape(line, g)
|
|
for _, glyph := range gs {
|
|
appendVectorPathFromSegments(path, glyph.scaledSegments, fixed26_6ToFloat32(origin.X), fixed26_6ToFloat32(origin.Y))
|
|
origin = origin.Add(fixed.Point26_6{
|
|
X: glyph.shapingGlyph.XAdvance,
|
|
Y: -glyph.shapingGlyph.YAdvance,
|
|
})
|
|
}
|
|
}
|
|
|
|
// direction implements Face.
|
|
func (g *GoTextFace) direction() Direction {
|
|
return g.Direction
|
|
}
|
|
|
|
// private implements Face.
|
|
func (g *GoTextFace) private() {
|
|
}
|