aboutsummaryrefslogtreecommitdiffstats
path: root/pugl/pugl.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-09-27 03:13:27 +0000
committerDavid Robillard <d@drobilla.net>2014-09-27 03:13:27 +0000
commit21b42c7b40c4dd0598b60fa7eda1e3c501e32e41 (patch)
treef7e39c0d1c3ff4ecaa072a399decfa9bf8ef0817 /pugl/pugl.h
parentdd9b6fe61373e0f1ff0015a2d6b01360897fa8fc (diff)
downloadpugl-21b42c7b40c4dd0598b60fa7eda1e3c501e32e41.tar.gz
pugl-21b42c7b40c4dd0598b60fa7eda1e3c501e32e41.tar.bz2
pugl-21b42c7b40c4dd0598b60fa7eda1e3c501e32e41.zip
Improve documentation.
Diffstat (limited to 'pugl/pugl.h')
-rw-r--r--pugl/pugl.h36
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.