jepler/fruitjam-doom
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add documentation for high-level txt_desktop.h functions.

Browse source 
Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 1450
This commit is contained in:
Simon Howard 2009-03-07 00:35:08 +00:00
parent 2b5dae761b
commit 11f9260535
1 changed files with 27 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
textscreen/txt_desktop.h
View file

@ -26,14 +26,37 @@
void TXT_AddDesktopWindow(txt_window_t *win);
void TXT_RemoveDesktopWindow(txt_window_t *win);
void TXT_SetDesktopTitle(char *title);
void TXT_DrawDesktop(void);
void TXT_GUIMainLoop(void);
void TXT_DispatchEvents(void);
void TXT_ExitMainLoop(void);
void TXT_DrawWindow(txt_window_t *window, int selected);
void TXT_WindowKeyPress(txt_window_t *window, int c);
#endif /* #ifndef TXT_DESKTOP_T */
/**
* Set the title displayed at the top of the screen.
*
* @param title The title to display.
*/
void TXT_SetDesktopTitle(char *title);
/**
* Exit the currently-running main loop and return from the
* @ref TXT_GUIMainLoop function.
*/
void TXT_ExitMainLoop(void);
/**
* Start the main event loop. At least one window must have been
* opened prior to running this function. When no windows are left
* open, the event loop exits.
*
* It is possible to trigger an exit from this function using the
* @ref TXT_ExitMainLoop function.
*/
void TXT_GUIMainLoop(void);
#endif /* #ifndef TXT_DESKTOP_H */