SDLGameEngine

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

Data Structures | Defines | Enumerations | Functions

# include/sgefont.h File Reference

Bitmap font handling and effects. More...

Go to the source code of this file.

## Data Structures
struct | SGEBITMAPFONT
| a bitmap font structure More...
struct | SGEFONT
| a font structure More...
struct | SGEFONTFXFADEINFO
| internal, holds information about a current fade state More...
struct | SGEFONTFXCOUNTDOWNINFO
| internal, holds information about a current count down More...
struct | SGEFONTFX
| holds information about a font effect More...
struct | SGEFONTFXFADEINOUTINFO
| internal, holds information about a in and out fading effect More...
## Defines
#define | SGEFONT_BITMAP 1
| font is a sge bitmap font
## Enumerations
enum | SGEFONTFX_TYPES { SGEFONTFX_FADE_IN, SGEFONTFX_FADE_OUT, SGEFONTFX_FADE_INOUT, SGEFONTFX_MOVE_IN, SGEFONTFX_MOVE_OUT, SGEFONTFX_MOVE_INOUT, SGEFONTFX_COUNTDOWN }
| different font effects More...
enum | SGEFONTFX_MOVEMENT { SGEFONTFX_MOVE_LINEAR, SGEFONTFX_MOVE_SLOWDOWN, SGEFONTFX_MOVE_ACCELERATE, SGEFONTFX_MOVE_BOUNCE }
| different move effects More...
## Functions
SGEFONT * | sgeFontNew (int type)
| create a new empty font
SGEFONT * | sgeFontNewFile (SGEFILE *f, int type, const char *filename)
| create a new font from a file
void | sgeFontDestroy (SGEFONT *f)
| destroy a font and free its resources
int | sgeFontGetLineHeight (SGEFONT *f)
| get the height of a line with the font
int | sgeFontPrint (SGEFONT *f, SDL_Surface *dest, int x, int y, const char *text)
| print a text with the font
int | sgeFontGetWidth (SGEFONT *f, const char *text)
| get the width of a text
void | sgeFontIgnoreAlpha (SGEFONT *f)
| ignore the alpha channel of a font
void | sgeFontUseAlpha (SGEFONT *f)
| use the alpha channel of a font (default)
SGEFONTFX * | sgeFontFXNew (SGEFONT *f, Uint32 fxtype, Uint8 movement, Uint32 runtime, Uint32 charOffset, int startx, int starty, int endx, int endy, const char *text)
| create a new font effect
void | sgeFontFXDraw (SGEFONTFX *fx)
| draw the effect
void | sgeFontFXDestroy (SGEFONTFX *fx)
| destroy the effect and free its resources
void | sgeFontFXCountdownSetValues (SGEFONTFX *fx, Sint32 start, Sint32 end)
| set the value range for a count down (or up) effect
void | sgeFontFXPreDelay (SGEFONTFX *fx, Uint32 delay)
| set the miliseconds to wait before starting the effect
void | sgeFontFXHideOnPreDelay (SGEFONTFX *fx, Uint8 yesno)
| hide the effect until pre delay is over
void | sgeFontFXPostDelay (SGEFONTFX *fx, Uint32 delay)
| wait after a effect is finished until it actually is treated as finished
void | sgeFontFXSetFinished (SGEFONTFX *fx)
| force an early finish of a effect
int | sgeFontFXFinished (SGEFONTFX *fx)
| check if a effect is finished
void | sgeFontFXSetTarget (SGEFONTFX *fx, SDL_Surface *surface)
| change render target (default screen) of the effect

## Detailed Description

Bitmap font handling and effects.

Definition in file sgefont.h.

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines