summaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/javax/media/opengl/GLRunnable.java
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2012-04-11 19:47:31 +0200
committerSven Gothel <[email protected]>2012-04-11 19:47:31 +0200
commit2cfc59f99b47c0a77fbc59e27d78e2580a87034f (patch)
treec93ecf1a0c9bb7621fbc51da760ca03cc4acdf2f /src/jogl/classes/javax/media/opengl/GLRunnable.java
parentbbac20d5f42b111fb39b74c6075f57aab1fe66ba (diff)
Refine API doc
Diffstat (limited to 'src/jogl/classes/javax/media/opengl/GLRunnable.java')
-rw-r--r--src/jogl/classes/javax/media/opengl/GLRunnable.java14
1 files changed, 8 insertions, 6 deletions
diff --git a/src/jogl/classes/javax/media/opengl/GLRunnable.java b/src/jogl/classes/javax/media/opengl/GLRunnable.java
index cbd086c77..141d07c19 100644
--- a/src/jogl/classes/javax/media/opengl/GLRunnable.java
+++ b/src/jogl/classes/javax/media/opengl/GLRunnable.java
@@ -39,12 +39,14 @@ package javax.media.opengl;
*/
public interface GLRunnable {
/**
- * Called by the drawable to initiate one-shot OpenGL commands by the
- * client, like {@link GLEventListener#display(GLAutoDrawable)}.
- *
- * @param drawable the associated drawable the implementation shall use
- * @return false if impl invalidates the back buffers, hence {@link GLAutoDrawable#display()} will
- * issue another {@link GLEventListener#display(GLAutoDrawable)} call. Otherwise true.
+ * Initiate one-shot OpenGL commands with a valid current context,
+ * processed by {@link GLAutoDrawable#display()}, enqueued by
+ * {@link GLAutoDrawable#invoke(boolean, GLRunnable)}.
+ *
+ * @param drawable the associated drawable and current context for this call
+ * @return true if the GL [back] framebuffer remain intact by this runnable, otherwise false.
+ * If returning false and hence the impl signals an invalidated back buffer,
+ * another {@link GLEventListener#display(GLAutoDrawable)} call will be issued.
*/
boolean run(GLAutoDrawable drawable);
}