added comments about use of the functions, and regrouped engine-use-only ones to...

git-svn-id: svn://svn.icculus.org/twilight/trunk/darkplaces@1039 d7cf8633-e32d-0410-b094-e92efae38249

diff --git a/ui.h b/ui.h
index 5d58c6ddf0ad5a443556a530c373252774ea3cc8..4fc2c1c653563a933cf02b85a036cc9833596136 100644 (file)
--- a/ui.h
+++ b/ui.h
@@ -1,4 +1,9 @@
 
+#ifndef UI_H
+#define UI_H
+
+// these defines and structures are for internal use only
+// (ui_t is passed around by users of the system, but should not be altered)
 #define MAX_UI_COUNT 16
 #define MAX_UI_ITEMS 256
 
@@ -26,12 +31,36 @@ typedef struct
 }
 ui_t;
 
+// engine use:
+// initializes the ui system
 void ui_init(void);
+// updates the mouse position, given an absolute loation (some input systems use this)
 void ui_mouseupdate(float x, float y);
+// updates the mouse position, by an offset from the previous location (some input systems use this)
 void ui_mouseupdaterelative(float x, float y);
+// left key update
+void ui_leftkeyupdate(int pressed);
+// right key update
+void ui_rightkeyupdate(int pressed);
+// up key update
+void ui_upkeyupdate(int pressed);
+// down key update
+void ui_downkeyupdate(int pressed);
+// mouse button update (note: 0 = left, 1 = right, 2 = middle, 3+ not supported yet)
+void ui_mousebuttonupdate(int button, int pressed);
+// perform input updates and check for clicks on items (note: calls callbacks)
+void ui_update(void);
+// draw all items of all panels
+void ui_draw(void);
+
+// intentionally public functions:
+// creates a panel
 ui_t *ui_create(void);
+// frees a panel
 void ui_free(ui_t *ui);
+// empties a panel, removing all the items
 void ui_clear(ui_t *ui);
+// sets an item in a panel (adds or replaces the item)
 void ui_item
 (
        ui_t *ui, char *basename, int number,
@@ -43,13 +72,11 @@ void ui_item
        void(*mouseclick)(void *nativedata1, void *nativedata2, float data1, float data2, float xfrac, float yfrac),
        void *nativedata1, void *nativedata2, float data1, float data2
 );
+// removes an item from a panel
 void ui_item_remove(ui_t *ui, char *basename, int number);
+// checks if a panel is enabled
 int ui_uiactive(ui_t *ui);
+// enables/disables a panel on the screen
 void ui_activate(ui_t *ui, int yes);
-void ui_leftkeyupdate(int pressed);
-void ui_rightkeyupdate(int pressed);
-void ui_upkeyupdate(int pressed);
-void ui_downkeyupdate(int pressed);
-void ui_mousebuttonupdate(int button, int pressed);
-void ui_update(void);
-void ui_draw(void);
+
+#endif