UI: Add back ability to select a custom interface font
[blender.git] / source / blender / blenfont / BLF_api.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/blenfont/BLF_api.h
28  *  \ingroup blf
29  */
30
31
32 #ifndef __BLF_API_H__
33 #define __BLF_API_H__
34
35 #include "BLI_compiler_attrs.h"
36
37 struct rctf;
38 struct ColorManagedDisplay;
39
40 int BLF_init(int points, int dpi);
41 void BLF_exit(void);
42 void BLF_default_dpi(int dpi);
43 void BLF_default_set(int fontid);
44
45 void BLF_cache_clear(void);
46
47 int BLF_load(const char *name) ATTR_NONNULL();
48 int BLF_load_mem(const char *name, const unsigned char *mem, int mem_size) ATTR_NONNULL();
49
50 int BLF_load_unique(const char *name) ATTR_NONNULL();
51 int BLF_load_mem_unique(const char *name, const unsigned char *mem, int mem_size) ATTR_NONNULL();
52
53 void BLF_unload(const char *name) ATTR_NONNULL();
54 void BLF_unload_id(int fontid);
55
56 /* Attach a file with metrics information from memory. */
57 void BLF_metrics_attach(int fontid, unsigned char *mem, int mem_size);
58
59 void BLF_aspect(int fontid, float x, float y, float z);
60 void BLF_position(int fontid, float x, float y, float z);
61 void BLF_size(int fontid, int size, int dpi);
62
63 /* Set a 4x4 matrix to be multiplied before draw the text.
64  * Remember that you need call BLF_enable(BLF_MATRIX)
65  * to enable this.
66  *
67  * The order of the matrix is like GL:
68  *
69  *  | m[0]  m[4]  m[8]  m[12] |
70  *  | m[1]  m[5]  m[9]  m[13] |
71  *  | m[2]  m[6]  m[10] m[14] |
72  *  | m[3]  m[7]  m[11] m[15] |
73  *
74  */
75 void BLF_matrix(int fontid, const double m[16]);
76
77 /* Draw the string using the default font, size and dpi. */
78 void BLF_draw_default(float x, float y, float z, const char *str, size_t len) ATTR_NONNULL();
79 void BLF_draw_default_ascii(float x, float y, float z, const char *str, size_t len) ATTR_NONNULL();
80
81 /* Draw the string using the current font. */
82 void BLF_draw(int fontid, const char *str, size_t len);
83 void BLF_draw_ascii(int fontid, const char *str, size_t len);
84 int BLF_draw_mono(int fontid, const char *str, size_t len, int cwidth);
85
86 /* Get the string byte offset that fits within a given width */
87 size_t BLF_width_to_strlen(int fontid, const char *str, size_t len, float width, float *r_width) ATTR_NONNULL(2);
88 /* Same as BLF_width_to_strlen but search from the string end */
89 size_t BLF_width_to_rstrlen(int fontid, const char *str, size_t len, float width, float *r_width) ATTR_NONNULL(2);
90
91 /* This function return the bounding box of the string
92  * and are not multiplied by the aspect.
93  */
94 void BLF_boundbox(int fontid, const char *str, size_t len, struct rctf *box) ATTR_NONNULL();
95
96 /* The next both function return the width and height
97  * of the string, using the current font and both value 
98  * are multiplied by the aspect of the font.
99  */
100 float BLF_width(int fontid, const char *str, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
101 float BLF_height(int fontid, const char *str, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
102
103 /* Return dimensions of the font without any sample text. */
104 float BLF_height_max(int fontid) ATTR_WARN_UNUSED_RESULT;
105 float BLF_width_max(int fontid) ATTR_WARN_UNUSED_RESULT;
106 float BLF_descender(int fontid) ATTR_WARN_UNUSED_RESULT;
107 float BLF_ascender(int fontid) ATTR_WARN_UNUSED_RESULT;
108
109 /* The following function return the width and height of the string, but
110  * just in one call, so avoid extra freetype2 stuff.
111  */
112 void BLF_width_and_height(int fontid, const char *str, size_t len, float *r_width, float *r_height) ATTR_NONNULL();
113
114 /* For fixed width fonts only, returns the width of a
115  * character.
116  */
117 float BLF_fixed_width(int fontid) ATTR_WARN_UNUSED_RESULT;
118
119 /* and this two function return the width and height
120  * of the string, using the default font and both value
121  * are multiplied by the aspect of the font.
122  */
123 void  BLF_width_and_height_default(const char *str, size_t len, float *r_width, float *r_height) ATTR_NONNULL();
124 float BLF_width_default(const char *str, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
125 float BLF_height_default(const char *str, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
126
127 /* Set rotation for default font. */
128 void BLF_rotation_default(float angle);
129
130 /* Enable/disable options to the default font. */
131 void BLF_enable_default(int option);
132 void BLF_disable_default(int option);
133
134 /* By default, rotation and clipping are disable and
135  * have to be enable/disable using BLF_enable/disable.
136  */
137 void BLF_rotation(int fontid, float angle);
138 void BLF_clipping(int fontid, float xmin, float ymin, float xmax, float ymax);
139 void BLF_clipping_default(float xmin, float ymin, float xmax, float ymax);
140 void BLF_blur(int fontid, int size);
141
142 void BLF_enable(int fontid, int option);
143 void BLF_disable(int fontid, int option);
144
145 /* Shadow options, level is the blur level, can be 3, 5 or 0 and
146  * the other argument are the rgba color.
147  * Take care that shadow need to be enable using BLF_enable!!!
148  */
149 void BLF_shadow(int fontid, int level, float r, float g, float b, float a);
150
151 /* Set the offset for shadow text, this is the current cursor
152  * position plus this offset, don't need call BLF_position before
153  * this function, the current position is calculate only on
154  * BLF_draw, so it's safe call this whenever you like.
155  */
156 void BLF_shadow_offset(int fontid, int x, int y);
157
158 /* Set the buffer, size and number of channels to draw, one thing to take care is call
159  * this function with NULL pointer when we finish, for example:
160  *
161  *     BLF_buffer(my_fbuf, my_cbuf, 100, 100, 4, true, NULL);
162  *
163  *     ... set color, position and draw ...
164  *
165  *     BLF_buffer(NULL, NULL, NULL, 0, 0, false, NULL);
166  */
167 void BLF_buffer(int fontid, float *fbuf, unsigned char *cbuf, int w, int h, int nch, struct ColorManagedDisplay *display);
168
169 /* Set the color to be used for text. */
170 void BLF_buffer_col(int fontid, float r, float g, float b, float a);
171
172 /* Draw the string into the buffer, this function draw in both buffer, float and unsigned char _BUT_
173  * it's not necessary set both buffer, NULL is valid here.
174  */
175 void BLF_draw_buffer(int fontid, const char *str) ATTR_NONNULL();
176
177 /* Add a path to the font dir paths. */
178 void BLF_dir_add(const char *path) ATTR_NONNULL();
179
180 /* Remove a path from the font dir paths. */
181 void BLF_dir_rem(const char *path) ATTR_NONNULL();
182
183 /* Return an array with all the font dir (this can be used for filesel) */
184 char **BLF_dir_get(int *ndir) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
185
186 /* Free the data return by BLF_dir_get. */
187 void BLF_dir_free(char **dirs, int count) ATTR_NONNULL();
188
189 #ifdef DEBUG
190 void BLF_state_print(int fontid);
191 #endif
192
193 /* font->flags. */
194 #define BLF_ROTATION         (1 << 0)
195 #define BLF_CLIPPING         (1 << 1)
196 #define BLF_SHADOW           (1 << 2)
197 #define BLF_KERNING_DEFAULT  (1 << 3)
198 #define BLF_MATRIX           (1 << 4)
199 #define BLF_ASPECT           (1 << 5)
200 #define BLF_HINTING          (1 << 6)
201
202 #define BLF_DRAW_STR_DUMMY_MAX 1024
203
204 /* XXX, bad design */
205 extern int blf_mono_font;
206 extern int blf_mono_font_render; /* don't mess drawing with render threads. */
207
208 #endif /* __BLF_API_H__ */