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