JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.nativewindow.awt.AWTGraphicsConfiguration Class Reference

A wrapper for an AWT GraphicsConfiguration allowing it to be handled in a toolkit-independent manner. More...

Inheritance diagram for com.jogamp.nativewindow.awt.AWTGraphicsConfiguration:
Collaboration diagram for com.jogamp.nativewindow.awt.AWTGraphicsConfiguration:

Public Member Functions

 AWTGraphicsConfiguration (final AWTGraphicsScreen screen, final CapabilitiesImmutable capsChosen, final CapabilitiesImmutable capsRequested, final GraphicsConfiguration config, final AbstractGraphicsConfiguration encapsulated)
 
void setChosenCapabilities (final CapabilitiesImmutable capsChosen)
 Set the capabilities to a new value. More...
 
Object clone ()
 
GraphicsConfiguration getAWTGraphicsConfiguration ()
 Return the AWT GraphicsConfiguration. More...
 
AbstractGraphicsConfiguration getNativeGraphicsConfiguration ()
 In case the implementation utilizes a delegation pattern to wrap abstract toolkits, this method shall return the native AbstractGraphicsConfiguration, otherwise this instance. More...
 
String toString ()
 
- Public Member Functions inherited from com.jogamp.nativewindow.DefaultGraphicsConfiguration
 DefaultGraphicsConfiguration (final AbstractGraphicsScreen screen, final CapabilitiesImmutable capsChosen, final CapabilitiesImmutable capsRequested)
 
Object clone ()
 
final AbstractGraphicsScreen getScreen ()
 Return the screen this graphics configuration is valid for. More...
 
final CapabilitiesImmutable getChosenCapabilities ()
 Return the capabilities reflecting this graphics configuration, which may differ from the capabilities used to choose this configuration. More...
 
final CapabilitiesImmutable getRequestedCapabilities ()
 Return the capabilities used to choose this graphics configuration. More...
 
AbstractGraphicsConfiguration getNativeGraphicsConfiguration ()
 In case the implementation utilizes a delegation pattern to wrap abstract toolkits, this method shall return the native AbstractGraphicsConfiguration, otherwise this instance. More...
 
final int getVisualID (final VIDType type) throws NativeWindowException
 Returns the native visual ID of the given type if supported, or VID_UNDEFINED if not supported. More...
 
final boolean isVisualIDSupported (final VIDType type)
 Returns true if the given VIDType is supported, otherwise false. More...
 
String toString ()
 
Object clone ()
 
AbstractGraphicsScreen getScreen ()
 Return the screen this graphics configuration is valid for. More...
 
CapabilitiesImmutable getChosenCapabilities ()
 Return the capabilities reflecting this graphics configuration, which may differ from the capabilities used to choose this configuration. More...
 
CapabilitiesImmutable getRequestedCapabilities ()
 Return the capabilities used to choose this graphics configuration. More...
 
AbstractGraphicsConfiguration getNativeGraphicsConfiguration ()
 In case the implementation utilizes a delegation pattern to wrap abstract toolkits, this method shall return the native AbstractGraphicsConfiguration, otherwise this instance. More...
 
int getVisualID (VIDType type) throws NativeWindowException
 Returns the native visual ID of the given type if supported, or VID_UNDEFINED if not supported. More...
 
boolean isVisualIDSupported (VIDType type)
 Returns true if the given VIDType is supported, otherwise false. More...
 

Static Public Member Functions

static AWTGraphicsConfiguration create (final GraphicsConfiguration gc, CapabilitiesImmutable capsChosen, CapabilitiesImmutable capsRequested)
 Method constructs a new AWTGraphicsConfiguration primarily based on the given GraphicsConfiguration. More...
 
static CapabilitiesImmutable setupCapabilitiesRGBABits (final CapabilitiesImmutable capabilitiesIn, final GraphicsConfiguration gc)
 Sets up the Capabilities' RGBA size based on the given GraphicsConfiguration's ColorModel. More...
 
- Static Public Member Functions inherited from com.jogamp.nativewindow.DefaultGraphicsConfiguration
static String toHexString (final int val)
 
static String toHexString (final long val)
 

Additional Inherited Members

- Static Public Attributes inherited from com.jogamp.nativewindow.VisualIDHolder
static final int VID_UNDEFINED = 0
 getVisualID(VIDType) result indicating an undefined value, which could be cause by an unsupported query. More...
 
- Protected Member Functions inherited from com.jogamp.nativewindow.DefaultGraphicsConfiguration
void setChosenCapabilities (final CapabilitiesImmutable capsChosen)
 Set the capabilities to a new value. More...
 
void setScreen (final AbstractGraphicsScreen screen)
 Set a new screen. More...
 
- Protected Attributes inherited from com.jogamp.nativewindow.DefaultGraphicsConfiguration
CapabilitiesImmutable capabilitiesChosen
 
CapabilitiesImmutable capabilitiesRequested
 
- Static Protected Attributes inherited from com.jogamp.nativewindow.DefaultGraphicsConfiguration
static final boolean DEBUG = Debug.debug("GraphicsConfiguration")
 

Detailed Description

A wrapper for an AWT GraphicsConfiguration allowing it to be handled in a toolkit-independent manner.

Definition at line 56 of file AWTGraphicsConfiguration.java.

Constructor & Destructor Documentation

◆ AWTGraphicsConfiguration()

com.jogamp.nativewindow.awt.AWTGraphicsConfiguration.AWTGraphicsConfiguration ( final AWTGraphicsScreen  screen,
final CapabilitiesImmutable  capsChosen,
final CapabilitiesImmutable  capsRequested,
final GraphicsConfiguration  config,
final AbstractGraphicsConfiguration  encapsulated 
)

Definition at line 60 of file AWTGraphicsConfiguration.java.

Here is the caller graph for this function:

Member Function Documentation

◆ clone()

Object com.jogamp.nativewindow.awt.AWTGraphicsConfiguration.clone ( )

◆ create()

static AWTGraphicsConfiguration com.jogamp.nativewindow.awt.AWTGraphicsConfiguration.create ( final GraphicsConfiguration  gc,
CapabilitiesImmutable  capsChosen,
CapabilitiesImmutable  capsRequested 
)
static

Method constructs a new AWTGraphicsConfiguration primarily based on the given GraphicsConfiguration.

Parameters
gcthe GraphicsConfiguration for the resulting AWTGraphicsConfiguration
capsChosenif null, capsRequested is copied and aligned with the graphics Capabilities of the AWT Component to produce the chosen Capabilities. Otherwise the capsChosen is used.
capsRequestedif null, default Capabilities are used, otherwise the given values.

Definition at line 84 of file AWTGraphicsConfiguration.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAWTGraphicsConfiguration()

GraphicsConfiguration com.jogamp.nativewindow.awt.AWTGraphicsConfiguration.getAWTGraphicsConfiguration ( )

Return the AWT GraphicsConfiguration.

Definition at line 124 of file AWTGraphicsConfiguration.java.

Here is the caller graph for this function:

◆ getNativeGraphicsConfiguration()

AbstractGraphicsConfiguration com.jogamp.nativewindow.awt.AWTGraphicsConfiguration.getNativeGraphicsConfiguration ( )

In case the implementation utilizes a delegation pattern to wrap abstract toolkits, this method shall return the native AbstractGraphicsConfiguration, otherwise this instance.

See also
NativeSurface::getGraphicsConfiguration()

Reimplemented from com.jogamp.nativewindow.DefaultGraphicsConfiguration.

Definition at line 129 of file AWTGraphicsConfiguration.java.

Here is the caller graph for this function:

◆ setChosenCapabilities()

void com.jogamp.nativewindow.awt.AWTGraphicsConfiguration.setChosenCapabilities ( final CapabilitiesImmutable  capsChosen)

Set the capabilities to a new value.

The use case for setting the Capabilities at a later time is a change or re-validation of capabilities.

See also
com.jogamp.nativewindow.GraphicsConfigurationFactory::chooseGraphicsConfiguration(Capabilities, CapabilitiesChooser, AbstractGraphicsScreen)

Reimplemented from com.jogamp.nativewindow.DefaultGraphicsConfiguration.

Definition at line 114 of file AWTGraphicsConfiguration.java.

Here is the caller graph for this function:

◆ setupCapabilitiesRGBABits()

static CapabilitiesImmutable com.jogamp.nativewindow.awt.AWTGraphicsConfiguration.setupCapabilitiesRGBABits ( final CapabilitiesImmutable  capabilitiesIn,
final GraphicsConfiguration  gc 
)
static

Sets up the Capabilities' RGBA size based on the given GraphicsConfiguration's ColorModel.

Parameters
capabilitiesthe Capabilities object whose red, green, blue, and alpha bits will be set
gcthe GraphicsConfiguration from which to derive the RGBA bit depths
Returns
the passed Capabilities

Definition at line 140 of file AWTGraphicsConfiguration.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ toString()

String com.jogamp.nativewindow.awt.AWTGraphicsConfiguration.toString ( )

Reimplemented from com.jogamp.nativewindow.DefaultGraphicsConfiguration.

Definition at line 173 of file AWTGraphicsConfiguration.java.

Here is the call graph for this function:

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