JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.DefaultGLCapabilitiesChooser Class Reference
Inheritance diagram for com.jogamp.opengl.DefaultGLCapabilitiesChooser:
Collaboration diagram for com.jogamp.opengl.DefaultGLCapabilitiesChooser:

Public Member Functions

int chooseCapabilities (final CapabilitiesImmutable desired, final List<? extends CapabilitiesImmutable > available, final int windowSystemRecommendedChoice)
 Chooses the index (0..available.length - 1) of the Capabilities most closely matching the desired one from the list of all supported. More...
 
int chooseCapabilities (CapabilitiesImmutable desired, List<? extends CapabilitiesImmutable > available, int windowSystemRecommendedChoice)
 Chooses the index (0..available.length - 1) of the Capabilities most closely matching the desired one from the list of all supported. More...
 

Detailed Description

The default implementation of the GLCapabilitiesChooser interface, which provides consistent visual selection behavior across platforms. The precise algorithm is deliberately left loosely specified. Some properties are:

  • As long as there is at least one available non-null GLCapabilities which matches the "stereo" option, will return a valid index.

  • Attempts to match as closely as possible the given GLCapabilities, but will select one with fewer capabilities (i.e., lower color depth) if necessary.

  • Prefers hardware-accelerated visuals to non-hardware-accelerated.

  • If there is no exact match, prefers a more-capable visual to a less-capable one.

  • If there is more than one exact match, chooses an arbitrary one.

  • May select the opposite of a double- or single-buffered visual (based on the user's request) in dire situations.

  • Color depth (including alpha) mismatches are weighted higher than depth buffer mismatches, which are in turn weighted higher than accumulation buffer (including alpha) and stencil buffer depth mismatches.

  • If a valid windowSystemRecommendedChoice parameter is supplied, chooses that instead of using the cross-platform code.

Definition at line 92 of file DefaultGLCapabilitiesChooser.java.

Member Function Documentation

◆ chooseCapabilities()

int com.jogamp.opengl.DefaultGLCapabilitiesChooser.chooseCapabilities ( final CapabilitiesImmutable  desired,
final List<? extends CapabilitiesImmutable available,
final int  windowSystemRecommendedChoice 
)

Chooses the index (0..available.length - 1) of the Capabilities most closely matching the desired one from the list of all supported.

Some of the entries in the available array may be null; the chooser must ignore these. The windowSystemRecommendedChoice parameter may be provided to the chooser by the underlying window system; if this index is valid, it is recommended, but not necessarily required, that the chooser select that entry.

Note: this method is called automatically by the GraphicsConfigurationFactory#chooseGraphicsConfiguration method when an instance of this class is passed in to it. It should generally not be invoked by users directly, unless it is desired to delegate the choice to some other CapabilitiesChooser object.

Implements com.jogamp.nativewindow.CapabilitiesChooser.

Reimplemented in com.jogamp.opengl.GenericGLCapabilitiesChooser, and com.jogamp.opengl.util.caps.NonFSAAGLCapsChooser.

Definition at line 116 of file DefaultGLCapabilitiesChooser.java.

Here is the call graph for this function:

The documentation for this class was generated from the following file: