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