summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
Diffstat (limited to 'API.md')
-rw-r--r--API.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/API.md b/API.md
index 677c00f..08148d7 100644
--- a/API.md
+++ b/API.md
@@ -1,6 +1,6 @@
# ReiLua API
-## Usage
+## Functions
Application needs 'main.lua' or 'main' file as entry point. ReiLua executable will first look it from same directory. Alternatively, path to the folder where "main.lua" is located can be given as argument. There are five Lua functions that the framework will call, 'RL.init', 'RL.process', 'RL.draw', 'RL.event', 'RL.log', and 'RL.exit'.
@@ -41,6 +41,10 @@ This function will be called on program close. Cleanup could be done here.
---
+## Arguments
+
+Arguments are stored in 'RL.arg' array.
+
## Globals - ConfigFlags
FLAG_VSYNC_HINT = 64
FLAG_FULLSCREEN_MODE = 2