Top Description Fields Methods
com.jogamp.nativewindow

public Interface CapabilitiesImmutable

extends VisualIDHolder, WriteCloneable, Comparable<CapabilitiesImmutable>
Known Direct Subinterfaces
com.jogamp.opengl.GLCapabilitiesImmutable
Known Direct Implementers
com.jogamp.nativewindow.Capabilities
Imports
com.jogamp.common.type.WriteCloneable

Specifies an immutable set of capabilities that a window's rendering context must support, such as color depth per channel.
See Also
com.jogamp.nativewindow.Capabilities

Field Summary

Inherited from com.jogamp.nativewindow.VisualIDHolder:
VID_UNDEFINED

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object obj)

Equality over the immutable attributes of both objects

public int
getAlphaBits()

Returns the number of bits for the color buffer's alpha component.

public int
getBlueBits()

Returns the number of bits for the color buffer's blue component.

public int
getGreenBits()

Returns the number of bits for the color buffer's green component.

public int
getRedBits()

Returns the number of bits for the color buffer's red component.

public int
getTransparentAlphaValue()

Gets the transparent alpha value for the frame buffer configuration.

public int
getTransparentBlueValue()

Gets the transparent blue value for the frame buffer configuration.

public int
getTransparentGreenValue()

Gets the transparent green value for the frame buffer configuration.

public int
getTransparentRedValue()

Gets the transparent red value for the frame buffer configuration.

public int
hashCode()

hash code over the immutable attributes of both objects

public boolean
isBackgroundOpaque()

Returns whether an opaque or translucent surface is requested, supported or chosen.

public boolean
isBitmap()

Returns whether bitmap offscreen mode is requested, available or chosen.

public boolean
isOnscreen()

Returns whether an on- or offscreen surface is requested, available or chosen.

public StringBuilder
toString(StringBuilder sink)

Return a textual representation of this object.

public String
toString()

Returns a textual representation of this object.

Inherited from com.jogamp.common.type.WriteCloneable:
cloneMutable
Inherited from com.jogamp.nativewindow.VisualIDHolder:
getVisualID
Inherited from java.lang.Comparable:
compareTo

Method Detail

equalsback to summary
public boolean equals(Object obj)

Equality over the immutable attributes of both objects

Annotations
@Override
getAlphaBitsback to summary
public 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.

getBlueBitsback to summary
public 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.

getGreenBitsback to summary
public 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.

getRedBitsback to summary
public 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.

getTransparentAlphaValueback to summary
public int getTransparentAlphaValue()

Gets the transparent alpha value for the frame buffer configuration. This value is undefined if; equals true.

getTransparentBlueValueback to summary
public int getTransparentBlueValue()

Gets the transparent blue value for the frame buffer configuration. This value is undefined if; equals true.

getTransparentGreenValueback to summary
public int getTransparentGreenValue()

Gets the transparent green value for the frame buffer configuration. This value is undefined if; equals true.

getTransparentRedValueback to summary
public int getTransparentRedValue()

Gets the transparent red value for the frame buffer configuration. This value is undefined if; equals true.

hashCodeback to summary
public int hashCode()

hash code over the immutable attributes of both objects

Annotations
@Override
isBackgroundOpaqueback to summary
public boolean isBackgroundOpaque()

Returns whether an opaque or translucent surface is requested, supported or chosen.

Default is true, i.e. opaque.

isBitmapback to summary
public 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.

isOnscreenback to summary
public 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.

toStringback to summary
public StringBuilder toString(StringBuilder sink)

Return a textual representation of this object. Use the given StringBuilder [optional].

toStringback to summary
public String toString()

Returns a textual representation of this object.

Annotations
@Override