Add blender internal font.
[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(void);
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 void BLF_set(int fontid);
41 void BLF_aspect(float aspect);
42 void BLF_position(float x, float y, float z);
43 void BLF_size(int size, int dpi);
44 void BLF_draw(char *str);
45
46 void BLF_boundbox(char *str, struct rctf *box);
47 float BLF_width(char *str);
48 float BLF_height(char *str);
49 void BLF_rotation(float angle);
50 void BLF_clipping(float xmin, float ymin, float xmax, float ymax);
51
52 void BLF_enable(int option);
53 void BLF_disable(int option);
54
55 /* return the id of the current font. */
56 int BLF_get(void);
57
58 /* Read the .Blanguages file, return 1 on success or 0 if fails. */
59 int BLF_lang_init(void);
60
61 /* Free the memory allocate for the .Blanguages. */
62 void BLF_lang_exit(void);
63
64 /* Set the current Language. */
65 void BLF_lang_set(int id);
66
67 /* Return a string with all the Language available. */
68 char *BLF_lang_pup(void);
69
70 /* Return the number of invalid lines in the .Blanguages file,
71  * zero means no error found.
72  */
73 int BLF_lang_error(void);
74
75 /* Return the code string for the specified language code. */
76 char *BLF_lang_find_code(short langid);
77
78 /* Add a path to the font dir paths. */
79 void BLF_dir_add(const char *path);
80
81 /* Remove a path from the font dir paths. */
82 void BLF_dir_rem(const char *path);
83
84 /* Return an array with all the font dir (this can be used for filesel) */
85 char **BLF_dir_get(int *ndir);
86
87 /* Free the data return by BLF_dir_get. */
88 void BLF_dir_free(char **dirs, int count);
89
90 /* font->flags. */
91 #define BLF_ROTATION (1<<0)
92 #define BLF_CLIPPING (1<<1)
93
94 #endif /* BLF_API_H */