1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/**
* Copyright 2013 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package javax.media.opengl;
/**
* Adds capabilities to set a shared {@link GLContext} directly or via an {@link GLAutoDrawable}.
* <p>
* Sharing of server-side OpenGL objects such as buffer objects, e.g. VBOs,
* and textures among OpenGL contexts is supported with this interface.
* </p>
* <p>
* A <i>master</i> {@link GLContext} is the {@link GLContext} which is created first,
* shared {@link GLContext} w/ this master are referred as slave {@link GLContext}
* and controls the shared object's lifecycle, i.e. their construction and destruction.
* </p>
* <h5><a name="lifecycle">Lifecycle Considerations</a></h5>
* <p>
* Be aware that the <i>master</i> {@link GLContext} and related resources
* <i>shall not</i> be destroyed before it's <i>slave</i> {@link GLContext} instances <i>while they are using them</i>.<br>
* Otherwise the OpenGL driver implementation may crash w/ SIGSEGV, since using already destroyed resources,
* e.g. OpenGL buffer objects, may not be validated by the driver!<br>
* </p>
* <p>
* Either proper lifecycle synchronization is implemented, e.g. by notifying the <i>slaves</i> about the loss of the shared resources,
* <i>or</i> the <i>slaves</i> validate whether the resources are still valid.
* </p>
* <p>
* To simplify above lifecycle issues, one may use a {@link GLDrawableFactory#createDummyDrawable(javax.media.nativewindow.AbstractGraphicsDevice, boolean, GLProfile) dummy}
* {@link GLDrawable} and it's {@link GLContext} as the <i>master</i> of all shared <i>slave</i> {@link GLContext}.
* Since this <i>dummy instance</i> does not depend on any native windowing system, it can be controlled easily w/o being <i>in sight</i>.<br>
* Below code creates a {@link GLAutoDrawable} based on a <i>dummy GLDrawable</i>:
* <pre>
// GLProfile and GLCapabilities should be equal across all shared GL drawable/context.
final GLCapabilitiesImmutable caps = ... ;
final GLProfile glp = caps.getGLProfile();
..
final boolean createNewDevice = true; // use 'own' display device!
final GLAutoDrawable sharedDrawable = GLDrawableFactory.getFactory(glp).createDummyAutoDrawable(null, createNewDevice, glp);
sharedDrawable.display(); // triggers GLContext object creation and native realization.
...
// Later a shared 'slave' can be created e.g.:
GLWindow glad = GLWindow.create(caps); // or any other GLAutoDrawable supporting GLSharedContextSetter
glad.setSharedAutoDrawable(sharedDrawable);
glad.addGLEventListener(..);
glad.setVisible(true); // GLWindow creation ..
* </pre>
* </p>
*/
public interface GLSharedContextSetter extends GLAutoDrawable {
/**
* Specifies an {@link GLContext OpenGL context}, which shall be shared by this {@link GLAutoDrawable}'s {@link GLContext}.
* <p>
* Since the {@link GLDrawable drawable} and {@link GLContext context} is created
* at {@link GLAutoDrawable#initialization GLAutoDrawable initialization}
* this method shall be called beforehand to have any effect.
* </p>
* <p>
* A set <i>sharedContext</i> will block context creation, i.e. {@link GLAutoDrawable#initialization GLAutoDrawable initialization},
* as long it is not {@link GLContext#isCreated() created natively}.
* </p>
* <p>
* See <a href="#lifecycle">Lifecycle Considerations</a>.
* </p>
*
* @param sharedContext The OpenGL context to be shared by this {@link GLAutoDrawable}'s {@link GLContext}.
* @throws IllegalStateException if a {@link #setSharedContext(GLContext) shared GLContext}
* or {@link #setSharedAutoDrawable(GLAutoDrawable) shared GLAutoDrawable} is already set,
* the given sharedContext is null or equal to this {@link GLAutoDrawable}'s context.
* @see #setSharedAutoDrawable(GLAutoDrawable)
*/
void setSharedContext(GLContext sharedContext) throws IllegalStateException;
/**
* Specifies an {@link GLAutoDrawable}, which {@link GLContext OpenGL context} shall be shared by this {@link GLAutoDrawable}'s {@link GLContext}.
* <p>
* Since the {@link GLDrawable drawable} and {@link GLContext context} is created
* at {@link GLAutoDrawable#initialization GLAutoDrawable initialization}
* this method shall be called beforehand to have any effect.
* </p>
* <p>
* A set <i>sharedAutoDrawable</i> will block context creation, i.e. {@link GLAutoDrawable#initialization GLAutoDrawable initialization},
* as long it's {@link GLContext} is <code>null</code>
* or has not been {@link GLContext#isCreated() created natively}.
* </p>
* <p>
* See <a href="#lifecycle">Lifecycle Considerations</a>.
* </p>
*
* @param sharedContext The GLAutoDrawable, which OpenGL context shall be shared by this {@link GLAutoDrawable}'s {@link GLContext}.
* @throws IllegalStateException if a {@link #setSharedContext(GLContext) shared GLContext}
* or {@link #setSharedAutoDrawable(GLAutoDrawable) shared GLAutoDrawable} is already set,
* the given sharedAutoDrawable is null or equal to this GLAutoDrawable.
* @see #setSharedContext(GLContext)
*/
void setSharedAutoDrawable(GLAutoDrawable sharedAutoDrawable) throws IllegalStateException;
}
|
