ClangFormat: apply to source, most of intern
[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 /* 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 /* goal: small but useful color API */
64 void BLF_color4ubv(int fontid, const unsigned char rgba[4]);
65 void BLF_color3ubv(int fontid, const unsigned char rgb[3]);
66 void BLF_color3ubv_alpha(int fontid, const unsigned char rgb[3], unsigned char alpha);
67 void BLF_color3ub(int fontid, unsigned char r, unsigned char g, unsigned char b);
68 void BLF_color4f(int fontid, float r, float g, float b, float a);
69 void BLF_color4fv(int fontid, const float rgba[4]);
70 void BLF_color3f(int fontid, float r, float g, float b);
71 void BLF_color3fv_alpha(int fontid, const float rgb[3], float alpha);
72 /* also available: UI_FontThemeColor(fontid, colorid) */
73
74 /* Set a 4x4 matrix to be multiplied before draw the text.
75  * Remember that you need call BLF_enable(BLF_MATRIX)
76  * to enable this.
77  *
78  * The order of the matrix is like GL:
79  *
80  *  | m[0]  m[4]  m[8]  m[12] |
81  *  | m[1]  m[5]  m[9]  m[13] |
82  *  | m[2]  m[6]  m[10] m[14] |
83  *  | m[3]  m[7]  m[11] m[15] |
84  */
85 void BLF_matrix(int fontid, const float m[16]);
86
87 /* Batch drawcalls together as long as
88  * the modelview matrix and the font remain unchanged. */
89 void BLF_batch_draw_begin(void);
90 void BLF_batch_draw_flush(void);
91 void BLF_batch_draw_end(void);
92
93 /* Draw the string using the default font, size and dpi. */
94 void BLF_draw_default(float x, float y, float z, const char *str, size_t len) ATTR_NONNULL();
95 void BLF_draw_default_ascii(float x, float y, float z, const char *str, size_t len) ATTR_NONNULL();
96
97 /* Set size and DPI, and return default font ID. */
98 int BLF_set_default(void);
99
100 /* Draw the string using the current font. */
101 void BLF_draw_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info)
102     ATTR_NONNULL(2);
103 void BLF_draw(int fontid, const char *str, size_t len) ATTR_NONNULL(2);
104 void BLF_draw_ascii_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info)
105     ATTR_NONNULL(2);
106 void BLF_draw_ascii(int fontid, const char *str, size_t len) ATTR_NONNULL(2);
107 int BLF_draw_mono(int fontid, const char *str, size_t len, int cwidth) ATTR_NONNULL(2);
108
109 /* Get the string byte offset that fits within a given width */
110 size_t BLF_width_to_strlen(int fontid, const char *str, size_t len, float width, float *r_width)
111     ATTR_NONNULL(2);
112 /* Same as BLF_width_to_strlen but search from the string end */
113 size_t BLF_width_to_rstrlen(int fontid, const char *str, size_t len, float width, float *r_width)
114     ATTR_NONNULL(2);
115
116 /* This function return the bounding box of the string
117  * and are not multiplied by the aspect.
118  */
119 void BLF_boundbox_ex(int fontid,
120                      const char *str,
121                      size_t len,
122                      struct rctf *box,
123                      struct ResultBLF *r_info) ATTR_NONNULL(2);
124 void BLF_boundbox(int fontid, const char *str, size_t len, struct rctf *box) ATTR_NONNULL();
125
126 /* The next both function return the width and height
127  * of the string, using the current font and both value
128  * are multiplied by the aspect of the font.
129  */
130 float BLF_width_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info)
131     ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2);
132 float BLF_width(int fontid, const char *str, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
133 float BLF_height_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info)
134     ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2);
135 float BLF_height(int fontid, const char *str, size_t len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
136
137 /* Return dimensions of the font without any sample text. */
138 int BLF_height_max(int fontid) ATTR_WARN_UNUSED_RESULT;
139 float BLF_width_max(int fontid) ATTR_WARN_UNUSED_RESULT;
140 float BLF_descender(int fontid) ATTR_WARN_UNUSED_RESULT;
141 float BLF_ascender(int fontid) ATTR_WARN_UNUSED_RESULT;
142
143 /* The following function return the width and height of the string, but
144  * just in one call, so avoid extra freetype2 stuff.
145  */
146 void BLF_width_and_height(int fontid, const char *str, size_t len, float *r_width, float *r_height)
147     ATTR_NONNULL();
148
149 /* For fixed width fonts only, returns the width of a
150  * character.
151  */
152 float BLF_fixed_width(int fontid) ATTR_WARN_UNUSED_RESULT;
153
154 /* By default, rotation and clipping are disable and
155  * have to be enable/disable using BLF_enable/disable.
156  */
157 void BLF_rotation(int fontid, float angle);
158 void BLF_clipping(int fontid, float xmin, float ymin, float xmax, float ymax);
159 void BLF_wordwrap(int fontid, int wrap_width);
160
161 #if BLF_BLUR_ENABLE
162 void BLF_blur(int fontid, int size);
163 #endif
164
165 void BLF_enable(int fontid, int option);
166 void BLF_disable(int fontid, int option);
167
168 /* Shadow options, level is the blur level, can be 3, 5 or 0 and
169  * the other argument are the rgba color.
170  * Take care that shadow need to be enable using BLF_enable!!!
171  */
172 void BLF_shadow(int fontid, int level, const float rgba[4]) ATTR_NONNULL(3);
173
174 /* Set the offset for shadow text, this is the current cursor
175  * position plus this offset, don't need call BLF_position before
176  * this function, the current position is calculate only on
177  * BLF_draw, so it's safe call this whenever you like.
178  */
179 void BLF_shadow_offset(int fontid, int x, int y);
180
181 /* Set the buffer, size and number of channels to draw, one thing to take care is call
182  * this function with NULL pointer when we finish, for example:
183  *
184  *     BLF_buffer(my_fbuf, my_cbuf, 100, 100, 4, true, NULL);
185  *
186  *     ... set color, position and draw ...
187  *
188  *     BLF_buffer(NULL, NULL, NULL, 0, 0, false, NULL);
189  */
190 void BLF_buffer(int fontid,
191                 float *fbuf,
192                 unsigned char *cbuf,
193                 int w,
194                 int h,
195                 int nch,
196                 struct ColorManagedDisplay *display);
197
198 /* Set the color to be used for text. */
199 void BLF_buffer_col(int fontid, const float rgba[4]) ATTR_NONNULL(2);
200
201 /* Draw the string into the buffer, this function draw in both buffer, float and unsigned char _BUT_
202  * it's not necessary set both buffer, NULL is valid here.
203  */
204 void BLF_draw_buffer_ex(int fontid, const char *str, size_t len, struct ResultBLF *r_info)
205     ATTR_NONNULL(2);
206 void BLF_draw_buffer(int fontid, const char *str, size_t len) ATTR_NONNULL(2);
207
208 /* Add a path to the font dir paths. */
209 void BLF_dir_add(const char *path) ATTR_NONNULL();
210
211 /* Remove a path from the font dir paths. */
212 void BLF_dir_rem(const char *path) ATTR_NONNULL();
213
214 /* Return an array with all the font dir (this can be used for filesel) */
215 char **BLF_dir_get(int *ndir) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
216
217 /* Free the data return by BLF_dir_get. */
218 void BLF_dir_free(char **dirs, int count) ATTR_NONNULL();
219
220 /* blf_thumbs.c */
221 void BLF_thumb_preview(const char *filename,
222                        const char **draw_str,
223                        const unsigned char draw_str_lines,
224                        const float font_color[4],
225                        const int font_size,
226                        unsigned char *buf,
227                        int w,
228                        int h,
229                        int channels) ATTR_NONNULL();
230
231 /* blf_font_i18.c */
232 unsigned char *BLF_get_unifont(int *unifont_size);
233 void BLF_free_unifont(void);
234 unsigned char *BLF_get_unifont_mono(int *unifont_size);
235 void BLF_free_unifont_mono(void);
236
237 #ifdef DEBUG
238 void BLF_state_print(int fontid);
239 #endif
240
241 /* font->flags. */
242 #define BLF_ROTATION (1 << 0)
243 #define BLF_CLIPPING (1 << 1)
244 #define BLF_SHADOW (1 << 2)
245 #define BLF_KERNING_DEFAULT (1 << 3)
246 #define BLF_MATRIX (1 << 4)
247 #define BLF_ASPECT (1 << 5)
248 #define BLF_WORD_WRAP (1 << 6)
249 #define BLF_MONOCHROME (1 << 7) /* no-AA */
250 #define BLF_HINTING_NONE (1 << 8)
251 #define BLF_HINTING_SLIGHT (1 << 9)
252 #define BLF_HINTING_FULL (1 << 10)
253
254 #define BLF_DRAW_STR_DUMMY_MAX 1024
255
256 /* XXX, bad design */
257 extern int blf_mono_font;
258 extern int blf_mono_font_render; /* don't mess drawing with render threads. */
259
260 /**
261  * Result of drawing/evaluating the string
262  */
263 struct ResultBLF {
264   /**
265    * Number of lines drawn when #BLF_WORD_WRAP is enabled (both wrapped and `\n` newline).
266    */
267   int lines;
268   /**
269    * The 'cursor' position on completion (ignoring character boundbox).
270    */
271   int width;
272 };
273
274 #endif /* __BLF_API_H__ */