diff options
Diffstat (limited to 'intern/bmfont/BMF_Api.h')
-rw-r--r-- | intern/bmfont/BMF_Api.h | 162 |
1 files changed, 0 insertions, 162 deletions
diff --git a/intern/bmfont/BMF_Api.h b/intern/bmfont/BMF_Api.h deleted file mode 100644 index 252f60623a7..00000000000 --- a/intern/bmfont/BMF_Api.h +++ /dev/null @@ -1,162 +0,0 @@ -/** - * $Id$ - * ***** BEGIN GPL LICENSE BLOCK ***** - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software Foundation, - * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - * - * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. - * All rights reserved. - * - * The Original Code is: all of this file. - * - * Contributor(s): none yet. - * - * ***** END GPL LICENSE BLOCK ***** - */ - -/** - - * $Id$ - * Copyright (C) 2001 NaN Technologies B.V. - * - * API of the OpenGL bitmap font library. - * Currently draws fonts using the glBitmap routine. - * This implies that drawing speed is heavyly dependant on - * the 2D capabilities of the graphics card. - */ - -#ifndef __BMF_API_H -#define __BMF_API_H - -#ifdef __cplusplus -extern "C" { -#endif - -#include "BMF_Fonts.h" - -/** - * Returns the font for a given font type. - * @param font The font to retrieve. - * @return The font (or nil if not found). - */ -BMF_Font* BMF_GetFont(BMF_FontType font); - -/** - * Draws a character at the current raster position. - * @param font The font to use. - * @param c The character to draw. - * @return Indication of success (0 == error). - */ -int BMF_DrawCharacter(BMF_Font* font, char c); - -/** - * Draws a string at the current raster position. - * @param font The font to use. - * @param str The string to draw. - * @return Indication of success (0 == error). - */ -int BMF_DrawString(BMF_Font* font, char* str); - -/** - * Returns the width of a character in pixels. - * @param font The font to use. - * @param c The character. - * @return The length. - */ -int BMF_GetCharacterWidth(BMF_Font* font, char c); - -/** - * Returns the width of a string of characters. - * @param font The font to use. - * @param str The string. - * @return The length. - */ -int BMF_GetStringWidth(BMF_Font* font, char* str); - -/** - * Returns the bounding box of a string of characters. - * @param font The font to use. - * @param str The string. - * @param llx Lower left x coord - * @param lly Lower left y coord - * @param urx Upper right x coord - * @param ury Upper right y coord - */ -void BMF_GetStringBoundingBox(BMF_Font* font, char* str, float*llx, float *lly, float *urx, float *ury); - - -/** - * Returns the bounding box of the font. The width and - * height represent the bounding box of the union of - * all glyps. The minimum and maximum values of the - * box represent the extent of the font and its positioning - * about the origin. - */ -void BMF_GetFontBoundingBox(BMF_Font* font, int *xmin_r, int *ymin_r, int *xmax_r, int *ymax_r); - -/** - * Same as GetFontBoundingBox but only returns the height - */ -int BMF_GetFontHeight(BMF_Font* font); - -/** - * Convert the given @a font to a texture, and return the GL texture - * ID of the texture. If the texture ID is bound, text can - * be drawn using the texture by calling DrawStringTexture. - * - * @param font The font to create the texture from. - * @return The GL texture ID of the new texture, or -1 if unable - * to create. - */ -int BMF_GetFontTexture(BMF_Font* font); - -/** - * Draw the given @a str at the point @a x, @a y, @a z, using - * texture coordinates. This assumes that an appropriate texture - * has been bound, see BMF_BitmapFont::GetTexture(). The string - * is drawn along the positive X axis. - * - * @param font The font to draw with. - * @param string The c-string to draw. - * @param x The x coordinate to start drawing at. - * @param y The y coordinate to start drawing at. - * @param z The z coordinate to start drawing at. - */ -void BMF_DrawStringTexture(BMF_Font* font, char* string, float x, float y, float z); - - /** - * Draw the given @a string at the point @a xpos, @a ypos using - * char and float buffers. - * - * @param string The c-string to draw. - * @param xpos The x coordinate to start drawing at. - * @param ypos The y coordinate to start drawing at. - * @param fgcol The forground color. - * @param bgcol The background color. - * @param buf Unsigned char image buffer, when NULL to not operate on it. - * @param fbuf float image buffer, when NULL to not operate on it. - * @param w image buffer width. - * @param h image buffer height. - * @param channels number of channels in the image (3 or 4 - currently) - */ -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); - - -#ifdef __cplusplus -} -#endif - -#endif /* __BMF_API_H */ - |