1 files changed, 120 insertions, 0 deletions
diff --git a/src/classes/javax/media/nwi/NativeWindow.java b/src/classes/javax/media/nwi/NativeWindow.java
new file mode 100644
index 000000000..f992c2231
--- /dev/null
+++ b/src/classes/javax/media/nwi/NativeWindow.java
@@ -0,0 +1,120 @@
+/*
+ * Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * 
+ * - Redistribution of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * 
+ * - Redistribution in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * 
+ * Neither the name of Sun Microsystems, Inc. or the names of
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * 
+ * This software is provided "AS IS," without a warranty of any kind. ALL
+ * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
+ * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
+ * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
+ * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
+ * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
+ * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
+ * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
+ * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
+ * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
+ * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
+ * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ * 
+ * You acknowledge that this software is not designed or intended for use
+ * in the design, construction, operation or maintenance of any nuclear
+ * facility.
+ * 
+ * Sun gratefully acknowledges that this software was originally authored
+ * and developed by Kenneth Bradley Russell and Christopher John Kline.
+ */
+
+package javax.media.nwi;
+
+/** Provides the mechanism by which the Java / OpenGL binding
+    interacts with windows. 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 {@link
+    NativeWindowFactory NativeWindowFactory} which can create
+    NativeWindow objects for its components. <P>
+
+    A NativeWindow created for a particular on-screen component is
+    expected to have the same lifetime as that component. As long as
+    the component is alive, the NativeWindow must be able to control
+    it, and any time it is visible and locked, provide information
+    such as the window handle to the Java / OpenGL binding so that
+    GLDrawables and GLContexts may be created for the window.
+*/
+
+public interface NativeWindow {
+  public static final int LOCK_NOT_SUPPORTED = 0;
+  public static final int LOCK_SURFACE_NOT_READY = 1;
+  public static final int LOCK_SURFACE_CHANGED = 2;
+  public static final int LOCK_SUCCESS = 3;
+
+  /**
+   * Lock this surface
+   */
+  public int lockSurface() throws NativeWindowException ;
+
+  /**
+   * Unlock this surface
+   */
+  public void unlockSurface();
+  public boolean isSurfaceLocked();
+
+  /** 
+   * render all native window information invalid,
+   * as if the native window was destroyed
+   */
+  public void invalidate();
+
+  /**
+   * Lifetime: locked state
+   */
+  public long getDisplayHandle();
+  public long getScreenHandle();
+
+  /**
+   * Returns the window handle for this NativeWindow. <P>
+   *
+   * The window handle shall reflect the platform one 
+   * for all window related operations, e.g. open, close, resize. <P>
+   *
+   * On X11 this returns an entity of type Window. <BR>
+   * On Microsoft Windows this returns an entity of type HWND. 
+   */
+  public long getWindowHandle();
+
+  /**
+   * Returns the handle to the surface for this NativeWindow. <P>
+   * 
+   * The surface handle shall reflect the platform one
+   * for all drawable surface operations, e.g. opengl, swap-buffer. <P>
+   *
+   * On X11 this returns an entity of type Window,
+   * since there is no differentiation of surface and window there. <BR>
+   * On Microsoft Windows this returns an entity of type HDC.
+   */
+  public long getSurfaceHandle();
+
+  /**
+   * Lifetime: after 1st lock, until invalidation
+   */
+  public long getVisualID();
+  public int  getScreenIndex();
+
+  /** Returns the current width of this window. */
+  public int getWidth();
+
+  /** Returns the current height of this window. */
+  public int getHeight();
+}