aboutsummaryrefslogtreecommitdiff
path: root/src/client/lua_api/load_gui.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/client/lua_api/load_gui.cpp')
-rw-r--r--src/client/lua_api/load_gui.cpp11
1 files changed, 9 insertions, 2 deletions
diff --git a/src/client/lua_api/load_gui.cpp b/src/client/lua_api/load_gui.cpp
index 64b9711..18fe78f 100644
--- a/src/client/lua_api/load_gui.cpp
+++ b/src/client/lua_api/load_gui.cpp
@@ -1,6 +1,5 @@
-/***
+/*
Utilities for drawing GUI things on the screen
-@module gui
*/
#include <stdio.h>
@@ -47,11 +46,19 @@ int screenheight(lua_State* L);
int getroot(lua_State *L);
/***
+Get the width of the screen.
+Get the width of the screen in pixels. This should have been set with the options
+in @{deviceinit.lua}, but may change of the course of the application's life (ex,
+if the user resizes the screen)
@function gui.scrw()
@treturn number The width of the screen
*/
/***
+Get the height of the screen.
+Get the height of the screen in pixels. This should have been set with the options
+in @{deviceinit.lua}, but may change of the course of the application's life (ex,
+if the user resizes the screen)
@function gui.scrh()
@treturn number The height of the screen
*/