BugFix:
[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 int BLF_load(char *name);
38 int BLF_load_mem(char *name, unsigned char *mem, int mem_size);
39
40 int BLF_load_unique(char *name);
41 int BLF_load_mem_unique(char *name, unsigned char *mem, int mem_size);
42
43 /* Attach a file with metrics information from memory. */
44 void BLF_metrics_attach(int fontid, unsigned char *mem, int mem_size);
45
46 void BLF_aspect(int fontid, float aspect);
47 void BLF_position(int fontid, float x, float y, float z);
48 void BLF_size(int fontid, int size, int dpi);
49
50 /* Draw the string using the default font, size and dpi. */
51 void BLF_draw_default(float x, float y, float z, char *str);
52
53 /* Draw the string using the current font. */
54 void BLF_draw(int fontid, char *str);
55
56 /*
57  * This function return the bounding box of the string
58  * and are not multiplied by the aspect.
59  */
60 void BLF_boundbox(int fontid, char *str, struct rctf *box);
61
62 /*
63  * The next both function return the width and height
64  * of the string, using the current font and both value 
65  * are multiplied by the aspect of the font.
66  */
67 float BLF_width(int fontid, char *str);
68 float BLF_height(int fontid, char *str);
69
70 /*
71  * The following function return the width and height of the string, but
72  * just in one call, so avoid extra freetype2 stuff.
73  */
74 void BLF_width_and_height(int fontid, char *str, float *width, float *height);
75
76 /*
77  * For fixed width fonts only, returns the width of a
78  * character.
79  */
80 float BLF_fixed_width(int fontid);
81
82 /*
83  * and this two function return the width and height
84  * of the string, using the default font and both value
85  * are multiplied by the aspect of the font.
86  */
87 float BLF_width_default(char *str);
88 float BLF_height_default(char *str);
89
90 /*
91  * Set rotation for default font.
92  */
93 void BLF_rotation_default(float angle);
94
95 /*
96  * Enable/disable options to the default font.
97  */
98 void BLF_enable_default(int option);
99 void BLF_disable_default(int option);
100
101 /*
102  * By default, rotation and clipping are disable and
103  * have to be enable/disable using BLF_enable/disable.
104  */
105 void BLF_rotation(int fontid, float angle);
106 void BLF_clipping(int fontid, float xmin, float ymin, float xmax, float ymax);
107 void BLF_blur(int fontid, int size);
108
109 void BLF_enable(int fontid, int option);
110 void BLF_disable(int fontid, int option);
111
112 /*
113  * Shadow options, level is the blur level, can be 3, 5 or 0 and
114  * the other argument are the rgba color.
115  * Take care that shadow need to be enable using BLF_enable!!.
116  */
117 void BLF_shadow(int fontid, int level, float r, float g, float b, float a);
118
119 /*
120  * Set the offset for shadow text, this is the current cursor
121  * position plus this offset, don't need call BLF_position before
122  * this function, the current position is calculate only on
123  * BLF_draw, so it's safe call this whenever you like.
124  */
125 void BLF_shadow_offset(int fontid, int x, int y);
126
127 /*
128  * Set the buffer, size and number of channels to draw, one thing to take care is call
129  * this function with NULL pointer when we finish, for example:
130  *      BLF_buffer(my_fbuf, my_cbuf, 100, 100, 4);
131  *
132  *      ... set color, position and draw ...
133  *
134  *      BLF_buffer(NULL, NULL, 0, 0, 0);
135  */
136 void BLF_buffer(int fontid, float *fbuf, unsigned char *cbuf, unsigned int w, unsigned int h, int nch);
137
138 /*
139  * Set the color to be used for text.
140  */
141 void BLF_buffer_col(int fontid, float r, float g, float b, float a);
142
143 /*
144  * Draw the string into the buffer, this function draw in both buffer, float and unsigned char _BUT_
145  * it's not necessary set both buffer, NULL is valid here.
146  */
147 void BLF_draw_buffer(int fontid, char *str);
148
149 /*
150  * Search the path directory to the locale files, this try all
151  * the case for Linux, Win and Mac.
152  */
153 void BLF_lang_init(void);
154
155 /* Set the current locale. */
156 void BLF_lang_set(const char *);
157
158 /* Set the current encoding name. */
159 void BLF_lang_encoding_name(const char *str);
160
161 /* Add a path to the font dir paths. */
162 void BLF_dir_add(const char *path);
163
164 /* Remove a path from the font dir paths. */
165 void BLF_dir_rem(const char *path);
166
167 /* Return an array with all the font dir (this can be used for filesel) */
168 char **BLF_dir_get(int *ndir);
169
170 /* Free the data return by BLF_dir_get. */
171 void BLF_dir_free(char **dirs, int count);
172
173 /* font->flags. */
174 #define BLF_ROTATION (1<<0)
175 #define BLF_CLIPPING (1<<1)
176 #define BLF_SHADOW (1<<2)
177 #define BLF_KERNING_DEFAULT (1<<3)
178
179 #endif /* BLF_API_H */