JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
OffscreenLayerOption.java
Go to the documentation of this file.
1/**
2 * Copyright 2011 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 */
28package com.jogamp.nativewindow;
29
30/**
31 * Handling requests for using an {@link OffscreenLayerSurface}
32 * within the implementation.
33 */
34public interface OffscreenLayerOption {
35 /**
36 * Request an offscreen layer, if supported.
37 * <p>
38 * Shall be called before the first {@link NativeWindow#lockSurface()},
39 * and hence before realization.
40 * </p>
41 *
42 * @see #getShallUseOffscreenLayer()
43 * @see #isOffscreenLayerSurfaceEnabled()
44 */
45 public void setShallUseOffscreenLayer(boolean v);
46
47 /** Returns the property set by {@link #setShallUseOffscreenLayer(boolean)}. */
48 public boolean getShallUseOffscreenLayer();
49
50 /**
51 * Returns true if this instance uses an offscreen layer, otherwise false.
52 * <p>
53 * This instance is an offscreen layer, if {@link #setShallUseOffscreenLayer(boolean) setShallUseOffscreenLayer(true)}
54 * has been called before it's realization and first lock and the underlying implementation supports it.
55 * </p>
56 * The return value is undefined before issuing the first {@link NativeWindow#lockSurface()}.
57 *
58 * @see #setShallUseOffscreenLayer(boolean)
59 */
61}
Handling requests for using an OffscreenLayerSurface within the implementation.
void setShallUseOffscreenLayer(boolean v)
Request an offscreen layer, if supported.
boolean getShallUseOffscreenLayer()
Returns the property set by setShallUseOffscreenLayer(boolean).
boolean isOffscreenLayerSurfaceEnabled()
Returns true if this instance uses an offscreen layer, otherwise false.