Back to index

supertuxkart  0.5+dfsg1
Functions
BMF_Api.h File Reference
#include "BMF_Fonts.h"
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

BMF_FontBMF_GetFont (BMF_FontType font)
 ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
int BMF_DrawCharacter (BMF_Font *font, char c)
 Draws a character at the current raster position.
int BMF_DrawString (BMF_Font *font, const char *str)
 Draws a string at the current raster position.
int BMF_GetCharacterWidth (BMF_Font *font, char c)
 Returns the width of a character in pixels.
int BMF_GetStringWidth (BMF_Font *font, char *str)
 Returns the width of a string of characters.
void BMF_GetBoundingBox (BMF_Font *font, int *xmin_r, int *ymin_r, int *xmax_r, int *ymax_r)
 Returns the bounding box of the font.
int BMF_GetFontTexture (BMF_Font *font)
 Convert the given font to a texture, and return the GL texture ID of the texture.
void BMF_DrawStringTexture (BMF_Font *font, char *string, float x, float y, float z)
 Draw the given str at the point x, y, z, using texture coordinates.

Function Documentation

int BMF_DrawCharacter ( BMF_Font font,
char  c 
)

Draws a character at the current raster position.

Parameters:
fontThe font to use.
cThe character to draw.
Returns:
Indication of success (0 == error).

Definition at line 119 of file BMF_Api.cpp.

{
       char str[2] = {c, '\0'};
       return BMF_DrawString(font, str);
}

Here is the call graph for this function:

int BMF_DrawString ( BMF_Font font,
const char *  str 
)

Draws a string at the current raster position.

Parameters:
fontThe font to use.
strThe string to draw.
Returns:
Indication of success (0 == error).

Definition at line 126 of file BMF_Api.cpp.

{
       if (!font) return 0;
       ((BMF_BitmapFont*)font)->drawString(str);
       return 1;
}

Here is the caller graph for this function:

void BMF_DrawStringTexture ( BMF_Font font,
char *  string,
float  x,
float  y,
float  z 
)

Draw the given str at the point x, y, 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.

Parameters:
fontThe font to draw with.
stringThe c-string to draw.
xThe x coordinate to start drawing at.
yThe y coordinate to start drawing at.
zThe z coordinate to start drawing at.

Definition at line 159 of file BMF_Api.cpp.

                                                                                    {
       if (!font) return;
       ((BMF_BitmapFont*)font)->drawStringTexture(string, x, y, z);
}
void BMF_GetBoundingBox ( BMF_Font font,
int *  xmin_r,
int *  ymin_r,
int *  xmax_r,
int *  ymax_r 
)

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.

Definition at line 148 of file BMF_Api.cpp.

{
       if (!font) return;
       ((BMF_BitmapFont*)font)->getBoundingBox(*xmin_r, *ymin_r, *xmax_r, *ymax_r);
}
int BMF_GetCharacterWidth ( BMF_Font font,
char  c 
)

Returns the width of a character in pixels.

Parameters:
fontThe font to use.
cThe character.
Returns:
The length.

Definition at line 134 of file BMF_Api.cpp.

{
       char str[2] = {c, '\0'};
       return BMF_GetStringWidth(font, str);
}

Here is the call graph for this function:

***** BEGIN GPL/BL DUAL LICENSE BLOCK *****

This program is free software; you can redistribute it and/or modify it under the terms of the GNU bteral Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. The Blender Foundation also sells licenses for use in proprietary software under the Blender License. See http://www.blender.org/BL/ for information about this.

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 bteral Public License for more details.

You should have received a copy of the GNU bteral 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/BL DUAL LICENSE BLOCK *****

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. Returns the font for a given font type.

Parameters:
fontThe font to retrieve.
Returns:
The font (or nil if not found).

Definition at line 81 of file BMF_Api.cpp.

{
       switch (font)
       {
#if BMF_INCLUDE_HELV10
       case BMF_kHelvetica10:      return (BMF_Font*) &bmfHelv10;
#endif // BMF_INCLUDE_HELV10
#if BMF_INCLUDE_HELV12
       case BMF_kHelvetica12:      return (BMF_Font*) &bmfHelv12;
#endif // BMF_INCLUDE_HELV12
#if BMF_INCLUDE_HELVB8
       case BMF_kHelveticaBold8:   return (BMF_Font*) &bmfHelvb8;
#endif // BMF_INCLUDE_HELVB8
#if BMF_INCLUDE_HELVB10
       case BMF_kHelveticaBold10:  return (BMF_Font*) &bmfHelvb10;
#endif // BMF_INCLUDE_HELVB10
#if BMF_INCLUDE_HELVB12
       case BMF_kHelveticaBold12:  return (BMF_Font*) &bmfHelvb12;
#endif // BMF_INCLUDE_HELVB12
#if BMF_INCLUDE_HELVB14
       case BMF_kHelveticaBold14:  return (BMF_Font*) &bmfHelvb14;
#endif // BMF_INCLUDE_HELVB12
#if BMF_INCLUDE_SCR12
       case BMF_kScreen12:  return (BMF_Font*) &bmfScreen12;
#endif // BMF_INCLUDE_SCR12
#if BMF_INCLUDE_SCR14
       case BMF_kScreen14:  return (BMF_Font*) &bmfScreen14;
#endif // BMF_INCLUDE_SCR14
#if BMF_INCLUDE_SCR15
       case BMF_kScreen15:  return (BMF_Font*) &bmfScreen15;
#endif // BMF_INCLUDE_SCR15
       default:
              break;
       }
       return 0;
}

Here is the caller graph for this function:

int BMF_GetFontTexture ( BMF_Font font)

Convert the given 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.

Parameters:
fontThe font to create the texture from.
Returns:
The GL texture ID of the new texture, or -1 if unable to create.

Definition at line 154 of file BMF_Api.cpp.

                                       {
       if (!font) return -1;
       return ((BMF_BitmapFont*)font)->getTexture();
}
int BMF_GetStringWidth ( BMF_Font font,
char *  str 
)

Returns the width of a string of characters.

Parameters:
fontThe font to use.
strThe string.
Returns:
The length.

Definition at line 141 of file BMF_Api.cpp.

{
       if (!font) return 0;
       return ((BMF_BitmapFont*)font)->getStringWidth(str);
}

Here is the caller graph for this function: