|
JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java (public API).
|
A screen may span multiple MonitorDevices representing their combined virtual size.
More...
Public Member Functions | |
| abstract int | hashCode () |
return precomputed hashCode from FQN getFQName() More... | |
| boolean | equals (final Object obj) |
return true if obj is of type Display and both FQN getFQName() equals More... | |
| abstract void | createNative () throws NativeWindowException |
| Manual trigger the native creation, if not done yet.. This is useful to be able to request the com.jogamp.nativewindow.AbstractGraphicsScreen, via getGraphicsScreen(). More... | |
| abstract void | destroy () |
| Manually trigger the destruction, incl. More... | |
| abstract boolean | isNativeValid () |
| abstract int | getReferenceCount () |
| abstract int | addReference () throws NativeWindowException |
See Display#addReference(). More... | |
| abstract int | removeReference () |
See Display#removeReference(). More... | |
| abstract AbstractGraphicsScreen | getGraphicsScreen () |
| abstract int | getIndex () |
| abstract int | getX () |
| See Coordinate System. More... | |
| abstract int | getY () |
| See Coordinate System. More... | |
| abstract int | getWidth () |
| abstract int | getHeight () |
| abstract RectangleImmutable | getViewport () |
| See Coordinate System. More... | |
| abstract RectangleImmutable | getViewportInWindowUnits () |
| See Coordinate System. More... | |
| abstract Display | getDisplay () |
| abstract String | getFQName () |
| abstract List< MonitorMode > | getMonitorModes () |
Return a list of all MonitorModes for all MonitorDevices. More... | |
| abstract List< MonitorDevice > | getMonitorDevices () |
Return a list of available MonitorDevices. More... | |
| abstract MonitorDevice | getPrimaryMonitor () |
Returns the windowing manager's primary MonitorDevice, which holds the system menu bar, etc. More... | |
| final MonitorDevice | getMainMonitor (final RectangleImmutable r) |
Returns the MonitorDevice with the highest viewport coverage of the given rectangle in window units, which is not a clone. More... | |
| final MonitorDevice | getFullyEnteredMonitor (final RectangleImmutable r) |
Returns the MonitorDevice which completely which viewport completely coverage the given rectangle in window units, which is not a clone. More... | |
| final MonitorDevice | getMonitorById (final int monitorId) |
Returns the MonitorDevice which matches the given integer monitorId. More... | |
| final MonitorDevice | getMonitorByHandle (final long monitorHandle) |
Returns the MonitorDevice which matches the given long monitorHandle. More... | |
| final MonitorDevice | getMonitorByName (final String name) |
Returns the MonitorDevice which matches the given name. More... | |
| final void | unionOfMonitorViewports (final Rectangle viewport, final Rectangle viewportInWindowUnits) |
Calculates the union of all monitor's viewport in pixel- and window units. More... | |
| abstract void | addMonitorModeListener (MonitorModeListener sml) |
| abstract void | removeMonitorModeListener (MonitorModeListener sml) |
Static Public Member Functions | |
| static Screen | getFirstScreenOf (final Display display, final int idx, final int fromIndex) |
| static Screen | getLastScreenOf (final Display display, final int idx, final int fromIndex) |
| static Collection< Screen > | getAllScreens () |
| Returns the global screen collection. More... | |
| static int | getActiveScreenNumber () |
Static Public Attributes | |
| static final int | SCREEN_MODE_CHANGE_TIMEOUT = 10000 |
| A 10s timeout for screen mode change. More... | |
| static final boolean | DEBUG = Debug.debug("Screen") |
Static Protected Member Functions | |
| static void | addScreen2List (final Screen screen) |
Static Protected Attributes | |
| static final ArrayList< WeakReference< Screen > > | screenList = new ArrayList<WeakReference<Screen>>() |
| static int | screensActive = 0 |
A screen may span multiple MonitorDevices representing their combined virtual size.
All values of this interface are represented in pixel units, if not stated otherwise.
Virtual viewport covers all MonitorDevices viewports and has it's origin in the top-left corner, and may not be at 0/0. Definition at line 58 of file Screen.java.
|
abstract |
| sml | MonitorModeListener to be added for MonitorEvent |
|
abstract |
| NativeWindowException | if the native creation failed. |
|
staticprotected |
Definition at line 385 of file Screen.java.
|
abstract |
Manual trigger the native creation, if not done yet..
This is useful to be able to request the com.jogamp.nativewindow.AbstractGraphicsScreen, via getGraphicsScreen().
Otherwise the abstract device won't be available before the dependent component (Window) is realized.
This method is usually invoke by addReference()
This method invokes Display#addReference() after creating the native peer,
which will issue Display#createNative() if the reference count was 0.
| NativeWindowException | if the native creation failed. |
|
abstract |
Manually trigger the destruction, incl.
native destruction.
This method is usually invoke by removeReference()
This method invokes Display#removeReference() after it's own destruction,
which will issue Display#destroy() if the reference count becomes 0.
| boolean com.jogamp.newt.Screen.equals | ( | final Object | obj | ) |
return true if obj is of type Display and both FQN getFQName() equals
Definition at line 74 of file Screen.java.
|
static |
Definition at line 419 of file Screen.java.
|
static |
Returns the global screen collection.
Definition at line 401 of file Screen.java.
|
abstract |
|
static |
| type | |
| name | |
| fromIndex | start index, then increasing until found or end of list * |
Definition at line 346 of file Screen.java.
|
abstract |
com.jogamp.newt.Display#getFQName() + getIndex(). | final MonitorDevice com.jogamp.newt.Screen.getFullyEnteredMonitor | ( | final RectangleImmutable | r | ) |
Returns the MonitorDevice which completely which viewport completely coverage the given rectangle in window units, which is not a clone.
If no match is found, null is being returned
| r | arbitrary rectangle in window units |
Definition at line 255 of file Screen.java.
|
abstract |
|
abstract |
|
abstract |
getDisplay().
|
static |
| type | |
| name | |
| fromIndex | start index, then decreasing until found or end of list. -1 is interpreted as size - 1. |
Definition at line 357 of file Screen.java.
| final MonitorDevice com.jogamp.newt.Screen.getMainMonitor | ( | final RectangleImmutable | r | ) |
Returns the MonitorDevice with the highest viewport coverage of the given rectangle in window units, which is not a clone.
If no coverage is detected the first MonitorDevice is returned.
| r | arbitrary rectangle in window units |
Definition at line 227 of file Screen.java.
| final MonitorDevice com.jogamp.newt.Screen.getMonitorByHandle | ( | final long | monitorHandle | ) |
Returns the MonitorDevice which matches the given long monitorHandle.
If no match is found, null is being returned
Definition at line 285 of file Screen.java.
| final MonitorDevice com.jogamp.newt.Screen.getMonitorById | ( | final int | monitorId | ) |
Returns the MonitorDevice which matches the given integer monitorId.
If no match is found, null is being returned
Definition at line 270 of file Screen.java.
| final MonitorDevice com.jogamp.newt.Screen.getMonitorByName | ( | final String | name | ) |
Returns the MonitorDevice which matches the given name.
If no match is found or the given name is null or empty, null is being returned
Definition at line 300 of file Screen.java.
|
abstract |
|
abstract |
Return a list of all MonitorModes for all MonitorDevices.
The list is ordered in descending order, see MonitorMode#compareTo(MonitorMode).
|
abstract |
Returns the windowing manager's primary MonitorDevice, which holds the system menu bar, etc.
|
abstract |
|
abstract |
See Coordinate System.
|
abstract |
See Coordinate System.
|
abstract |
|
abstract |
See Coordinate System.
|
abstract |
See Coordinate System.
|
abstract |
return precomputed hashCode from FQN getFQName()
|
abstract |
|
abstract |
| sml | MonitorModeListener to be removed from MonitorEvent |
|
abstract |
See Display#removeReference().
| final void com.jogamp.newt.Screen.unionOfMonitorViewports | ( | final Rectangle | viewport, |
| final Rectangle | viewportInWindowUnits | ||
| ) |
Calculates the union of all monitor's viewport in pixel- and window units.
Should be equal to getX(), getY(), getWidth() and getHeight(), however, some native toolkits may choose a different virtual screen area.
| viewport | storage for result in pixel units, maybe null |
| viewportInWindowUnits | storage for result in window units, maybe null |
Definition at line 321 of file Screen.java.
|
static |
Definition at line 66 of file Screen.java.
|
static |
A 10s timeout for screen mode change.
It is observed, that some platforms need a notable amount of time for this task, especially in case of rotation change.
Definition at line 64 of file Screen.java.
|
staticprotected |
Definition at line 336 of file Screen.java.
|
staticprotected |
Definition at line 337 of file Screen.java.