Data Structures | |
struct | OSL_FONT |
struct | OSL_FONTINFO |
struct | OSL_FONT_FORMAT_HEADER |
Macros | |
#define | oslSetFont(f) (osl_curFont = f) |
#define | OSL_FONT_OFT 1 |
#define | OSL_FONT_INTRA 2 |
#define | oslDrawStringf(x, y,...) { char __str[1000]; sprintf(__str , __VA_ARGS__); oslDrawString(x, y, __str); } |
Functions | |
void | oslInitConsole () |
OSL_FONT * | oslLoadFontFile (const char *filename) |
OSL_FONT * | oslLoadFont (OSL_FONTINFO *fi) |
void | oslDrawChar (int x, int y, unsigned char c) |
void | oslDrawString (int x, int y, const char *str) |
void | oslDrawStringLimited (int x, int y, int width, const char *str) |
void | oslConsolePrint (const char *str) |
void | oslSetTextColor (OSL_COLOR color) |
void | oslSetBkColor (OSL_COLOR color) |
void | oslDrawTextBox (int x0, int y0, int x1, int y1, const char *text, int format) |
void | oslDrawTextBoxByWords (int x0, int y0, int x1, int y1, const char *text, int format) |
void | oslDeleteFont (OSL_FONT *f) |
int | oslGetStringWidth (const char *str) |
int | oslGetTextBoxHeight (int width, int maxHeight, const char *text, int format) |
int | oslIntraFontInit (unsigned int options) |
OSL_FONT * | oslLoadIntraFontFile (const char *filename, unsigned int options) |
void | oslIntraFontSetStyle (OSL_FONT *f, float size, unsigned int color, unsigned int shadowColor, unsigned int options) |
float | oslIntraFontPrintColumn (OSL_FONT *f, float x, float y, float width, int autoBreakLine, const char *text) |
void | oslIntraFontShutdown () |
Variables | |
OSL_FONT * | osl_curFont |
int | osl_consolePosX |
int | osl_consolePosY |
OSL_FONT * | osl_sceFont |
Text functions in OSLib. Don't forget to look at the 'Debug Console' section (subsection of the 'Main' section).
#define oslSetFont | ( | f | ) | (osl_curFont = f) |
Sets the current font. For forward compatibilty, please use this function rather than osl_curFont = yourFont.
#define OSL_FONT_OFT 1 |
Font type OFT
#define OSL_FONT_INTRA 2 |
Font type INTRA
#define oslDrawStringf | ( | x, | |
y, | |||
... | |||
) | { char __str[1000]; sprintf(__str , __VA_ARGS__); oslDrawString(x, y, __str); } |
Draws a formatted string litteral at the specified x and y positions.
void oslInitConsole | ( | ) |
Initializes the console. You do not need to call this anymore, as it's automatically done upon oslInitGfx.
OSL_FONT* oslLoadFontFile | ( | const char * | filename | ) |
Loads a font from a file. Remember that you can load virtual files located in RAM, see the VirtualFile section for more information. Also, there is an application (font2osl) which converts fonts to the OldSchool Library Font format (.oft).
OSL_FONT* oslLoadFont | ( | OSL_FONTINFO * | fi | ) |
Loads a font from a OSL_FONTINFO file (located in RAM). Rather use oslLoadFontFile, which is more friendly. Use this ONLY with OFT fonts (doesen't work with intraFont).
void oslDrawChar | ( | int | x, |
int | y, | ||
unsigned char | c | ||
) |
Draws a single character at the specified x and y positions. If you must draw several characters placed one after the other, use oslDrawString, as indiviudal oslDrawChar calls will be slightly slower.
void oslDrawString | ( | int | x, |
int | y, | ||
const char * | str | ||
) |
Draws a string litteral at the specified x and y positions.
void oslDrawStringLimited | ( | int | x, |
int | y, | ||
int | width, | ||
const char * | str | ||
) |
Draws a string litteral at the specified x and y positions limiting it to a given width.
void oslConsolePrint | ( | const char * | str | ) |
Outputs a text to the console at the current cursor position, and moves it. Here for debugging purposes, not very useful in a game.
void oslSetTextColor | ( | OSL_COLOR | color | ) |
Sets the current text color. This doesen't work with intraFont (use oslIntraFontSetStyle)
void oslSetBkColor | ( | OSL_COLOR | color | ) |
Sets the text background color. Setting a transparent color (e.g. RGBA(0, 0, 0, 0)) will disable drawing a background. In this case, the text rendering will be faster. This doesen't work with intraFont (use oslIntraFontSetStyle)
void oslDrawTextBox | ( | int | x0, |
int | y0, | ||
int | x1, | ||
int | y1, | ||
const char * | text, | ||
int | format | ||
) |
Draws a text box, that is, text contained in a rectangle. The text will automatically be wrapped at the end of a line and be placed below.
x0,y0 | Top-left corner of the text box. |
x1,y1 | Bottom-right corner of the text box. |
text | Text to be drawn. Can contain characters to make a carriage return. |
format | Let it 0. |
void oslDrawTextBoxByWords | ( | int | x0, |
int | y0, | ||
int | x1, | ||
int | y1, | ||
const char * | text, | ||
int | format | ||
) |
Draws a text box, that is, text contained in a rectangle. The text will automatically be wrapped at the end of a line and be placed below. Draw text by word's and not by char's
x0,y0 | Top-left corner of the text box. |
x1,y1 | Bottom-right corner of the text box. |
text | Text to be drawn. Can contain characters to make a carriage return. |
format | Let it 0. |
void oslDeleteFont | ( | OSL_FONT * | f | ) |
Deletes a font.
Warning: the font must NOT be currently selected (that is f != osl_curFont) else your program will crash the next time you'll try to draw a character (or later).
int oslGetStringWidth | ( | const char * | str | ) |
Returns the size (in pixels) of a text, using the currently selected font. Note that you can get the height of the text and some other parameters by exploring the OSL_FONT structure. The following sample shows you how to center a text horizontally and align it to the bottom of the screen:
int oslGetTextBoxHeight | ( | int | width, |
int | maxHeight, | ||
const char * | text, | ||
int | format | ||
) |
Returns the height (in pixels) which would take a text box drawn with oslDrawTextBox.
int oslIntraFontInit | ( | unsigned int | options | ) |
Inits intraFont (MUST be called before loading any pgf font). The same options will be applied to all intraFonts
options | INTRAFONT_XXX flags as defined above including flags related to CACHE (ored together) |
OSL_FONT* oslLoadIntraFontFile | ( | const char * | filename, |
unsigned int | options | ||
) |
Loads a font from a pgf file (intraFont). Use this if you want to load a pgf font with options different from the one passed to oslIntraFontInit.
void oslIntraFontSetStyle | ( | OSL_FONT * | f, |
float | size, | ||
unsigned int | color, | ||
unsigned int | shadowColor, | ||
unsigned int | options | ||
) |
Sets style for a pgf font (works ONLY with pgf font)
float oslIntraFontPrintColumn | ( | OSL_FONT * | f, |
float | x, | ||
float | y, | ||
float | width, | ||
int | autoBreakLine, | ||
const char * | text | ||
) |
Draw text along the baseline starting at x, y.
f | - A valid OSL_FONT with type OSL_FONT_INTRA |
x | - X position on screen |
y | - Y position on screen |
width | - column width for automatic line breaking (intraFontPrintColumn... versions only) |
autoBreakLine | - char length of text to draw (...Ex versions only) |
text | - Text to draw (ASCII & extended ASCII, S-JIS or UTF-8 encoded) |
void oslIntraFontShutdown | ( | ) |
Shuts down intraFont
OSL_FONT* osl_curFont |
Current font. You can read from it but please do not write to it, use oslSetFont instead.
int osl_consolePosX |
Console horizontal position (in pixels). Use oslMoveTo to move the cursor.
int osl_consolePosY |
Console vertical position (in pixels).
OSL_FONT* osl_sceFont |
System OSLib font.