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