JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java (public API).
|
Specifies a set of OpenGL capabilities. More...
Public Member Functions | |
GLCapabilities (final GLProfile glp) throws GLException | |
Creates a GLCapabilities object. More... | |
Object | cloneMutable () |
Object | clone () |
GLCapabilities | copyFrom (final CapabilitiesImmutable source) |
Copies all CapabilitiesImmutable values from source into this instance. More... | |
GLCapabilities | copyFrom (final GLCapabilitiesImmutable source) |
Copies all GLCapabilitiesImmutable values from source into this instance. More... | |
int | hashCode () |
Hash code over the immutable attributes. More... | |
boolean | equals (final Object obj) |
Equality over the immutable attributes of both objects. More... | |
int | compareTo (final CapabilitiesImmutable o) |
comparing hw/sw, stereo, multisample, stencil, RGBA and depth only More... | |
final GLProfile | getGLProfile () |
Returns the GL profile you desire or used by the drawable. More... | |
void | setGLProfile (final GLProfile profile) |
Sets the GL profile you desire. More... | |
final boolean | isPBuffer () |
Returns whether pbuffer offscreen mode is requested, available or chosen. More... | |
void | setPBuffer (final boolean enable) |
Requesting offscreen pbuffer mode. More... | |
final boolean | isFBO () |
Returns whether FBO offscreen mode is requested, available or chosen. More... | |
void | setFBO (final boolean enable) |
Requesting offscreen FBO mode. More... | |
final boolean | getDoubleBuffered () |
Returns whether double-buffering is requested, available or chosen. More... | |
void | setDoubleBuffered (final boolean enable) |
Enables or disables double buffering. More... | |
final boolean | getStereo () |
Returns whether stereo is requested, available or chosen. More... | |
void | setStereo (final boolean enable) |
Enables or disables stereo viewing. More... | |
final boolean | getHardwareAccelerated () |
Returns whether hardware acceleration is requested, available or chosen. More... | |
void | setHardwareAccelerated (final boolean enable) |
Enables or disables hardware acceleration. More... | |
final int | getDepthBits () |
Returns the number of depth buffer bits. More... | |
void | setDepthBits (final int depthBits) |
Sets the number of bits requested for the depth buffer. More... | |
final int | getStencilBits () |
Returns the number of stencil buffer bits. More... | |
void | setStencilBits (final int stencilBits) |
Sets the number of bits requested for the stencil buffer. More... | |
final int | getAccumRedBits () |
Returns the number of bits for the accumulation buffer's red component. More... | |
void | setAccumRedBits (final int accumRedBits) |
Sets the number of bits requested for the accumulation buffer's red component. More... | |
final int | getAccumGreenBits () |
Returns the number of bits for the accumulation buffer's green component. More... | |
void | setAccumGreenBits (final int accumGreenBits) |
Sets the number of bits requested for the accumulation buffer's green component. More... | |
final int | getAccumBlueBits () |
Returns the number of bits for the accumulation buffer's blue component. More... | |
void | setAccumBlueBits (final int accumBlueBits) |
Sets the number of bits requested for the accumulation buffer's blue component. More... | |
final int | getAccumAlphaBits () |
Returns the number of bits for the accumulation buffer's alpha component. More... | |
void | setAccumAlphaBits (final int accumAlphaBits) |
Sets number of bits requested for accumulation buffer's alpha component. More... | |
void | setSampleExtension (final String se) |
Sets the desired extension for full-scene antialiasing (FSAA), default is DEFAULT_SAMPLE_EXTENSION . More... | |
final String | getSampleExtension () |
Returns the extension for full-scene antialiasing (FSAA). More... | |
void | setSampleBuffers (final boolean enable) |
Defaults to false. More... | |
final boolean | getSampleBuffers () |
Returns whether sample buffers for full-scene antialiasing (FSAA) should be allocated for this drawable. More... | |
void | setNumSamples (final int numSamples) |
If sample buffers are enabled, indicates the number of buffers to be allocated. More... | |
final int | getNumSamples () |
Returns the number of sample buffers to be allocated if sample buffers are enabled, otherwise returns 0. More... | |
StringBuilder | toString (StringBuilder sink) |
Return a textual representation of this object. More... | |
String | toString () |
Returns a textual representation of this GLCapabilities object. More... | |
![]() | |
Capabilities () | |
Creates a Capabilities object. More... | |
Object | cloneMutable () |
Object | clone () |
Capabilities | copyFrom (final CapabilitiesImmutable other) |
Copies all Capabilities values from source into this instance. More... | |
int | hashCode () |
Hash code over the immutable attributes. More... | |
boolean | equals (final Object obj) |
Equality over the immutable attributes of both objects. More... | |
int | compareTo (final CapabilitiesImmutable caps) |
Comparing RGBA values only. More... | |
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... | |
boolean | isVisualIDSupported (final VIDType type) |
Returns true if the given VIDType is supported, otherwise false. More... | |
final int | getRedBits () |
Returns the number of bits for the color buffer's red component. More... | |
void | setRedBits (final int redBits) |
Sets the number of bits requested for the color buffer's red component. More... | |
final int | getGreenBits () |
Returns the number of bits for the color buffer's green component. More... | |
void | setGreenBits (final int greenBits) |
Sets the number of bits requested for the color buffer's green component. More... | |
final int | getBlueBits () |
Returns the number of bits for the color buffer's blue component. More... | |
void | setBlueBits (final int blueBits) |
Sets the number of bits requested for the color buffer's blue component. More... | |
final int | getAlphaBits () |
Returns the number of bits for the color buffer's alpha component. More... | |
void | setAlphaBits (final int alphaBits) |
Sets the number of bits requested for the color buffer's alpha component. More... | |
void | setBackgroundOpaque (final boolean opaque) |
Sets whether the surface shall be opaque or translucent. More... | |
final boolean | isBackgroundOpaque () |
Returns whether an opaque or translucent surface is requested, supported or chosen. More... | |
void | setOnscreen (final boolean onscreen) |
Sets whether the surface shall be on- or offscreen. More... | |
final boolean | isOnscreen () |
Returns whether an on- or offscreen surface is requested, available or chosen. More... | |
void | setBitmap (final boolean enable) |
Requesting offscreen bitmap mode. More... | |
boolean | isBitmap () |
Returns whether bitmap offscreen mode is requested, available or chosen. More... | |
final int | getTransparentRedValue () |
Gets the transparent red value for the frame buffer configuration. More... | |
final int | getTransparentGreenValue () |
Gets the transparent green value for the frame buffer configuration. More... | |
final int | getTransparentBlueValue () |
Gets the transparent blue value for the frame buffer configuration. More... | |
final int | getTransparentAlphaValue () |
Gets the transparent alpha value for the frame buffer configuration. More... | |
void | setTransparentRedValue (final int transValueRed) |
Sets the transparent red value for the frame buffer configuration, ranging from 0 to the maximum frame buffer value for red. More... | |
void | setTransparentGreenValue (final int transValueGreen) |
Sets the transparent green value for the frame buffer configuration, ranging from 0 to the maximum frame buffer value for green. More... | |
void | setTransparentBlueValue (final int transValueBlue) |
Sets the transparent blue value for the frame buffer configuration, ranging from 0 to the maximum frame buffer value for blue. More... | |
void | setTransparentAlphaValue (final int transValueAlpha) |
Sets the transparent alpha value for the frame buffer configuration, ranging from 0 to the maximum frame buffer value for alpha. More... | |
StringBuilder | toString (final StringBuilder sink) |
Return a textual representation of this object. More... | |
String | toString () |
Returns a textual representation of this Capabilities object. More... | |
int | getRedBits () |
Returns the number of bits for the color buffer's red component. More... | |
int | getGreenBits () |
Returns the number of bits for the color buffer's green component. More... | |
int | getBlueBits () |
Returns the number of bits for the color buffer's blue component. More... | |
int | getAlphaBits () |
Returns the number of bits for the color buffer's alpha component. More... | |
boolean | isBackgroundOpaque () |
Returns whether an opaque or translucent surface is requested, supported or chosen. More... | |
boolean | isOnscreen () |
Returns whether an on- or offscreen surface is requested, available or chosen. More... | |
boolean | isBitmap () |
Returns whether bitmap offscreen mode is requested, available or chosen. More... | |
int | getTransparentRedValue () |
Gets the transparent red value for the frame buffer configuration. More... | |
int | getTransparentGreenValue () |
Gets the transparent green value for the frame buffer configuration. More... | |
int | getTransparentBlueValue () |
Gets the transparent blue value for the frame buffer configuration. More... | |
int | getTransparentAlphaValue () |
Gets the transparent alpha value for the frame buffer configuration. More... | |
boolean | equals (Object obj) |
Equality over the immutable attributes of both objects. More... | |
int | hashCode () |
Hash code over the immutable attributes. More... | |
StringBuilder | toString (StringBuilder sink) |
Return a textual representation of this object. More... | |
String | toString () |
Returns a textual representation of this object. 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... | |
GLProfile | getGLProfile () |
Returns the GL profile you desire or used by the drawable. More... | |
int | getAccumAlphaBits () |
Returns the number of bits for the accumulation buffer's alpha component. More... | |
int | getAccumBlueBits () |
Returns the number of bits for the accumulation buffer's blue component. More... | |
int | getAccumGreenBits () |
Returns the number of bits for the accumulation buffer's green component. More... | |
int | getAccumRedBits () |
Returns the number of bits for the accumulation buffer's red component. More... | |
int | getDepthBits () |
Returns the number of depth buffer bits. More... | |
boolean | getDoubleBuffered () |
Returns whether double-buffering is requested, available or chosen. More... | |
boolean | getHardwareAccelerated () |
Returns whether hardware acceleration is requested, available or chosen. More... | |
String | getSampleExtension () |
Returns the extension for full-scene antialiasing (FSAA). More... | |
boolean | getSampleBuffers () |
Returns whether sample buffers for full-scene antialiasing (FSAA) should be allocated for this drawable. More... | |
int | getNumSamples () |
Returns the number of sample buffers to be allocated if sample buffers are enabled, otherwise returns 0. More... | |
int | getStencilBits () |
Returns the number of stencil buffer bits. More... | |
boolean | getStereo () |
Returns whether stereo is requested, available or chosen. More... | |
boolean | isPBuffer () |
Returns whether pbuffer offscreen mode is requested, available or chosen. More... | |
boolean | isFBO () |
Returns whether FBO offscreen mode is requested, available or chosen. More... | |
boolean | equals (Object obj) |
Equality over the immutable attributes of both objects. More... | |
int | hashCode () |
Hash code over the immutable attributes. More... | |
String | toString () |
Returns a textual representation of this object. More... | |
Additional Inherited Members | |
![]() | |
static final int | VID_UNDEFINED = 0 |
getVisualID(VIDType) result indicating an undefined value, which could be cause by an unsupported query. More... | |
![]() | |
static final String | DEFAULT_SAMPLE_EXTENSION = "default" |
One of the platform's default sample extension EGL.EGL_SAMPLES, GLX.GLX_SAMPLES, WGLExt.WGL_SAMPLES_ARB if available, or any other known fallback one, ie EGLExt.EGL_COVERAGE_SAMPLES_NV More... | |
![]() | |
StringBuilder | onoffScreenToString (StringBuilder sink) |
Return a textual representation of this object's on/off screen state. More... | |
StringBuilder | toString (StringBuilder sink, final boolean withOnOffScreen) |
final String | toHexString (final int val) |
![]() | |
static final String | na_str = "----" |
static final String | ESEP = "/" |
Element separator. More... | |
static final String | CSEP = ", " |
Component separator. More... | |
Specifies a set of OpenGL capabilities.
At creation time of a GLDrawable
using GLDrawableFactory
, an instance of this class is passed, describing the desired capabilities that a rendering context must support, such as the OpenGL profile, color depth and whether stereo is enabled.
The actual capabilites of created GLDrawable
s are then reflected by their own GLCapabilites instance, which can be queried with GLDrawable#getChosenGLCapabilities()
.
It currently contains the minimal number of routines which allow configuration on all supported window systems.
Definition at line 58 of file GLCapabilities.java.
com.jogamp.opengl.GLCapabilities.GLCapabilities | ( | final GLProfile | glp | ) | throws GLException |
Creates a GLCapabilities object.
All attributes are in a default state.
GLException | if no profile is given and no default profile is available for the default device. |
Definition at line 83 of file GLCapabilities.java.
Object com.jogamp.opengl.GLCapabilities.clone | ( | ) |
Reimplemented from com.jogamp.nativewindow.Capabilities.
Definition at line 93 of file GLCapabilities.java.
Object com.jogamp.opengl.GLCapabilities.cloneMutable | ( | ) |
Reimplemented from com.jogamp.nativewindow.Capabilities.
Definition at line 88 of file GLCapabilities.java.
int com.jogamp.opengl.GLCapabilities.compareTo | ( | final CapabilitiesImmutable | o | ) |
comparing hw/sw, stereo, multisample, stencil, RGBA and depth only
Reimplemented from com.jogamp.nativewindow.Capabilities.
Definition at line 187 of file GLCapabilities.java.
GLCapabilities com.jogamp.opengl.GLCapabilities.copyFrom | ( | final CapabilitiesImmutable | source | ) |
Copies all CapabilitiesImmutable
values from source
into this instance.
Reimplemented from com.jogamp.nativewindow.Capabilities.
Definition at line 106 of file GLCapabilities.java.
GLCapabilities com.jogamp.opengl.GLCapabilities.copyFrom | ( | final GLCapabilitiesImmutable | source | ) |
Copies all GLCapabilitiesImmutable
values from source
into this instance.
Definition at line 116 of file GLCapabilities.java.
boolean com.jogamp.opengl.GLCapabilities.equals | ( | final Object | obj | ) |
Equality over the immutable attributes of both objects.
Reimplemented from com.jogamp.nativewindow.Capabilities.
Definition at line 158 of file GLCapabilities.java.
final int com.jogamp.opengl.GLCapabilities.getAccumAlphaBits | ( | ) |
Returns the number of bits for the accumulation buffer's alpha component.
On some systems only the accumulation buffer depth, which is the sum of the red, green, and blue bits, is considered.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 390 of file GLCapabilities.java.
final int com.jogamp.opengl.GLCapabilities.getAccumBlueBits | ( | ) |
Returns the number of bits for the accumulation buffer's blue component.
On some systems only the accumulation buffer depth, which is the sum of the red, green, and blue bits, is considered.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 377 of file GLCapabilities.java.
final int com.jogamp.opengl.GLCapabilities.getAccumGreenBits | ( | ) |
Returns the number of bits for the accumulation buffer's green component.
On some systems only the accumulation buffer depth, which is the sum of the red, green, and blue bits, is considered.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 364 of file GLCapabilities.java.
final int com.jogamp.opengl.GLCapabilities.getAccumRedBits | ( | ) |
Returns the number of bits for the accumulation buffer's red component.
On some systems only the accumulation buffer depth, which is the sum of the red, green, and blue bits, is considered.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 351 of file GLCapabilities.java.
final int com.jogamp.opengl.GLCapabilities.getDepthBits | ( | ) |
Returns the number of depth buffer bits.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 331 of file GLCapabilities.java.
final boolean com.jogamp.opengl.GLCapabilities.getDoubleBuffered | ( | ) |
Returns whether double-buffering is requested, available or chosen.
Default is true.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 301 of file GLCapabilities.java.
final GLProfile com.jogamp.opengl.GLCapabilities.getGLProfile | ( | ) |
Returns the GL profile you desire or used by the drawable.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 243 of file GLCapabilities.java.
final boolean com.jogamp.opengl.GLCapabilities.getHardwareAccelerated | ( | ) |
Returns whether hardware acceleration is requested, available or chosen.
Default is true.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 321 of file GLCapabilities.java.
final int com.jogamp.opengl.GLCapabilities.getNumSamples | ( | ) |
Returns the number of sample buffers to be allocated if sample buffers are enabled, otherwise returns 0.
Default is 0 due to disable sample buffers per default.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 445 of file GLCapabilities.java.
final boolean com.jogamp.opengl.GLCapabilities.getSampleBuffers | ( | ) |
Returns whether sample buffers for full-scene antialiasing (FSAA) should be allocated for this drawable.
Default is false.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 431 of file GLCapabilities.java.
final String com.jogamp.opengl.GLCapabilities.getSampleExtension | ( | ) |
Returns the extension for full-scene antialiasing (FSAA).
Default is DEFAULT_SAMPLE_EXTENSION
.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 411 of file GLCapabilities.java.
final int com.jogamp.opengl.GLCapabilities.getStencilBits | ( | ) |
Returns the number of stencil buffer bits.
Default is 0.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 341 of file GLCapabilities.java.
final boolean com.jogamp.opengl.GLCapabilities.getStereo | ( | ) |
Returns whether stereo is requested, available or chosen.
Default is false.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 311 of file GLCapabilities.java.
int com.jogamp.opengl.GLCapabilities.hashCode | ( | ) |
Hash code over the immutable attributes.
Reimplemented from com.jogamp.nativewindow.Capabilities.
Definition at line 137 of file GLCapabilities.java.
final boolean com.jogamp.opengl.GLCapabilities.isFBO | ( | ) |
Returns whether FBO offscreen mode is requested, available or chosen.
Default is false.
For chosen capabilities, only the selected offscreen surface is set to true
.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 277 of file GLCapabilities.java.
final boolean com.jogamp.opengl.GLCapabilities.isPBuffer | ( | ) |
Returns whether pbuffer offscreen mode is requested, available or chosen.
Default is false.
For chosen capabilities, only the selected offscreen surface is set to true
.
Implements com.jogamp.opengl.GLCapabilitiesImmutable.
Definition at line 253 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setAccumAlphaBits | ( | final int | accumAlphaBits | ) |
Sets number of bits requested for accumulation buffer's alpha component.
On some systems only the accumulation buffer depth, which is the sum of the red, green, and blue bits, is considered.
Definition at line 398 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setAccumBlueBits | ( | final int | accumBlueBits | ) |
Sets the number of bits requested for the accumulation buffer's blue component.
On some systems only the accumulation buffer depth, which is the sum of the red, green, and blue bits, is considered.
Definition at line 385 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setAccumGreenBits | ( | final int | accumGreenBits | ) |
Sets the number of bits requested for the accumulation buffer's green component.
On some systems only the accumulation buffer depth, which is the sum of the red, green, and blue bits, is considered.
Definition at line 372 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setAccumRedBits | ( | final int | accumRedBits | ) |
Sets the number of bits requested for the accumulation buffer's red component.
On some systems only the accumulation buffer depth, which is the sum of the red, green, and blue bits, is considered.
Definition at line 359 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setDepthBits | ( | final int | depthBits | ) |
Sets the number of bits requested for the depth buffer.
Definition at line 336 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setDoubleBuffered | ( | final boolean | enable | ) |
Enables or disables double buffering.
Definition at line 306 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setFBO | ( | final boolean | enable | ) |
Requesting offscreen FBO mode.
If enabled this method also invokes setOnscreen(false)
.
Defaults to false.
Requesting offscreen FBO mode disables the offscreen auto selection.
Definition at line 293 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setGLProfile | ( | final GLProfile | profile | ) |
Sets the GL profile you desire.
Definition at line 248 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setHardwareAccelerated | ( | final boolean | enable | ) |
Enables or disables hardware acceleration.
Definition at line 326 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setNumSamples | ( | final int | numSamples | ) |
If sample buffers are enabled, indicates the number of buffers to be allocated.
Defaults to 2.
Definition at line 440 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setPBuffer | ( | final boolean | enable | ) |
Requesting offscreen pbuffer mode.
If enabled this method also invokes setOnscreen(false)
.
Defaults to false.
Requesting offscreen pbuffer mode disables the offscreen auto selection.
Definition at line 269 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setSampleBuffers | ( | final boolean | enable | ) |
Defaults to false.
Indicates whether sample buffers for full-scene antialiasing (FSAA) should be allocated for this drawable.
Mind that this requires the alpha component.
If enabled this method also invokes setAlphaBits(1)
if getAlphaBits()
== 0.
Definition at line 423 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setSampleExtension | ( | final String | se | ) |
Sets the desired extension for full-scene antialiasing (FSAA), default is DEFAULT_SAMPLE_EXTENSION
.
Definition at line 406 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setStencilBits | ( | final int | stencilBits | ) |
Sets the number of bits requested for the stencil buffer.
Definition at line 346 of file GLCapabilities.java.
void com.jogamp.opengl.GLCapabilities.setStereo | ( | final boolean | enable | ) |
Enables or disables stereo viewing.
Definition at line 316 of file GLCapabilities.java.
String com.jogamp.opengl.GLCapabilities.toString | ( | ) |
Returns a textual representation of this GLCapabilities object.
Reimplemented from com.jogamp.nativewindow.Capabilities.
Definition at line 515 of file GLCapabilities.java.
StringBuilder com.jogamp.opengl.GLCapabilities.toString | ( | StringBuilder | sink | ) |
Return a textual representation of this object.
Use the given StringBuilder [optional].
Reimplemented from com.jogamp.nativewindow.Capabilities.
Definition at line 450 of file GLCapabilities.java.