aboutsummaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/com/jogamp/opengl/GLRunnable.java
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2023-03-19 06:11:35 +0100
committerSven Gothel <[email protected]>2023-03-19 06:11:35 +0100
commit603068a4e6af5293db10db73ead3a83b7a74af34 (patch)
treede6097189acfe6efe0e5ff51a9b9803bb7d91c56 /src/jogl/classes/com/jogamp/opengl/GLRunnable.java
parentf8584748e33aab56780eca5cf7009a5a0d11991d (diff)
API doc cleanup, add + refine math tests
API doc
Diffstat (limited to 'src/jogl/classes/com/jogamp/opengl/GLRunnable.java')
-rw-r--r--src/jogl/classes/com/jogamp/opengl/GLRunnable.java7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/jogl/classes/com/jogamp/opengl/GLRunnable.java b/src/jogl/classes/com/jogamp/opengl/GLRunnable.java
index 97a72d6cd..f8bd56fdc 100644
--- a/src/jogl/classes/com/jogamp/opengl/GLRunnable.java
+++ b/src/jogl/classes/com/jogamp/opengl/GLRunnable.java
@@ -41,6 +41,13 @@ package com.jogamp.opengl;
* The OpenGL context is current while executing the GLRunnable.
* </p>
* <p>
+ * {@link GLRunnable#run(GLAutoDrawable)} shall return true to indicate
+ * that the GL [back] framebuffer remains intact by this runnable. <br/>
+ * If returning false {@link GLAutoDrawable} will call
+ * {@link GLEventListener#display(GLAutoDrawable) display(GLAutoDrawable)}
+ * of all registered {@link GLEventListener}s once more to reinstate the framebuffer.
+ * </p>
+ * <p>
* This might be useful to inject OpenGL commands from an I/O event listener.
* </p>
*/