JOGL 2.3.2 · jogamp.nativewindow.x11.X11Capabilities

Modifier and Type	Field and Description
private final XVisualInfo	xVisualInfo

Access	Constructor and Description
public	X11Capabilities(final XVisualInfo xVisualInfo)

Modifier and Type	Method and Description
public Object	clone() Overrides com.jogamp.nativewindow.Capabilities.clone. Creates and returns a copy of this object.
public Object	cloneMutable() Overrides com.jogamp.nativewindow.Capabilities.cloneMutable. Implements com.jogamp.common.type.WriteCloneable.cloneMutable. Get a mutable clone from this instance.
public final int	getVisualID(final VisualIDHolder.VIDType type) Overrides com.jogamp.nativewindow.Capabilities.getVisualID. Implements com.jogamp.nativewindow.VisualIDHolder.getVisualID. Returns the native visual ID of the given `type` if supported, or `VID_UNDEFINED` if not supported.
public final int	getXVisualID()
public final XVisualInfo	getXVisualInfo()
public final boolean	hasXVisualInfo()
public StringBuilder	toString(StringBuilder sink) Overrides com.jogamp.nativewindow.Capabilities.toString. Implements com.jogamp.nativewindow.CapabilitiesImmutable.toString. Return a textual representation of this object.

xVisualInfo	back to summary
private final XVisualInfo xVisualInfo

X11Capabilities	back to summary
public X11Capabilities(final XVisualInfo xVisualInfo)

Method Detail

clone back to summary

clone	back to summary
public Object clone() Overrides com.jogamp.nativewindow.Capabilities.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override

public Object clone()

Overrides com.jogamp.nativewindow.Capabilities.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

cloneMutable	back to summary
public Object cloneMutable() Overrides com.jogamp.nativewindow.Capabilities.cloneMutable. Implements com.jogamp.common.type.WriteCloneable.cloneMutable. Doc from com.jogamp.common.type.WriteCloneable.cloneMutable. Get a mutable clone from this instance. Annotations @Override

cloneMutable

back to summary

public Object cloneMutable()

Overrides com.jogamp.nativewindow.Capabilities.cloneMutable.

Implements com.jogamp.common.type.WriteCloneable.cloneMutable.

Doc from com.jogamp.common.type.WriteCloneable.cloneMutable.

Get a mutable clone from this instance.

Annotations

@Override

getVisualID back to summary

getVisualID	back to summary
public final int getVisualID(final VisualIDHolder.VIDType type) throws NativeWindowException Overrides com.jogamp.nativewindow.Capabilities.getVisualID. Implements com.jogamp.nativewindow.VisualIDHolder.getVisualID. Doc from com.jogamp.nativewindow.VisualIDHolder.getVisualID. Returns the native visual ID of the given `type` if supported, or `VID_UNDEFINED` if not supported. Depending on the native windowing system, `type` is handled as follows: X11 throws NativeWindowException on `EGL_CONFIG`, `WIN32_PFD` `INTRINSIC`: X11 XVisual ID `NATIVE`: X11 XVisual ID `X11_XVISUAL`: X11 XVisual ID `X11_FBCONFIG`: `VID_UNDEFINED` X11/GL throws NativeWindowException on `EGL_CONFIG`, `WIN32_PFD` `INTRINSIC`: X11 XVisual ID `NATIVE`: X11 XVisual ID `X11_XVISUAL`: X11 XVisual ID `X11_FBCONFIG`: X11 FBConfig ID or `VID_UNDEFINED` Windows/GL throws NativeWindowException on `EGL_CONFIG`, `X11_XVISUAL`, `X11_FBCONFIG` `INTRINSIC`: Win32 PIXELFORMATDESCRIPTOR ID `NATIVE`: Win32 PIXELFORMATDESCRIPTOR ID `WIN32_PFD`: Win32 PIXELFORMATDESCRIPTOR ID EGL/GL throws NativeWindowException on `X11_XVISUAL`, `X11_FBCONFIG`, `WIN32_PFD` `INTRINSIC`: EGL Config ID `NATIVE`: EGL NativeVisual ID (X11 XVisual ID, Win32 PIXELFORMATDESCRIPTOR ID, ...) `EGL_CONFIG`: EGL Config ID Note: `INTRINSIC` and `NATIVE` are always handled, but may result in `VID_UNDEFINED`. The latter is true if the native value are actually undefined or the corresponding object is not mapped to a native visual object. Annotations @Override Exceptions NativeWindowException: if `type` is neither `INTRINSIC` nor `NATIVE` and does not match the native implementation.

public final int getVisualID(final VisualIDHolder.VIDType type) throws NativeWindowException

Overrides com.jogamp.nativewindow.Capabilities.getVisualID.

Implements com.jogamp.nativewindow.VisualIDHolder.getVisualID.

Doc from com.jogamp.nativewindow.VisualIDHolder.getVisualID.

Returns the native visual ID of the given type if supported, or VID_UNDEFINED if not supported.

Depending on the native windowing system, type is handled as follows:

X11 throws NativeWindowException on EGL_CONFIG, WIN32_PFD
- INTRINSIC: X11 XVisual ID
- NATIVE: X11 XVisual ID
- X11_XVISUAL: X11 XVisual ID
- X11_FBCONFIG: VID_UNDEFINED
X11/GL throws NativeWindowException on EGL_CONFIG, WIN32_PFD
- INTRINSIC: X11 XVisual ID
- NATIVE: X11 XVisual ID
- X11_XVISUAL: X11 XVisual ID
- X11_FBCONFIG: X11 FBConfig ID or VID_UNDEFINED
Windows/GL throws NativeWindowException on EGL_CONFIG, X11_XVISUAL, X11_FBCONFIG
- INTRINSIC: Win32 PIXELFORMATDESCRIPTOR ID
- NATIVE: Win32 PIXELFORMATDESCRIPTOR ID
- WIN32_PFD: Win32 PIXELFORMATDESCRIPTOR ID
EGL/GL throws NativeWindowException on X11_XVISUAL, X11_FBCONFIG, WIN32_PFD
- INTRINSIC: EGL Config ID
- NATIVE: EGL NativeVisual ID (X11 XVisual ID, Win32 PIXELFORMATDESCRIPTOR ID, ...)
- EGL_CONFIG: EGL Config ID

Note: INTRINSIC and NATIVE are always handled, but may result in VID_UNDEFINED. The latter is true if the native value are actually undefined or the corresponding object is not mapped to a native visual object.

Annotations

@Override

Exceptions

NativeWindowException:: if type is neither INTRINSIC nor NATIVE and does not match the native implementation.

getXVisualID	back to summary
public final int getXVisualID()

getXVisualInfo	back to summary
public final XVisualInfo getXVisualInfo()

hasXVisualInfo	back to summary
public final boolean hasXVisualInfo()

toString	back to summary
public StringBuilder toString(StringBuilder sink) Overrides com.jogamp.nativewindow.Capabilities.toString. Implements com.jogamp.nativewindow.CapabilitiesImmutable.toString. Doc from com.jogamp.nativewindow.CapabilitiesImmutable.toString. Return a textual representation of this object. Use the given StringBuilder [optional]. Annotations @Override

toString

back to summary

public StringBuilder toString(StringBuilder sink)

Overrides com.jogamp.nativewindow.Capabilities.toString.

Implements com.jogamp.nativewindow.CapabilitiesImmutable.toString.

Doc from com.jogamp.nativewindow.CapabilitiesImmutable.toString.

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

Annotations

@Override

public Class X11Capabilities

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail