VgaGames 3 - Miscellaneous man-pages

[.. upper level ..]

VG3_output_text()

Show a box containing text.
SYNTAX
int VG3_output_text(void *wstruct, int fcolor, int bcolor, const char *text)

FUNCTION PARAMETERS
wstruct Window-struct
fcolor Foreground color (from VGAG3_COLORS or VGAG3_COLOR_CUSTOM)
bcolor Background color (from VGAG3_COLORS or VGAG3_COLOR_CUSTOM)
text Text

RETURN VALUE
Returns integer: - 1: Got request for closing the window and exiting the game - 0: OK - -1: failure

ERRORS
On error VG3_errmsg() returns: EINVAL - error in argument ENOSYS - cannot create image ENOMEM - cannot get memory

DESCRIPTION
Show an text-box on top of the actual window. Navigate using the keys cursor-up, cursor-down or pagewise backspace and space. The current background image will be dimmed out and used as background for the box. The background color bcolor may be VGAG3_COLOR_TRANSPARENT.

SEE ALSO
VG3_draw_textline() VG3_input_box() VG3_input_select()