gov.nasa.worldwind.util.BasicGLCapabilitiesChooser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of worldwind-pcm Show documentation
worldwind-pcm
The newest version!
/*
 * Copyright (C) 2013 United States Government as represented by the Administrator of the
 * National Aeronautics and Space Administration.
 * All Rights Reserved.
 */
package gov.nasa.worldwind.util;

import com.jogamp.nativewindow.*;
import com.jogamp.opengl.*;
import java.util.List;

/**
 * BasicGLCapabilitiesChooser provides an implementation of {@link com.jogamp.opengl.GLCapabilitiesChooser} for use
 * with WorldWindow implementations (for example, WorldWindowGLCanvas and WorldWindowGLJPanel).
 * 
 * BasicGLCapabilitiesChooser extends the behavior of the default GLCapabilitiesChooser by implementing a fallback
 * behavior when device supported stereo is requested but is not supported by the hardware. In this case,
 * BasicGLCapabilitiesChooser attempts to find a match to the desired capabilities, but without device supported stereo.
 * When the application does not request device supported stereo, BasicGLCapabilitiesChooser provides the same behavior
 * as DefaultGLCapabilitiesChooser.
 *
 * @author dcollins
 * @version $Id: BasicGLCapabilitiesChooser.java 1739 2013-12-04 03:38:19Z dcollins $
 */
public class BasicGLCapabilitiesChooser extends DefaultGLCapabilitiesChooser
{
    /** Constructs a new BasicGLCapabilitiesChooser, but otherwise does nothing. */
    public BasicGLCapabilitiesChooser()
    {
    }

    /**
     * Overridden to provide a fallback behavior when device supported stereo requested but is not supported by the
     * hardware. When the desired GL capabilities does not specify device supported stereo, this calls
     * DefaultGLCapabilitiesChooser.chooseCapabilities.
     *
     * @param desired                       the desired GL capabilities.
     * @param available                     the list of available GL capabilities on the graphics device.
     * @param windowSystemRecommendedChoice an index into the list of available GL capabilities indicating the window
     *                                      system's recommended capabilities, or -1 to indicate no recommendation.
     *
     * @return an index into the list of available GL capabilities.
     */
    @Override
    public int chooseCapabilities(CapabilitiesImmutable desired,
        List available, int windowSystemRecommendedChoice)
    {
        if (desired instanceof GLCapabilities && ((GLCapabilities) desired).getStereo())
        {
            return this.chooseStereoCapabilities(desired, available, windowSystemRecommendedChoice);
        }

        return super.chooseCapabilities(desired, available, windowSystemRecommendedChoice);
    }

    /**
     * Attempts to use the superclass functionality to find a match to the desired GL capabilities in the list of
     * available capabilities. This assumes that the desired GL capabilities request device supported stereo. If the
     * superclass cannot find a match, this attempts to find a match to the desired capabilities, but without device
     * supported stereo.
     *
     * @param desired                       the desired GL capabilities.
     * @param available                     the list of available GL capabilities on the graphics device.
     * @param windowSystemRecommendedChoice an index into the list of available GL capabilities indicating the window
     *                                      system's recommended capabilities, or -1 to indicate no recommendation.
     *
     * @return an index into the list of available GL capabilities.
     */
    protected int chooseStereoCapabilities(CapabilitiesImmutable desired,
        List available, int windowSystemRecommendedChoice)
    {
        try
        {
            return super.chooseCapabilities(desired, available, windowSystemRecommendedChoice);
        }
        catch (NativeWindowException e)  // superclass cannot find a match
        {
            Logging.logger().warning(Logging.getMessage("generic.StereoNotSupported"));
        }

        GLCapabilities fallback = (GLCapabilities) desired.cloneMutable();
        fallback.setStereo(false);

        return super.chooseCapabilities(fallback, available, windowSystemRecommendedChoice);
    }
}