Add masks to all channels in SDL_CreateRGBSurface calls
[sdl_tbmf.git] / README
blob75e28eec8ae31f4dd814694f71cf3cf13719b756
1 SDL_tbmf is a library for loading and using TBMF files in a SDL application.
3 The generic installation insctructions are in file INSTALL and RPM
4 installation instructions could be found from INSTALL.RPM.
6 Package contains four header files that you might want to use:
7         SDL_tbmf.h
8                 contains the Font class definition. Use it in those parts of
9                 your program which don't make use of TextSurface class or
10                 drawText() function, but still need the Font.
11         SDL_tbmf_errors.h
12                 contains the Error class definition. You can use it if you
13                 want to catch errors that library calls might throw if an
14                 error happens.
15         SDL_tbmf_drawtext.h
16                 contains the drawText() function. It can be used to type text
17                 to some surface with some Font. If you use this header,
18                 SDL_tbmf.h is not needed to include because this header
19                 includes it already.
20         SDL_tbmf_textsurf.h
21                 contains the TextSurface class, which is usable in cases where
22                 same text is used several times. This header also includes
23                 SDL_tbmf.h.
25 Everything in the header files is defined under sdl_tbmf namespace so you
26 should use either "using namespace sdl_tbmf;" or "sdl_tbmf::" syntax to use
27 headers.
29 If you are interested in TBMF file format, there is TBMF-spec.txt file in doc
30 directory. You can make also TBMF files from TTF files with ttf2tbmf program.
32 Library should be quite easy to use. I have made a simple example program that
33 uses the library. Its name is tbmf-typer.
36 Comments, suggestions and bug reports are welcome. You can send me E-mail.
38 Tuomas Suutari <thsuut@utu.fi>