diff options
author | sanine-a <sanine.not@pm.me> | 2020-05-21 09:38:23 -0500 |
---|---|---|
committer | sanine-a <sanine.not@pm.me> | 2020-05-21 09:38:23 -0500 |
commit | 9b66b322b600ab0db66cb6f3ff5a7c4196b9193f (patch) | |
tree | 1faebcf20bde4d5f380a4d7b94a6a8075cfcc480 /include/honey.h | |
parent | a09b5a72d365f10e35b012e04b95891abf0b8313 (diff) |
fix documentation errors
Diffstat (limited to 'include/honey.h')
-rw-r--r-- | include/honey.h | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/include/honey.h b/include/honey.h index bea21c4..3cddabc 100644 --- a/include/honey.h +++ b/include/honey.h @@ -1,7 +1,11 @@ #ifndef HONEY_ENGINE_H #define HONEY_ENGINE_H -/** @file Defines the basic loading and callback functions. */ +/** @file honey.h + * + * @brief Defines the basic loading and callback functions. +*/ + #include "common.h" #include "mesh.h" #include "primitives.h" @@ -20,12 +24,23 @@ honey_window honey_setup(int screen_width, int screen_height, char* window_title static void (*honey_update_callback)(float dt); static void (*honey_draw_callback)(); -static float honey_draw_dt = 0.16; +/** @brief Set the main update function. + * + * @param[in] update_callback The function to call every loop + */ void honey_set_update_callback(void (*update_callback)(float)); + +/** @brief Set the main draw function + * + * @param[in] draw_callback The function to call every draw cycle + */ void honey_set_draw_callback(void (*draw_callback)()); -void honey_set_fps(unsigned int); +/** @brief The main game loop. + * + * @param[in] window The window the game is running in, created with honey_setup() + */ void honey_run(honey_window window); #define honey_set_resize_callback glfwSetFramebufferSizeCallback |