]> git.tdb.fi Git - libs/gl.git/blob - source/font.h
Pull in sized depth component formats from ARB_depth_texture
[libs/gl.git] / source / font.h
1 #ifndef MSP_GL_FONT_H_
2 #define MSP_GL_FONT_H_
3
4 #include <map>
5 #include <string>
6 #include <msp/datafile/objectloader.h>
7 #include <msp/stringcodec/utf8.h>
8 #include "vertexarray.h"
9
10 namespace Msp {
11 namespace GL {
12
13 class PrimitiveBuilder;
14 class Texture2D;
15
16 /**
17 Stores a set of glyphs and creates strings out of them.
18 */
19 class Font
20 {
21 public:
22         class Loader: public DataFile::CollectionObjectLoader<Font>
23         {
24         public:
25                 Loader(Font &);
26                 Loader(Font &, Collection &);
27
28         private:
29                 void init();
30                 void glyph(unsigned);
31                 void kerning(unsigned, unsigned, float);
32                 void texture();
33                 void texture_ref(const std::string &);
34         };
35
36         struct Glyph
37         {
38                 class Loader: public Msp::DataFile::ObjectLoader<Glyph>
39                 {
40                 public:
41                         Loader(Glyph &);
42                 private:
43                         void texcoords(float, float, float, float);
44                 };
45
46                 unsigned code;
47                 float x1, y1;
48                 float x2, y2;
49                 float w, h;
50                 float off_x, off_y;
51                 float advance;
52         };
53
54 private:
55         typedef std::map<unsigned, Glyph> GlyphMap;
56         typedef std::pair<unsigned, unsigned> KerningKey;
57         typedef std::map<KerningKey, float> KerningMap;
58
59         RefPtr<const Texture2D> texture;
60         float native_size;
61         float ascent;
62         float descent;
63         float cap_height;
64         float x_height;
65         GlyphMap glyphs;
66         KerningMap kerning;
67
68 public:
69         Font();
70         ~Font();
71
72         void set_texture(const Texture2D &);
73         const Texture2D &get_texture() const;
74
75         /** Adds a glyph to the font.  There must not be an existing glyph with the
76         same code. */
77         void add_glyph(const Glyph &);
78         void set_kerning(unsigned, unsigned, float);
79
80         /** Returns the size used to generate the font texture.  This serves as a
81         hint for obtaining the best quality when rendering strings. */
82         float get_native_size() const { return native_size; }
83
84         float get_ascent() const { return ascent; }
85         float get_descent() const { return descent; }
86         float get_cap_height() const { return cap_height; }
87         float get_x_height() const { return x_height; }
88
89         /** Returns the width of a string, in multiples of the font size.  Scale the
90         result according to the size used in rendering. */
91         float get_string_width(const std::string &, StringCodec::Decoder &) const;
92
93         template<class C>
94         float get_string_width(const std::string &str) const
95         {
96                 typename C::Decoder dec;
97                 return get_string_width(str, dec);
98         }
99
100         float get_string_width(const std::string &str) const
101         { return get_string_width<StringCodec::Utf8>(str); }
102
103         /** Draws a string to the framebuffer with Immediate.  It is drawn with size
104         1.0; set up matrices for the desired size before the call. */
105         void draw_string(const std::string &, StringCodec::Decoder &, const Color & = Color()) const;
106
107         template<class C>
108         void draw_string(const std::string &str, const Color &color = Color()) const
109         {
110                 typename C::Decoder dec;
111                 draw_string(str, dec, color);
112         }
113
114         void draw_string(const std::string &str, const Color &color = Color()) const
115         { draw_string<StringCodec::Utf8>(str, color); }
116
117         /** Builds the primitives for a string.  Two-dimensional vertex and texture
118         coordinates are generated.  Size 1.0 is used for building; set up the
119         builder's matrix before the call.  The texture is not bound, to avoid
120         unnecessary bindings when creating meshes. */
121         void build_string(const std::string &, StringCodec::Decoder &, PrimitiveBuilder &) const;
122
123         template<class C>
124         void build_string(const std::string &str, PrimitiveBuilder &pb) const
125         {
126                 typename C::Decoder dec;
127                 build_string(str, dec, pb);
128         }
129
130         void build_string(const std::string &str, PrimitiveBuilder &pb) const
131         { return build_string<StringCodec::Utf8>(str, pb); }
132
133 private:
134         void create_glyph_quad(const Glyph &, PrimitiveBuilder &) const;
135         float get_glyph_advance(unsigned, unsigned = 0) const;
136 };
137
138 } // namespace GL
139 } // namespace Msp
140
141 #endif