Line data Source code
1 : package uicore
2 :
3 : import (
4 : "math"
5 : "sync"
6 :
7 : text "github.com/hajimehoshi/ebiten/v2/text/v2"
8 : )
9 :
10 : // textMu は ebiten text/v2 の測定・描画と、測定結果キャッシュへのアクセスを直列化する。
11 : // GoTextFaceSource の遅延グリフキャッシュ runeToBoolMap はスレッド安全でなく、共有フェイスへ
12 : // 同時に測定・描画するとキャッシュが壊れる。本番の描画は単一ゴルーチンなのでロックは常に無競合で、
13 : // 並列テストのときだけ直列化が効く。ebiten text へ触れるのは MeasureText と
14 : // EbitenCanvas.DrawText の2箇所なので、この mutex で全経路を覆う。
15 : var textMu sync.Mutex
16 :
17 : // measureCache は (文字列, フェイス) ごとの測定結果を覚える。Text.Draw が位置決めのため毎フレーム
18 : // MeasureText を呼ぶが、結果は決定的なので一度測れば使い回せる。フェイスは起動時に生成した
19 : // *GoTextFace か *MultiFace のポインタ実体で、比較可能かつ不変なのでキーに使える。
20 : //
21 : // 動的文字列でキーが際限なく増えないよう上限で丸ごと捨てる。捨てても再測定で正しく埋め直すので、
22 : // キャッシュミスが増えるだけで結果は変わらない。
23 : var measureCache = map[measureKey][2]int{}
24 :
25 : type measureKey struct {
26 : s string
27 : face text.Face
28 : }
29 :
30 : const measureCacheMax = 4096
31 :
32 : // MeasureText は face で描いたときの s の送り幅と高さを画素で返す。
33 : //
34 : // フォントの送り幅はほぼ整数だが、わずかに端数を持つ。切り捨てると境界をまたぐたびに
35 : // 1px 揺れ、列の幅や中央寄せの位置がずれる。四捨五入で境界から遠ざけ、丸め方を
36 : // この1箇所に固定する。寸法を内容から決めたい箇所はすべてここを通す。
37 : //
38 : // フェイスが nil なら測れないので 0 を返す。呼び出し側は左上寄せへ倒すなどの
39 : // 退避をとる。
40 : func MeasureText(s string, face text.Face) (int, int) {
41 1 : if face == nil {
42 1 : return 0, 0
43 1 : }
44 1 : key := measureKey{s: s, face: face}
45 1 : textMu.Lock()
46 1 : defer textMu.Unlock()
47 1 : if wh, ok := measureCache[key]; ok {
48 1 : return wh[0], wh[1]
49 1 : }
50 1 : w, h := text.Measure(s, face, 0)
51 1 : wh := [2]int{int(math.Round(w)), int(math.Round(h))}
52 1 : if len(measureCache) >= measureCacheMax {
53 0 : clear(measureCache)
54 0 : }
55 1 : measureCache[key] = wh
56 1 : return wh[0], wh[1]
57 : }
58 :
59 : // MeasureTextWidth は MeasureText の幅だけを返す。列幅や送り幅の算出に使う。
60 : func MeasureTextWidth(s string, face text.Face) int {
61 1 : w, _ := MeasureText(s, face)
62 1 : return w
63 1 : }
64 :
65 : // FitWidth は中身に合わせた箱の幅を返す。最も広い中身に extra を足し、lower を下回らせない。
66 : //
67 : // extra は中身の外側に足す幅で、左右のパディングなら2つぶん、列と列の間隔ならその1つぶんを渡す。
68 : // lower は箱として痩せすぎる下限で、不要なら 0 を渡す。中身がひとつも無ければ lower になる。
69 : //
70 : // 内容ぴったりの幅を決める計算はこれ1つにする。表の列・選択肢の塊・ボタン・バッジ・
71 : // キーキャップと、同じ規則を要る箇所が散らばっており、別々に書くと下限や余白の扱いがずれる。
72 : func FitWidth(contents []int, extra, lower int) int {
73 1 : widest := 0
74 1 : for _, c := range contents {
75 1 : widest = max(widest, c)
76 1 : }
77 1 : return max(widest+extra, lower)
78 : }
79 :
80 : // LineHeight は face の自然な行送りを画素で返す。アセンダとディセンダを含む字面の
81 : // 高さから取るので、固定値のように字面に対して間延びしない。
82 : func LineHeight(face text.Face) int {
83 : // アセンダとディセンダを両方持つ字を測り、フェイスの縦の広がりを代表させる
84 1 : _, h := MeasureText("Ag", face)
85 1 : return h
86 1 : }
|