Yes I did it again ;)
[blender-staging.git] / intern / bmfont / BMF_Api.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  *
37  * API of the OpenGL bitmap font library.
38  * Currently draws fonts using the glBitmap routine.
39  * This implies that drawing speed is heavyly dependant on
40  * the 2D capabilities of the graphics card.
41  */
42
43 #ifndef __BMF_API_H
44 #define __BMF_API_H
45
46 #ifdef HAVE_CONFIG_H
47 #include <config.h>
48 #endif
49
50 #ifdef __cplusplus
51 extern "C" { 
52 #endif
53
54 #include "BMF_Fonts.h"
55
56 /**
57  * Returns the font for a given font type.
58  * @param font  The font to retrieve.
59  * @return The font (or nil if not found).
60  */
61 BMF_Font* BMF_GetFont(BMF_FontType font);
62
63 /**
64  * Draws a character at the current raster position.
65  * @param font  The font to use.
66  * @param c             The character to draw.
67  * @return Indication of success (0 == error).
68  */
69 int BMF_DrawCharacter(BMF_Font* font, char c);
70
71 /**
72  * Draws a string at the current raster position.
73  * @param font  The font to use.
74  * @param str   The string to draw.
75  * @return Indication of success (0 == error).
76  */
77 int BMF_DrawString(BMF_Font* font, char* str);
78
79 /**
80  * Returns the width of a character in pixels.
81  * @param font  The font to use.
82  * @param c             The character.
83  * @return The length.
84  */
85 int BMF_GetCharacterWidth(BMF_Font* font, char c);
86
87 /**
88  * Returns the width of a string of characters.
89  * @param font  The font to use.
90  * @param str   The string.
91  * @return The length.
92  */
93 int BMF_GetStringWidth(BMF_Font* font, char* str);
94
95 /**
96  * Returns the bounding box of the font. The width and
97  * height represent the bounding box of the union of
98  * all glyps. The minimum and maximum values of the
99  * box represent the extent of the font and its positioning
100  * about the origin.
101  */
102 void BMF_GetBoundingBox(BMF_Font* font, int *xmin_r, int *ymin_r, int *xmax_r, int *ymax_r);
103
104 /**
105  * Convert the given @a font to a texture, and return the GL texture
106  * ID of the texture. If the texture ID is bound, text can
107  * be drawn using the texture by calling DrawStringTexture.
108  * 
109  * @param font The font to create the texture from.
110  * @return The GL texture ID of the new texture, or -1 if unable
111  * to create.
112  */
113 int BMF_GetFontTexture(BMF_Font* font);
114
115 /**
116  * Draw the given @a str at the point @a x, @a y, @a z, using
117  * texture coordinates. This assumes that an appropriate texture
118  * has been bound, see BMF_BitmapFont::GetTexture(). The string
119  * is drawn along the positive X axis.
120  * 
121  * @param font The font to draw with.
122  * @param string The c-string to draw.
123  * @param x The x coordinate to start drawing at.
124  * @param y The y coordinate to start drawing at.
125  * @param z The z coordinate to start drawing at.
126  */
127 void BMF_DrawStringTexture(BMF_Font* font, char* string, float x, float y, float z);
128
129 #ifdef __cplusplus
130 }
131 #endif
132
133 #endif /* __BMF_API_H */
134