Fix assert in some cases when using DataTransfer modifier for custom normals.
[blender.git] / source / blender / blenfont / BLF_api.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2009 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup blf
22  */
23
24 #ifndef __BLF_API_H__
25 #define __BLF_API_H__
26
27 #include "BLI_compiler_attrs.h"
28 #include "BLI_sys_types.h"
29
30 /* enable this only if needed (unused circa 2016) */
31 #define BLF_BLUR_ENABLE 0
32
33 struct ColorManagedDisplay;
34 struct ResultBLF;
35 struct rctf;
36
37 int BLF_init(void);
38 void BLF_exit(void);
39 void BLF_default_dpi(int dpi);
40 void BLF_default_set(int fontid);
41 int BLF_default(void);      /* get default font ID so we can pass it to other functions */
42 void BLF_batch_reset(void); /* call when changing opengl context. */
43
44 void BLF_cache_clear(void);
45
46 /* Loads a font, or returns an already loaded font and increments its reference count. */
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 /* Check if font supports a particular glyph. */
57 bool BLF_has_glyph(int fontid, unsigned int unicode);
58
59 /* Attach a file with metrics information from memory. */
60 void BLF_metrics_attach(int fontid, unsigned char *mem, int mem_size);
61
62 void BLF_aspect(int fontid, float x, float y, float z);
63 void BLF_position(int fontid, float x, float y, float z);
64 void BLF_size(int fontid, int size, int dpi);
65
66 /* goal: small but useful color API */
67 void BLF_color4ubv(int fontid, const unsigned char rgba[4]);
68 void BLF_color3ubv(int fontid, const unsigned char rgb[3]);
69 void BLF_color3ubv_alpha(int fontid, const unsigned char rgb[3], unsigned char alpha);
70 void BLF_color3ub(int fontid, unsigned char r, unsigned char g, unsigned char b);
71 void BLF_color4f(int fontid, float r, float g, float b, float a);
72 void BLF_color4fv(int fontid, const float rgba[4]);
73 void BLF_color3f(int fontid, float r, float g, float b);
74 void BLF_color3fv_alpha(int fontid, const float rgb[3], float alpha);
75 /* also available: UI_FontThemeColor(fontid, colorid) */
76
77 /* Set a 4x4 matrix to be multiplied before draw the text.
78  * Remember that you need call BLF_enable(BLF_MATRIX)
79  * to enable this.
80  *
81  * The order of the matrix is like GL:
82  *
83  *  | m[0]  m[4]  m[8]  m[12] |
84  *  | m[1]  m[5]  m[9]  m[13] |
85  *  | m[2]  m[6]  m[10] m[14] |
86  *  | m[3]  m[7]  m[11] m[15] |
87  */
88 void BLF_matrix(int fontid, const float m[16]);
89
90 /* Batch drawcalls together as long as
91  * the modelview matrix and the font remain unchanged. */
92 void BLF_batch_draw_begin(void);
93 void BLF_batch_draw_flush(void);
94 void BLF_batch_draw_end(void);
95
96 /* Draw the string using the default font, size and dpi. */
97 void BLF_draw_default(float x, float y, float z, const char *str, size_t len) ATTR_NONNULL();
98 void BLF_draw_default_ascii(float x, float y, float z, const char *str, size_t len) ATTR_NONNULL();
99
100 /* Set size and DPI, and return default font ID. */
101 int BLF_set_default(void);
102
103 /* Draw the string using the current font. */
104 void BLF_draw_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info)
105     ATTR_NONNULL(2);
106 void BLF_draw(int fontid, const char *str, size_t len) ATTR_NONNULL(2);
107 void BLF_draw_ascii_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info)
108     ATTR_NONNULL(2);
109 void BLF_draw_ascii(int fontid, const char *str, size_t len) ATTR_NONNULL(2);
110 int BLF_draw_mono(int fontid, const char *str, size_t len, int cwidth) ATTR_NONNULL(2);
111
112 /* Get the string byte offset that fits within a given width */
113 size_t BLF_width_to_strlen(int fontid, const char *str, size_t len, float width, float *r_width)
114     ATTR_NONNULL(2);
115 /* Same as BLF_width_to_strlen but search from the string end */
116 size_t BLF_width_to_rstrlen(int fontid, const char *str, size_t len, float width, float *r_width)
117     ATTR_NONNULL(2);
118
119 /* This function return the bounding box of the string
120  * and are not multiplied by the aspect.
121  */
122 void BLF_boundbox_ex(int fontid,
123                      const char *str,
124                      size_t len,
125                      struct rctf *box,
126                      struct ResultBLF *r_info) ATTR_NONNULL(2);
127 void BLF_boundbox(int fontid, const char *str, size_t len, struct rctf *box) ATTR_NONNULL();
128
129 /* The next both function return the width and height
130  * of the string, using the current font and both value
131  * are multiplied by the aspect of the font.
132  */
133 float BLF_width_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info)
134     ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2);
135 float BLF_width(int fontid, const char *str, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
136 float BLF_height_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info)
137     ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2);
138 float BLF_height(int fontid, const char *str, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
139
140 /* Return dimensions of the font without any sample text. */
141 int BLF_height_max(int fontid) ATTR_WARN_UNUSED_RESULT;
142 float BLF_width_max(int fontid) ATTR_WARN_UNUSED_RESULT;
143 float BLF_descender(int fontid) ATTR_WARN_UNUSED_RESULT;
144 float BLF_ascender(int fontid) ATTR_WARN_UNUSED_RESULT;
145
146 /* The following function return the width and height of the string, but
147  * just in one call, so avoid extra freetype2 stuff.
148  */
149 void BLF_width_and_height(int fontid, const char *str, size_t len, float *r_width, float *r_height)
150     ATTR_NONNULL();
151
152 /* For fixed width fonts only, returns the width of a
153  * character.
154  */
155 float BLF_fixed_width(int fontid) ATTR_WARN_UNUSED_RESULT;
156
157 /* By default, rotation and clipping are disable and
158  * have to be enable/disable using BLF_enable/disable.
159  */
160 void BLF_rotation(int fontid, float angle);
161 void BLF_clipping(int fontid, float xmin, float ymin, float xmax, float ymax);
162 void BLF_wordwrap(int fontid, int wrap_width);
163
164 #if BLF_BLUR_ENABLE
165 void BLF_blur(int fontid, int size);
166 #endif
167
168 void BLF_enable(int fontid, int option);
169 void BLF_disable(int fontid, int option);
170
171 /* Shadow options, level is the blur level, can be 3, 5 or 0 and
172  * the other argument are the rgba color.
173  * Take care that shadow need to be enable using BLF_enable!!!
174  */
175 void BLF_shadow(int fontid, int level, const float rgba[4]) ATTR_NONNULL(3);
176
177 /* Set the offset for shadow text, this is the current cursor
178  * position plus this offset, don't need call BLF_position before
179  * this function, the current position is calculate only on
180  * BLF_draw, so it's safe call this whenever you like.
181  */
182 void BLF_shadow_offset(int fontid, int x, int y);
183
184 /* Set the buffer, size and number of channels to draw, one thing to take care is call
185  * this function with NULL pointer when we finish, for example:
186  *
187  *     BLF_buffer(my_fbuf, my_cbuf, 100, 100, 4, true, NULL);
188  *
189  *     ... set color, position and draw ...
190  *
191  *     BLF_buffer(NULL, NULL, NULL, 0, 0, false, NULL);
192  */
193 void BLF_buffer(int fontid,
194                 float *fbuf,
195                 unsigned char *cbuf,
196                 int w,
197                 int h,
198                 int nch,
199                 struct ColorManagedDisplay *display);
200
201 /* Set the color to be used for text. */
202 void BLF_buffer_col(int fontid, const float rgba[4]) ATTR_NONNULL(2);
203
204 /* Draw the string into the buffer, this function draw in both buffer,
205  * float and unsigned char _BUT_ it's not necessary set both buffer, NULL is valid here.
206  */
207 void BLF_draw_buffer_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info)
208     ATTR_NONNULL(2);
209 void BLF_draw_buffer(int fontid, const char *str, size_t len) ATTR_NONNULL(2);
210
211 /* Add a path to the font dir paths. */
212 void BLF_dir_add(const char *path) ATTR_NONNULL();
213
214 /* Remove a path from the font dir paths. */
215 void BLF_dir_rem(const char *path) ATTR_NONNULL();
216
217 /* Return an array with all the font dir (this can be used for filesel) */
218 char **BLF_dir_get(int *ndir) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
219
220 /* Free the data return by BLF_dir_get. */
221 void BLF_dir_free(char **dirs, int count) ATTR_NONNULL();
222
223 /* blf_thumbs.c */
224 void BLF_thumb_preview(const char *filename,
225                        const char **draw_str,
226                        const unsigned char draw_str_lines,
227                        const float font_color[4],
228                        const int font_size,
229                        unsigned char *buf,
230                        int w,
231                        int h,
232                        int channels) ATTR_NONNULL();
233
234 /* blf_font_i18.c */
235 unsigned char *BLF_get_unifont(int *unifont_size);
236 void BLF_free_unifont(void);
237 unsigned char *BLF_get_unifont_mono(int *unifont_size);
238 void BLF_free_unifont_mono(void);
239
240 #ifdef DEBUG
241 void BLF_state_print(int fontid);
242 #endif
243
244 /* font->flags. */
245 #define BLF_ROTATION (1 << 0)
246 #define BLF_CLIPPING (1 << 1)
247 #define BLF_SHADOW (1 << 2)
248 #define BLF_KERNING_DEFAULT (1 << 3)
249 #define BLF_MATRIX (1 << 4)
250 #define BLF_ASPECT (1 << 5)
251 #define BLF_WORD_WRAP (1 << 6)
252 #define BLF_MONOCHROME (1 << 7) /* no-AA */
253 #define BLF_HINTING_NONE (1 << 8)
254 #define BLF_HINTING_SLIGHT (1 << 9)
255 #define BLF_HINTING_FULL (1 << 10)
256
257 #define BLF_DRAW_STR_DUMMY_MAX 1024
258
259 /* XXX, bad design */
260 extern int blf_mono_font;
261 extern int blf_mono_font_render; /* don't mess drawing with render threads. */
262
263 /**
264  * Result of drawing/evaluating the string
265  */
266 struct ResultBLF {
267   /**
268    * Number of lines drawn when #BLF_WORD_WRAP is enabled (both wrapped and `\n` newline).
269    */
270   int lines;
271   /**
272    * The 'cursor' position on completion (ignoring character boundbox).
273    */
274   int width;
275 };
276
277 #endif /* __BLF_API_H__ */