3dphotoshoot
view libs/drawtext/drawtext.h @ 27:3d082c566b53
fixed all the bugs, pc version works
| author | John Tsiombikas <nuclear@member.fsf.org> |
|---|---|
| date | Thu, 18 Jun 2015 04:32:25 +0300 |
| parents | c71c477521ca |
| 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>
23 #include "assman.h"
25 struct dtx_font;
26 struct dtx_glyphmap;
28 /* draw buffering modes */
29 enum {
30 DTX_NBF, /* unbuffered */
31 DTX_LBF, /* line buffered */
32 DTX_FBF /* fully buffered */
33 };
35 struct dtx_box {
36 float x, y;
37 float width, height;
38 };
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
44 /* Open a truetype/opentype/whatever font.
45 *
46 * If sz is non-zero, the default ASCII glyphmap at the requested point size is
47 * automatically created as well, and ready to use.
48 *
49 * To use other unicode ranges and different font sizes you must first call
50 * dtx_prepare or dtx_prepare_range before issuing any drawing calls, otherwise
51 * nothing will be rendered.
52 */
53 struct dtx_font *dtx_open_font(const char *fname, int sz);
54 /* open a font by loading a precompiled glyphmap (see: dtx_save_glyphmap)
55 * this works even when compiled without freetype support
56 */
57 struct dtx_font *dtx_open_font_glyphmap(const char *fname);
58 /* close a font opened by either of the above */
59 void dtx_close_font(struct dtx_font *fnt);
61 /* prepare an ASCII glyphmap for the specified font size */
62 void dtx_prepare(struct dtx_font *fnt, int sz);
63 /* prepare an arbitrary unicode range glyphmap for the specified font size */
64 void dtx_prepare_range(struct dtx_font *fnt, int sz, int cstart, int cend);
66 /* Finds the glyphmap that contains the specified character code and matches the requested size
67 * Returns null if it hasn't been created (you should call dtx_prepare/dtx_prepare_range).
68 */
69 struct dtx_glyphmap *dtx_get_font_glyphmap(struct dtx_font *fnt, int sz, int code);
71 /* Finds the glyphmap that contains the specified unicode range and matches the requested font size
72 * Will automatically generate one if it can't find it.
73 */
74 struct dtx_glyphmap *dtx_get_font_glyphmap_range(struct dtx_font *fnt, int sz, int cstart, int cend);
76 /* Creates and returns a glyphmap for a particular unicode range and font size.
77 * The generated glyphmap is added to the font's list of glyphmaps.
78 */
79 struct dtx_glyphmap *dtx_create_glyphmap_range(struct dtx_font *fnt, int sz, int cstart, int cend);
80 /* free a glyphmap */
81 void dtx_free_glyphmap(struct dtx_glyphmap *gmap);
83 /* returns a pointer to the raster image of a glyphmap (1 byte per pixel grayscale) */
84 unsigned char *dtx_get_glyphmap_image(struct dtx_glyphmap *gmap);
85 /* returns the width of the glyphmap image in pixels */
86 int dtx_get_glyphmap_width(struct dtx_glyphmap *gmap);
87 /* returns the height of the glyphmap image in pixels */
88 int dtx_get_glyphmap_height(struct dtx_glyphmap *gmap);
90 /* The following functions can be used even when the library is compiled without
91 * freetype support.
92 */
93 struct dtx_glyphmap *dtx_load_glyphmap(const char *fname);
94 struct dtx_glyphmap *dtx_load_glyphmap_stream(ass_file *fp);
95 int dtx_save_glyphmap(const char *fname, const struct dtx_glyphmap *gmap);
96 int dtx_save_glyphmap_stream(FILE *fp, const struct dtx_glyphmap *gmap);
98 /* adds a glyphmap to a font */
99 void dtx_add_glyphmap(struct dtx_font *fnt, struct dtx_glyphmap *gmap);
101 /* ---- rendering ---- */
103 /* before drawing anything this function must set the font to use */
104 void dtx_use_font(struct dtx_font *fnt, int sz);
106 /* sets the buffering mode
107 * - DTX_NBUF: every call to dtx_string gets rendered immediately.
108 * - DTX_LBUF: renders when the buffer is full or the string contains a newline.
109 * - DTX_FBUF: renders only when the buffer is full (you must call dtx_flush explicitly).
110 */
111 void dtx_draw_buffering(int mode);
113 /* Sets the vertex attribute indices to use for passing vertex and texture coordinate
114 * data. By default both are -1 which means you don't have to use a shader, and if you
115 * do they are accessible through gl_Vertex and gl_MultiTexCoord0, as usual.
116 *
117 * NOTE: If you are using OpenGL ES 2.x or OpenGL >= 3.1 pure (non-compatibility) context
118 * you must specify valid attribute indices.
119 */
120 void dtx_vertex_attribs(int vert_attr, int tex_attr);
122 /* draws a single glyph at the origin */
123 void dtx_glyph(int code);
124 /* draws a utf-8 string starting at the origin. \n \r and \t are handled appropriately. */
125 void dtx_string(const char *str);
127 void dtx_printf(const char *fmt, ...);
129 /* render any pending glyphs (see dtx_draw_buffering) */
130 void dtx_flush(void);
133 /* ---- encodings ---- */
135 /* returns a pointer to the next character in a utf-8 stream */
136 char *dtx_utf8_next_char(char *str);
138 /* returns the unicode character codepoint of the utf-8 character starting at str */
139 int dtx_utf8_char_code(const char *str);
141 /* returns the number of bytes of the utf-8 character starting at str */
142 int dtx_utf8_nbytes(const char *str);
144 /* returns the number of utf-8 character in a zero-terminated utf-8 string */
145 int dtx_utf8_char_count(const char *str);
147 /* Converts a unicode code-point to a utf-8 character by filling in the buffer
148 * passed at the second argument, and returns the number of bytes taken by that
149 * utf-8 character.
150 * It's valid to pass a null buffer pointer, in which case only the byte count is
151 * returned (useful to figure out how much memory to allocate for a buffer).
152 */
153 size_t dtx_utf8_from_char_code(int code, char *buf);
155 /* Converts a unicode utf-16 wchar_t string to utf-8, filling in the buffer passed
156 * at the second argument. Returns the size of the resulting string in bytes.
157 *
158 * It's valid to pass a null buffer pointer, in which case only the size gets
159 * calculated and returned, which is useful for figuring out how much memory to
160 * allocate for the utf-8 buffer.
161 */
162 size_t dtx_utf8_from_string(const wchar_t *str, char *buf);
165 /* ---- metrics ---- */
166 float dtx_line_height(void);
168 /* rendered dimensions of a single glyph */
169 void dtx_glyph_box(int code, struct dtx_box *box);
170 float dtx_glyph_width(int code);
171 float dtx_glyph_height(int code);
173 /* rendered dimensions of a string */
174 void dtx_string_box(const char *str, struct dtx_box *box);
175 float dtx_string_width(const char *str);
176 float dtx_string_height(const char *str);
178 /* returns the horizontal position of the n-th character of the rendered string
179 * (useful for placing cursors)
180 */
181 float dtx_char_pos(const char *str, int n);
183 int dtx_char_at_pt(const char *str, float pt);
185 #ifdef __cplusplus
186 }
187 #endif
189 #endif /* LIBDRAWTEXT_H_ */