aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2023-05-12 17:09:03 -0400
committerDavid Robillard <d@drobilla.net>2023-05-12 17:09:03 -0400
commit70a01e11a5c7b6c47717eb4b324e30ee331a817a (patch)
tree1d2fb3924d3974f7adb5a692fe152282a8c33802 /include
parent1f2bb7e20131395a30fc4ce55740de6984d56f10 (diff)
downloadpugl-70a01e11a5c7b6c47717eb4b324e30ee331a817a.tar.gz
pugl-70a01e11a5c7b6c47717eb4b324e30ee331a817a.tar.bz2
pugl-70a01e11a5c7b6c47717eb4b324e30ee331a817a.zip
Improve size hint documentation
Diffstat (limited to 'include')
-rw-r--r--include/pugl/pugl.h24
1 files changed, 21 insertions, 3 deletions
diff --git a/include/pugl/pugl.h b/include/pugl/pugl.h
index 189cfe4..f9dd37e 100644
--- a/include/pugl/pugl.h
+++ b/include/pugl/pugl.h
@@ -955,9 +955,27 @@ typedef enum {
size gracefully.
*/
typedef enum {
- PUGL_DEFAULT_SIZE, ///< Default size
- PUGL_MIN_SIZE, ///< Minimum size
- PUGL_MAX_SIZE, ///< Maximum size
+ /**
+ Default size.
+
+ This is used as the size during window creation as a default, if no other
+ size is specified.
+ */
+ PUGL_DEFAULT_SIZE,
+
+ /**
+ Minimum size.
+
+ If set, the view's size should be constrained to be at least this large.
+ */
+ PUGL_MIN_SIZE,
+
+ /**
+ Maximum size.
+
+ If set, the view's size should be constrained to be at most this large.
+ */
+ PUGL_MAX_SIZE,
/**
Fixed aspect ratio.