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

Specifies an immutable set of capabilities that a window's rendering context must support, such as color depth per channel. More...

Inheritance diagram for com.jogamp.nativewindow.CapabilitiesImmutable:
Collaboration diagram for com.jogamp.nativewindow.CapabilitiesImmutable:

Public Member Functions

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

Additional Inherited Members

- 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 capabilities that a window's rendering context must support, such as color depth per channel.

See also
com.jogamp.nativewindow.Capabilities

Definition at line 39 of file CapabilitiesImmutable.java.

Member Function Documentation

◆ equals()

boolean com.jogamp.nativewindow.CapabilitiesImmutable.equals ( Object  obj)

Equality over the immutable attributes of both objects.

Implemented in com.jogamp.opengl.GLCapabilities, com.jogamp.nativewindow.Capabilities, and com.jogamp.opengl.GLCapabilitiesImmutable.

Here is the caller graph for this function:

◆ getAlphaBits()

int com.jogamp.nativewindow.CapabilitiesImmutable.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.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ getBlueBits()

int com.jogamp.nativewindow.CapabilitiesImmutable.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.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ getGreenBits()

int com.jogamp.nativewindow.CapabilitiesImmutable.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.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ getRedBits()

int com.jogamp.nativewindow.CapabilitiesImmutable.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.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ getTransparentAlphaValue()

int com.jogamp.nativewindow.CapabilitiesImmutable.getTransparentAlphaValue ( )

Gets the transparent alpha value for the frame buffer configuration.

This value is undefined if; equals true.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ getTransparentBlueValue()

int com.jogamp.nativewindow.CapabilitiesImmutable.getTransparentBlueValue ( )

Gets the transparent blue value for the frame buffer configuration.

This value is undefined if; equals true.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ getTransparentGreenValue()

int com.jogamp.nativewindow.CapabilitiesImmutable.getTransparentGreenValue ( )

Gets the transparent green value for the frame buffer configuration.

This value is undefined if; equals true.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ getTransparentRedValue()

int com.jogamp.nativewindow.CapabilitiesImmutable.getTransparentRedValue ( )

Gets the transparent red value for the frame buffer configuration.

This value is undefined if; equals true.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ hashCode()

int com.jogamp.nativewindow.CapabilitiesImmutable.hashCode ( )

◆ isBackgroundOpaque()

boolean com.jogamp.nativewindow.CapabilitiesImmutable.isBackgroundOpaque ( )

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

Default is true, i.e. opaque.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ isBitmap()

boolean com.jogamp.nativewindow.CapabilitiesImmutable.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.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ isOnscreen()

boolean com.jogamp.nativewindow.CapabilitiesImmutable.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.

Implemented in com.jogamp.nativewindow.Capabilities.

Here is the caller graph for this function:

◆ toString() [1/2]

String com.jogamp.nativewindow.CapabilitiesImmutable.toString ( )

Returns a textual representation of this object.

Implemented in com.jogamp.opengl.GLCapabilities, com.jogamp.opengl.GLCapabilitiesImmutable, and com.jogamp.nativewindow.Capabilities.

◆ toString() [2/2]

StringBuilder com.jogamp.nativewindow.CapabilitiesImmutable.toString ( StringBuilder  sink)

Return a textual representation of this object.

Use the given StringBuilder [optional].

Implemented in com.jogamp.nativewindow.Capabilities, and com.jogamp.opengl.GLCapabilities.


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