JOGL 2.3.2 · com.jogamp.nativewindow.NativeWindow

Extend the NativeSurface interface with windowing information such as window-handle, window-size and window-position.

All values of this interface are represented in window units, if not stated otherwise. See NativeSurface.

Coordinate System

Abstract screen space has it's origin in the top-left corner, and may not be at 0/0.
Window origin is in it's top-left corner, see getX() and getY().
Window client-area excludes insets, i.e. window decoration.
Window origin is relative to it's parent window if exist, or the screen position (top-level).

A window toolkit such as the AWT may either implement this interface directly with one of its components, or provide and register an implementation of NativeWindowFactory which can create NativeWindow objects for its components.

Field Summary

Inherited from com.jogamp.nativewindow.NativeSurface:: LOCK_SUCCESS LOCK_SURFACE_CHANGED LOCK_SURFACE_NOT_READY LOCK_SURFACE_UNLOCKED

Method Summary

Modifier and Type	Method and Description
public void	destroy() Destroys this window incl.
public int	Returns: height of the client area in window units getHeight() Returns the height of the client area excluding insets (window decorations) in window units.
public InsetsImmutable	Returns: insets getInsets() Returns the insets defined as the width and height of the window decoration on the left, right, top and bottom in window units.
public Point	getLocationOnScreen(Point Optional `Point` storage. If not null, `null`, it is translated about the resulting screen position and returned. point) Returns the window's top-left client-area position in the screen.
public NativeSurface	getNativeSurface() Redeclares com.jogamp.nativewindow.NativeSurfaceHolder.getNativeSurface. Returns the associated `NativeSurface` of this `NativeSurfaceHolder`.
public NativeWindow	Returns: The parent NativeWindow, or null if this NativeWindow is top level. getParent()
public int	Returns: width of the client area in window units getWidth() Returns the width of the client area excluding insets (window decorations) in window units.
public long	getWindowHandle() Returns the window handle for this NativeWindow.
public int	getX() Returns the x position of the top-left corner of the client area relative to it's parent in window units.
public int	getY() Returns the current y position of the top-left corner of the client area relative to it's parent in window units.
public boolean	hasFocus() Returns true if this native window owns the focus, otherwise false.

Inherited from com.jogamp.nativewindow.NativeSurface:: addSurfaceUpdatedListener addSurfaceUpdatedListener convertToPixelUnits convertToWindowUnits getDisplayHandle getGraphicsConfiguration getScreenIndex getSurfaceHandle getSurfaceHeight getSurfaceLockOwner getSurfaceWidth isSurfaceLockedByOtherThread lockSurface removeSurfaceUpdatedListener surfaceSwap unlockSurface

Method Detail

destroy	back to summary
public void destroy() Destroys this window incl. releasing all related resources.

getHeight back to summary

getHeight	back to summary
public int getHeight() Returns the height of the client area excluding insets (window decorations) in window units. Returns:int height of the client area in window units See Also `NativeSurface#getSurfaceHeight()`

public int getHeight()

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

Returns:int: height of the client area in window units
See Also: NativeSurface#getSurfaceHeight()

getInsets back to summary

getInsets	back to summary
public 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. 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 `getX()` - getInsets().`getLeftWidth()` `getY()` - getInsets().`getTopHeight()` The top-level window size is `getWidth()` + getInsets().`getTotalWidth()` `getHeight()` + getInsets().`getTotalHeight()` Returns:InsetsImmutable insets

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

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

  getX() - getInsets().getLeftWidth()
  getY() - getInsets().getTopHeight()

The top-level window size is

  getWidth()  + getInsets().getTotalWidth()
  getHeight() + getInsets().getTotalHeight()

Returns:InsetsImmutable: insets

getLocationOnScreen back to summary

getLocationOnScreen	back to summary
public Point getLocationOnScreen(Point point) 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. Parameters point:Point Optional `Point` storage. If not null, `null`, it is translated about the resulting screen position and returned. See Also `getX()`, `getY()`, `getInsets()`

public Point getLocationOnScreen(Point point)

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.

Parameters

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

See Also

getX(), getY(), getInsets()

getNativeSurface back to summary

getNativeSurface	back to summary
public NativeSurface getNativeSurface() Redeclares com.jogamp.nativewindow.NativeSurfaceHolder.getNativeSurface. Doc from com.jogamp.nativewindow.NativeSurfaceHolder.getNativeSurface. Returns the associated `NativeSurface` of this `NativeSurfaceHolder`. Returns this instance, which is-a `NativeSurface`. Annotations @Override

public NativeSurface getNativeSurface()

Redeclares com.jogamp.nativewindow.NativeSurfaceHolder.getNativeSurface.

Doc from com.jogamp.nativewindow.NativeSurfaceHolder.getNativeSurface.

Returns the associated NativeSurface of this NativeSurfaceHolder.

Returns this instance, which is-a NativeSurface.

Annotations

@Override

getParent	back to summary
public NativeWindow getParent() Returns:NativeWindow The parent NativeWindow, or null if this NativeWindow is top level.

getWidth back to summary

getWidth	back to summary
public int getWidth() Returns the width of the client area excluding insets (window decorations) in window units. Returns:int width of the client area in window units See Also `NativeSurface#getSurfaceWidth()`

public int getWidth()

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

Returns:int: width of the client area in window units
See Also: NativeSurface#getSurfaceWidth()

getWindowHandle	back to summary
public long getWindowHandle() 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.

getWindowHandle

back to summary

public long getWindowHandle()

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.

getX back to summary

getX	back to summary
public int getX() 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. See Also `getInsets()`, `getLocationOnScreen(Point)`

public int getX()

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.

See Also: getInsets(), getLocationOnScreen(Point)

getY back to summary

getY	back to summary
public int getY() 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. See Also `getInsets()`, `getLocationOnScreen(Point)`

public int getY()

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.

See Also: getInsets(), getLocationOnScreen(Point)

hasFocus	back to summary
public boolean hasFocus() Returns true if this native window owns the focus, otherwise false.

public Interface NativeWindow

Coordinate System

Field Summary

Method Summary

Method Detail