Added some missing directory includes for CMake. Still some linker errors to resolve.
[blender.git] / source / blender / ftfont / FTF_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) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef _FTF_API_H
31 #define _FTF_API_H
32
33 #define FTF_EXPORT
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #include <stdio.h>
40 #include "FTF_Settings.h"
41
42 /**
43  * Set Font Size
44  * @param int size
45  */
46 FTF_EXPORT void FTF_SetSize(int size);
47
48 /**
49  * Get Font Size
50  * @return Font size
51  */
52 FTF_EXPORT int FTF_GetSize(void);
53
54 /**
55  * Ascender
56  * @return Ascend size
57  */
58 FTF_EXPORT int FTF_Ascender(void);
59
60 /**
61  * Descender
62  * @return Descend size
63  */
64 FTF_EXPORT int FTF_Descender(void);
65
66 /**
67  * String Translation and Code Conversion
68  * @param str source string
69  * @param ustr distnation string
70  * @param flag mode flag
71  */
72 FTF_EXPORT void FTF_TransConvString(char* str, char* ustr, unsigned int flag);
73
74 /**
75  * Draw a character at the current raster position.
76  * @param c the character to draw
77  * @param mode flag to forward to FTF_TransConvString()
78  * @return Width drawing
79  */
80 //FTF_EXPORT float FTF_DrawCharacter(char c, unsigned int flag);
81
82 /**
83  * Draws a string at the current raster postion.
84  * @param str The string to draw
85  * @param mode flag to forward to FTF_TransConvString()
86  * @return Width drawing
87  */
88 FTF_EXPORT float FTF_DrawString(char* str, unsigned int flag);
89
90
91 /**
92  * Get a character width
93  * @param mode flag to forward to FTF_TransConvString()
94  */
95 FTF_EXPORT float FTF_GetCharacterWidth(char c, unsigned int flag);
96
97
98 /**
99  * Get a string width
100  * @param mode flag to forward to FTF_TransConvString()
101  */
102 FTF_EXPORT float FTF_GetStringWidth(char* str, unsigned int flag);
103
104 /**
105  * Get Bounding Box
106  * @param llx   Lower left near x coord
107  * @param lly   Lower left near y coord
108  * @param llz   Lower left near z coord
109  * @param urx   Upper right far x coord
110  * @param ury   Upper right far y coord
111  * @param urz   Upper right far z coord
112  * @param mode flag to forward to FTF_TransConvString()
113  * not test yet.
114  */
115 FTF_EXPORT void FTF_GetBoundingBox(char* str, float*llx, float *lly, float *llz, float *urx, float *ury, float *urz, unsigned int flag);
116
117 /**
118  * Following stuff added by phase, ton
119  */
120
121 /**
122  * SetFontSize
123  * @param size
124  */
125 FTF_EXPORT void FTF_SetFontSize(char size);
126
127 /**
128  * SetFont
129  * @param str
130  * @param size
131  */
132 FTF_EXPORT int FTF_SetFont(const unsigned char* str, int datasize, int fontsize);
133
134 /**
135  * SetLanguage
136  * @param str
137  * not test yet.
138  */
139 FTF_EXPORT void FTF_SetLanguage(char* str);
140
141 /**
142  * SetLanguage
143  * @param str
144  * not tested yet.
145  */
146 FTF_EXPORT void FTF_SetEncoding(char* str);
147
148 FTF_EXPORT void FTF_SetPosition(float x, float y);
149 FTF_EXPORT void FTF_SetMode(int mode);
150 FTF_EXPORT void FTF_SetScale(float fsize);
151
152 FTF_EXPORT void FTF_End(void);
153
154 /* Font preview functions */
155 FTF_EXPORT int FTF_GetNewFont (const unsigned char *str, int datasize, int fontsize);
156 FTF_EXPORT float FTF_DrawNewFontString(char* str, unsigned int flag);
157
158 #ifdef __cplusplus
159 }
160 #endif
161
162 #endif /* __FTF_API_H */
163