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