JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.GLCapabilitiesImmutable Interface Reference

Specifies an immutable set of OpenGL capabilities. More...

Inheritance diagram for com.jogamp.opengl.GLCapabilitiesImmutable:
Collaboration diagram for com.jogamp.opengl.GLCapabilitiesImmutable:

Public Member Functions

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...
 
- Public Member Functions inherited from com.jogamp.nativewindow.CapabilitiesImmutable
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...
 
- Public Member Functions inherited from com.jogamp.nativewindow.VisualIDHolder
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 Attributes

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...
 
- 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...
 

Detailed Description

Specifies an immutable set of OpenGL capabilities.


See also
com.jogamp.opengl.GLCapabilities
com.jogamp.nativewindow.CapabilitiesImmutable

Definition at line 39 of file GLCapabilitiesImmutable.java.

Member Function Documentation

◆ equals()

boolean com.jogamp.opengl.GLCapabilitiesImmutable.equals ( Object  obj)

Equality over the immutable attributes of both objects.

Implements com.jogamp.nativewindow.CapabilitiesImmutable.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getAccumAlphaBits()

int com.jogamp.opengl.GLCapabilitiesImmutable.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.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getAccumBlueBits()

int com.jogamp.opengl.GLCapabilitiesImmutable.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.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getAccumGreenBits()

int com.jogamp.opengl.GLCapabilitiesImmutable.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.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getAccumRedBits()

int com.jogamp.opengl.GLCapabilitiesImmutable.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.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getDepthBits()

int com.jogamp.opengl.GLCapabilitiesImmutable.getDepthBits ( )

Returns the number of depth buffer bits.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getDoubleBuffered()

boolean com.jogamp.opengl.GLCapabilitiesImmutable.getDoubleBuffered ( )

Returns whether double-buffering is requested, available or chosen.

Default is true.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getGLProfile()

GLProfile com.jogamp.opengl.GLCapabilitiesImmutable.getGLProfile ( )

Returns the GL profile you desire or used by the drawable.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getHardwareAccelerated()

boolean com.jogamp.opengl.GLCapabilitiesImmutable.getHardwareAccelerated ( )

Returns whether hardware acceleration is requested, available or chosen.

Default is true.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getNumSamples()

int com.jogamp.opengl.GLCapabilitiesImmutable.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.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getSampleBuffers()

boolean com.jogamp.opengl.GLCapabilitiesImmutable.getSampleBuffers ( )

Returns whether sample buffers for full-scene antialiasing (FSAA) should be allocated for this drawable.

Default is false.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getSampleExtension()

String com.jogamp.opengl.GLCapabilitiesImmutable.getSampleExtension ( )

Returns the extension for full-scene antialiasing (FSAA).

Default is DEFAULT_SAMPLE_EXTENSION.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getStencilBits()

int com.jogamp.opengl.GLCapabilitiesImmutable.getStencilBits ( )

Returns the number of stencil buffer bits.

Default is 0.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ getStereo()

boolean com.jogamp.opengl.GLCapabilitiesImmutable.getStereo ( )

Returns whether stereo is requested, available or chosen.

Default is false.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ hashCode()

int com.jogamp.opengl.GLCapabilitiesImmutable.hashCode ( )

Hash code over the immutable attributes.

Implements com.jogamp.nativewindow.CapabilitiesImmutable.

Implemented in com.jogamp.opengl.GLCapabilities.

◆ isFBO()

boolean com.jogamp.opengl.GLCapabilitiesImmutable.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.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ isPBuffer()

boolean com.jogamp.opengl.GLCapabilitiesImmutable.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.

Implemented in com.jogamp.opengl.GLCapabilities.

Here is the caller graph for this function:

◆ toString()

String com.jogamp.opengl.GLCapabilitiesImmutable.toString ( )

Returns a textual representation of this object.

Implements com.jogamp.nativewindow.CapabilitiesImmutable.

Implemented in com.jogamp.opengl.GLCapabilities.

Member Data Documentation

◆ DEFAULT_SAMPLE_EXTENSION

final String com.jogamp.opengl.GLCapabilitiesImmutable.DEFAULT_SAMPLE_EXTENSION = "default"
static

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

Definition at line 45 of file GLCapabilitiesImmutable.java.


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