console copy text was upside down.
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /*
75  * For fixed width fonts only, returns the width of a
76  * character.
77  */
78 float BLF_fixed_width(void);
79
80 /*
81  * and this two function return the width and height
82  * of the string, using the default font and both value
83  * are multiplied by the aspect of the font.
84  */
85 float BLF_width_default(char *str);
86 float BLF_height_default(char *str);
87
88 /*
89  * set rotation for default font
90  */
91 void BLF_default_rotation(float angle);
92
93 /*
94  * By default, rotation and clipping are disable and
95  * have to be enable/disable using BLF_enable/disable.
96  */
97 void BLF_rotation(float angle);
98 void BLF_clipping(float xmin, float ymin, float xmax, float ymax);
99 void BLF_blur(int size);
100
101 void BLF_enable(int option);
102 void BLF_disable(int option);
103
104 /*
105  * Shadow options, level is the blur level, can be 3, 5 or 0 and
106  * the other argument are the rgba color.
107  * Take care that shadow need to be enable using BLF_enable!!.
108  */
109 void BLF_shadow(int level, float r, float g, float b, float a);
110
111 /*
112  * Set the offset for shadow text, this is the current cursor
113  * position plus this offset, don't need call BLF_position before
114  * this function, the current position is calculate only on
115  * BLF_draw, so it's safe call this whenever you like.
116  */
117 void BLF_shadow_offset(int x, int y);
118
119 /*
120  * Search the path directory to the locale files, this try all
121  * the case for Linux, Win and Mac.
122  */
123 void BLF_lang_init(void);
124
125 /* Set the current locale. */
126 void BLF_lang_set(const char *);
127
128 /* Set the current encoding name. */
129 void BLF_lang_encoding_name(const char *str);
130
131 /* Add a path to the font dir paths. */
132 void BLF_dir_add(const char *path);
133
134 /* Remove a path from the font dir paths. */
135 void BLF_dir_rem(const char *path);
136
137 /* Return an array with all the font dir (this can be used for filesel) */
138 char **BLF_dir_get(int *ndir);
139
140 /* Free the data return by BLF_dir_get. */
141 void BLF_dir_free(char **dirs, int count);
142
143 /* font->flags. */
144 #define BLF_ROTATION (1<<0)
145 #define BLF_CLIPPING (1<<1)
146 #define BLF_SHADOW (1<<2)
147 #define BLF_KERNING_DEFAULT (1<<3)
148
149 /* font->mode. */
150 #define BLF_MODE_TEXTURE 0
151 #define BLF_MODE_BITMAP 1
152
153 #endif /* BLF_API_H */