-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
SpriteFont.cs
404 lines (349 loc) · 13.6 KB
/
SpriteFont.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
// MonoGame - Copyright (C) The MonoGame Team
// This file is subject to the terms and conditions defined in
// file 'LICENSE.txt', which is part of this source code package.
// Original code from SilverSprite Project
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Text;
namespace Microsoft.Xna.Framework.Graphics
{
public sealed class SpriteFont
{
internal static class Errors
{
public const string TextContainsUnresolvableCharacters =
"Text contains characters that cannot be resolved by this SpriteFont.";
public const string UnresolvableCharacter =
"Character cannot be resolved by this SpriteFont.";
}
private readonly Glyph[] _glyphs;
private readonly CharacterRegion[] _regions;
private char? _defaultCharacter;
private int _defaultGlyphIndex = -1;
private readonly Texture2D _texture;
/// <summary>
/// All the glyphs in this SpriteFont.
/// </summary>
public Glyph[] Glyphs { get { return _glyphs; } }
class CharComparer: IEqualityComparer<char>
{
public bool Equals(char x, char y)
{
return x == y;
}
public int GetHashCode(char b)
{
return (b);
}
static public readonly CharComparer Default = new CharComparer();
}
/// <summary>
/// Initializes a new instance of the <see cref="SpriteFont" /> class.
/// </summary>
/// <param name="texture">The font texture.</param>
/// <param name="glyphBounds">The rectangles in the font texture containing letters.</param>
/// <param name="cropping">The cropping rectangles, which are applied to the corresponding glyphBounds to calculate the bounds of the actual character.</param>
/// <param name="characters">The characters.</param>
/// <param name="lineSpacing">The line spacing (the distance from baseline to baseline) of the font.</param>
/// <param name="spacing">The spacing (tracking) between characters in the font.</param>
/// <param name="kerning">The letters kernings(X - left side bearing, Y - width and Z - right side bearing).</param>
/// <param name="defaultCharacter">The character that will be substituted when a given character is not included in the font.</param>
public SpriteFont (
Texture2D texture, List<Rectangle> glyphBounds, List<Rectangle> cropping, List<char> characters,
int lineSpacing, float spacing, List<Vector3> kerning, char? defaultCharacter)
{
Characters = new ReadOnlyCollection<char>(characters.ToArray());
_texture = texture;
LineSpacing = lineSpacing;
Spacing = spacing;
_glyphs = new Glyph[characters.Count];
var regions = new Stack<CharacterRegion>();
for (var i = 0; i < characters.Count; i++)
{
_glyphs[i] = new Glyph
{
BoundsInTexture = glyphBounds[i],
Cropping = cropping[i],
Character = characters[i],
LeftSideBearing = kerning[i].X,
Width = kerning[i].Y,
RightSideBearing = kerning[i].Z,
WidthIncludingBearings = kerning[i].X + kerning[i].Y + kerning[i].Z
};
if(regions.Count == 0 || characters[i] > (regions.Peek().End+1))
{
// Start a new region
regions.Push(new CharacterRegion(characters[i], i));
}
else if(characters[i] == (regions.Peek().End+1))
{
var currentRegion = regions.Pop();
// include character in currentRegion
currentRegion.End++;
regions.Push(currentRegion);
}
else // characters[i] < (regions.Peek().End+1)
{
throw new InvalidOperationException("Invalid SpriteFont. Character map must be in ascending order.");
}
}
_regions = regions.ToArray();
Array.Reverse(_regions);
DefaultCharacter = defaultCharacter;
}
/// <summary>
/// Gets the texture that this SpriteFont draws from.
/// </summary>
/// <remarks>Can be used to implement custom rendering of a SpriteFont</remarks>
public Texture2D Texture { get { return _texture; } }
/// <summary>
/// Returns a copy of the dictionary containing the glyphs in this SpriteFont.
/// </summary>
/// <returns>A new Dictionary containing all of the glyphs inthis SpriteFont</returns>
/// <remarks>Can be used to calculate character bounds when implementing custom SpriteFont rendering.</remarks>
public Dictionary<char, Glyph> GetGlyphs()
{
var glyphsDictionary = new Dictionary<char, Glyph>(_glyphs.Length, CharComparer.Default);
foreach(var glyph in _glyphs)
glyphsDictionary.Add(glyph.Character, glyph);
return glyphsDictionary;
}
/// <summary>
/// Gets a collection of the characters in the font.
/// </summary>
public ReadOnlyCollection<char> Characters { get; private set; }
/// <summary>
/// Gets or sets the character that will be substituted when a
/// given character is not included in the font.
/// </summary>
public char? DefaultCharacter
{
get { return _defaultCharacter; }
set
{
// Get the default glyph index here once.
if (value.HasValue)
{
if(!TryGetGlyphIndex(value.Value, out _defaultGlyphIndex))
throw new ArgumentException(Errors.UnresolvableCharacter);
}
else
_defaultGlyphIndex = -1;
_defaultCharacter = value;
}
}
/// <summary>
/// Gets or sets the line spacing (the distance from baseline
/// to baseline) of the font.
/// </summary>
public int LineSpacing { get; set; }
/// <summary>
/// Gets or sets the spacing (tracking) between characters in
/// the font.
/// </summary>
public float Spacing { get; set; }
/// <summary>
/// Returns the size of a string when rendered in this font.
/// </summary>
/// <param name="text">The text to measure.</param>
/// <returns>The size, in pixels, of 'text' when rendered in
/// this font.</returns>
public Vector2 MeasureString(string text)
{
var source = new CharacterSource(text);
Vector2 size;
MeasureString(ref source, out size);
return size;
}
/// <summary>
/// Returns the size of the contents of a StringBuilder when
/// rendered in this font.
/// </summary>
/// <param name="text">The text to measure.</param>
/// <returns>The size, in pixels, of 'text' when rendered in
/// this font.</returns>
public Vector2 MeasureString(StringBuilder text)
{
var source = new CharacterSource(text);
Vector2 size;
MeasureString(ref source, out size);
return size;
}
internal unsafe void MeasureString(ref CharacterSource text, out Vector2 size)
{
if (text.Length == 0)
{
size = Vector2.Zero;
return;
}
var width = 0.0f;
var finalLineHeight = (float)LineSpacing;
var offset = Vector2.Zero;
var firstGlyphOfLine = true;
fixed (Glyph* pGlyphs = Glyphs)
for (var i = 0; i < text.Length; ++i)
{
var c = text[i];
if (c == '\r')
continue;
if (c == '\n')
{
finalLineHeight = LineSpacing;
offset.X = 0;
offset.Y += LineSpacing;
firstGlyphOfLine = true;
continue;
}
var currentGlyphIndex = GetGlyphIndexOrDefault(c);
Debug.Assert(currentGlyphIndex >= 0 && currentGlyphIndex < Glyphs.Length, "currentGlyphIndex was outside the bounds of the array.");
var pCurrentGlyph = pGlyphs + currentGlyphIndex;
// The first character on a line might have a negative left side bearing.
// In this scenario, SpriteBatch/SpriteFont normally offset the text to the right,
// so that text does not hang off the left side of its rectangle.
if (firstGlyphOfLine) {
offset.X = Math.Max(pCurrentGlyph->LeftSideBearing, 0);
firstGlyphOfLine = false;
} else {
offset.X += Spacing + pCurrentGlyph->LeftSideBearing;
}
offset.X += pCurrentGlyph->Width;
var proposedWidth = offset.X + Math.Max(pCurrentGlyph->RightSideBearing, 0);
if (proposedWidth > width)
width = proposedWidth;
offset.X += pCurrentGlyph->RightSideBearing;
if (pCurrentGlyph->Cropping.Height > finalLineHeight)
finalLineHeight = pCurrentGlyph->Cropping.Height;
}
size.X = width;
size.Y = offset.Y + finalLineHeight;
}
internal unsafe bool TryGetGlyphIndex(char c, out int index)
{
fixed (CharacterRegion* pRegions = _regions)
{
// Get region Index
int regionIdx = -1;
var l = 0;
var r = _regions.Length - 1;
while (l <= r)
{
var m = (l + r) >> 1;
Debug.Assert(m >= 0 && m < _regions.Length, "Index was outside the bounds of the array.");
if (pRegions[m].End < c)
{
l = m + 1;
}
else if (pRegions[m].Start > c)
{
r = m - 1;
}
else
{
regionIdx = m;
break;
}
}
if (regionIdx == -1)
{
index = -1;
return false;
}
index = pRegions[regionIdx].StartIndex + (c - pRegions[regionIdx].Start);
}
return true;
}
internal int GetGlyphIndexOrDefault(char c)
{
int glyphIdx;
if (!TryGetGlyphIndex(c, out glyphIdx))
{
if (_defaultGlyphIndex == -1)
throw new ArgumentException(Errors.TextContainsUnresolvableCharacters, "text");
return _defaultGlyphIndex;
}
else
return glyphIdx;
}
internal struct CharacterSource
{
private readonly string _string;
private readonly StringBuilder _builder;
public CharacterSource(string s)
{
_string = s;
_builder = null;
Length = s.Length;
}
public CharacterSource(StringBuilder builder)
{
_builder = builder;
_string = null;
Length = _builder.Length;
}
public readonly int Length;
public char this [int index]
{
get
{
if (_string != null)
return _string[index];
return _builder[index];
}
}
}
/// <summary>
/// Struct that defines the spacing, Kerning, and bounds of a character.
/// </summary>
/// <remarks>Provides the data necessary to implement custom SpriteFont rendering.</remarks>
public struct Glyph
{
/// <summary>
/// The char associated with this glyph.
/// </summary>
public char Character;
/// <summary>
/// Rectangle in the font texture where this letter exists.
/// </summary>
public Rectangle BoundsInTexture;
/// <summary>
/// Cropping applied to the BoundsInTexture to calculate the bounds of the actual character.
/// </summary>
public Rectangle Cropping;
/// <summary>
/// The amount of space between the left side ofthe character and its first pixel in the X dimention.
/// </summary>
public float LeftSideBearing;
/// <summary>
/// The amount of space between the right side of the character and its last pixel in the X dimention.
/// </summary>
public float RightSideBearing;
/// <summary>
/// Width of the character before kerning is applied.
/// </summary>
public float Width;
/// <summary>
/// Width of the character before kerning is applied.
/// </summary>
public float WidthIncludingBearings;
public static readonly Glyph Empty = new Glyph();
public override string ToString ()
{
return "CharacterIndex=" + Character + ", Glyph=" + BoundsInTexture + ", Cropping=" + Cropping + ", Kerning=" + LeftSideBearing + "," + Width + "," + RightSideBearing;
}
}
private struct CharacterRegion
{
public char Start;
public char End;
public int StartIndex;
public CharacterRegion(char start, int startIndex)
{
this.Start = start;
this.End = start;
this.StartIndex = startIndex;
}
}
}
}