|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjogamp.opengl.GLAutoDrawableBase
com.jogamp.newt.opengl.GLWindow
public class GLWindow
An implementation of GLAutoDrawable and Window interface,
using a delegated Window instance, which may be an aggregation (lifecycle: created and destroyed).
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, javax.media.opengl.GLRunnable) to the OpenGL command stream.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface com.jogamp.newt.Window |
|---|
Window.FocusRunnable, Window.ReparentOperation |
| Nested classes/interfaces inherited from interface javax.media.nativewindow.WindowClosingProtocol |
|---|
WindowClosingProtocol.WindowClosingMode |
| Field Summary |
|---|
| Fields inherited from class jogamp.opengl.GLAutoDrawableBase |
|---|
DEBUG |
| Fields inherited from interface javax.media.opengl.GLAutoDrawable |
|---|
SCREEN_CHANGE_ACTION_ENABLED |
| Fields inherited from interface com.jogamp.newt.Window |
|---|
DEBUG_IMPLEMENTATION, DEBUG_KEY_EVENT, DEBUG_MOUSE_EVENT, TIMEOUT_NATIVEWINDOW |
| Fields inherited from interface javax.media.nativewindow.NativeSurface |
|---|
LOCK_SUCCESS, LOCK_SURFACE_CHANGED, LOCK_SURFACE_NOT_READY, LOCK_SURFACE_UNLOCKED |
| Fields inherited from interface javax.media.opengl.FPSCounter |
|---|
DEFAULT_FRAMES_PER_INTERVAL |
| Method Summary | |
|---|---|
boolean |
addChild(NativeWindow win)
|
void |
addKeyListener(int index,
KeyListener l)
Inserts the given KeyListener at the
specified position in the list. |
void |
addKeyListener(KeyListener l)
Appends the given KeyListener to the end of
the list. |
void |
addMouseListener(int index,
MouseListener l)
Inserts the given MouseListener at the
specified position in the list. |
void |
addMouseListener(MouseListener l)
Appends the given MouseListener to the end of
the list. |
void |
addSurfaceUpdatedListener(int index,
SurfaceUpdatedListener l)
Inserts the given SurfaceUpdatedListener at the
specified position in the list. |
void |
addSurfaceUpdatedListener(SurfaceUpdatedListener l)
Appends the given SurfaceUpdatedListener to the end of the list. |
void |
addWindowListener(int index,
WindowListener l)
Inserts the given WindowListener at the
specified position in the list. |
void |
addWindowListener(WindowListener l)
Appends the given WindowListener to the end of
the list. |
void |
confinePointer(boolean grab)
Confine the pointer to this window, ie. |
boolean |
consumeEvent(NEWTEvent event)
Consume the event |
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. |
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. |
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. |
void |
enqueueEvent(boolean wait,
NEWTEvent event)
|
CapabilitiesImmutable |
getChosenCapabilities()
Gets an immutable set of chosen capabilities. |
WindowClosingProtocol.WindowClosingMode |
getDefaultCloseOperation()
|
Window |
getDelegatedWindow()
If the implementation uses delegation, return the delegated Window instance,
otherwise return this instance. |
long |
getDisplayHandle()
Convenience: Get display handle from AbstractGraphicsConfiguration . |
GLDrawableFactory |
getFactory()
Return the GLDrawableFactory being used to create this instance. |
AbstractGraphicsConfiguration |
getGraphicsConfiguration()
Returns the graphics configuration corresponding to this window. |
int |
getHeight()
Returns the current height of this GLDrawable. |
InsetsImmutable |
getInsets()
Returns the insets defined as the width and height of the window decoration on the left, right, top and bottom. Insets are zero if the window is undecorated, including child windows. |
KeyListener |
getKeyListener(int index)
|
KeyListener[] |
getKeyListeners()
|
Point |
getLocationOnScreen(Point storage)
Returns the current position of the top-left corner of the client area in screen coordinates. |
MouseListener |
getMouseListener(int index)
|
MouseListener[] |
getMouseListeners()
|
NativeWindow |
getParent()
|
CapabilitiesImmutable |
getRequestedCapabilities()
Gets an immutable set of requested capabilities. |
Screen |
getScreen()
|
int |
getScreenIndex()
Convenience: Get display handle from AbstractGraphicsConfiguration . |
long |
getSurfaceHandle()
Returns the handle to the surface for this NativeSurface. |
Thread |
getSurfaceLockOwner()
Return the locking owner's Thread, or null if not locked. |
String |
getTitle()
|
Object |
getUpstreamWidget()
Method may return the upstream UI toolkit object holding this GLAutoDrawable instance, if exist. |
int |
getWidth()
Returns the current width of this GLDrawable. |
long |
getWindowHandle()
Returns the window handle for this NativeWindow. |
WindowListener |
getWindowListener(int index)
|
WindowListener[] |
getWindowListeners()
|
int |
getX()
|
int |
getY()
|
boolean |
hasFocus()
Returns true if this native window owns the focus, otherwise false. |
boolean |
isAlwaysOnTop()
|
boolean |
isFullscreen()
|
boolean |
isKeyboardVisible()
Return true if the virtual on-screen keyboard is visible, otherwise false. |
boolean |
isNativeValid()
|
boolean |
isPointerConfined()
|
boolean |
isPointerVisible()
|
boolean |
isSurfaceLockedByOtherThread()
Query if surface is locked by another thread, i.e. |
boolean |
isUndecorated()
|
boolean |
isVisible()
|
int |
lockSurface()
Lock the surface of this native window. |
static void |
main(String[] args)
A most simple JOGL AWT test entry |
boolean |
removeChild(NativeWindow win)
|
void |
removeKeyListener(KeyListener l)
|
void |
removeMouseListener(MouseListener l)
|
void |
removeSurfaceUpdatedListener(SurfaceUpdatedListener l)
Remove the specified SurfaceUpdatedListener from the list. |
void |
removeWindowListener(WindowListener l)
|
Window.ReparentOperation |
reparentWindow(NativeWindow newParent)
Change this window's parent window. |
Window.ReparentOperation |
reparentWindow(NativeWindow newParent,
boolean forceDestroyCreate)
|
void |
requestFocus()
Request focus for this native window |
void |
requestFocus(boolean wait)
Request focus for this native window |
void |
runOnEDTIfAvail(boolean wait,
Runnable task)
|
void |
sendWindowEvent(int eventType)
|
void |
setAlwaysOnTop(boolean value)
|
CapabilitiesChooser |
setCapabilitiesChooser(CapabilitiesChooser chooser)
Set the CapabilitiesChooser to help determine the native visual type. |
WindowClosingProtocol.WindowClosingMode |
setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)
|
void |
setFocusAction(Window.FocusRunnable focusAction)
Sets a Window.FocusRunnable,
which Window.FocusRunnable.run() method is executed before the native focus is requested. |
boolean |
setFullscreen(boolean fullscreen)
|
void |
setKeyboardFocusHandler(KeyListener l)
Sets a KeyListener allowing focus traversal with a covered window toolkit like AWT. |
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. |
void |
setPointerVisible(boolean mouseVisible)
Makes the pointer visible or invisible. |
void |
setPosition(int x,
int y)
Sets the location of the window's client area, excluding insets (window decorations). This call is ignored if in fullscreen mode. |
void |
setRealized(boolean realized)
Indicates to on-screen GLDrawable implementations whether the underlying window has been created and can be drawn into. |
void |
setSharedContext(GLContext sharedContext)
Specifies an OpenGL context to share with.At native creation, setVisible(true),
a drawable and context is created besides the native Window itself,hence you shall set the shared context before. |
void |
setSize(int width,
int height)
Sets the size of the window's client area, excluding decorations. |
void |
setTitle(String title)
|
void |
setTopLevelPosition(int x,
int y)
Sets the location of the top-level window inclusive insets (window decorations). |
void |
setTopLevelSize(int width,
int height)
Sets the size of the top-level window including insets (window decorations). |
void |
setUndecorated(boolean value)
|
void |
setVisible(boolean visible)
setVisible makes the window and children visible if visible is true,
otherwise the window and children becomes invisible. |
boolean |
surfaceSwap()
Provide a mechanism to utilize custom (pre-) swap surface code. |
void |
surfaceUpdated(Object updater,
NativeSurface ns,
long when)
Notification of a surface update event, eg. |
void |
swapBuffers()
Swaps the front and back buffers of this drawable. |
String |
toString()
|
void |
unlockSurface()
Unlock the surface of this native window Shall not modify the surface handle, see NativeSurface.lockSurface() |
void |
warpPointer(int x,
int y)
Moves the pointer to x/y relative to this window's origin. |
void |
windowRepaint(int x,
int y,
int width,
int height)
|
| Methods inherited from class jogamp.opengl.GLAutoDrawableBase |
|---|
addGLEventListener, addGLEventListener, createContext, defaultSwapBuffers, disposeGLEventListener, getAnimator, getAutoSwapBufferMode, getChosenGLCapabilities, getContext, getContextCreationFlags, getDelegatedDrawable, getFPSStartTime, getGL, getGLEventListener, getGLEventListenerCount, getGLEventListenerInitState, getGLProfile, getHandle, getLastFPS, getLastFPSPeriod, getLastFPSUpdateTime, getNativeSurface, getSkipContextReleaseThread, getTotalFPS, getTotalFPSDuration, getTotalFPSFrames, getUpdateFPSFrames, invoke, invoke, isRealized, removeGLEventListener, resetFPSCounter, setAnimator, setAutoSwapBufferMode, setContext, setContextCreationFlags, setGL, setGLEventListenerInitState, setSkipContextReleaseThread, setUpdateFPSFrames |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface javax.media.opengl.GLAutoDrawable |
|---|
addGLEventListener, addGLEventListener, createContext, disposeGLEventListener, getAnimator, getAutoSwapBufferMode, getContext, getContextCreationFlags, getDelegatedDrawable, getGL, getGLEventListener, getGLEventListenerCount, getGLEventListenerInitState, invoke, invoke, removeGLEventListener, setAnimator, setAutoSwapBufferMode, setContext, setContextCreationFlags, setGL, setGLEventListenerInitState |
| Methods inherited from interface javax.media.opengl.GLDrawable |
|---|
getChosenGLCapabilities, getGLProfile, getHandle, getNativeSurface, isRealized |
| Methods inherited from interface javax.media.opengl.FPSCounter |
|---|
getFPSStartTime, getLastFPS, getLastFPSPeriod, getLastFPSUpdateTime, getTotalFPS, getTotalFPSDuration, getTotalFPSFrames, getUpdateFPSFrames, resetFPSCounter, setUpdateFPSFrames |
| Method Detail |
|---|
public final Object getUpstreamWidget()
GLAutoDrawableGLAutoDrawable instance, if exist.
Currently known Java UI toolkits and it's known return types are:
| Toolkit | GLAutoDrawable Implementation | ~ | Return Type of getUpstreamWidget() |
| NEWT | GLWindow | has a | Window |
| SWT | GLCanvas | is a | Canvas |
| AWT | GLCanvas | is a | Canvas |
| AWT | GLJPanel | is a | JPanel |
This method may also return null if no UI toolkit is being used,
as common for offscreen rendering.
getUpstreamWidget in interface GLAutoDrawablepublic static GLWindow create(GLCapabilitiesImmutable caps)
The lifecycle of this Window's Screen and Display is handled via Screen.addReference()
and Screen.removeReference().
public static GLWindow create(Screen screen,
GLCapabilitiesImmutable caps)
The lifecycle of this Window's Screen and Display is handled via Screen.addReference()
and Screen.removeReference().
public static GLWindow create(Window window)
The lifecycle of this Window's Screen and Display is handled via Screen.addReference()
and Screen.removeReference().
public static GLWindow create(NativeWindow parentNativeWindow,
GLCapabilitiesImmutable caps)
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().
public WindowClosingProtocol.WindowClosingMode getDefaultCloseOperation()
getDefaultCloseOperation in interface WindowClosingProtocolWindowClosingProtocol.WindowClosingMode.DISPOSE_ON_CLOSE,
WindowClosingProtocol.WindowClosingMode.DO_NOTHING_ON_CLOSEpublic WindowClosingProtocol.WindowClosingMode setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)
setDefaultCloseOperation in interface WindowClosingProtocolop - the new close operation value
WindowClosingProtocol.WindowClosingMode.DISPOSE_ON_CLOSE,
WindowClosingProtocol.WindowClosingMode.DO_NOTHING_ON_CLOSEpublic CapabilitiesChooser setCapabilitiesChooser(CapabilitiesChooser chooser)
Window
setCapabilitiesChooser in interface Windowchooser - the new CapabilitiesChooser
public final CapabilitiesImmutable getChosenCapabilities()
Window
getChosenCapabilities in interface Windowpublic final CapabilitiesImmutable getRequestedCapabilities()
Window
getRequestedCapabilities in interface Windowpublic final Window getDelegatedWindow()
WindowWindow instance,
otherwise return this instance.
getDelegatedWindow in interface Windowpublic final NativeWindow getParent()
getParent in interface NativeWindowpublic final Screen getScreen()
getScreen in interface Windowpublic final void setTitle(String title)
setTitle in interface Windowpublic final String getTitle()
getTitle in interface Windowpublic final boolean isPointerVisible()
isPointerVisible in interface WindowWindow.setPointerVisible(boolean)public final void setPointerVisible(boolean mouseVisible)
Window
setPointerVisible in interface WindowmouseVisible - defaults to true for platforms w/ visible pointer,
otherwise defaults to true, eg. Android.Window.confinePointer(boolean)public final boolean isPointerConfined()
isPointerConfined in interface WindowWindow.confinePointer(boolean)public final void confinePointer(boolean grab)
WindowBefore 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.
confinePointer in interface Windowgrab - defaults to false.public final void setUndecorated(boolean value)
setUndecorated in interface Window
public final void warpPointer(int x,
int y)
Window
warpPointer in interface Windowx - relative pointer x position within this windowy - relative pointer y position within this windowWindow.confinePointer(boolean)public final boolean isUndecorated()
isUndecorated in interface Windowpublic final void setAlwaysOnTop(boolean value)
setAlwaysOnTop in interface Windowpublic final boolean isAlwaysOnTop()
isAlwaysOnTop in interface Windowpublic final void setFocusAction(Window.FocusRunnable focusAction)
WindowWindow.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.
setFocusAction in interface Windowpublic void setKeyboardFocusHandler(KeyListener l)
WindowKeyListener 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 InputEvent.consumedTag.
setKeyboardFocusHandler in interface Windowpublic final void requestFocus()
WindowThe request is handled on this Window EDT and blocked until finished.
requestFocus in interface WindowWindow.requestFocus(boolean)public final void requestFocus(boolean wait)
WindowThe request is handled on this Window EDT.
requestFocus in interface Windowwait - true if waiting until the request is executed, otherwise falseWindow.requestFocus()public boolean hasFocus()
NativeWindow
hasFocus in interface NativeWindowpublic final InsetsImmutable getInsets()
NativeWindow
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
getX() - getInsets().The top-level window size isgetLeftWidth()getY() - getInsets().getTopHeight()
getWidth() + getInsets().getTotalWidth()getHeight() + getInsets().getTotalHeight()
getInsets in interface NativeWindowpublic final int getX()
getX in interface NativeWindowNativeWindow.getInsets()public final int getY()
getY in interface NativeWindowNativeWindow.getInsets()public final int getWidth()
GLDrawable
getWidth in interface NativeSurfacegetWidth in interface GLDrawablegetWidth in class jogamp.opengl.GLAutoDrawableBasepublic final int getHeight()
GLDrawable
getHeight in interface NativeSurfacegetHeight in interface GLDrawablegetHeight in class jogamp.opengl.GLAutoDrawableBase
public final void setPosition(int x,
int y)
Window
setPosition in interface Windowx - coord of the client-area's top left cornery - coord of the client-area's top left cornerNativeWindow.getInsets()
public void setTopLevelPosition(int x,
int y)
WindowNote: 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.
setTopLevelPosition in interface Windowx - coord of the top-level left cornery - coord of the top-level left cornerWindow.setPosition(int, int),
NativeWindow.getInsets()public final boolean setFullscreen(boolean fullscreen)
setFullscreen in interface Windowpublic final boolean isFullscreen()
isFullscreen in interface Windowpublic final boolean isVisible()
isVisible in interface Windowpublic final String toString()
toString in interface GLDrawabletoString in class jogamp.opengl.GLAutoDrawableBasepublic final Window.ReparentOperation reparentWindow(NativeWindow newParent)
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.
reparentWindow in interface WindownewParent - The new parent NativeWindow. If null, this Window becomes a top level window.
public final Window.ReparentOperation reparentWindow(NativeWindow newParent,
boolean forceDestroyCreate)
reparentWindow in interface Windowpublic final boolean removeChild(NativeWindow win)
removeChild in interface Windowpublic final boolean addChild(NativeWindow win)
addChild in interface Windowpublic final void destroy()
GLAutoDrawabledispose(..) for all
registered GLEventListeners. Called automatically by the
window system toolkit upon receiving a destroy notification. This
routine may be called manually.
destroy in interface Windowdestroy in interface NativeWindowdestroy in interface GLAutoDrawableWindow.destroy(),
Window.setVisible(boolean)public final void setVisible(boolean visible)
WindowsetVisible makes the window and children visible if visible is true,
otherwise the window and children becomes invisible.
The setVisible(true) is responsible to actual create the native window.
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(true) has no effect as long the parent's is not valid yet,
i.e. NativeWindow.getWindowHandle() returns null.
setVisible(true) shall be repeated when the parent becomes valid.
setVisible in interface Window
public final void setSize(int width,
int height)
Window
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.
setSize in interface Windowwidth - of the window's client areaheight - of the window's client areaNativeWindow.getInsets()
public void setTopLevelSize(int width,
int height)
WindowNote: Insets (if supported) are available only after the window is set visible and hence has been created.
setTopLevelSize in interface Windowwidth - of the top-level window areaheight - of the top-level window areaWindow.setSize(int, int),
NativeWindow.getInsets()public final boolean isNativeValid()
isNativeValid in interface WindowsetVisible(true), otherwise false.Window.setVisible(boolean),
#destroy(boolean)public Point getLocationOnScreen(Point storage)
NativeWindowSince the position reflects the client area, it does not include the insets.
getLocationOnScreen in interface NativeWindowstorage - if not null,
Point.translate(javax.media.nativewindow.util.Point)
the passed Point by this location on the screen and return it.
public void setSharedContext(GLContext sharedContext)
OpenGL context to share with.setVisible(true),
a drawable and context is created besides the native Window itself,
sharedContext - The OpenGL context shared by this GLWindow's onepublic void display()
GLAutoDrawableCauses OpenGL rendering to be performed for this GLAutoDrawable in the following order:
display(..) for all
registered GLEventListeners. GLRunnable,
enqueued via GLAutoDrawable.invoke(boolean, GLRunnable).
May be called periodically by a running GLAnimatorControl implementation,
which must register itself with GLAutoDrawable.setAnimator(javax.media.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.
display in interface GLAutoDrawableGLAutoDrawable.setAnimator(javax.media.opengl.GLAnimatorControl)public final GLDrawableFactory getFactory()
GLDrawableGLDrawableFactory being used to create this instance.
getFactory in interface GLDrawablepublic final void setRealized(boolean realized)
GLDrawablesetRealized on a GLCanvas, a GLJPanel, or a
GLPbuffer, as these perform the appropriate calls on their
underlying GLDrawables internally.
Developers implementing new OpenGL components for various window
toolkits need to call this method against GLDrawables obtained
from the GLDrawableFactory via the GLDrawableFactory.getGLDrawable() method. It must typically be
called with an argument of true when the component
associated with the GLDrawable is realized and with an argument
of false just before the component is unrealized.
For the AWT, this means calling setRealized(true) in
the addNotify method and with an argument of
false in the removeNotify method.
GLDrawable implementations should handle multiple
cycles of setRealized(true) /
setRealized(false) calls. Most, if not all, Java
window toolkits have a persistent object associated with a given
component, regardless of whether that component is currently
realized. The GLDrawable object associated with a
particular component is intended to be similarly persistent. A
GLDrawable is intended to be created for a given
component when it is constructed and live as long as that
component. setRealized allows the
GLDrawable to re-initialize and destroy any
associated resources as the component becomes realized and
unrealized, respectively.
With an argument of true,
the minimum implementation shall call
NativeSurface's lockSurface() and if successfull:
GLCapabilities, which are associated with
the attached NativeSurface's AbstractGraphicsConfiguration.NativeSurface's unlockSurface().NativeSurface's lockSurface()
ensures resolving the window/surface handles, and the drawable's GLCapabilities
might have changed.
Calling this method has no other effects. For example, if
removeNotify is called on a Canvas implementation
for which a GLDrawable has been created, it is also necessary to
destroy all OpenGL contexts associated with that GLDrawable. This
is not done automatically by the implementation.
setRealized in interface GLDrawable
public final void swapBuffers()
throws GLException
GLDrawableGLAutoDrawable 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.
swapBuffers in interface GLDrawableGLExceptionpublic boolean consumeEvent(NEWTEvent event)
NEWTEventConsumer
consumeEvent in interface NEWTEventConsumer
public final void windowRepaint(int x,
int y,
int width,
int height)
windowRepaint in interface Window
public final void enqueueEvent(boolean wait,
NEWTEvent event)
enqueueEvent in interface Window
public final void runOnEDTIfAvail(boolean wait,
Runnable task)
runOnEDTIfAvail in interface Windowpublic final void removeSurfaceUpdatedListener(SurfaceUpdatedListener l)
NativeSurfaceSurfaceUpdatedListener from the list.
removeSurfaceUpdatedListener in interface NativeSurfacepublic final void addSurfaceUpdatedListener(SurfaceUpdatedListener l)
NativeSurfaceSurfaceUpdatedListener to the end of the list.
addSurfaceUpdatedListener in interface NativeSurface
public final void addSurfaceUpdatedListener(int index,
SurfaceUpdatedListener l)
throws IndexOutOfBoundsException
NativeSurfaceSurfaceUpdatedListener at the
specified position in the list.
addSurfaceUpdatedListener in interface NativeSurfaceindex - 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
IndexOutOfBoundsException - If the index is not within (0 <= index && index <= size()), or -1public void sendWindowEvent(int eventType)
sendWindowEvent in interface Windowpublic final WindowListener getWindowListener(int index)
getWindowListener in interface Windowpublic final WindowListener[] getWindowListeners()
getWindowListeners in interface Windowpublic final void removeWindowListener(WindowListener l)
removeWindowListener in interface Windowpublic final void addWindowListener(WindowListener l)
WindowWindowListener to the end of
the list.
addWindowListener in interface Window
public final void addWindowListener(int index,
WindowListener l)
throws IndexOutOfBoundsException
WindowWindowListener at the
specified position in the list.
addWindowListener in interface Windowindex - 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
IndexOutOfBoundsException - If the index is not within (0 <= index && index <= size()), or -1public final void setKeyboardVisible(boolean visible)
Windowvisible is true
or false.
One known platform where NEWT supports this feature is Android.
setKeyboardVisible in interface Windowpublic final boolean isKeyboardVisible()
Windowtrue 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.
isKeyboardVisible in interface WindowWindow.setKeyboardVisible(boolean)public final void addKeyListener(KeyListener l)
WindowKeyListener to the end of
the list.
addKeyListener in interface Window
public final void addKeyListener(int index,
KeyListener l)
WindowKeyListener at the
specified position in the list.
addKeyListener in interface Windowindex - 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 insertedpublic final void removeKeyListener(KeyListener l)
removeKeyListener in interface Windowpublic final KeyListener getKeyListener(int index)
getKeyListener in interface Windowpublic final KeyListener[] getKeyListeners()
getKeyListeners in interface Windowpublic final void addMouseListener(MouseListener l)
WindowMouseListener to the end of
the list.
addMouseListener in interface Window
public final void addMouseListener(int index,
MouseListener l)
WindowMouseListener at the
specified position in the list.
addMouseListener in interface Windowindex - 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 insertedpublic final void removeMouseListener(MouseListener l)
removeMouseListener in interface Windowpublic final MouseListener getMouseListener(int index)
getMouseListener in interface Windowpublic final MouseListener[] getMouseListeners()
getMouseListeners in interface Window
public final int lockSurface()
throws NativeWindowException,
RuntimeException
NativeSurface
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 = lockSurface() > LOCK_SURFACE_NOT_READY;
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).
lockSurface in interface NativeSurfaceNativeSurface.LOCK_SUCCESS, NativeSurface.LOCK_SURFACE_CHANGED or NativeSurface.LOCK_SURFACE_NOT_READY.
NativeWindowException - if native locking failed, maybe platform related
RuntimeException - after timeout when waiting for the surface lockRecursiveLockpublic final void unlockSurface()
NativeSurfaceNativeSurface.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.
unlockSurface in interface NativeSurfaceNativeSurface.lockSurface(),
RecursiveLockpublic final boolean isSurfaceLockedByOtherThread()
NativeSurface
final Thread o = getSurfaceLockOwner();
if( null != o && Thread.currentThread() != o ) { .. }
isSurfaceLockedByOtherThread in interface NativeSurfacepublic final Thread getSurfaceLockOwner()
NativeSurface
getSurfaceLockOwner in interface NativeSurfacepublic final boolean surfaceSwap()
NativeSurfaceThe implementation may itself apply the swapping, in which case true shall be returned.
surfaceSwap in interface NativeSurfacepublic final long getWindowHandle()
NativeWindowThe 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.
getWindowHandle in interface NativeWindowpublic final long getSurfaceHandle()
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.
getSurfaceHandle in interface NativeSurfacepublic final AbstractGraphicsConfiguration getGraphicsConfiguration()
NativeSurface
In case the implementation utilizes a delegation pattern to wrap abstract toolkits,
this method shall return the native AbstractGraphicsConfiguration via AbstractGraphicsConfiguration.getNativeGraphicsConfiguration().
getGraphicsConfiguration in interface NativeSurfaceAbstractGraphicsConfiguration.getNativeGraphicsConfiguration(),
javax.media.nativewindow.GraphicsConfigurationFactory#chooseGraphicsConfiguration(Capabilities, CapabilitiesChooser, AbstractGraphicsScreen)public final long getDisplayHandle()
NativeSurface
getDisplayHandle in interface NativeSurfacepublic final int getScreenIndex()
NativeSurface
getScreenIndex in interface NativeSurface
public final void surfaceUpdated(Object updater,
NativeSurface ns,
long when)
SurfaceUpdatedListener
surfaceUpdated in interface SurfaceUpdatedListenerupdater - is the caller object who updated the surface,
e.g. a JOGL GLDrawable.ns - the updated NativeSurfacewhen - the time in ms, when the surface was updatedpublic static void main(String[] args)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||