com.jogamp.nativewindow.OffscreenLayerOption Maven / Gradle / Ivy

/**
 * Copyright 2011 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 com.jogamp.nativewindow;

/**
 * Handling requests for using an {@link OffscreenLayerSurface}
 * within the implementation.
 */
public interface OffscreenLayerOption {
    /**
     * Request an offscreen layer, if supported.
     * 
     * Shall be called before the first {@link NativeWindow#lockSurface()},
     * and hence before realization.
     * 
     *
     * @see #getShallUseOffscreenLayer()
     * @see #isOffscreenLayerSurfaceEnabled()
     */
    public void setShallUseOffscreenLayer(boolean v);

    /** Returns the property set by {@link #setShallUseOffscreenLayer(boolean)}. */
    public boolean getShallUseOffscreenLayer();

    /**
     * Returns true if this instance uses an offscreen layer, otherwise false.
     * 
     * This instance is an offscreen layer, if {@link #setShallUseOffscreenLayer(boolean) setShallUseOffscreenLayer(true)}
     * has been called before it's realization and first lock and the underlying implementation supports it.
     * 
     * The return value is undefined before issuing the first {@link NativeWindow#lockSurface()}.
     *
     * @see #setShallUseOffscreenLayer(boolean)
     */
    public boolean isOffscreenLayerSurfaceEnabled();
}