Package com.jogamp.opengl

Class GLCapabilities

java.lang.Object
com.jogamp.nativewindow.Capabilities
com.jogamp.opengl.GLCapabilities
All Implemented Interfaces:
com.jogamp.common.type.WriteCloneable, CapabilitiesImmutable, VisualIDHolder, GLCapabilitiesImmutable, Cloneable, Comparable<CapabilitiesImmutable>
public class GLCapabilities extends Capabilities implements Cloneable, GLCapabilitiesImmutable
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 GLDrawables 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.

  • Constructor Details

    • GLCapabilities

      public GLCapabilities(GLProfile glp) throws GLException
      Creates a GLCapabilities object. All attributes are in a default state.
      Parameters:
      glp - GLProfile, or null for the default GLProfile
      Throws:
      GLException - if no profile is given and no default profile is available for the default device.

  • Method Details

    • cloneMutable

      public Object cloneMutable()
      Specified by:
      cloneMutable in interface com.jogamp.common.type.WriteCloneable
      Overrides:
      cloneMutable in class Capabilities

    • clone

      public Object clone()
      Overrides:
      clone in class Capabilities

    • copyFrom

      public GLCapabilities copyFrom(GLCapabilitiesImmutable source)
      Copies all GLCapabilitiesImmutable values from source into this instance.
      Returns:
      this instance

    • hashCode

      public int hashCode()
      Description copied from interface: com.jogamp.nativewindow.CapabilitiesImmutable
      hash code over the immutable attributes of both objects
      Specified by:
      hashCode in interface CapabilitiesImmutable
      Specified by:
      hashCode in interface GLCapabilitiesImmutable
      Overrides:
      hashCode in class Capabilities

    • equals

      public boolean equals(Object obj)
      Description copied from interface: com.jogamp.nativewindow.CapabilitiesImmutable
      Equality over the immutable attributes of both objects
      Specified by:
      equals in interface CapabilitiesImmutable
      Specified by:
      equals in interface GLCapabilitiesImmutable
      Overrides:
      equals in class Capabilities

    • compareTo

      public int compareTo(CapabilitiesImmutable o)
      comparing hw/sw, stereo, multisample, stencil, RGBA and depth only
      Specified by:
      compareTo in interface Comparable<CapabilitiesImmutable>
      Overrides:
      compareTo in class Capabilities

    • getGLProfile

      public final GLProfile getGLProfile()
      Description copied from interface: GLCapabilitiesImmutable
      Returns the GL profile you desire or used by the drawable.
      Specified by:
      getGLProfile in interface GLCapabilitiesImmutable

    • setGLProfile

      public void setGLProfile(GLProfile profile)
      Sets the GL profile you desire

    • isPBuffer

      public final boolean isPBuffer()
      Description copied from interface: GLCapabilitiesImmutable
      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.

      Specified by:
      isPBuffer in interface GLCapabilitiesImmutable

    • setPBuffer

      public void setPBuffer(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.

    • isFBO

      public final boolean isFBO()
      Description copied from interface: GLCapabilitiesImmutable
      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.

      Specified by:
      isFBO in interface GLCapabilitiesImmutable

    • setFBO

      public void setFBO(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.

    • getDoubleBuffered

      public final boolean getDoubleBuffered()
      Description copied from interface: GLCapabilitiesImmutable
      Returns whether double-buffering is requested, available or chosen.

      Default is true.

      Specified by:
      getDoubleBuffered in interface GLCapabilitiesImmutable

    • setDoubleBuffered

      public void setDoubleBuffered(boolean enable)
      Enables or disables double buffering.

    • getStereo

      public final boolean getStereo()
      Description copied from interface: GLCapabilitiesImmutable
      Returns whether stereo is requested, available or chosen.

      Default is false.

      Specified by:
      getStereo in interface GLCapabilitiesImmutable

    • setStereo

      public void setStereo(boolean enable)
      Enables or disables stereo viewing.

    • getHardwareAccelerated

      public final boolean getHardwareAccelerated()
      Description copied from interface: GLCapabilitiesImmutable
      Returns whether hardware acceleration is requested, available or chosen.

      Default is true.

      Specified by:
      getHardwareAccelerated in interface GLCapabilitiesImmutable

    • setHardwareAccelerated

      public void setHardwareAccelerated(boolean enable)
      Enables or disables hardware acceleration.

    • getDepthBits

      public final int getDepthBits()
      Description copied from interface: GLCapabilitiesImmutable
      Returns the number of depth buffer bits.
      Specified by:
      getDepthBits in interface GLCapabilitiesImmutable

    • setDepthBits

      public void setDepthBits(int depthBits)
      Sets the number of bits requested for the depth buffer.

    • getStencilBits

      public final int getStencilBits()
      Description copied from interface: GLCapabilitiesImmutable
      Returns the number of stencil buffer bits.

      Default is 0.

      Specified by:
      getStencilBits in interface GLCapabilitiesImmutable

    • setStencilBits

      public void setStencilBits(int stencilBits)
      Sets the number of bits requested for the stencil buffer.

    • getAccumRedBits

      public final int getAccumRedBits()
      Description copied from interface: GLCapabilitiesImmutable
      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.
      Specified by:
      getAccumRedBits in interface GLCapabilitiesImmutable

    • setAccumRedBits

      public void setAccumRedBits(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.

    • getAccumGreenBits

      public final int getAccumGreenBits()
      Description copied from interface: GLCapabilitiesImmutable
      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.
      Specified by:
      getAccumGreenBits in interface GLCapabilitiesImmutable

    • setAccumGreenBits

      public void setAccumGreenBits(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.

    • getAccumBlueBits

      public final int getAccumBlueBits()
      Description copied from interface: GLCapabilitiesImmutable
      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.
      Specified by:
      getAccumBlueBits in interface GLCapabilitiesImmutable

    • setAccumBlueBits

      public void setAccumBlueBits(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.

    • getAccumAlphaBits

      public final int getAccumAlphaBits()
      Description copied from interface: GLCapabilitiesImmutable
      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.
      Specified by:
      getAccumAlphaBits in interface GLCapabilitiesImmutable

    • setAccumAlphaBits

      public void setAccumAlphaBits(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.

    • setSampleExtension

      public void setSampleExtension(String se)
      Sets the desired extension for full-scene antialiasing (FSAA), default is GLCapabilitiesImmutable.DEFAULT_SAMPLE_EXTENSION.

    • getSampleExtension

      public final String getSampleExtension()
      Description copied from interface: GLCapabilitiesImmutable
      Returns the extension for full-scene antialiasing (FSAA).

      Default is GLCapabilitiesImmutable.DEFAULT_SAMPLE_EXTENSION.

      Specified by:
      getSampleExtension in interface GLCapabilitiesImmutable

    • setSampleBuffers

      public void setSampleBuffers(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 Capabilities.getAlphaBits() == 0.

    • getSampleBuffers

      public final boolean getSampleBuffers()
      Description copied from interface: GLCapabilitiesImmutable
      Returns whether sample buffers for full-scene antialiasing (FSAA) should be allocated for this drawable.

      Default is false.

      Specified by:
      getSampleBuffers in interface GLCapabilitiesImmutable

    • setNumSamples

      public void setNumSamples(int numSamples)
      If sample buffers are enabled, indicates the number of buffers to be allocated. Defaults to 2.
      See Also:

    • getNumSamples

      public final int getNumSamples()
      Description copied from interface: GLCapabilitiesImmutable
      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.

      Specified by:
      getNumSamples in interface GLCapabilitiesImmutable

    • toString

      public StringBuilder toString(StringBuilder sink)
      Description copied from interface: com.jogamp.nativewindow.CapabilitiesImmutable
      Return a textual representation of this object. Use the given StringBuilder [optional].
      Specified by:
      toString in interface CapabilitiesImmutable
      Overrides:
      toString in class Capabilities

    • toString

      public String toString()
      Returns a textual representation of this GLCapabilities object.
      Specified by:
      toString in interface CapabilitiesImmutable
      Specified by:
      toString in interface GLCapabilitiesImmutable
      Overrides:
      toString in class Capabilities