jogamp.opengl.GLAutoDrawableBase

com.jogamp.newt.opengl.GLWindow

All Implemented Interfaces:: NativeSurface, NativeSurfaceHolder, NativeWindow, ScalableSurface, SurfaceUpdatedListener, WindowClosingProtocol, NEWTEventConsumer, Window, FPSCounter, GLAutoDrawable, GLDrawable, GLSharedContextSetter, GLStateKeeper

public class GLWindow extends jogamp.opengl.GLAutoDrawableBase implements GLAutoDrawable, Window, NEWTEventConsumer, FPSCounter

An implementation of GLAutoDrawable and Window interface, using a delegated Window instance, which may be an aggregation (lifecycle: created and destroyed).

This implementation supports GL state preservation, hence isGLStatePreservationSupported() returns true.

This implementation does not make the OpenGL context current
before calling the various input EventListener callbacks, ie MouseListener etc.
This design decision is made in favor of a more performant and simplified implementation. Also the event dispatcher shall be implemented OpenGL agnostic.
To be able to use OpenGL commands from within such input NEWTEventListener,
you can inject GLRunnable objects via GLAutoDrawableBase.invoke(boolean, GLRunnable) to the OpenGL command stream.

OpenGL Context Sharing

To share a GLContext see the following note in the documentation overview: context sharing as well as GLSharedContextSetter.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jogamp.opengl.GLStateKeeper
GLStateKeeper.Listener

Nested classes/interfaces inherited from interface com.jogamp.newt.Window
Window.FocusRunnable, Window.ReparentOperation

Nested classes/interfaces inherited from interface com.jogamp.nativewindow.WindowClosingProtocol
WindowClosingProtocol.WindowClosingMode
Field Summary

Fields inherited from class jogamp.opengl.GLAutoDrawableBase
DEBUG

Fields inherited from interface com.jogamp.opengl.FPSCounter
DEFAULT_FRAMES_PER_INTERVAL

Fields inherited from interface com.jogamp.opengl.GLAutoDrawable
SCREEN_CHANGE_ACTION_ENABLED

Fields inherited from interface com.jogamp.nativewindow.NativeSurface
LOCK_SUCCESS, LOCK_SURFACE_CHANGED, LOCK_SURFACE_NOT_READY, LOCK_SURFACE_UNLOCKED

Fields inherited from interface com.jogamp.nativewindow.ScalableSurface
AUTOMAX_PIXELSCALE, IDENTITY_PIXELSCALE

Fields inherited from interface com.jogamp.newt.Window
DEBUG_IMPLEMENTATION, DEBUG_KEY_EVENT, DEBUG_MOUSE_EVENT, REPARENT_HINT_BECOMES_VISIBLE, REPARENT_HINT_FORCE_RECREATION, STATE_BIT_ALWAYSONBOTTOM, STATE_BIT_ALWAYSONTOP, STATE_BIT_AUTOPOSITION, STATE_BIT_CHILDWIN, STATE_BIT_FOCUSED, STATE_BIT_FULLSCREEN, STATE_BIT_MAXIMIZED_HORZ, STATE_BIT_MAXIMIZED_VERT, STATE_BIT_POINTERCONFINED, STATE_BIT_POINTERVISIBLE, STATE_BIT_RESIZABLE, STATE_BIT_STICKY, STATE_BIT_UNDECORATED, STATE_BIT_VISIBLE, STATE_MASK_ALWAYSONBOTTOM, STATE_MASK_ALWAYSONTOP, STATE_MASK_AUTOPOSITION, STATE_MASK_CHILDWIN, STATE_MASK_FOCUSED, STATE_MASK_FULLSCREEN, STATE_MASK_MAXIMIZED_HORZ, STATE_MASK_MAXIMIZED_VERT, STATE_MASK_POINTERCONFINED, STATE_MASK_POINTERVISIBLE, STATE_MASK_RESIZABLE, STATE_MASK_STICKY, STATE_MASK_UNDECORATED, STATE_MASK_VISIBLE, TIMEOUT_NATIVEWINDOW
Method Summary

Modifier and Type

Method

Description

final boolean

addChild(NativeWindow win)

final void

addGestureHandler(int index, GestureHandler gh)

Inserts the given GestureHandler at the specified position in the list.

final void

addGestureHandler(GestureHandler gh)

Appends the given GestureHandler to the end of the list.

final void

addGestureListener(int index, GestureHandler.GestureListener gl)

Inserts the given GestureHandler.GestureListener at the specified position in the list.

final void

addGestureListener(GestureHandler.GestureListener gl)

Appends the given GestureHandler.GestureListener to the end of the list.

final void

addKeyListener(int index, KeyListener l)

Inserts the given KeyListener at the specified position in the list.

final void

addKeyListener(KeyListener l)

Appends the given KeyListener to the end of the list.

final void

addMouseListener(int index, MouseListener l)

Inserts the given MouseListener at the specified position in the list.

final void

addMouseListener(MouseListener l)

Appends the given MouseListener to the end of the list.

final void

addSurfaceUpdatedListener(int index, SurfaceUpdatedListener l)

Inserts the given SurfaceUpdatedListener at the specified position in the list.

final void

addSurfaceUpdatedListener(SurfaceUpdatedListener l)

Appends the given SurfaceUpdatedListener to the end of the list.

final void

addWindowListener(int index, WindowListener l)

Inserts the given WindowListener at the specified position in the list.

final void

addWindowListener(WindowListener l)

Appends the given WindowListener to the end of the list.

boolean

areDefaultGesturesEnabled()

Return true if default GestureHandler are enabled.

final void

confinePointer(boolean grab)

Confine the pointer to this window, ie.

boolean

consumeEvent(NEWTEvent event)

Consume the event

final int[]

convertToPixelUnits(int[] windowUnitsAndResult)

Converts the given window units into pixel units in place.

final int[]

convertToWindowUnits(int[] pixelUnitsAndResult)

Converts the given pixel units into window units in place.

static GLWindow

create(NativeWindow parentNativeWindow, GLCapabilitiesImmutable caps)

Creates a new GLWindow attaching a new child Window of the given parentNativeWindow with the given GLCapabilities.

static GLWindow

create(Screen screen, GLCapabilitiesImmutable caps)

Creates a new GLWindow attaching a new Window referencing the given Screen with the given GLCapabilities.

static GLWindow

create(Window window)

Creates a new GLWindow attaching the given window.

static GLWindow

create(GLCapabilitiesImmutable caps)

Creates a new GLWindow attaching a new Window referencing a new default Screen and default Display with the given GLCapabilities.

final void

destroy()

Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext.

void

display()

Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order: Calling display(..) for all registered GLEventListeners.

final void

enqueueEvent(boolean wait, NEWTEvent event)

Enqueues a NEWT event.

final Rectangle

getBounds()

Returns a newly created Rectangle containing window origin, NativeWindow.getX() & NativeWindow.getY(), and size, NativeWindow.getWidth() & NativeWindow.getHeight(), in window units.

final CapabilitiesImmutable

getChosenCapabilities()

Gets an immutable set of chosen capabilities.

final float[]

getCurrentSurfaceScale(float[] result)

Returns the current pixel scale of the associated NativeSurface.

WindowClosingProtocol.WindowClosingMode

getDefaultCloseOperation()

final Window

getDelegatedWindow()

If the implementation uses delegation, return the delegated Window instance, otherwise return this instance.

final long

getDisplayHandle()

Convenience: Get display handle from AbstractGraphicsConfiguration .

final GLDrawableFactory

getFactory()

Return the GLDrawableFactory being used to create this instance.

final AbstractGraphicsConfiguration

getGraphicsConfiguration()

Returns the graphics configuration corresponding to this window.

final int

getHeight()

Returns the height of the client area excluding insets (window decorations) in window units.

final InsetsImmutable

getInsets()

Returns the insets defined as the width and height of the window decoration on the left, right, top and bottom in window units.

final KeyListener

getKeyListener(int index)

final KeyListener[]

getKeyListeners()

Point

getLocationOnScreen(Point storage)

Returns the window's top-left client-area position in the screen.

final MonitorDevice

getMainMonitor()

Returns the MonitorDevice with the highest viewport coverage of this window.

final float[]

getMaximumSurfaceScale(float[] result)

Returns the maximum pixel scale of the associated NativeSurface.

final float[]

getMinimumSurfaceScale(float[] result)

Returns the minimum pixel scale of the associated NativeSurface.

final MouseListener

getMouseListener(int index)

Returns the MouseListener from the list at the given index.

final MouseListener[]

getMouseListeners()

Returns all MouseListener

final NativeWindow

getParent()

final float[]

getPixelsPerMM(float[] ppmmStore)

Returns the pixels per millimeter of this window's NativeSurface according to the main monitor's current mode's surface resolution.

final Display.PointerIcon

getPointerIcon()

Returns the current Display.PointerIcon, which maybe null for the default.

final CapabilitiesImmutable

getRequestedCapabilities()

Gets an immutable set of requested capabilities.

final float[]

getRequestedSurfaceScale(float[] result)

Returns the requested pixel scale of the associated NativeSurface.

final Screen

getScreen()

final int

getScreenIndex()

Convenience: Get display handle from AbstractGraphicsConfiguration .

final int

getStateMask()

Returns the current status mask of this instance.

final String

getStateMaskString()

Returns a string representation of the current state mask.

final int

getStatePublicBitCount()

Number of all public state bits.

final int

getStatePublicBitmask()

Bitmask covering all public state bits.

final int

getSupportedStateMask()

Returns the supported state mask of the implementation.

final String

getSupportedStateMaskString()

Returns a string representation of the supported state mask.

final long

getSurfaceHandle()

Returns the handle to the surface for this NativeSurface.

final int

getSurfaceHeight()

Returns the height of this GLDrawable's surface client area in pixel units.

final Thread

getSurfaceLockOwner()

Return the locking owner's Thread, or null if not locked.

final int

getSurfaceWidth()

Returns the width of this GLDrawable's surface client area in pixel units.

final String

getTitle()

final com.jogamp.common.util.locks.RecursiveLock

getUpstreamLock()

Returns the recursive lock object of the upstream widget to synchronize multithreaded access on top of NativeSurface.lockSurface().

final Object

getUpstreamWidget()

Method may return the upstream UI toolkit object holding this GLAutoDrawable instance, if exist.

final int

getWidth()

Returns the width of the client area excluding insets (window decorations) in window units.

final long

getWindowHandle()

Returns the window handle for this NativeWindow.

final WindowListener

getWindowListener(int index)

final WindowListener[]

getWindowListeners()

final int

getX()

Returns the x position of the top-left corner of the client area relative to it's parent in window units.

final int

getY()

Returns the current y position of the top-left corner of the client area relative to it's parent in window units.

boolean

hasFocus()

Returns true if this native window owns the focus, otherwise false.

final boolean

isAlwaysOnBottom()

final boolean

isAlwaysOnTop()

final boolean

isChildWindow()

Returns true if this window is a child window, i.e.

final boolean

isFullscreen()

final boolean

isGLStatePreservationSupported()

final boolean

isKeyboardVisible()

Return true if the virtual on-screen keyboard is visible, otherwise false.

final boolean

isMaximizedHorz()

final boolean

isMaximizedVert()

final boolean

isNativeValid()

final boolean

isPointerConfined()

final boolean

isPointerVisible()

final boolean

isResizable()

final boolean

isSticky()

final boolean

isSurfaceLockedByOtherThread()

Query if surface is locked by another thread, i.e.

final boolean

isUndecorated()

final boolean

isVisible()

final int

lockSurface()

Lock the surface of this native window.

static void

main(String[] args)

A most simple JOGL AWT test entry

final boolean

removeChild(NativeWindow win)

final void

removeGestureHandler(GestureHandler gh)

Removes the given GestureHandler from the list.

final void

removeGestureListener(GestureHandler.GestureListener gl)

Removes the given GestureHandler.GestureListener from the list.

final void

removeKeyListener(KeyListener l)

final void

removeMouseListener(MouseListener l)

Removes the given MouseListener from the list.

final void

removeSurfaceUpdatedListener(SurfaceUpdatedListener l)

Remove the specified SurfaceUpdatedListener from the list.

final void

removeWindowListener(WindowListener l)

final Window.ReparentOperation

reparentWindow(NativeWindow newParent, int x, int y, int hints)

Change this window's parent window.

final void

requestFocus()

Request focus for this native window

final void

requestFocus(boolean wait)

Request focus for this native window

final void

runOnEDTIfAvail(boolean wait, Runnable task)

void

sendWindowEvent(int eventType)

Send a WindowEvent to all WindowListener.

final void

setAlwaysOnBottom(boolean value)

Operation is ignored if this instance is a child window.

final void

setAlwaysOnTop(boolean value)

Operation is ignored if this instance is a child window.

CapabilitiesChooser

setCapabilitiesChooser(CapabilitiesChooser chooser)

Set the CapabilitiesChooser to help determine the native visual type.

WindowClosingProtocol.WindowClosingMode

setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)

void

setDefaultGesturesEnabled(boolean enable)

Enable or disable default GestureHandler.

final void

setFocusAction(Window.FocusRunnable focusAction)

Sets a Window.FocusRunnable, which Window.FocusRunnable.run() method is executed before the native focus is requested.

final boolean

setFullscreen(boolean fullscreen)

Enable or disable fullscreen mode for this window.

boolean

setFullscreen(List<MonitorDevice> monitors)

Enable fullscreen mode for this window spanning across the given MonitorDevices or across all MonitorDevices.

void

setKeyboardFocusHandler(KeyListener l)

Sets a KeyListener allowing focus traversal with a covered window toolkit like AWT.

final void

setKeyboardVisible(boolean visible)

In case the platform supports or even requires a virtual on-screen keyboard, this method shows or hide it depending on whether visible is true or false.

final void

setMaximized(boolean horz, boolean vert)

Operation is ignored if this instance is a child window.

final void

setPointerIcon(Display.PointerIcon pi)

final void

setPointerVisible(boolean mouseVisible)

Makes the pointer visible or invisible.

final void

setPosition(int x, int y)

Sets the location of the window's client area excluding insets (window decorations) in window units.
This call is ignored if in fullscreen mode.

final void

setResizable(boolean value)

Operation is ignored if this instance is a child window.

final void

setSize(int width, int height)

Sets the size of the window's client area in window units, excluding decorations.

final void

setSticky(boolean value)

Operation is ignored if this instance is a child window.

final boolean

setSurfaceScale(float[] pixelScale)

Request a pixel scale in x- and y-direction for the associated NativeSurface, where size_in_pixel_units = pixel_scale * size_in_window_units.

final void

setSurfaceSize(int pixelWidth, int pixelHeight)

Sets the size of the window's surface in pixel units which claims the window's client area excluding decorations.

final void

setTitle(String title)

void

setTopLevelPosition(int x, int y)

Sets the location of the top-level window inclusive insets (window decorations) in window units.

void

setTopLevelSize(int width, int height)

Sets the size of the top-level window including insets (window decorations) in window units.

final void

setUndecorated(boolean value)

final void

setVisible(boolean visible)

Calls setVisible(true, visible), i.e.

void

setVisible(boolean wait, boolean visible)

setVisible(..) makes the window and children visible if visible is true, otherwise the window and children becomes invisible.

void

setWindowDestroyNotifyAction(Runnable r)

Set a custom action handling destruction issued by a toolkit triggered window destroy replacing the default Window.destroy() action.

final boolean

surfaceSwap()

Provide a mechanism to utilize custom (pre-) swap surface code.

final void

surfaceUpdated(Object updater, NativeSurface ns, long when)

Notification of a surface update event, eg.

final void

swapBuffers()

Swaps the front and back buffers of this drawable.

final String

toString()

final void

unlockSurface()

Unlock the surface of this native window Shall not modify the surface handle, see NativeSurface.lockSurface()

final void

warpPointer(int x, int y)

Moves the pointer to x/y relative to this window's origin in pixel units.

final void

windowRepaint(int x, int y, int width, int height)

Trigger window repaint while passing the dirty region in pixel units.

Methods inherited from class jogamp.opengl.GLAutoDrawableBase
addGLEventListener, addGLEventListener, areAllGLEventListenerInitialized, clearPreservedGLState, createContext, defaultSwapBuffers, disposeGLEventListener, flushGLRunnables, getAnimator, getAutoSwapBufferMode, getChosenGLCapabilities, getContext, getContextCreationFlags, getDelegatedDrawable, getExclusiveContextThread, getFPSStartTime, getGL, getGLEventListener, getGLEventListenerCount, getGLEventListenerInitState, getGLProfile, getHandle, getLastFPS, getLastFPSPeriod, getLastFPSUpdateTime, getNativeSurface, getPreservedGLState, getRequestedGLCapabilities, getTotalFPS, getTotalFPSDuration, getTotalFPSFrames, getUpdateFPSFrames, invoke, invoke, invokeOnCurrentThread, invokeOnNewThread, isGLOriented, isRealized, isThreadGLCapable, preserveGLStateAtDestroy, removeGLEventListener, resetFPSCounter, setAnimator, setAutoSwapBufferMode, setContext, setContextCreationFlags, setExclusiveContextThread, setGL, setGLEventListenerInitState, setGLStateKeeperListener, setRealized, setSharedAutoDrawable, setSharedContext, setUpdateFPSFrames

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jogamp.opengl.FPSCounter
getFPSStartTime, getLastFPS, getLastFPSPeriod, getLastFPSUpdateTime, getTotalFPS, getTotalFPSDuration, getTotalFPSFrames, getUpdateFPSFrames, resetFPSCounter, setUpdateFPSFrames

Methods inherited from interface com.jogamp.opengl.GLAutoDrawable
addGLEventListener, addGLEventListener, areAllGLEventListenerInitialized, createContext, disposeGLEventListener, flushGLRunnables, getAnimator, getAutoSwapBufferMode, getContext, getContextCreationFlags, getDelegatedDrawable, getExclusiveContextThread, getGL, getGLEventListener, getGLEventListenerCount, getGLEventListenerInitState, invoke, invoke, isThreadGLCapable, removeGLEventListener, setAnimator, setAutoSwapBufferMode, setContext, setContextCreationFlags, setExclusiveContextThread, setGL, setGLEventListenerInitState

Methods inherited from interface com.jogamp.opengl.GLDrawable
getChosenGLCapabilities, getGLProfile, getHandle, getNativeSurface, getRequestedGLCapabilities, isGLOriented, isRealized, setRealized

Methods inherited from interface com.jogamp.nativewindow.NativeWindow
getNativeSurface

Method Details

getUpstreamWidget

public final Object getUpstreamWidget()

Description copied from interface: GLAutoDrawable

Method may return the upstream UI toolkit object holding this GLAutoDrawable instance, if exist.

Currently known Java UI toolkits and it's known return types are:

Toolkit	GLAutoDrawable Implementation	~	Return Type of getUpstreamWidget()</td
NEWT	`GLWindow`	has a	`Window`</td
SWT	`GLCanvas`	is a	`Canvas`</td
AWT	`GLCanvas`	is a	`Canvas`</td
AWT	`GLJPanel`	is a	`JPanel`</td

However, the result may be other object types than the listed above due to new supported toolkits.

This method may also return null if no UI toolkit is being used, as common for offscreen rendering.

Specified by:: getUpstreamWidget in interface GLAutoDrawable

getUpstreamLock

public final com.jogamp.common.util.locks.RecursiveLock getUpstreamLock()

Description copied from interface: GLAutoDrawable

Returns the recursive lock object of the upstream widget to synchronize multithreaded access on top of NativeSurface.lockSurface().
See GLAutoDrawable Locking.

Specified by:

getUpstreamLock in interface GLAutoDrawable
create

public static GLWindow create(GLCapabilitiesImmutable caps)

Creates a new GLWindow attaching a new Window referencing a new default Screen and default Display with the given GLCapabilities.
The lifecycle of this Window's Screen and Display is handled via Screen.addReference() and Screen.removeReference().
The default Display will be reused if already instantiated.
create

public static GLWindow create(Screen screen, GLCapabilitiesImmutable caps)

Creates a new GLWindow attaching a new Window referencing the given Screen with the given GLCapabilities.
The lifecycle of this Window's Screen and Display is handled via Screen.addReference() and Screen.removeReference().
create

public static GLWindow create(Window window)

Creates a new GLWindow attaching the given window.
The lifecycle of this Window's Screen and Display is handled via Screen.addReference() and Screen.removeReference().
create

public static GLWindow create(NativeWindow parentNativeWindow, GLCapabilitiesImmutable caps)

Creates a new GLWindow attaching a new child Window of the given parentNativeWindow with the given GLCapabilities.
The Display/Screen will be compatible with the parentNativeWindow, or even identical in case it's a Newt Window. An already instantiated compatible Display will be reused.

The lifecycle of this Window's Screen and Display is handled via Screen.addReference() and Screen.removeReference().
getDefaultCloseOperation

public WindowClosingProtocol.WindowClosingMode getDefaultCloseOperation()
Specified by:

getDefaultCloseOperation in interface WindowClosingProtocol

Returns:

the current close operation value

See Also:
- WindowClosingProtocol.WindowClosingMode.DISPOSE_ON_CLOSE
- WindowClosingProtocol.WindowClosingMode.DO_NOTHING_ON_CLOSE
setDefaultCloseOperation

public WindowClosingProtocol.WindowClosingMode setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)
Specified by:

setDefaultCloseOperation in interface WindowClosingProtocol

Parameters:

op - the new close operation value

Returns:

the previous close operation value

See Also:
- WindowClosingProtocol.WindowClosingMode.DISPOSE_ON_CLOSE
- WindowClosingProtocol.WindowClosingMode.DO_NOTHING_ON_CLOSE
getStatePublicBitCount

public final int getStatePublicBitCount()

Description copied from interface: Window

Number of all public state bits.
Specified by:

getStatePublicBitCount in interface Window

See Also:
- Window.getStateMask()
getStatePublicBitmask

public final int getStatePublicBitmask()

Description copied from interface: Window

Bitmask covering all public state bits.
Specified by:

getStatePublicBitmask in interface Window

See Also:
- Window.getStateMask()
getStateMask

public final int getStateMask()

Description copied from interface: Window

Returns the current status mask of this instance.
Specified by:

getStateMask in interface Window

See Also:
getStateMaskString

public final String getStateMaskString()

Description copied from interface: Window

Returns a string representation of the current state mask.

Specified by:

getStateMaskString in interface Window
getSupportedStateMask

public final int getSupportedStateMask()

Description copied from interface: Window
Returns the supported state mask of the implementation.
Implementation provides supported state mask values at runtime after native window creation, i.e. first visibility.

Please note that a window's size shall also be allowed to change, i.e. Window.setSize(int, int).

Default value is Window.STATE_MASK_VISIBLE | Window.STATE_MASK_FOCUSED | Window.STATE_MASK_FULLSCREEN, i.e. the minimum requirement for all implementations.

Before native window creation Window.getStatePublicBitmask() is returned, i.e. it is assumed all features are supported.

Semantic of the supported state-mask bits (after native creation, i.e. 1st visibility):
- Window.STATE_MASK_VISIBLE: Visibility can be toggled. Minimum requirement.
- Window.STATE_MASK_CHILDWIN: Native window parenting is supported.
- Window.STATE_MASK_FOCUSED: Window focus management is supported. Minimum requirement.
- Window.STATE_MASK_UNDECORATED: Window decoration can be toggled.
- Window.STATE_MASK_ALWAYSONTOP: Window can be set always-on-top.
- Window.STATE_MASK_ALWAYSONBOTTOM: Window can be set always-on-bottom.
- Window.STATE_MASK_STICKY: Window can be set sticky.
- Window.STATE_MASK_RESIZABLE: Window resizability can be toggled.
- Window.STATE_MASK_MAXIMIZED_VERT: Window can be maximized-vertically.
- Window.STATE_MASK_MAXIMIZED_HORZ: Window can be maximized-horizontally.
- Window.STATE_MASK_FULLSCREEN: Window fullscreen can be toggled.
- Window.STATE_MASK_POINTERVISIBLE: Window pointer visibility can be toggled.
- Window.STATE_MASK_POINTERCONFINED: Window pointer can be confined.
Specified by:

getSupportedStateMask in interface Window

See Also:
- Window.getStateMask()
getSupportedStateMaskString

public final String getSupportedStateMaskString()

Description copied from interface: Window

Returns a string representation of the supported state mask.

Specified by:

getSupportedStateMaskString in interface Window
setCapabilitiesChooser

public CapabilitiesChooser setCapabilitiesChooser(CapabilitiesChooser chooser)

Description copied from interface: Window

Set the CapabilitiesChooser to help determine the native visual type.

Specified by:

setCapabilitiesChooser in interface Window

Parameters:

chooser - the new CapabilitiesChooser

Returns:

the previous CapabilitiesChooser
getChosenCapabilities

public final CapabilitiesImmutable getChosenCapabilities()

Description copied from interface: Window

Gets an immutable set of chosen capabilities.

Specified by:

getChosenCapabilities in interface Window

Returns:

the chosen capabilities
getRequestedCapabilities

public final CapabilitiesImmutable getRequestedCapabilities()

Description copied from interface: Window

Gets an immutable set of requested capabilities.

Specified by:

getRequestedCapabilities in interface Window

Returns:

the requested capabilities
getDelegatedWindow

public final Window getDelegatedWindow()

Description copied from interface: Window

If the implementation uses delegation, return the delegated Window instance, otherwise return this instance.

Specified by:

getDelegatedWindow in interface Window
getParent

public final NativeWindow getParent()

Specified by:

getParent in interface NativeWindow

Returns:

The parent NativeWindow, or null if this NativeWindow is top level.
getScreen

public final Screen getScreen()

Specified by:

getScreen in interface Window

Returns:

The associated Screen
getMainMonitor

public final MonitorDevice getMainMonitor()

Description copied from interface: Window

Returns the MonitorDevice with the highest viewport coverage of this window.
If no coverage is detected the first MonitorDevice is returned.

Specified by:

getMainMonitor in interface Window
setTitle

public final void setTitle(String title)

Specified by:

setTitle in interface Window
getTitle

public final String getTitle()

Specified by:

getTitle in interface Window
isPointerVisible

public final boolean isPointerVisible()
Specified by:

isPointerVisible in interface Window

See Also:
- Window.setPointerVisible(boolean)
setPointerVisible

public final void setPointerVisible(boolean mouseVisible)

Description copied from interface: Window

Makes the pointer visible or invisible.
Specified by:

setPointerVisible in interface Window

Parameters:

mouseVisible - defaults to true for platforms w/ visible pointer, otherwise defaults to true, eg. Android.

See Also:
- Window.confinePointer(boolean)
getPointerIcon

public final Display.PointerIcon getPointerIcon()

Description copied from interface: Window

Returns the current Display.PointerIcon, which maybe null for the default.
Specified by:

getPointerIcon in interface Window

See Also:
- Window.setPointerIcon(PointerIcon)
setPointerIcon

public final void setPointerIcon(Display.PointerIcon pi)
Specified by:

setPointerIcon in interface Window

Parameters:

pi - Valid Display.PointerIcon reference or null to reset the pointer icon to default.

See Also:
- Display.PointerIcon
- Display.createPointerIcon(com.jogamp.common.util.IOUtil.ClassResources, int, int)
isPointerConfined

public final boolean isPointerConfined()
Specified by:

isPointerConfined in interface Window

See Also:
- Window.confinePointer(boolean)
confinePointer

public final void confinePointer(boolean grab)

Description copied from interface: Window

Confine the pointer to this window, ie. pointer jail.
Before jailing the mouse pointer, the window request the focus and the pointer is centered in the window.

In combination w/ Window.warpPointer(int, int) and maybe Window.setPointerVisible(boolean) a simple mouse navigation can be realized.

Specified by:

confinePointer in interface Window

Parameters:

grab - defaults to false.
setUndecorated

public final void setUndecorated(boolean value)

Specified by:

setUndecorated in interface Window
warpPointer

public final void warpPointer(int x, int y)

Description copied from interface: Window

Moves the pointer to x/y relative to this window's origin in pixel units.
Specified by:

warpPointer in interface Window

Parameters:

x - relative pointer x position within this window in pixel units

y - relative pointer y position within this window in pixel units

See Also:
- Window.confinePointer(boolean)
isUndecorated

public final boolean isUndecorated()

Specified by:

isUndecorated in interface Window
setAlwaysOnTop

public final void setAlwaysOnTop(boolean value)

Description copied from interface: Window

Operation is ignored if this instance is a child window.

Specified by:

setAlwaysOnTop in interface Window
isAlwaysOnTop

public final boolean isAlwaysOnTop()

Specified by:

isAlwaysOnTop in interface Window
setAlwaysOnBottom

public final void setAlwaysOnBottom(boolean value)

Description copied from interface: Window

Operation is ignored if this instance is a child window.

Specified by:

setAlwaysOnBottom in interface Window
isAlwaysOnBottom

public final boolean isAlwaysOnBottom()

Specified by:

isAlwaysOnBottom in interface Window
setResizable

public final void setResizable(boolean value)

Description copied from interface: Window

Operation is ignored if this instance is a child window.

Specified by:

setResizable in interface Window
isResizable

public final boolean isResizable()

Specified by:

isResizable in interface Window
setSticky

public final void setSticky(boolean value)

Description copied from interface: Window

Operation is ignored if this instance is a child window.

Specified by:

setSticky in interface Window
isSticky

public final boolean isSticky()

Specified by:

isSticky in interface Window
setMaximized

public final void setMaximized(boolean horz, boolean vert)

Description copied from interface: Window

Operation is ignored if this instance is a child window.

Specified by:

setMaximized in interface Window
isMaximizedVert

public final boolean isMaximizedVert()

Specified by:

isMaximizedVert in interface Window
isMaximizedHorz

public final boolean isMaximizedHorz()

Specified by:

isMaximizedHorz in interface Window
setFocusAction

public final void setFocusAction(Window.FocusRunnable focusAction)

Description copied from interface: Window

Sets a Window.FocusRunnable, which Window.FocusRunnable.run() method is executed before the native focus is requested.
This allows notifying a covered window toolkit like AWT that the focus is requested, hence focus traversal can be made transparent.

Specified by:

setFocusAction in interface Window
setKeyboardFocusHandler

public void setKeyboardFocusHandler(KeyListener l)

Description copied from interface: Window

Sets a KeyListener allowing focus traversal with a covered window toolkit like AWT.
The KeyListener methods are invoked prior to all other KeyListener's allowing to suppress the KeyEvent via the NEWTEvent.consumedTag and to perform focus traversal with a 3rd party toolkit.

The KeyListener methods are not invoked for auto-repeat events.

Specified by:

setKeyboardFocusHandler in interface Window
requestFocus

public final void requestFocus()

Description copied from interface: Window

Request focus for this native window
The request is handled on this Window EDT and blocked until finished.
Specified by:

requestFocus in interface Window

See Also:
- Window.requestFocus(boolean)
requestFocus

public final void requestFocus(boolean wait)

Description copied from interface: Window

Request focus for this native window
The request is handled on this Window EDT.
Specified by:

requestFocus in interface Window

Parameters:

wait - true if waiting until the request is executed, otherwise false

See Also:
- Window.requestFocus()
hasFocus

public boolean hasFocus()

Description copied from interface: NativeWindow

Returns true if this native window owns the focus, otherwise false.

Specified by:

hasFocus in interface NativeWindow
getInsets

public final InsetsImmutable getInsets()

Description copied from interface: NativeWindow
Returns the insets defined as the width and height of the window decoration on the left, right, top and bottom in window units.
Insets are zero if the window is undecorated, including child windows.

Insets are available only after the native window has been created, ie. the native window has been made visible.
The top-level window area's top-left corner is located at
```
   NativeWindow.getX() - getInsets().getLeftWidth()
   NativeWindow.getY() - getInsets().getTopHeight()
 
```
The top-level window size is
```
   NativeWindow.getWidth()  + getInsets().getTotalWidth()
   NativeWindow.getHeight() + getInsets().getTotalHeight()
 
```
Specified by:

getInsets in interface NativeWindow

Returns:

insets
getX

public final int getX()

Description copied from interface: NativeWindow

Returns the x position of the top-left corner of the client area relative to it's parent in window units.
If no parent exist (top-level window), this coordinate equals the screen coordinate.

Since the position reflects the client area, it does not include the insets.

See Coordinate System.
Specified by:

getX in interface NativeWindow

See Also:
- NativeWindow.getInsets()
- NativeWindow.getLocationOnScreen(Point)
getY

public final int getY()

Description copied from interface: NativeWindow

Returns the current y position of the top-left corner of the client area relative to it's parent in window units.
If no parent exist (top-level window), this coordinate equals the screen coordinate.

Since the position reflects the client area, it does not include the insets.

See Coordinate System.
Specified by:

getY in interface NativeWindow

See Also:
- NativeWindow.getInsets()
- NativeWindow.getLocationOnScreen(Point)
getWidth

public final int getWidth()

Description copied from interface: NativeWindow

Returns the width of the client area excluding insets (window decorations) in window units.
Specified by:

getWidth in interface NativeWindow

Returns:

width of the client area in window units

See Also:
- NativeSurface.getSurfaceWidth()
getHeight

public final int getHeight()

Description copied from interface: NativeWindow

Returns the height of the client area excluding insets (window decorations) in window units.
Specified by:

getHeight in interface NativeWindow

Returns:

height of the client area in window units

See Also:
- NativeSurface.getSurfaceHeight()
getBounds

public final Rectangle getBounds()

Description copied from interface: Window

Returns a newly created Rectangle containing window origin, NativeWindow.getX() & NativeWindow.getY(), and size, NativeWindow.getWidth() & NativeWindow.getHeight(), in window units.

Specified by:

getBounds in interface Window
getSurfaceWidth

public final int getSurfaceWidth()

Description copied from interface: GLDrawable

Returns the width of this GLDrawable's surface client area in pixel units.
Specified by:

getSurfaceWidth in interface GLDrawable

Specified by:

getSurfaceWidth in interface NativeSurface

Overrides:

getSurfaceWidth in class jogamp.opengl.GLAutoDrawableBase

Returns:

width of the client area in pixel units

See Also:
- NativeSurface.getSurfaceWidth()
getSurfaceHeight

public final int getSurfaceHeight()

Description copied from interface: GLDrawable

Returns the height of this GLDrawable's surface client area in pixel units.
Specified by:

getSurfaceHeight in interface GLDrawable

Specified by:

getSurfaceHeight in interface NativeSurface

Overrides:

getSurfaceHeight in class jogamp.opengl.GLAutoDrawableBase

Returns:

height of the client area in pixel units

See Also:
- NativeSurface.getSurfaceHeight()
convertToWindowUnits

public final int[] convertToWindowUnits(int[] pixelUnitsAndResult)

Description copied from interface: NativeSurface

Converts the given pixel units into window units in place.
Specified by:

convertToWindowUnits in interface NativeSurface

Parameters:

pixelUnitsAndResult - int[2] storage holding the pixel units for the x- and y-coord to convert and the resulting values.

Returns:

result int[2] storage pixelUnitsAndResult for chaining holding the converted values

See Also:
- ScalableSurface
convertToPixelUnits

public final int[] convertToPixelUnits(int[] windowUnitsAndResult)

Description copied from interface: NativeSurface

Converts the given window units into pixel units in place.
Specified by:

convertToPixelUnits in interface NativeSurface

Parameters:

windowUnitsAndResult - int[2] storage holding the window units for the x- and y-coord to convert and the resulting values.

Returns:

result int[2] storage windowUnitsAndResult for chaining holding the converted values

See Also:
- ScalableSurface
setSurfaceScale

public final boolean setSurfaceScale(float[] pixelScale)

Description copied from interface: ScalableSurface

Request a pixel scale in x- and y-direction for the associated NativeSurface, where size_in_pixel_units = pixel_scale * size_in_window_units.
Default pixel scale request for both directions is ScalableSurface.AUTOMAX_PIXELSCALE.

In case platform only supports uniform pixel scale, i.e. one scale for both directions, either ScalableSurface.AUTOMAX_PIXELSCALE or the maximum requested pixel scale component is used.

The requested pixel scale will be validated against platform limits before native scale-setup, i.e. clipped to ScalableSurface.IDENTITY_PIXELSCALE if not supported or clipped to the platform maximum. It can be queried via ScalableSurface.getRequestedSurfaceScale(float[]).

The actual realized pixel scale values of the NativeSurface can be queried via ScalableSurface.getCurrentSurfaceScale(float[]) or computed via surface.convertToPixelUnits(new int[] { 1, 1 })
Specified by:

setSurfaceScale in interface ScalableSurface

Parameters:

pixelScale - requested surface pixel scale float[2] values for x- and y-direction.

Returns:

true if the current pixel scale has changed, otherwise false.

See Also:
- ScalableSurface.getRequestedSurfaceScale(float[])
getRequestedSurfaceScale

public final float[] getRequestedSurfaceScale(float[] result)

Description copied from interface: ScalableSurface

Returns the requested pixel scale of the associated NativeSurface.
Specified by:

getRequestedSurfaceScale in interface ScalableSurface

Parameters:

result - float[2] storage for the result

Returns:

the passed storage containing the current pixelScale for chaining

See Also:
- ScalableSurface.setSurfaceScale(float[])
getCurrentSurfaceScale

public final float[] getCurrentSurfaceScale(float[] result)

Description copied from interface: ScalableSurface

Returns the current pixel scale of the associated NativeSurface.

Specified by:

getCurrentSurfaceScale in interface ScalableSurface

Parameters:

result - float[2] storage for the result

Returns:

the passed storage containing the current pixelScale for chaining
getMinimumSurfaceScale

public final float[] getMinimumSurfaceScale(float[] result)

Description copied from interface: ScalableSurface

Returns the minimum pixel scale of the associated NativeSurface.

Specified by:

getMinimumSurfaceScale in interface ScalableSurface

Parameters:

result - float[2] storage for the result

Returns:

the passed storage containing the minimum pixelScale for chaining
getMaximumSurfaceScale

public final float[] getMaximumSurfaceScale(float[] result)

Description copied from interface: ScalableSurface
Returns the maximum pixel scale of the associated NativeSurface.
The maximum pixel scale maybe used to determine the proper dpi value of the monitor displaying this NativeSurface.
```
    surfacePpMM = monitorPpMM * currentSurfaceScale / nativeSurfaceScale,
    with PpMM == pixel per millimeter
 
```
Specified by:

getMaximumSurfaceScale in interface ScalableSurface

Parameters:

result - float[2] storage for the result

Returns:

the passed storage containing the maximum pixelScale for chaining
getPixelsPerMM

public final float[] getPixelsPerMM(float[] ppmmStore)

Description copied from interface: Window
Returns the pixels per millimeter of this window's NativeSurface according to the main monitor's current mode's surface resolution.
Method takes the current surface-scale and native surface-scale into account, i.e.:
```
    surfacePpMM = monitorPpMM * currentSurfaceScale / nativeSurfaceScale,
    with PpMM == pixel per millimeter
 
```
To convert the result to dpi, i.e. dots-per-inch, multiply both components with 25.4f.
Specified by:

getPixelsPerMM in interface Window

Parameters:

ppmmStore - float[2] storage for the ppmm result

Returns:

the passed storage containing the ppmm for chaining
setPosition

public final void setPosition(int x, int y)

Description copied from interface: Window

Sets the location of the window's client area excluding insets (window decorations) in window units.
This call is ignored if in fullscreen mode.
Specified by:

setPosition in interface Window

Parameters:

x - coord of the client-area's top left corner in window units

y - coord of the client-area's top left corner in window units

See Also:
- NativeWindow.getInsets()
setTopLevelPosition

public void setTopLevelPosition(int x, int y)

Description copied from interface: Window

Sets the location of the top-level window inclusive insets (window decorations) in window units.

Note: Insets (if supported) are available only after the window is set visible and hence has been created.
This call is ignored if in fullscreen mode.
Specified by:

setTopLevelPosition in interface Window

Parameters:

x - coord of the top-level left corner in window units

y - coord of the top-level left corner in window units

See Also:
- Window.setPosition(int, int)
- NativeWindow.getInsets()
setFullscreen

public final boolean setFullscreen(boolean fullscreen)

Description copied from interface: Window

Enable or disable fullscreen mode for this window.
Fullscreen mode is established on the main monitor.

This method is lifecycle heavy.
Specified by:

setFullscreen in interface Window

Parameters:

fullscreen - enable or disable fullscreen mode

Returns:

success

See Also:
- Window.setFullscreen(List)
- Window.isFullscreen()
setFullscreen

public boolean setFullscreen(List<MonitorDevice> monitors)

Description copied from interface: Window

Enable fullscreen mode for this window spanning across the given MonitorDevices or across all MonitorDevices.
Disable fullscreen via Window.setFullscreen(boolean).

This method is lifecycle heavy.
Specified by:

setFullscreen in interface Window

Parameters:

monitors - if null fullscreen will be spanned across all MonitorDevices, otherwise across the given list of MonitorDevice.

Returns:

success

See Also:
- Window.setFullscreen(boolean)
- Window.isFullscreen()
isFullscreen

public final boolean isFullscreen()

Specified by:

isFullscreen in interface Window
isVisible

public final boolean isVisible()
Specified by:

isVisible in interface Window

See Also:
- Window.STATE_BIT_VISIBLE
- Window.setVisible(boolean, boolean)
toString

public final String toString()

Specified by:

toString in interface GLDrawable

Overrides:

toString in class jogamp.opengl.GLAutoDrawableBase
reparentWindow

public final Window.ReparentOperation reparentWindow(NativeWindow newParent, int x, int y, int hints)

Description copied from interface: Window

Change this window's parent window.

In case the old parent is not null and a Window, this window is removed from it's list of children.
In case the new parent is not null and a Window, this window is added to it's list of children.

This method is lifecycle heavy.

Specified by:

reparentWindow in interface Window

Parameters:

newParent - The new parent NativeWindow. If null, this Window becomes a top level window.

x - new top-level position in window units, use -1 for default position.

y - new top-level position in window units, use -1 for default position.

hints - May contain hints (bitfield values) like Window.REPARENT_HINT_FORCE_RECREATION or Window.REPARENT_HINT_BECOMES_VISIBLE.

Returns:

The issued reparent action type (strategy) as defined in Window.ReparentAction
isChildWindow

public final boolean isChildWindow()

Description copied from interface: Window

Returns true if this window is a child window, i.e. has been reparented.
Otherwise return false, i.e. this window is a top-level window.

Specified by:

isChildWindow in interface Window
removeChild

public final boolean removeChild(NativeWindow win)

Specified by:

removeChild in interface Window
addChild

public final boolean addChild(NativeWindow win)

Specified by:

addChild in interface Window
destroy

public final void destroy()

Description copied from interface: GLAutoDrawable

Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext. If a window is attached to it's implementation, it shall be closed. Causes disposing of all OpenGL resources by calling dispose(..) for all registered GLEventListeners. Called automatically by the window system toolkit upon receiving a destroy notification. This routine may be called manually.
Specified by:

destroy in interface GLAutoDrawable

Specified by:

destroy in interface NativeWindow

Specified by:

destroy in interface Window

See Also:
- Window.destroy()
- Window.setVisible(boolean)
setWindowDestroyNotifyAction

public void setWindowDestroyNotifyAction(Runnable r)

Description copied from interface: Window

Set a custom action handling destruction issued by a toolkit triggered window destroy replacing the default Window.destroy() action.
The custom action shall call Window.destroy() but may perform further tasks before and after.

Specified by:

setWindowDestroyNotifyAction in interface Window
setVisible

public final void setVisible(boolean visible)

Description copied from interface: Window

Calls setVisible(true, visible), i.e. blocks until the window becomes visible.
This method is lifecycle heavy.
Specified by:

setVisible in interface Window

See Also:
- Window.setVisible(boolean, boolean)
- Window.STATE_BIT_VISIBLE
setVisible

public void setVisible(boolean wait, boolean visible)

Description copied from interface: Window
setVisible(..) makes the window and children visible if visible is true, otherwise the window and children becomes invisible.
Native instance gets created at first visibility, following NEWT's lazy creation pattern.

If wait is true, method blocks until window is visible and valid, otherwise method returns immediately.

Zero size semantics are respected, see Window.setSize(int,int):
```
 if ( 0 == windowHandle && visible ) {
   this.visible = visible;
   if( 0 < width && 0 < height ) {
     createNative();
   }
 } else if ( this.visible != visible ) {
   this.visible = visible;
   setNativeSizeImpl();
 }
 
```
In case this window is a child window and has a NativeWindow parent,
setVisible(wait, true) has no effect as long the parent's is not valid yet, i.e. NativeWindow.getWindowHandle() returns null.
setVisible(wait, true) shall be repeated when the parent becomes valid.

This method is lifecycle heavy.
Specified by:

setVisible in interface Window

See Also:
- Window.STATE_BIT_VISIBLE
setSize

public final void setSize(int width, int height)

Description copied from interface: Window
Sets the size of the window's client area in window units, excluding decorations.
Zero size semantics are respected, see Window.setVisible(boolean):
```
 if ( visible && 0 != windowHandle && ( 0 ≥ width || 0 ≥ height ) ) {
   setVisible(false);
 } else if ( visible && 0 == windowHandle && 0 < width && 0 < height ) {
   setVisible(true);
 } else {
   // as expected ..
 }
 
```
This call is ignored if in fullscreen mode.
Specified by:

setSize in interface Window

Parameters:

width - of the window's client area in window units

height - of the window's client area in window units

See Also:
setSurfaceSize

public final void setSurfaceSize(int pixelWidth, int pixelHeight)

Description copied from interface: Window
Sets the size of the window's surface in pixel units which claims the window's client area excluding decorations.
In multiple monitor mode, setting the window's surface size in pixel units might not be possible due to unknown scale values of the target display. Hence re-setting the pixel unit size after window creation is recommended.

Zero size semantics are respected, see Window.setVisible(boolean):
```
 if ( visible && 0 != windowHandle && ( 0 ≥ width || 0 ≥ height ) ) {
   setVisible(false);
 } else if ( visible && 0 == windowHandle && 0 < width && 0 < height ) {
   setVisible(true);
 } else {
   // as expected ..
 }
 
```
This call is ignored if in fullscreen mode.
Specified by:

setSurfaceSize in interface Window

Parameters:

pixelWidth - of the window's client area in pixel units

pixelHeight - of the window's client area in pixel units

See Also:
- Window.setSize(int, int)
- NativeWindow.getInsets()
setTopLevelSize

public void setTopLevelSize(int width, int height)

Description copied from interface: Window

Sets the size of the top-level window including insets (window decorations) in window units.
Note: Insets (if supported) are available only after the window is set visible and hence has been created.
Specified by:

setTopLevelSize in interface Window

Parameters:

width - of the top-level window area in window units

height - of the top-level window area in window units

See Also:
- Window.setSize(int, int)
- NativeWindow.getInsets()
isNativeValid

public final boolean isNativeValid()
Specified by:

isNativeValid in interface Window

Returns:

true if the native window handle is valid and ready to operate, ie if the native window has been created via setVisible(true), otherwise false.

See Also:
- Window.setVisible(boolean)
- #destroy(boolean)
getLocationOnScreen

public Point getLocationOnScreen(Point storage)

Description copied from interface: NativeWindow

Returns the window's top-left client-area position in the screen.
If Point is not null, it is translated about the resulting screen position and returned.

See Coordinate System.

Since the position reflects the client area, it does not include the insets.
Specified by:

getLocationOnScreen in interface NativeWindow

Parameters:

storage - Optional Point storage. If not null, null, it is translated about the resulting screen position and returned.

See Also:
display

public void display()

Description copied from interface: GLAutoDrawable
Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order:
- Calling display(..) for all registered GLEventListeners.
- Executes all one-shot GLRunnable, enqueued via GLAutoDrawable.invoke(boolean, GLRunnable).
May be called periodically by a running GLAnimatorControl implementation,
which must register itself with GLAutoDrawable.setAnimator(com.jogamp.opengl.GLAnimatorControl).

Called automatically by the window system toolkit upon receiving a repaint() request,
except an GLAnimatorControl implementation GLAnimatorControl.isAnimating().

This routine may also be called manually for better control over the rendering process. It is legal to call another GLAutoDrawable's display method from within the display(..) callback.

In case of a new generated OpenGL context, the implementation shall call init(..) for all registered GLEventListeners before making the actual display(..) calls, in case this has not been done yet.
Specified by:

display in interface GLAutoDrawable

See Also:
- GLAutoDrawable.setAnimator(com.jogamp.opengl.GLAnimatorControl)
isGLStatePreservationSupported

public final boolean isGLStatePreservationSupported()

GLWindow supports GL state preservation, hence returns true.
Specified by:

isGLStatePreservationSupported in interface GLStateKeeper

Overrides:

isGLStatePreservationSupported in class jogamp.opengl.GLAutoDrawableBase

Returns:

true if GL state preservation is supported in implementation and on current platform, false otherwise.

See Also:
getFactory

public final GLDrawableFactory getFactory()

Description copied from interface: GLDrawable

Return the GLDrawableFactory being used to create this instance.

Specified by:

getFactory in interface GLDrawable
swapBuffers

public final void swapBuffers() throws GLException

Description copied from interface: GLDrawable

Swaps the front and back buffers of this drawable. For GLAutoDrawable implementations, when automatic buffer swapping is enabled (as is the default), this method is called automatically and should not be called by the end user.

Specified by:

swapBuffers in interface GLDrawable

Throws:

GLException
consumeEvent

public boolean consumeEvent(NEWTEvent event)

Description copied from interface: NEWTEventConsumer

Consume the event

Specified by:

consumeEvent in interface NEWTEventConsumer

Returns:

true if the event has been consumed, otherwise it returns false for later propagation.
windowRepaint

public final void windowRepaint(int x, int y, int width, int height)

Description copied from interface: Window

Trigger window repaint while passing the dirty region in pixel units.

Specified by:

windowRepaint in interface Window

Parameters:

x - dirty-region y-pos in pixel units

y - dirty-region x-pos in pixel units

width - dirty-region width in pixel units

height - dirty-region height in pixel units
enqueueEvent

public final void enqueueEvent(boolean wait, NEWTEvent event)

Description copied from interface: Window

Enqueues a NEWT event.

Specified by:

enqueueEvent in interface Window

Parameters:

wait - Passing true will block until the event has been processed, otherwise method returns immediately.

event - The event to enqueue.
runOnEDTIfAvail

public final void runOnEDTIfAvail(boolean wait, Runnable task)

Specified by:

runOnEDTIfAvail in interface Window
sendWindowEvent

public void sendWindowEvent(int eventType)

Description copied from interface: Window

Send a WindowEvent to all WindowListener.

Specified by:

sendWindowEvent in interface Window

Parameters:

eventType - a WindowEvent type, e.g. WindowEvent.EVENT_WINDOW_REPAINT.
getWindowListener

public final WindowListener getWindowListener(int index)

Specified by:

getWindowListener in interface Window
getWindowListeners

public final WindowListener[] getWindowListeners()

Specified by:

getWindowListeners in interface Window
removeWindowListener

public final void removeWindowListener(WindowListener l)

Specified by:

removeWindowListener in interface Window
addWindowListener

public final void addWindowListener(WindowListener l)

Description copied from interface: Window

Appends the given WindowListener to the end of the list.

Specified by:

addWindowListener in interface Window
addWindowListener

public final void addWindowListener(int index, WindowListener l) throws IndexOutOfBoundsException

Description copied from interface: Window

Inserts the given WindowListener at the specified position in the list.

Specified by:

addWindowListener in interface Window

Parameters:

index - Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size().

l - The listener object to be inserted

Throws:

IndexOutOfBoundsException - If the index is not within (0 <= index && index <= size()), or -1
setKeyboardVisible

public final void setKeyboardVisible(boolean visible)

Description copied from interface: Window

In case the platform supports or even requires a virtual on-screen keyboard, this method shows or hide it depending on whether visible is true or false.
One known platform where NEWT supports this feature is Android.

Specified by:

setKeyboardVisible in interface Window
isKeyboardVisible

public final boolean isKeyboardVisible()

Description copied from interface: Window

Return true if the virtual on-screen keyboard is visible, otherwise false.
Currently on Android, the only supported platform right now, there is no way to reliably be notified of the current keyboard state.
It would be best, if your code does not rely on this information.
Specified by:

isKeyboardVisible in interface Window

See Also:
- Window.setKeyboardVisible(boolean)
addKeyListener

public final void addKeyListener(KeyListener l)

Description copied from interface: Window

Appends the given KeyListener to the end of the list.

Specified by:

addKeyListener in interface Window
addKeyListener

public final void addKeyListener(int index, KeyListener l)

Description copied from interface: Window

Inserts the given KeyListener at the specified position in the list.

Specified by:

addKeyListener in interface Window

Parameters:

index - Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size().

l - The listener object to be inserted
removeKeyListener

public final void removeKeyListener(KeyListener l)

Specified by:

removeKeyListener in interface Window
getKeyListener

public final KeyListener getKeyListener(int index)

Specified by:

getKeyListener in interface Window
getKeyListeners

public final KeyListener[] getKeyListeners()

Specified by:

getKeyListeners in interface Window
addMouseListener

public final void addMouseListener(MouseListener l)

Description copied from interface: Window

Appends the given MouseListener to the end of the list.

Specified by:

addMouseListener in interface Window
addMouseListener

public final void addMouseListener(int index, MouseListener l)

Description copied from interface: Window

Inserts the given MouseListener at the specified position in the list.

Specified by:

addMouseListener in interface Window

Parameters:

index - Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size().

l - The listener object to be inserted
removeMouseListener

public final void removeMouseListener(MouseListener l)

Description copied from interface: Window

Removes the given MouseListener from the list.

Specified by:

removeMouseListener in interface Window
getMouseListener

public final MouseListener getMouseListener(int index)

Description copied from interface: Window

Returns the MouseListener from the list at the given index.

Specified by:

getMouseListener in interface Window
getMouseListeners

public final MouseListener[] getMouseListeners()

Description copied from interface: Window

Returns all MouseListener

Specified by:

getMouseListeners in interface Window
setDefaultGesturesEnabled

public void setDefaultGesturesEnabled(boolean enable)

Description copied from interface: Window

Enable or disable default GestureHandler. Default is enabled.

Specified by:

setDefaultGesturesEnabled in interface Window
areDefaultGesturesEnabled

public boolean areDefaultGesturesEnabled()

Description copied from interface: Window

Return true if default GestureHandler are enabled.

Specified by:

areDefaultGesturesEnabled in interface Window
addGestureHandler

public final void addGestureHandler(GestureHandler gh)

Description copied from interface: Window

Appends the given GestureHandler to the end of the list.

Specified by:

addGestureHandler in interface Window
addGestureHandler

public final void addGestureHandler(int index, GestureHandler gh)

Description copied from interface: Window

Inserts the given GestureHandler at the specified position in the list.

Specified by:

addGestureHandler in interface Window

Parameters:

index - Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size().
removeGestureHandler

public final void removeGestureHandler(GestureHandler gh)

Description copied from interface: Window

Removes the given GestureHandler from the list.

Specified by:

removeGestureHandler in interface Window
addGestureListener

public final void addGestureListener(GestureHandler.GestureListener gl)

Description copied from interface: Window

Appends the given GestureHandler.GestureListener to the end of the list.

Specified by:

addGestureListener in interface Window
addGestureListener

public final void addGestureListener(int index, GestureHandler.GestureListener gl)

Description copied from interface: Window

Inserts the given GestureHandler.GestureListener at the specified position in the list.

Specified by:

addGestureListener in interface Window

Parameters:

index - Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size().
removeGestureListener

public final void removeGestureListener(GestureHandler.GestureListener gl)

Description copied from interface: Window

Removes the given GestureHandler.GestureListener from the list.

Specified by:

removeGestureListener in interface Window
lockSurface

public final int lockSurface() throws NativeWindowException, RuntimeException

Description copied from interface: NativeSurface
Lock the surface of this native window.
The surface handle shall be valid after a successfull call, ie return a value other than NativeSurface.LOCK_SURFACE_UNLOCKED and NativeSurface.LOCK_SURFACE_NOT_READY, which is
```
    boolean ok = LOCK_SURFACE_NOT_READY < lockSurface();
 
```
The caller may need to take care of the result NativeSurface.LOCK_SURFACE_CHANGED, where the surface handle is valid but has changed.

This call is blocking until the surface has been locked or a timeout is reached. The latter will throw a runtime exception.

This call allows recursion from the same thread.

The implementation may want to aquire the application level RecursiveLock first before proceeding with a native surface lock.

The implementation shall also invoke AbstractGraphicsDevice.lock() for the initial lock (recursive count zero).
Specified by:

lockSurface in interface NativeSurface

Returns:

NativeSurface.LOCK_SUCCESS, NativeSurface.LOCK_SURFACE_CHANGED or NativeSurface.LOCK_SURFACE_NOT_READY.

Throws:

NativeWindowException - if native locking failed, maybe platform related

RuntimeException - after timeout when waiting for the surface lock

See Also:
- RecursiveLock
unlockSurface

public final void unlockSurface()

Description copied from interface: NativeSurface

Unlock the surface of this native window Shall not modify the surface handle, see NativeSurface.lockSurface()
The implementation shall also invoke AbstractGraphicsDevice.unlock() for the final unlock (recursive count zero).
The implementation shall be fail safe, i.e. tolerant in case the native resources are already released / unlocked. In this case the implementation shall simply ignore the call.
Specified by:

unlockSurface in interface NativeSurface

See Also:
- NativeSurface.lockSurface()
- RecursiveLock
isSurfaceLockedByOtherThread

public final boolean isSurfaceLockedByOtherThread()

Description copied from interface: NativeSurface
Query if surface is locked by another thread, i.e. not the current one.
Convenient shortcut for:
```
   final Thread o = getSurfaceLockOwner();
   if( null != o && Thread.currentThread() != o ) { .. }
 
```
Specified by:

isSurfaceLockedByOtherThread in interface NativeSurface
getSurfaceLockOwner

public final Thread getSurfaceLockOwner()

Description copied from interface: NativeSurface

Return the locking owner's Thread, or null if not locked.

Specified by:

getSurfaceLockOwner in interface NativeSurface
surfaceSwap

public final boolean surfaceSwap()

Description copied from interface: NativeSurface

Provide a mechanism to utilize custom (pre-) swap surface code. This method is called before the render toolkit (e.g. JOGL) swaps the buffer/surface if double buffering is enabled.
The implementation may itself apply the swapping, in which case true shall be returned.

Specified by:

surfaceSwap in interface NativeSurface

Returns:

true if this method completed swapping the surface, otherwise false, in which case eg the GLDrawable implementation has to swap the code.
removeSurfaceUpdatedListener

public final void removeSurfaceUpdatedListener(SurfaceUpdatedListener l)

Description copied from interface: NativeSurface

Remove the specified SurfaceUpdatedListener from the list.

Specified by:

removeSurfaceUpdatedListener in interface NativeSurface
addSurfaceUpdatedListener

public final void addSurfaceUpdatedListener(SurfaceUpdatedListener l)

Description copied from interface: NativeSurface

Appends the given SurfaceUpdatedListener to the end of the list.

Specified by:

addSurfaceUpdatedListener in interface NativeSurface
addSurfaceUpdatedListener

public final void addSurfaceUpdatedListener(int index, SurfaceUpdatedListener l) throws IndexOutOfBoundsException

Description copied from interface: NativeSurface

Inserts the given SurfaceUpdatedListener at the specified position in the list.

Specified by:

addSurfaceUpdatedListener in interface NativeSurface

Parameters:

index - Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size().

l - The listener object to be inserted

Throws:

IndexOutOfBoundsException - If the index is not within (0 <= index && index <= size()), or -1
surfaceUpdated

public final void surfaceUpdated(Object updater, NativeSurface ns, long when)

Description copied from interface: SurfaceUpdatedListener

Notification of a surface update event, eg. after a swap buffer operation.

Specified by:

surfaceUpdated in interface SurfaceUpdatedListener

Parameters:

updater - is the caller object who updated the surface, e.g. a JOGL GLDrawable.

ns - the updated NativeSurface

when - the time in ms, when the surface was updated
getWindowHandle

public final long getWindowHandle()

Description copied from interface: NativeWindow

Returns the window handle for this NativeWindow.
The window handle shall reflect the platform one for all window related operations, e.g. open, close, resize.
On X11 this returns an entity of type Window.
On Microsoft Windows this returns an entity of type HWND.

Specified by:

getWindowHandle in interface NativeWindow
getSurfaceHandle

public final long getSurfaceHandle()

Description copied from interface: NativeSurface

Returns the handle to the surface for this NativeSurface.
The surface handle should be set/update by NativeSurface.lockSurface(), where NativeSurface.unlockSurface() is not allowed to modify it. After NativeSurface.unlockSurface() it is no more guaranteed that the surface handle is still valid. The surface handle shall reflect the platform one for all drawable surface operations, e.g. opengl, swap-buffer.
On X11 this returns an entity of type Window, since there is no differentiation of surface and window there.
On Microsoft Windows this returns an entity of type HDC.

Specified by:

getSurfaceHandle in interface NativeSurface
getGraphicsConfiguration

public final AbstractGraphicsConfiguration getGraphicsConfiguration()

Description copied from interface: NativeSurface

Returns the graphics configuration corresponding to this window.
In case the implementation utilizes a delegation pattern to wrap abstract toolkits, this method shall return the native AbstractGraphicsConfiguration via AbstractGraphicsConfiguration.getNativeGraphicsConfiguration().
Specified by:

getGraphicsConfiguration in interface NativeSurface

See Also:
- AbstractGraphicsConfiguration.getNativeGraphicsConfiguration()
- com.jogamp.nativewindow.GraphicsConfigurationFactory#chooseGraphicsConfiguration(Capabilities, CapabilitiesChooser, AbstractGraphicsScreen)
getDisplayHandle

public final long getDisplayHandle()

Description copied from interface: NativeSurface

Convenience: Get display handle from AbstractGraphicsConfiguration . AbstractGraphicsScreen . AbstractGraphicsDevice

Specified by:

getDisplayHandle in interface NativeSurface
getScreenIndex

public final int getScreenIndex()

Description copied from interface: NativeSurface

Convenience: Get display handle from AbstractGraphicsConfiguration . AbstractGraphicsScreen

Specified by:

getScreenIndex in interface NativeSurface
main

public static void main(String[] args)

A most simple JOGL AWT test entry

Class GLWindow

OpenGL Context Sharing

Nested Class Summary

Nested classes/interfaces inherited from interface com.jogamp.opengl.GLStateKeeper

Nested classes/interfaces inherited from interface com.jogamp.newt.Window

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

Field Summary

Fields inherited from class jogamp.opengl.GLAutoDrawableBase

Fields inherited from interface com.jogamp.opengl.FPSCounter

Fields inherited from interface com.jogamp.opengl.GLAutoDrawable

Fields inherited from interface com.jogamp.nativewindow.NativeSurface

Fields inherited from interface com.jogamp.nativewindow.ScalableSurface

Fields inherited from interface com.jogamp.newt.Window

Method Summary

Methods inherited from class jogamp.opengl.GLAutoDrawableBase

Methods inherited from class java.lang.Object

Methods inherited from interface com.jogamp.opengl.FPSCounter

Methods inherited from interface com.jogamp.opengl.GLAutoDrawable

Methods inherited from interface com.jogamp.opengl.GLDrawable

Methods inherited from interface com.jogamp.nativewindow.NativeWindow

Method Details

getUpstreamWidget

getUpstreamLock

create

create

create

create

getDefaultCloseOperation

setDefaultCloseOperation

getStatePublicBitCount

getStatePublicBitmask

getStateMask

getStateMaskString

getSupportedStateMask

getSupportedStateMaskString

setCapabilitiesChooser

getChosenCapabilities

getRequestedCapabilities

getDelegatedWindow

getParent

getScreen

getMainMonitor

setTitle

getTitle

isPointerVisible

setPointerVisible

getPointerIcon

setPointerIcon

isPointerConfined

confinePointer

setUndecorated

warpPointer

isUndecorated

setAlwaysOnTop

isAlwaysOnTop

setAlwaysOnBottom

isAlwaysOnBottom

setResizable

isResizable

setSticky

isSticky

setMaximized

isMaximizedVert

isMaximizedHorz

setFocusAction

setKeyboardFocusHandler

requestFocus

requestFocus

hasFocus

getInsets

getX

getY

getWidth

getHeight

getBounds

getSurfaceWidth

getSurfaceHeight

convertToWindowUnits

convertToPixelUnits

setSurfaceScale