aboutsummaryrefslogtreecommitdiff
path: root/subprojects/d2tk/pugl/bindings/cxx/include/pugl
diff options
context:
space:
mode:
Diffstat (limited to 'subprojects/d2tk/pugl/bindings/cxx/include/pugl')
-rw-r--r--subprojects/d2tk/pugl/bindings/cxx/include/pugl/cairo.hpp2
-rw-r--r--subprojects/d2tk/pugl/bindings/cxx/include/pugl/gl.hpp2
-rw-r--r--subprojects/d2tk/pugl/bindings/cxx/include/pugl/pugl.hpp34
-rw-r--r--subprojects/d2tk/pugl/bindings/cxx/include/pugl/stub.hpp2
-rw-r--r--subprojects/d2tk/pugl/bindings/cxx/include/pugl/vulkan.hpp2
5 files changed, 36 insertions, 6 deletions
diff --git a/subprojects/d2tk/pugl/bindings/cxx/include/pugl/cairo.hpp b/subprojects/d2tk/pugl/bindings/cxx/include/pugl/cairo.hpp
index 126bfe3..15dc5de 100644
--- a/subprojects/d2tk/pugl/bindings/cxx/include/pugl/cairo.hpp
+++ b/subprojects/d2tk/pugl/bindings/cxx/include/pugl/cairo.hpp
@@ -25,7 +25,7 @@ namespace pugl {
/**
@defgroup cairoxx Cairo
Cairo graphics support.
- @ingroup pugl_cxx
+ @ingroup puglxx
@{
*/
diff --git a/subprojects/d2tk/pugl/bindings/cxx/include/pugl/gl.hpp b/subprojects/d2tk/pugl/bindings/cxx/include/pugl/gl.hpp
index c845d80..023dd45 100644
--- a/subprojects/d2tk/pugl/bindings/cxx/include/pugl/gl.hpp
+++ b/subprojects/d2tk/pugl/bindings/cxx/include/pugl/gl.hpp
@@ -26,7 +26,7 @@ namespace pugl {
/**
@defgroup glxx OpenGL
OpenGL graphics support.
- @ingroup pugl_cxx
+ @ingroup puglxx
@{
*/
diff --git a/subprojects/d2tk/pugl/bindings/cxx/include/pugl/pugl.hpp b/subprojects/d2tk/pugl/bindings/cxx/include/pugl/pugl.hpp
index 9e65589..fc3bb03 100644
--- a/subprojects/d2tk/pugl/bindings/cxx/include/pugl/pugl.hpp
+++ b/subprojects/d2tk/pugl/bindings/cxx/include/pugl/pugl.hpp
@@ -580,13 +580,43 @@ public:
return static_cast<Status>(puglRequestAttention(cobj()));
}
- /// @copydoc puglStartTimer
+ /**
+ Activate a repeating timer event.
+
+ This starts a timer which will send a timer event to `view` every
+ `timeout` seconds. This can be used to perform some action in a view at a
+ regular interval with relatively low frequency. Note that the frequency
+ of timer events may be limited by how often update() is called.
+
+ If the given timer already exists, it is replaced.
+
+ @param id The identifier for this timer. This is an application-specific
+ ID that should be a low number, typically the value of a constant or `enum`
+ that starts from 0. There is a platform-specific limit to the number of
+ supported timers, and overhead associated with each, so applications should
+ create only a few timers and perform several tasks in one if necessary.
+
+ @param timeout The period, in seconds, of this timer. This is not
+ guaranteed to have a resolution better than 10ms (the maximum timer
+ resolution on Windows) and may be rounded up if it is too short. On X11
+ and MacOS, a resolution of about 1ms can usually be relied on.
+
+ @return #PUGL_FAILURE if timers are not supported by the system,
+ #PUGL_UNKNOWN_ERROR if setting the timer failed.
+ */
Status startTimer(const uintptr_t id, const double timeout) noexcept
{
return static_cast<Status>(puglStartTimer(cobj(), id, timeout));
}
- /// @copydoc puglStopTimer
+ /**
+ Stop an active timer.
+
+ @param id The ID previously passed to startTimer().
+
+ @return #PUGL_FAILURE if timers are not supported by this system,
+ #PUGL_UNKNOWN_ERROR if stopping the timer failed.
+ */
Status stopTimer(const uintptr_t id) noexcept
{
return static_cast<Status>(puglStopTimer(cobj(), id));
diff --git a/subprojects/d2tk/pugl/bindings/cxx/include/pugl/stub.hpp b/subprojects/d2tk/pugl/bindings/cxx/include/pugl/stub.hpp
index 6946fe0..fbafcee 100644
--- a/subprojects/d2tk/pugl/bindings/cxx/include/pugl/stub.hpp
+++ b/subprojects/d2tk/pugl/bindings/cxx/include/pugl/stub.hpp
@@ -25,7 +25,7 @@ namespace pugl {
/**
@defgroup stubxx Stub
Stub graphics support.
- @ingroup pugl_cxx
+ @ingroup puglxx
@{
*/
diff --git a/subprojects/d2tk/pugl/bindings/cxx/include/pugl/vulkan.hpp b/subprojects/d2tk/pugl/bindings/cxx/include/pugl/vulkan.hpp
index 2612578..f3dbcad 100644
--- a/subprojects/d2tk/pugl/bindings/cxx/include/pugl/vulkan.hpp
+++ b/subprojects/d2tk/pugl/bindings/cxx/include/pugl/vulkan.hpp
@@ -43,7 +43,7 @@ namespace pugl {
vulkan-hpp smart handles, it is relatively straightforward to wrap the
result of createSurface() manually.
- @ingroup pugl_cxx
+ @ingroup puglxx
@{
*/