fix a small bug , and update language-packs
[blender-staging.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 /** \file blender/blenfont/BLF_api.h
30  *  \ingroup blf
31  */
32
33
34 #ifndef BLF_API_H
35 #define BLF_API_H
36
37 #include <stdlib.h>
38 struct rctf;
39
40 int BLF_init(int points, int dpi);
41 void BLF_exit(void);
42
43 void BLF_cache_clear(void);
44
45 const char* BLF_gettext(const char *msgid);
46
47 int BLF_load(const char *name);
48 int BLF_load_mem(const char *name, unsigned char *mem, int mem_size);
49
50 int BLF_load_unique(const char *name);
51 int BLF_load_mem_unique(const char *name, unsigned char *mem, int mem_size);
52
53 /* Attach a file with metrics information from memory. */
54 void BLF_metrics_attach(int fontid, unsigned char *mem, int mem_size);
55
56 void BLF_aspect(int fontid, float x, float y, float z);
57 void BLF_position(int fontid, float x, float y, float z);
58 void BLF_size(int fontid, int size, int dpi);
59
60 /* Set a 4x4 matrix to be multiplied before draw the text.
61  * Remember that you need call BLF_enable(BLF_MATRIX)
62  * to enable this.
63  *
64  * The order of the matrix is like GL:
65
66         | m[0]  m[4]  m[8]  m[12] |
67         | m[1]  m[5]  m[9]  m[13] |
68         | m[2]  m[6]  m[10] m[14] |
69         | m[3]  m[7]  m[11] m[15] |
70
71  */
72 void BLF_matrix(int fontid, double *m);
73
74 /* Draw the string using the default font, size and dpi. */
75 void BLF_draw_default(float x, float y, float z, const char *str, size_t len);
76 void BLF_draw_default_ascii(float x, float y, float z, const char *str, size_t len);
77
78 /* Draw the string using the current font. */
79 void BLF_draw(int fontid, const char *str, size_t len);
80 void BLF_draw_ascii(int fontid, const char *str, size_t len);
81
82 /*
83  * This function return the bounding box of the string
84  * and are not multiplied by the aspect.
85  */
86 void BLF_boundbox(int fontid, const char *str, struct rctf *box);
87
88 /*
89  * The next both function return the width and height
90  * of the string, using the current font and both value 
91  * are multiplied by the aspect of the font.
92  */
93 float BLF_width(int fontid, const char *str);
94 float BLF_height(int fontid, const char *str);
95
96 /*
97  * Return dimensions of the font without any sample text.
98  */
99 float BLF_height_max(int fontid);
100 float BLF_width_max(int fontid);
101 float BLF_descender(int fontid);
102 float BLF_ascender(int fontid);
103
104 /*
105  * The following function return the width and height of the string, but
106  * just in one call, so avoid extra freetype2 stuff.
107  */
108 void BLF_width_and_height(int fontid, const char *str, float *width, float *height);
109
110 /*
111  * For fixed width fonts only, returns the width of a
112  * character.
113  */
114 float BLF_fixed_width(int fontid);
115
116 /*
117  * and this two function return the width and height
118  * of the string, using the default font and both value
119  * are multiplied by the aspect of the font.
120  */
121 float BLF_width_default(const char *str);
122 float BLF_height_default(const char *str);
123
124 /*
125  * Set rotation for default font.
126  */
127 void BLF_rotation_default(float angle);
128
129 /*
130  * Enable/disable options to the default font.
131  */
132 void BLF_enable_default(int option);
133 void BLF_disable_default(int option);
134
135 /*
136  * By default, rotation and clipping are disable and
137  * have to be enable/disable using BLF_enable/disable.
138  */
139 void BLF_rotation(int fontid, float angle);
140 void BLF_clipping(int fontid, float xmin, float ymin, float xmax, float ymax);
141 void BLF_clipping_default(float xmin, float ymin, float xmax, float ymax);
142 void BLF_blur(int fontid, int size);
143
144 void BLF_enable(int fontid, int option);
145 void BLF_disable(int fontid, int option);
146
147 /*
148  * Shadow options, level is the blur level, can be 3, 5 or 0 and
149  * the other argument are the rgba color.
150  * Take care that shadow need to be enable using BLF_enable!!.
151  */
152 void BLF_shadow(int fontid, int level, float r, float g, float b, float a);
153
154 /*
155  * Set the offset for shadow text, this is the current cursor
156  * position plus this offset, don't need call BLF_position before
157  * this function, the current position is calculate only on
158  * BLF_draw, so it's safe call this whenever you like.
159  */
160 void BLF_shadow_offset(int fontid, int x, int y);
161
162 /*
163  * Set the buffer, size and number of channels to draw, one thing to take care is call
164  * this function with NULL pointer when we finish, for example:
165  *      BLF_buffer(my_fbuf, my_cbuf, 100, 100, 4);
166  *
167  *      ... set color, position and draw ...
168  *
169  *      BLF_buffer(NULL, NULL, 0, 0, 0);
170  */
171 void BLF_buffer(int fontid, float *fbuf, unsigned char *cbuf, int w, int h, int nch);
172
173 /*
174  * Set the color to be used for text.
175  */
176 void BLF_buffer_col(int fontid, float r, float g, float b, float a);
177
178 /*
179  * Draw the string into the buffer, this function draw in both buffer, float and unsigned char _BUT_
180  * it's not necessary set both buffer, NULL is valid here.
181  */
182 void BLF_draw_buffer(int fontid, const char *str);
183
184 /*
185  * Search the path directory to the locale files, this try all
186  * the case for Linux, Win and Mac.
187  */
188 void BLF_lang_init(void);
189
190 /* Set the current locale. */
191 void BLF_lang_set(const char *);
192
193 /* Set the current encoding name. */
194 void BLF_lang_encoding_name(const char *str);
195
196 void BLF_lang_encoding(const char *str);
197
198 /* Add a path to the font dir paths. */
199 void BLF_dir_add(const char *path);
200
201 /* Remove a path from the font dir paths. */
202 void BLF_dir_rem(const char *path);
203
204 /* Return an array with all the font dir (this can be used for filesel) */
205 char **BLF_dir_get(int *ndir);
206
207 /* Free the data return by BLF_dir_get. */
208 void BLF_dir_free(char **dirs, int count);
209
210 /* font->flags. */
211 #define BLF_ROTATION (1<<0)
212 #define BLF_CLIPPING (1<<1)
213 #define BLF_SHADOW (1<<2)
214 #define BLF_KERNING_DEFAULT (1<<3)
215 #define BLF_MATRIX (1<<4)
216 #define BLF_ASPECT (1<<5)
217
218 // XXX, bad design
219 extern int blf_mono_font;
220 extern int blf_mono_font_render; // dont mess drawing with render threads.
221
222 #define _(msgid) BLF_gettext(msgid)
223 #define N_(msgid) msgid
224
225 #endif /* BLF_API_H */