JOGL
v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java (public API).
GLRunnable.java
Go to the documentation of this file.
1
/**
2
* Copyright 2010 JogAmp Community. All rights reserved.
3
*
4
* Redistribution and use in source and binary forms, with or without modification, are
5
* permitted provided that the following conditions are met:
6
*
7
* 1. Redistributions of source code must retain the above copyright notice, this list of
8
* conditions and the following disclaimer.
9
*
10
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
11
* of conditions and the following disclaimer in the documentation and/or other materials
12
* provided with the distribution.
13
*
14
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23
*
24
* The views and conclusions contained in the software and documentation are those of the
25
* authors and should not be interpreted as representing official policies, either expressed
26
* or implied, of JogAmp Community.
27
*/
28
29
package
com.jogamp.opengl;
30
31
/**
32
* <p>
33
* Declares a one-shot OpenGL command usable for injection
34
* via {@link GLAutoDrawable#invoke(boolean, com.jogamp.opengl.GLRunnable)}.<br>
35
* {@link GLAutoDrawable} executes the GLRunnables within it's {@link GLAutoDrawable#display() display()}
36
* method after all registered {@link GLEventListener}s
37
* {@link GLEventListener#display(GLAutoDrawable) display(GLAutoDrawable)}
38
* methods has been called.
39
* </p>
40
* <p>
41
* The OpenGL context is current while executing the GLRunnable.
42
* </p>
43
* <p>
44
* {@link GLRunnable#run(GLAutoDrawable)} shall return true to indicate
45
* that the GL [back] framebuffer remains intact by this runnable. <br/>
46
* If returning false {@link GLAutoDrawable} will call
47
* {@link GLEventListener#display(GLAutoDrawable) display(GLAutoDrawable)}
48
* of all registered {@link GLEventListener}s once more to reinstate the framebuffer.
49
* </p>
50
* <p>
51
* This might be useful to inject OpenGL commands from an I/O event listener.
52
* </p>
53
*/
54
public
interface
GLRunnable
{
55
/**
56
* @param drawable the associated drawable and current context for this call
57
* @return true if the GL [back] framebuffer remains intact by this runnable, otherwise false.
58
* If returning false {@link GLAutoDrawable} will call
59
* {@link GLEventListener#display(GLAutoDrawable) display(GLAutoDrawable)}
60
* of all registered {@link GLEventListener}s once more.
61
* @see GLRunnable
62
*/
63
boolean
run
(
GLAutoDrawable
drawable);
64
}
65
com.jogamp.opengl.GLAutoDrawable
A higher-level abstraction than GLDrawable which supplies an event based mechanism (GLEventListener) ...
Definition:
GLAutoDrawable.java:146
com.jogamp.opengl.GLRunnable
Definition:
GLRunnable.java:54
com.jogamp.opengl.GLRunnable.run
boolean run(GLAutoDrawable drawable)
src
jogl
classes
com
jogamp
opengl
GLRunnable.java
Generated by
1.9.4