svn merge -r 14236:14505 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender-staging.git] / intern / bmfont / BMF_Api.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL 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.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /**
30
31  * $Id$
32  * Copyright (C) 2001 NaN Technologies B.V.
33  *
34  * API of the OpenGL bitmap font library.
35  * Currently draws fonts using the glBitmap routine.
36  * This implies that drawing speed is heavyly dependant on
37  * the 2D capabilities of the graphics card.
38  */
39
40 #ifndef __BMF_API_H
41 #define __BMF_API_H
42
43 #ifdef __cplusplus
44 extern "C" { 
45 #endif
46
47 #include "BMF_Fonts.h"
48
49 /**
50  * Returns the font for a given font type.
51  * @param font  The font to retrieve.
52  * @return The font (or nil if not found).
53  */
54 BMF_Font* BMF_GetFont(BMF_FontType font);
55
56 /**
57  * Draws a character at the current raster position.
58  * @param font  The font to use.
59  * @param c             The character to draw.
60  * @return Indication of success (0 == error).
61  */
62 int BMF_DrawCharacter(BMF_Font* font, char c);
63
64 /**
65  * Draws a string at the current raster position.
66  * @param font  The font to use.
67  * @param str   The string to draw.
68  * @return Indication of success (0 == error).
69  */
70 int BMF_DrawString(BMF_Font* font, char* str);
71
72 /**
73  * Returns the width of a character in pixels.
74  * @param font  The font to use.
75  * @param c             The character.
76  * @return The length.
77  */
78 int BMF_GetCharacterWidth(BMF_Font* font, char c);
79
80 /**
81  * Returns the width of a string of characters.
82  * @param font  The font to use.
83  * @param str   The string.
84  * @return The length.
85  */
86 int BMF_GetStringWidth(BMF_Font* font, char* str);
87
88 /**
89  * Returns the bounding box of a string of characters.
90  * @param font  The font to use.
91  * @param str   The string.
92  * @param llx   Lower left x coord
93  * @param lly   Lower left y coord
94  * @param urx   Upper right x coord
95  * @param ury   Upper right y coord
96  */
97 void BMF_GetStringBoundingBox(BMF_Font* font, char* str, float*llx, float *lly, float *urx, float *ury);
98
99
100 /**
101  * Returns the bounding box of the font. The width and
102  * height represent the bounding box of the union of
103  * all glyps. The minimum and maximum values of the
104  * box represent the extent of the font and its positioning
105  * about the origin.
106  */
107 void BMF_GetFontBoundingBox(BMF_Font* font, int *xmin_r, int *ymin_r, int *xmax_r, int *ymax_r);
108
109 /**
110  * Same as GetFontBoundingBox but only returns the height
111  */
112 int BMF_GetFontHeight(BMF_Font* font);
113
114 /**
115  * Convert the given @a font to a texture, and return the GL texture
116  * ID of the texture. If the texture ID is bound, text can
117  * be drawn using the texture by calling DrawStringTexture.
118  * 
119  * @param font The font to create the texture from.
120  * @return The GL texture ID of the new texture, or -1 if unable
121  * to create.
122  */
123 int BMF_GetFontTexture(BMF_Font* font);
124
125 /**
126  * Draw the given @a str at the point @a x, @a y, @a z, using
127  * texture coordinates. This assumes that an appropriate texture
128  * has been bound, see BMF_BitmapFont::GetTexture(). The string
129  * is drawn along the positive X axis.
130  * 
131  * @param font The font to draw with.
132  * @param string The c-string to draw.
133  * @param x The x coordinate to start drawing at.
134  * @param y The y coordinate to start drawing at.
135  * @param z The z coordinate to start drawing at.
136  */
137 void BMF_DrawStringTexture(BMF_Font* font, char* string, float x, float y, float z);
138
139         /**
140  * Draw the given @a string at the point @a xpos, @a ypos using
141  * char and float buffers.
142  * 
143  * @param string The c-string to draw.
144  * @param xpos The x coordinate to start drawing at.
145  * @param ypos The y coordinate to start drawing at.
146  * @param fgcol The forground color.
147  * @param bgcol The background color.
148  * @param buf Unsigned char image buffer, when NULL to not operate on it.
149  * @param fbuf float image buffer, when NULL to not operate on it.
150  * @param w image buffer width.
151  * @param h image buffer height.
152  * @param channels number of channels in the image (3 or 4 - currently)
153          */
154 void BMF_DrawStringBuf(BMF_Font* font, char *str, int posx, int posy, float *col, unsigned char *buf, float *fbuf, int w, int h, int channels);
155
156
157 #ifdef __cplusplus
158 }
159 #endif
160
161 #endif /* __BMF_API_H */
162