6f348ccc26748e41c9cd14fa45073dc46a9df160
[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 struct ColorManagedDisplay;
37
38 int BLF_init(int points, int dpi);
39 void BLF_exit(void);
40
41 void BLF_cache_clear(void);
42
43 int BLF_load(const char *name);
44 int BLF_load_mem(const char *name, const unsigned char *mem, int mem_size);
45
46 int BLF_load_unique(const char *name);
47 int BLF_load_mem_unique(const char *name, const unsigned char *mem, int mem_size);
48
49 void BLF_unload(const char *name);
50
51 /* Attach a file with metrics information from memory. */
52 void BLF_metrics_attach(int fontid, unsigned char *mem, int mem_size);
53
54 void BLF_aspect(int fontid, float x, float y, float z);
55 void BLF_position(int fontid, float x, float y, float z);
56 void BLF_size(int fontid, int size, int dpi);
57
58 /* Set a 4x4 matrix to be multiplied before draw the text.
59  * Remember that you need call BLF_enable(BLF_MATRIX)
60  * to enable this.
61  *
62  * The order of the matrix is like GL:
63  *
64  *  | m[0]  m[4]  m[8]  m[12] |
65  *  | m[1]  m[5]  m[9]  m[13] |
66  *  | m[2]  m[6]  m[10] m[14] |
67  *  | m[3]  m[7]  m[11] m[15] |
68  *
69  */
70 void BLF_matrix(int fontid, const double m[16]);
71
72 /* Draw the string using the default font, size and dpi. */
73 void BLF_draw_default(float x, float y, float z, const char *str, size_t len);
74 void BLF_draw_default_ascii(float x, float y, float z, const char *str, size_t len);
75
76 /* Draw the string using the current font. */
77 void BLF_draw(int fontid, const char *str, size_t len);
78 void BLF_draw_ascii(int fontid, const char *str, size_t len);
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 /* The next both function return the width and height
86  * of the string, using the current font and both value 
87  * are multiplied by the aspect of the font.
88  */
89 float BLF_width(int fontid, const char *str);
90 float BLF_height(int fontid, const char *str);
91
92 /* Return dimensions of the font without any sample text. */
93 float BLF_height_max(int fontid);
94 float BLF_width_max(int fontid);
95 float BLF_descender(int fontid);
96 float BLF_ascender(int fontid);
97
98 /* The following function return the width and height of the string, but
99  * just in one call, so avoid extra freetype2 stuff.
100  */
101 void BLF_width_and_height(int fontid, const char *str, float *width, float *height);
102
103 /* For fixed width fonts only, returns the width of a
104  * character.
105  */
106 float BLF_fixed_width(int fontid);
107
108 /* and this two function return the width and height
109  * of the string, using the default font and both value
110  * are multiplied by the aspect of the font.
111  */
112 void  BLF_width_and_height_default(const char *str, float *width, float *height);
113 float BLF_width_default(const char *str);
114 float BLF_height_default(const char *str);
115
116 /* Set rotation for default font. */
117 void BLF_rotation_default(float angle);
118
119 /* Enable/disable options to the default font. */
120 void BLF_enable_default(int option);
121 void BLF_disable_default(int option);
122
123 /* By default, rotation and clipping are disable and
124  * have to be enable/disable using BLF_enable/disable.
125  */
126 void BLF_rotation(int fontid, float angle);
127 void BLF_clipping(int fontid, float xmin, float ymin, float xmax, float ymax);
128 void BLF_clipping_default(float xmin, float ymin, float xmax, float ymax);
129 void BLF_blur(int fontid, int size);
130
131 void BLF_enable(int fontid, int option);
132 void BLF_disable(int fontid, int option);
133
134 /* Shadow options, level is the blur level, can be 3, 5 or 0 and
135  * the other argument are the rgba color.
136  * Take care that shadow need to be enable using BLF_enable!!!
137  */
138 void BLF_shadow(int fontid, int level, float r, float g, float b, float a);
139
140 /* Set the offset for shadow text, this is the current cursor
141  * position plus this offset, don't need call BLF_position before
142  * this function, the current position is calculate only on
143  * BLF_draw, so it's safe call this whenever you like.
144  */
145 void BLF_shadow_offset(int fontid, int x, int y);
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  *
150  *     BLF_buffer(my_fbuf, my_cbuf, 100, 100, 4, TRUE);
151  *
152  *     ... set color, position and draw ...
153  *
154  *     BLF_buffer(NULL, NULL, 0, 0, 0, FALSE);
155  */
156 void BLF_buffer(int fontid, float *fbuf, unsigned char *cbuf, int w, int h, int nch, struct ColorManagedDisplay *display);
157
158 /* Set the color to be used for text. */
159 void BLF_buffer_col(int fontid, float r, float g, float b, float a);
160
161 /* Draw the string into the buffer, this function draw in both buffer, float and unsigned char _BUT_
162  * it's not necessary set both buffer, NULL is valid here.
163  */
164 void BLF_draw_buffer(int fontid, const char *str);
165
166 /* Add a path to the font dir paths. */
167 void BLF_dir_add(const char *path);
168
169 /* Remove a path from the font dir paths. */
170 void BLF_dir_rem(const char *path);
171
172 /* Return an array with all the font dir (this can be used for filesel) */
173 char **BLF_dir_get(int *ndir);
174
175 /* Free the data return by BLF_dir_get. */
176 void BLF_dir_free(char **dirs, int count);
177
178 /* font->flags. */
179 #define BLF_ROTATION         (1 << 0)
180 #define BLF_CLIPPING         (1 << 1)
181 #define BLF_SHADOW           (1 << 2)
182 #define BLF_KERNING_DEFAULT  (1 << 3)
183 #define BLF_MATRIX           (1 << 4)
184 #define BLF_ASPECT           (1 << 5)
185
186 #define BLF_DRAW_STR_DUMMY_MAX 1024
187
188 /* XXX, bad design */
189 extern int blf_mono_font;
190 extern int blf_mono_font_render; /* don't mess drawing with render threads. */
191
192 #endif /* __BLF_API_H__ */