1 /* 2 * Copyright (c) 2011, 2019, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package sun.java2d.opengl; 27 28 import java.awt.AWTException; 29 import java.awt.BufferCapabilities; 30 import java.awt.Component; 31 import java.awt.Graphics; 32 import java.awt.Graphics2D; 33 import java.awt.Image; 34 import java.awt.ImageCapabilities; 35 import java.awt.Rectangle; 36 import java.awt.Transparency; 37 import java.awt.color.ColorSpace; 38 import java.awt.image.BufferedImage; 39 import java.awt.image.ColorModel; 40 import java.awt.image.DataBuffer; 41 import java.awt.image.DirectColorModel; 42 import java.awt.image.VolatileImage; 43 import java.awt.image.WritableRaster; 44 45 import sun.awt.CGraphicsConfig; 46 import sun.awt.CGraphicsDevice; 47 import sun.awt.image.OffScreenImage; 48 import sun.awt.image.SunVolatileImage; 49 import sun.java2d.Disposer; 50 import sun.java2d.DisposerRecord; 51 import sun.java2d.Surface; 52 import sun.java2d.SurfaceData; 53 import sun.java2d.opengl.OGLContext.OGLContextCaps; 54 import sun.java2d.pipe.hw.AccelSurface; 55 import sun.java2d.pipe.hw.AccelTypedVolatileImage; 56 import sun.java2d.pipe.hw.ContextCapabilities; 57 import sun.lwawt.LWComponentPeer; 58 import sun.lwawt.macosx.CFRetainedResource; 59 import sun.lwawt.macosx.CPlatformView; 60 61 import static sun.java2d.opengl.OGLContext.OGLContextCaps.CAPS_DOUBLEBUFFERED; 62 import static sun.java2d.opengl.OGLContext.OGLContextCaps.CAPS_EXT_FBOBJECT; 63 import static sun.java2d.opengl.OGLSurfaceData.FBOBJECT; 64 import static sun.java2d.opengl.OGLSurfaceData.TEXTURE; 65 66 public final class CGLGraphicsConfig extends CGraphicsConfig 67 implements OGLGraphicsConfig 68 { 69 //private static final int kOpenGLSwapInterval = 70 // RuntimeOptions.getCurrentOptions().OpenGLSwapInterval; 71 private static final int kOpenGLSwapInterval = 0; // TODO 72 private static boolean cglAvailable; 73 private static ImageCapabilities imageCaps = new CGLImageCaps(); 74 75 private int pixfmt; 76 private BufferCapabilities bufferCaps; 77 private long pConfigInfo; 78 private ContextCapabilities oglCaps; 79 private OGLContext context; 80 private final Object disposerReferent = new Object(); 81 private final int maxTextureSize; 82 83 private static native boolean initCGL(); 84 private static native long getCGLConfigInfo(int displayID, int visualnum, 85 int swapInterval); 86 private static native int getOGLCapabilities(long configInfo); 87 88 /** 89 * Returns GL_MAX_TEXTURE_SIZE from the shared opengl context. Must be 90 * called under OGLRQ lock, because this method change current context. 91 * 92 * @return GL_MAX_TEXTURE_SIZE 93 */ 94 private static native int nativeGetMaxTextureSize(); 95 96 static { 97 cglAvailable = initCGL(); 98 } 99 100 private CGLGraphicsConfig(CGraphicsDevice device, int pixfmt, 101 long configInfo, int maxTextureSize, 102 ContextCapabilities oglCaps) { 103 super(device); 104 105 this.pixfmt = pixfmt; 106 this.pConfigInfo = configInfo; 107 this.oglCaps = oglCaps; 108 this.maxTextureSize = maxTextureSize; 109 context = new OGLContext(OGLRenderQueue.getInstance(), this); 110 111 // add a record to the Disposer so that we destroy the native 112 // CGLGraphicsConfigInfo data when this object goes away 113 Disposer.addRecord(disposerReferent, 114 new CGLGCDisposerRecord(pConfigInfo)); 115 } 116 117 @Override 118 public Object getProxyKey() { 119 return this; 120 } 121 122 @Override 123 public SurfaceData createManagedSurface(int w, int h, int transparency) { 124 return CGLSurfaceData.createData(this, w, h, 125 getColorModel(transparency), 126 null, 127 OGLSurfaceData.TEXTURE); 128 } 129 130 public static CGLGraphicsConfig getConfig(CGraphicsDevice device, 131 int displayID, int pixfmt) 132 { 133 if (!cglAvailable) { 134 return null; 135 } 136 137 long cfginfo = 0; 138 int textureSize = 0; 139 final String[] ids = new String[1]; 140 OGLRenderQueue rq = OGLRenderQueue.getInstance(); 141 rq.lock(); 142 try { 143 // getCGLConfigInfo() creates and destroys temporary 144 // surfaces/contexts, so we should first invalidate the current 145 // Java-level context and flush the queue... 146 OGLContext.invalidateCurrentContext(); 147 cfginfo = getCGLConfigInfo(displayID, pixfmt, kOpenGLSwapInterval); 148 if (cfginfo != 0L) { 149 textureSize = nativeGetMaxTextureSize(); 150 // 7160609: GL still fails to create a square texture of this 151 // size. Half should be safe enough. 152 // Explicitly not support a texture more than 2^14, see 8010999. 153 textureSize = textureSize <= 16384 ? textureSize / 2 : 8192; 154 OGLContext.setScratchSurface(cfginfo); 155 rq.flushAndInvokeNow(() -> { 156 ids[0] = OGLContext.getOGLIdString(); 157 }); 158 } 159 } finally { 160 rq.unlock(); 161 } 162 if (cfginfo == 0) { 163 return null; 164 } 165 166 int oglCaps = getOGLCapabilities(cfginfo); 167 ContextCapabilities caps = new OGLContextCaps(oglCaps, ids[0]); 168 return new CGLGraphicsConfig(device, pixfmt, cfginfo, textureSize, caps); 169 } 170 171 public static boolean isCGLAvailable() { 172 return cglAvailable; 173 } 174 175 /** 176 * Returns true if the provided capability bit is present for this config. 177 * See OGLContext.java for a list of supported capabilities. 178 */ 179 @Override 180 public boolean isCapPresent(int cap) { 181 return ((oglCaps.getCaps() & cap) != 0); 182 } 183 184 @Override 185 public long getNativeConfigInfo() { 186 return pConfigInfo; 187 } 188 189 @Override 190 public OGLContext getContext() { 191 return context; 192 } 193 194 @Override 195 public BufferedImage createCompatibleImage(int width, int height) { 196 ColorModel model = new DirectColorModel(24, 0xff0000, 0xff00, 0xff); 197 WritableRaster 198 raster = model.createCompatibleWritableRaster(width, height); 199 return new BufferedImage(model, raster, model.isAlphaPremultiplied(), 200 null); 201 } 202 203 @Override 204 public ColorModel getColorModel(int transparency) { 205 switch (transparency) { 206 case Transparency.OPAQUE: 207 // REMIND: once the ColorModel spec is changed, this should be 208 // an opaque premultiplied DCM... 209 return new DirectColorModel(24, 0xff0000, 0xff00, 0xff); 210 case Transparency.BITMASK: 211 return new DirectColorModel(25, 0xff0000, 0xff00, 0xff, 0x1000000); 212 case Transparency.TRANSLUCENT: 213 ColorSpace cs = ColorSpace.getInstance(ColorSpace.CS_sRGB); 214 return new DirectColorModel(cs, 32, 215 0xff0000, 0xff00, 0xff, 0xff000000, 216 true, DataBuffer.TYPE_INT); 217 default: 218 return null; 219 } 220 } 221 222 public boolean isDoubleBuffered() { 223 return isCapPresent(CAPS_DOUBLEBUFFERED); 224 } 225 226 private static class CGLGCDisposerRecord implements DisposerRecord { 227 private long pCfgInfo; 228 public CGLGCDisposerRecord(long pCfgInfo) { 229 this.pCfgInfo = pCfgInfo; 230 } 231 public void dispose() { 232 if (pCfgInfo != 0) { 233 OGLRenderQueue.disposeGraphicsConfig(pCfgInfo); 234 pCfgInfo = 0; 235 } 236 } 237 } 238 239 // TODO: CGraphicsConfig doesn't implement displayChanged() yet 240 //@Override 241 public synchronized void displayChanged() { 242 //super.displayChanged(); 243 244 // the context could hold a reference to a CGLSurfaceData, which in 245 // turn has a reference back to this CGLGraphicsConfig, so in order 246 // for this instance to be disposed we need to break the connection 247 OGLRenderQueue rq = OGLRenderQueue.getInstance(); 248 rq.lock(); 249 try { 250 OGLContext.invalidateCurrentContext(); 251 } finally { 252 rq.unlock(); 253 } 254 } 255 256 @Override 257 public String toString() { 258 String display = getDevice().getIDstring(); 259 return ("CGLGraphicsConfig[" + display + ", pixfmt=" + pixfmt + "]"); 260 } 261 262 @Override 263 public SurfaceData createSurfaceData(CPlatformView pView) { 264 return CGLSurfaceData.createData(pView); 265 } 266 267 @Override 268 public SurfaceData createSurfaceData(CFRetainedResource layer) { 269 return CGLSurfaceData.createData((CGLLayer) layer); 270 } 271 272 @Override 273 public Image createAcceleratedImage(Component target, 274 int width, int height) 275 { 276 ColorModel model = getColorModel(Transparency.OPAQUE); 277 WritableRaster wr = model.createCompatibleWritableRaster(width, height); 278 return new OffScreenImage(target, model, wr, 279 model.isAlphaPremultiplied()); 280 } 281 282 @Override 283 public void assertOperationSupported(final int numBuffers, 284 final BufferCapabilities caps) 285 throws AWTException { 286 // Assume this method is never called with numBuffers != 2, as 0 is 287 // unsupported, and 1 corresponds to a SingleBufferStrategy which 288 // doesn't depend on the peer. Screen is considered as a separate 289 // "buffer". 290 if (numBuffers != 2) { 291 throw new AWTException("Only double buffering is supported"); 292 } 293 final BufferCapabilities configCaps = getBufferCapabilities(); 294 if (!configCaps.isPageFlipping()) { 295 throw new AWTException("Page flipping is not supported"); 296 } 297 if (caps.getFlipContents() == BufferCapabilities.FlipContents.PRIOR) { 298 throw new AWTException("FlipContents.PRIOR is not supported"); 299 } 300 } 301 302 @Override 303 public Image createBackBuffer(final LWComponentPeer<?, ?> peer) { 304 final Rectangle r = peer.getBounds(); 305 // It is possible for the component to have size 0x0, adjust it to 306 // be at least 1x1 to avoid IAE 307 final int w = Math.max(1, r.width); 308 final int h = Math.max(1, r.height); 309 final int transparency = peer.isTranslucent() ? Transparency.TRANSLUCENT 310 : Transparency.OPAQUE; 311 return new SunVolatileImage(this, w, h, transparency, null); 312 } 313 314 @Override 315 public void destroyBackBuffer(final Image backBuffer) { 316 if (backBuffer != null) { 317 backBuffer.flush(); 318 } 319 } 320 321 @Override 322 public void flip(final LWComponentPeer<?, ?> peer, final Image backBuffer, 323 final int x1, final int y1, final int x2, final int y2, 324 final BufferCapabilities.FlipContents flipAction) { 325 final Graphics g = peer.getGraphics(); 326 try { 327 g.drawImage(backBuffer, x1, y1, x2, y2, x1, y1, x2, y2, null); 328 } finally { 329 g.dispose(); 330 } 331 if (flipAction == BufferCapabilities.FlipContents.BACKGROUND) { 332 final Graphics2D bg = (Graphics2D) backBuffer.getGraphics(); 333 try { 334 bg.setBackground(peer.getBackground()); 335 bg.clearRect(0, 0, backBuffer.getWidth(null), 336 backBuffer.getHeight(null)); 337 } finally { 338 bg.dispose(); 339 } 340 } 341 } 342 343 private static class CGLBufferCaps extends BufferCapabilities { 344 public CGLBufferCaps(boolean dblBuf) { 345 super(imageCaps, imageCaps, 346 dblBuf ? FlipContents.UNDEFINED : null); 347 } 348 } 349 350 @Override 351 public BufferCapabilities getBufferCapabilities() { 352 if (bufferCaps == null) { 353 bufferCaps = new CGLBufferCaps(isDoubleBuffered()); 354 } 355 return bufferCaps; 356 } 357 358 private static class CGLImageCaps extends ImageCapabilities { 359 private CGLImageCaps() { 360 super(true); 361 } 362 public boolean isTrueVolatile() { 363 return true; 364 } 365 } 366 367 @Override 368 public ImageCapabilities getImageCapabilities() { 369 return imageCaps; 370 } 371 372 @Override 373 public VolatileImage createCompatibleVolatileImage(int width, int height, 374 int transparency, 375 int type) { 376 if ((type != FBOBJECT && type != TEXTURE) 377 || transparency == Transparency.BITMASK 378 || type == FBOBJECT && !isCapPresent(CAPS_EXT_FBOBJECT)) { 379 return null; 380 } 381 SunVolatileImage vi = new AccelTypedVolatileImage(this, width, height, 382 transparency, type); 383 Surface sd = vi.getDestSurface(); 384 if (!(sd instanceof AccelSurface) || 385 ((AccelSurface)sd).getType() != type) 386 { 387 vi.flush(); 388 vi = null; 389 } 390 391 return vi; 392 } 393 394 @Override 395 public ContextCapabilities getContextCapabilities() { 396 return oglCaps; 397 } 398 399 @Override 400 public int getMaxTextureWidth() { 401 return Math.max(maxTextureSize / getDevice().getScaleFactor(), 402 getBounds().width); 403 } 404 405 @Override 406 public int getMaxTextureHeight() { 407 return Math.max(maxTextureSize / getDevice().getScaleFactor(), 408 getBounds().height); 409 } 410 }