Jogamp
Bug 741 HiDPI: Simplify ScalableSurface (2): Add request pixelScale API entry, fixed...
[jogl.git] / src / newt / classes / jogamp / newt / driver / awt / AWTCanvas.java
1 /*
2  * Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved.
3  * Copyright (c) 2010 JogAmp Community. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  * - Redistribution of source code must retain the above copyright
10  *   notice, this list of conditions and the following disclaimer.
11  *
12  * - Redistribution in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in the
14  *   documentation and/or other materials provided with the distribution.
15  *
16  * Neither the name of Sun Microsystems, Inc. or the names of
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * This software is provided "AS IS," without a warranty of any kind. ALL
21  * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
22  * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
23  * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
24  * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
25  * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
26  * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
27  * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
28  * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
29  * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
30  * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
31  * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
32  *
33  */
34
35 package jogamp.newt.driver.awt;
36
37 import java.awt.Canvas;
38 import java.awt.Graphics;
39 import java.awt.GraphicsDevice;
40 import java.awt.GraphicsConfiguration;
41 import java.lang.reflect.Method;
42 import java.security.AccessController;
43 import java.security.PrivilegedAction;
44
45 import javax.media.nativewindow.AbstractGraphicsDevice;
46 import javax.media.nativewindow.AbstractGraphicsScreen;
47 import javax.media.nativewindow.CapabilitiesChooser;
48 import javax.media.nativewindow.CapabilitiesImmutable;
49 import javax.media.nativewindow.GraphicsConfigurationFactory;
50 import javax.media.nativewindow.NativeWindow;
51 import javax.media.nativewindow.NativeWindowException;
52 import javax.media.nativewindow.NativeWindowFactory;
53 import javax.media.nativewindow.VisualIDHolder;
54
55 import com.jogamp.nativewindow.awt.AWTGraphicsConfiguration;
56 import com.jogamp.nativewindow.awt.AWTGraphicsDevice;
57 import com.jogamp.nativewindow.awt.AWTGraphicsScreen;
58 import com.jogamp.nativewindow.awt.JAWTWindow;
59 import com.jogamp.newt.Window;
60
61 @SuppressWarnings("serial")
62 public class AWTCanvas extends Canvas {
63   private GraphicsDevice device;
64   private GraphicsConfiguration chosen;
65   private AWTGraphicsConfiguration awtConfig;
66   private volatile JAWTWindow jawtWindow=null; // the JAWTWindow presentation of this AWT Canvas, bound to the 'drawable' lifecycle
67   private CapabilitiesChooser chooser=null;
68   private final CapabilitiesImmutable capabilities;
69   private final UpstreamScalable upstreamScale;
70
71   public static interface UpstreamScalable {
72       int[] getReqPixelScale();
73       void setHasPixelScale(final int[] pixelScale);
74   }
75
76   private boolean displayConfigChanged=false;
77
78   public AWTCanvas(CapabilitiesImmutable capabilities, CapabilitiesChooser chooser, UpstreamScalable upstreamScale) {
79     super();
80
81     if(null==capabilities) {
82         throw new NativeWindowException("Capabilities null");
83     }
84     this.capabilities=capabilities;
85     this.chooser=chooser;
86     this.upstreamScale = upstreamScale;
87   }
88
89   public AWTGraphicsConfiguration getAWTGraphicsConfiguration() {
90     return awtConfig;
91   }
92
93   /**
94    * Overridden from Canvas to prevent the AWT's clearing of the
95    * canvas from interfering with the OpenGL rendering.
96    */
97   @Override
98   public void update(Graphics g) {
99     // paint(g);
100   }
101
102   /** Overridden to cause OpenGL rendering to be performed during
103       repaint cycles. Subclasses which override this method must call
104       super.paint() in their paint() method in order to function
105       properly.
106    */
107   @Override
108   public void paint(Graphics g) {
109   }
110
111   public boolean hasDeviceChanged() {
112     boolean res = displayConfigChanged;
113     displayConfigChanged=false;
114     return res;
115   }
116
117   @Override
118   public void addNotify() {
119
120     /**
121      * 'super.addNotify()' determines the GraphicsConfiguration,
122      * while calling this class's overriden 'getGraphicsConfiguration()' method
123      * after which it creates the native peer.
124      * Hence we have to set the 'awtConfig' before since it's GraphicsConfiguration
125      * is being used in getGraphicsConfiguration().
126      * This code order also allows recreation, ie re-adding the GLCanvas.
127      */
128     awtConfig = chooseGraphicsConfiguration(capabilities, capabilities, chooser, device);
129     if(Window.DEBUG_IMPLEMENTATION) {
130         System.err.println(getThreadName()+": AWTCanvas.addNotify.0: Created Config: "+awtConfig);
131     }
132     if(null==awtConfig) {
133         throw new NativeWindowException("Error: NULL AWTGraphicsConfiguration");
134     }
135     chosen = awtConfig.getAWTGraphicsConfiguration();
136
137     // before native peer is valid: X11
138     disableBackgroundErase();
139
140     // issues getGraphicsConfiguration() and creates the native peer
141     super.addNotify();
142
143     // after native peer is valid: Windows
144     disableBackgroundErase();
145
146     {
147         jawtWindow = (JAWTWindow) NativeWindowFactory.getNativeWindow(this, awtConfig);
148         // trigger initialization cycle
149         jawtWindow.setSurfaceScale(upstreamScale.getReqPixelScale() );
150         jawtWindow.lockSurface();
151         upstreamScale.setHasPixelScale(jawtWindow.getCurrentSurfaceScale(new int[2]));
152         jawtWindow.unlockSurface();
153     }
154
155     GraphicsConfiguration gc = super.getGraphicsConfiguration();
156     if(null!=gc) {
157         device = gc.getDevice();
158     }
159     if(Window.DEBUG_IMPLEMENTATION) {
160         System.err.println(getThreadName()+": AWTCanvas.addNotify.X");
161     }
162   }
163
164   public NativeWindow getNativeWindow() {
165     final JAWTWindow _jawtWindow = jawtWindow;
166     return (null != _jawtWindow) ? _jawtWindow : null;
167   }
168
169   public boolean isOffscreenLayerSurfaceEnabled() {
170       return null != jawtWindow ? jawtWindow.isOffscreenLayerSurfaceEnabled() : false;
171   }
172
173   @Override
174   public void removeNotify() {
175       try {
176         dispose();
177       } finally {
178         super.removeNotify();
179       }
180   }
181
182   private void dispose() {
183     if( null != jawtWindow ) {
184         jawtWindow.destroy();
185         if(Window.DEBUG_IMPLEMENTATION) {
186             System.err.println(getThreadName()+": AWTCanvas.disposeJAWTWindowAndAWTDeviceOnEDT(): post JAWTWindow: "+jawtWindow);
187         }
188         jawtWindow=null;
189     }
190     if(null != awtConfig) {
191         AbstractGraphicsDevice adevice = awtConfig.getNativeGraphicsConfiguration().getScreen().getDevice();
192         String adeviceMsg=null;
193         if(Window.DEBUG_IMPLEMENTATION) {
194             adeviceMsg = adevice.toString();
195         }
196         boolean closed = adevice.close();
197         if(Window.DEBUG_IMPLEMENTATION) {
198             System.err.println(getThreadName()+": AWTCanvas.dispose(): closed GraphicsDevice: "+adeviceMsg+", result: "+closed);
199         }
200     }
201   }
202
203   private String getThreadName() { return Thread.currentThread().getName(); }
204
205   /**
206    * Overridden to choose a GraphicsConfiguration on a parent container's
207    * GraphicsDevice because both devices
208    */
209   @Override
210   public GraphicsConfiguration getGraphicsConfiguration() {
211     /*
212      * Workaround for problems with Xinerama and java.awt.Component.checkGD
213      * when adding to a container on a different graphics device than the
214      * one that this Canvas is associated with.
215      *
216      * GC will be null unless:
217      *   - A native peer has assigned it. This means we have a native
218      *     peer, and are already comitted to a graphics configuration.
219      *   - This canvas has been added to a component hierarchy and has
220      *     an ancestor with a non-null GC, but the native peer has not
221      *     yet been created. This means we can still choose the GC on
222      *     all platforms since the peer hasn't been created.
223      */
224     final GraphicsConfiguration gc = super.getGraphicsConfiguration();
225     /*
226      * chosen is only non-null on platforms where the GLDrawableFactory
227      * returns a non-null GraphicsConfiguration (in the GLCanvas
228      * constructor).
229      *
230      * if gc is from this Canvas' native peer then it should equal chosen,
231      * otherwise it is from an ancestor component that this Canvas is being
232      * added to, and we go into this block.
233      */
234     if (gc != null && chosen != null && !chosen.equals(gc)) {
235       /*
236        * Check for compatibility with gc. If they differ by only the
237        * device then return a new GCconfig with the super-class' GDevice
238        * (and presumably the same visual ID in Xinerama).
239        *
240        */
241       if (!chosen.getDevice().getIDstring().equals(gc.getDevice().getIDstring())) {
242         /*
243          * Here we select a GraphicsConfiguration on the alternate
244          * device that is presumably identical to the chosen
245          * configuration, but on the other device.
246          *
247          * Should really check to ensure that we select a configuration
248          * with the same X visual ID for Xinerama screens, otherwise the
249          * GLDrawable may have the wrong visual ID (I don't think this
250          * ever gets updated). May need to add a method to
251          * X11GLDrawableFactory to do this in a platform specific
252          * manner.
253          *
254          * However, on platforms where we can actually get into this
255          * block, both devices should have the same visual list, and the
256          * same configuration should be selected here.
257          */
258         AWTGraphicsConfiguration config = chooseGraphicsConfiguration(
259                 awtConfig.getChosenCapabilities(), awtConfig.getRequestedCapabilities(), chooser, gc.getDevice());
260         final GraphicsConfiguration compatible = (null!=config)?config.getAWTGraphicsConfiguration():null;
261         if(Window.DEBUG_IMPLEMENTATION) {
262             Exception e = new Exception("Info: Call Stack: "+Thread.currentThread().getName());
263             e.printStackTrace();
264             System.err.println("Created Config (n): HAVE    GC "+chosen);
265             System.err.println("Created Config (n): THIS    GC "+gc);
266             System.err.println("Created Config (n): Choosen GC "+compatible);
267             System.err.println("Created Config (n): HAVE    CF "+awtConfig);
268             System.err.println("Created Config (n): Choosen CF "+config);
269             System.err.println("Created Config (n): EQUALS CAPS "+config.getChosenCapabilities().equals(awtConfig.getChosenCapabilities()));
270         }
271
272         if (compatible != null) {
273           /*
274            * Save the new GC for equals test above, and to return to
275            * any outside callers of this method.
276            */
277           chosen = compatible;
278           if( !config.getChosenCapabilities().equals(awtConfig.getChosenCapabilities())) {
279               displayConfigChanged=true;
280           }
281           awtConfig = config;
282         }
283       }
284
285       /*
286        * If a compatible GC was not found in the block above, this will
287        * return the GC that was selected in the constructor (and might
288        * cause an exception in Component.checkGD when adding to a
289        * container, but in this case that would be the desired behavior).
290        *
291        */
292       return chosen;
293     } else if (gc == null) {
294       /*
295        * The GC is null, which means we have no native peer, and are not
296        * part of a (realized) component hierarchy. So we return the
297        * desired visual that was selected in the constructor (possibly
298        * null).
299        */
300       return chosen;
301     }
302
303     /*
304      * Otherwise we have not explicitly selected a GC in the constructor, so
305      * just return what Canvas would have.
306      */
307     return gc;
308   }
309
310   private static AWTGraphicsConfiguration chooseGraphicsConfiguration(CapabilitiesImmutable capsChosen,
311                                                                       CapabilitiesImmutable capsRequested,
312                                                                       CapabilitiesChooser chooser,
313                                                                       GraphicsDevice device) {
314     final AbstractGraphicsScreen aScreen = null != device ?
315             AWTGraphicsScreen.createScreenDevice(device, AbstractGraphicsDevice.DEFAULT_UNIT):
316             AWTGraphicsScreen.createDefault();
317     AWTGraphicsConfiguration config = (AWTGraphicsConfiguration)
318       GraphicsConfigurationFactory.getFactory(AWTGraphicsDevice.class, capsChosen.getClass()).chooseGraphicsConfiguration(capsChosen,
319                                                                                                    capsRequested,
320                                                                                                    chooser, aScreen, VisualIDHolder.VID_UNDEFINED);
321     if (config == null) {
322       throw new NativeWindowException("Error: Couldn't fetch AWTGraphicsConfiguration");
323     }
324
325     return config;
326   }
327
328   // Disables the AWT's erasing of this Canvas's background on Windows
329   // in Java SE 6. This internal API is not available in previous
330   // releases, but the system property
331   // -Dsun.awt.noerasebackground=true can be specified to get similar
332   // results globally in previous releases.
333   private static boolean disableBackgroundEraseInitialized;
334   private static Method  disableBackgroundEraseMethod;
335   private void disableBackgroundErase() {
336     if (!disableBackgroundEraseInitialized) {
337       try {
338         AccessController.doPrivileged(new PrivilegedAction<Object>() {
339             @Override
340             public Object run() {
341               try {
342                 Class<?> clazz = getToolkit().getClass();
343                 while (clazz != null && disableBackgroundEraseMethod == null) {
344                   try {
345                     disableBackgroundEraseMethod =
346                       clazz.getDeclaredMethod("disableBackgroundErase",
347                                               new Class[] { Canvas.class });
348                     disableBackgroundEraseMethod.setAccessible(true);
349                   } catch (Exception e) {
350                     clazz = clazz.getSuperclass();
351                   }
352                 }
353               } catch (Exception e) {
354               }
355               return null;
356             }
357           });
358       } catch (Exception e) {
359       }
360       disableBackgroundEraseInitialized = true;
361       if(Window.DEBUG_IMPLEMENTATION) {
362         System.err.println("AWTCanvas: TK disableBackgroundErase method found: "+
363                 (null!=disableBackgroundEraseMethod));
364       }
365     }
366     if (disableBackgroundEraseMethod != null) {
367       Throwable t=null;
368       try {
369         disableBackgroundEraseMethod.invoke(getToolkit(), new Object[] { this });
370       } catch (Exception e) {
371         // FIXME: workaround for 6504460 (incorrect backport of 6333613 in 5.0u10)
372         // throw new GLException(e);
373         t = e;
374       }
375       if(Window.DEBUG_IMPLEMENTATION) {
376         System.err.println("AWTCanvas: TK disableBackgroundErase error: "+t);
377       }
378     }
379   }
380 }
http://JogAmp.org git info: FAQ, tutorial and man pages.