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