Interface CapabilitiesImmutable

All Superinterfaces:
Comparable<CapabilitiesImmutable>, VisualIDHolder, com.jogamp.common.type.WriteCloneable
All Known Implementing Classes:
Capabilities

public interface CapabilitiesImmutable extends VisualIDHolder, com.jogamp.common.type.WriteCloneable, Comparable<CapabilitiesImmutable>
Specifies an immutable set of capabilities that a window's rendering context must support, such as color depth per channel.
See Also:
  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.jogamp.nativewindow.VisualIDHolder

    VisualIDHolder.VIDComparator, VisualIDHolder.VIDType
  • Field Summary

    Fields inherited from interface com.jogamp.nativewindow.VisualIDHolder

    VID_UNDEFINED
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Equality over the immutable attributes of both objects
    int
    Returns the number of bits for the color buffer's alpha component.
    int
    Returns the number of bits for the color buffer's blue component.
    int
    Returns the number of bits for the color buffer's green component.
    int
    Returns the number of bits for the color buffer's red component.
    int
    Gets the transparent alpha value for the frame buffer configuration.
    int
    Gets the transparent blue value for the frame buffer configuration.
    int
    Gets the transparent green value for the frame buffer configuration.
    int
    Gets the transparent red value for the frame buffer configuration.
    int
    hash code over the immutable attributes of both objects
    boolean
    Returns whether an opaque or translucent surface is requested, supported or chosen.
    boolean
    Returns whether bitmap offscreen mode is requested, available or chosen.
    boolean
    Returns whether an on- or offscreen surface is requested, available or chosen.
    Returns a textual representation of this object.
    Return a textual representation of this object.

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface com.jogamp.nativewindow.VisualIDHolder

    getVisualID

    Methods inherited from interface com.jogamp.common.type.WriteCloneable

    cloneMutable
  • Method Details

    • getRedBits

      int getRedBits()
      Returns the number of bits for the color buffer's red component. On some systems only the color depth, which is the sum of the red, green, and blue bits, is considered.
    • getGreenBits

      int getGreenBits()
      Returns the number of bits for the color buffer's green component. On some systems only the color depth, which is the sum of the red, green, and blue bits, is considered.
    • getBlueBits

      int getBlueBits()
      Returns the number of bits for the color buffer's blue component. On some systems only the color depth, which is the sum of the red, green, and blue bits, is considered.
    • getAlphaBits

      int getAlphaBits()
      Returns the number of bits for the color buffer's alpha component. On some systems only the color depth, which is the sum of the red, green, and blue bits, is considered.
    • isBackgroundOpaque

      boolean isBackgroundOpaque()
      Returns whether an opaque or translucent surface is requested, supported or chosen.

      Default is true, i.e. opaque.

    • isOnscreen

      boolean isOnscreen()
      Returns whether an on- or offscreen surface is requested, available or chosen.

      Default is true, i.e. onscreen.

      Mind that an capabilities intance w/ available semantics may show onscreen, but also the offscreen modes FBO, Pbuffer or bitmap. This is valid, since one native configuration maybe used for either functionality.

    • isBitmap

      boolean isBitmap()
      Returns whether bitmap offscreen mode is requested, available or chosen.

      Default is false.

      For chosen capabilities, only the selected offscreen surface is set to true.

    • getTransparentRedValue

      int getTransparentRedValue()
      Gets the transparent red value for the frame buffer configuration. This value is undefined if; equals true.
    • getTransparentGreenValue

      int getTransparentGreenValue()
      Gets the transparent green value for the frame buffer configuration. This value is undefined if; equals true.
    • getTransparentBlueValue

      int getTransparentBlueValue()
      Gets the transparent blue value for the frame buffer configuration. This value is undefined if; equals true.
    • getTransparentAlphaValue

      int getTransparentAlphaValue()
      Gets the transparent alpha value for the frame buffer configuration. This value is undefined if; equals true.
    • equals

      boolean equals(Object obj)
      Equality over the immutable attributes of both objects
      Overrides:
      equals in class Object
    • hashCode

      int hashCode()
      hash code over the immutable attributes of both objects
      Overrides:
      hashCode in class Object
    • toString

      StringBuilder toString(StringBuilder sink)
      Return a textual representation of this object. Use the given StringBuilder [optional].
    • toString

      String toString()
      Returns a textual representation of this object.
      Overrides:
      toString in class Object