libdrawtext
view src/drawtext.h @ 30:828e29b08493
added the nofreetype example to the examples makefile
| author | John Tsiombikas <nuclear@member.fsf.org> |
|---|---|
| date | Tue, 15 Apr 2014 05:52:01 +0300 |
| parents | df6d52b36bd6 |
| children |
line source
1 /*
2 libdrawtext - a simple library for fast text rendering in OpenGL
3 Copyright (C) 2011-2014 John Tsiombikas <nuclear@member.fsf.org>
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18 #ifndef LIBDRAWTEXT_H_
19 #define LIBDRAWTEXT_H_
21 #include <stdio.h>
22 #include <stdlib.h>
24 struct dtx_font;
25 struct dtx_glyphmap;
27 /* draw buffering modes */
28 enum {
29 DTX_NBF, /* unbuffered */
30 DTX_LBF, /* line buffered */
31 DTX_FBF /* fully buffered */
32 };
34 struct dtx_box {
35 float x, y;
36 float width, height;
37 };
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
43 /* Open a truetype/opentype/whatever font.
44 *
45 * If sz is non-zero, the default ASCII glyphmap at the requested point size is
46 * automatically created as well, and ready to use.
47 *
48 * To use other unicode ranges and different font sizes you must first call
49 * dtx_prepare or dtx_prepare_range before issuing any drawing calls, otherwise
50 * nothing will be rendered.
51 */
52 struct dtx_font *dtx_open_font(const char *fname, int sz);
53 /* open a font by loading a precompiled glyphmap (see: dtx_save_glyphmap)
54 * this works even when compiled without freetype support
55 */
56 struct dtx_font *dtx_open_font_glyphmap(const char *fname);
57 /* close a font opened by either of the above */
58 void dtx_close_font(struct dtx_font *fnt);
60 /* prepare an ASCII glyphmap for the specified font size */
61 void dtx_prepare(struct dtx_font *fnt, int sz);
62 /* prepare an arbitrary unicode range glyphmap for the specified font size */
63 void dtx_prepare_range(struct dtx_font *fnt, int sz, int cstart, int cend);
65 /* Finds the glyphmap that contains the specified character code and matches the requested size
66 * Returns null if it hasn't been created (you should call dtx_prepare/dtx_prepare_range).
67 */
68 struct dtx_glyphmap *dtx_get_font_glyphmap(struct dtx_font *fnt, int sz, int code);
70 /* Finds the glyphmap that contains the specified unicode range and matches the requested font size
71 * Will automatically generate one if it can't find it.
72 */
73 struct dtx_glyphmap *dtx_get_font_glyphmap_range(struct dtx_font *fnt, int sz, int cstart, int cend);
75 /* Creates and returns a glyphmap for a particular unicode range and font size.
76 * The generated glyphmap is added to the font's list of glyphmaps.
77 */
78 struct dtx_glyphmap *dtx_create_glyphmap_range(struct dtx_font *fnt, int sz, int cstart, int cend);
79 /* free a glyphmap */
80 void dtx_free_glyphmap(struct dtx_glyphmap *gmap);
82 /* returns a pointer to the raster image of a glyphmap (1 byte per pixel grayscale) */
83 unsigned char *dtx_get_glyphmap_image(struct dtx_glyphmap *gmap);
84 /* returns the width of the glyphmap image in pixels */
85 int dtx_get_glyphmap_width(struct dtx_glyphmap *gmap);
86 /* returns the height of the glyphmap image in pixels */
87 int dtx_get_glyphmap_height(struct dtx_glyphmap *gmap);
89 /* The following functions can be used even when the library is compiled without
90 * freetype support.
91 */
92 struct dtx_glyphmap *dtx_load_glyphmap(const char *fname);
93 struct dtx_glyphmap *dtx_load_glyphmap_stream(FILE *fp);
94 int dtx_save_glyphmap(const char *fname, const struct dtx_glyphmap *gmap);
95 int dtx_save_glyphmap_stream(FILE *fp, const struct dtx_glyphmap *gmap);
97 /* adds a glyphmap to a font */
98 void dtx_add_glyphmap(struct dtx_font *fnt, struct dtx_glyphmap *gmap);
100 /* ---- rendering ---- */
102 /* before drawing anything this function must set the font to use */
103 void dtx_use_font(struct dtx_font *fnt, int sz);
105 /* sets the buffering mode
106 * - DTX_NBUF: every call to dtx_string gets rendered immediately.
107 * - DTX_LBUF: renders when the buffer is full or the string contains a newline.
108 * - DTX_FBUF: renders only when the buffer is full (you must call dtx_flush explicitly).
109 */
110 void dtx_draw_buffering(int mode);
112 /* Sets the vertex attribute indices to use for passing vertex and texture coordinate
113 * data. By default both are -1 which means you don't have to use a shader, and if you
114 * do they are accessible through gl_Vertex and gl_MultiTexCoord0, as usual.
115 *
116 * NOTE: If you are using OpenGL ES 2.x or OpenGL >= 3.1 pure (non-compatibility) context
117 * you must specify valid attribute indices.
118 */
119 void dtx_vertex_attribs(int vert_attr, int tex_attr);
121 /* draws a single glyph at the origin */
122 void dtx_glyph(int code);
123 /* draws a utf-8 string starting at the origin. \n \r and \t are handled appropriately. */
124 void dtx_string(const char *str);
126 void dtx_printf(const char *fmt, ...);
128 /* render any pending glyphs (see dtx_draw_buffering) */
129 void dtx_flush(void);
132 /* ---- encodings ---- */
134 /* returns a pointer to the next character in a utf-8 stream */
135 char *dtx_utf8_next_char(char *str);
137 /* returns the unicode character codepoint of the utf-8 character starting at str */
138 int dtx_utf8_char_code(const char *str);
140 /* returns the number of bytes of the utf-8 character starting at str */
141 int dtx_utf8_nbytes(const char *str);
143 /* returns the number of utf-8 character in a zero-terminated utf-8 string */
144 int dtx_utf8_char_count(const char *str);
146 /* Converts a unicode code-point to a utf-8 character by filling in the buffer
147 * passed at the second argument, and returns the number of bytes taken by that
148 * utf-8 character.
149 * It's valid to pass a null buffer pointer, in which case only the byte count is
150 * returned (useful to figure out how much memory to allocate for a buffer).
151 */
152 size_t dtx_utf8_from_char_code(int code, char *buf);
154 /* Converts a unicode utf-16 wchar_t string to utf-8, filling in the buffer passed
155 * at the second argument. Returns the size of the resulting string in bytes.
156 *
157 * It's valid to pass a null buffer pointer, in which case only the size gets
158 * calculated and returned, which is useful for figuring out how much memory to
159 * allocate for the utf-8 buffer.
160 */
161 size_t dtx_utf8_from_string(const wchar_t *str, char *buf);
164 /* ---- metrics ---- */
165 float dtx_line_height(void);
167 /* rendered dimensions of a single glyph */
168 void dtx_glyph_box(int code, struct dtx_box *box);
169 float dtx_glyph_width(int code);
170 float dtx_glyph_height(int code);
172 /* rendered dimensions of a string */
173 void dtx_string_box(const char *str, struct dtx_box *box);
174 float dtx_string_width(const char *str);
175 float dtx_string_height(const char *str);
177 /* returns the horizontal position of the n-th character of the rendered string
178 * (useful for placing cursors)
179 */
180 float dtx_char_pos(const char *str, int n);
182 int dtx_char_at_pt(const char *str, float pt);
184 #ifdef __cplusplus
185 }
186 #endif
188 #endif /* LIBDRAWTEXT_H_ */