diff options
Diffstat (limited to 'pugl/pugl.h')
| -rw-r--r-- | pugl/pugl.h | 36 |
1 files changed, 33 insertions, 3 deletions
diff --git a/pugl/pugl.h b/pugl/pugl.h index d13ce12..68ecc19 100644 --- a/pugl/pugl.h +++ b/pugl/pugl.h @@ -135,6 +135,12 @@ typedef void (*PuglScrollFunc)(PuglView* view, typedef void (*PuglSpecialFunc)(PuglView* view, bool press, PuglKey key); /** + @name Initialization + Configuration functions which must be called before creating a window. + @{ +*/ + +/** Create a Pugl context. To create a window, call the various puglInit* functions as necessary, then @@ -171,6 +177,16 @@ PUGL_API void puglInitContextType(PuglView* view, PuglContextType type); /** + @} +*/ + +/** + @name Windows + Window management functions. + @{ +*/ + +/** Create a window with the settings given by the various puglInit functions. @return 1 (pugl does not currently support multiple windows). @@ -191,6 +207,16 @@ PUGL_API void puglHideWindow(PuglView* view); /** + Return the native window handle. +*/ +PUGL_API PuglNativeWindow +puglGetNativeWindow(PuglView* view); + +/** + @} +*/ + +/** Set the handle to be passed to all callbacks. This is generally a pointer to a struct which contains all necessary state. @@ -238,6 +264,12 @@ PUGL_API void puglIgnoreKeyRepeat(PuglView* view, bool ignore); /** + @name Event Callbacks + Functions to set event callbacks for handling user input. + @{ +*/ + +/** Set the function to call when an event occurs. */ PUGL_API void @@ -292,10 +324,8 @@ PUGL_API void puglSetReshapeFunc(PuglView* view, PuglReshapeFunc reshapeFunc); /** - Return the native window handle. + @} */ -PUGL_API PuglNativeWindow -puglGetNativeWindow(PuglView* view); /** Grab the input focus. |