1 /*
   2  * Copyright (c) 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 #ifndef MTLGraphicsConfig_h_Included
  27 #define MTLGraphicsConfig_h_Included
  28 
  29 #import "jni.h"
  30 #import "MTLSurfaceDataBase.h"
  31 #import "MTLContext.h"
  32 #import <Cocoa/Cocoa.h>
  33 #import <Metal/Metal.h>
  34 #import <MetalKit/MetalKit.h>
  35 
  36 
  37 @interface MTLGraphicsConfigUtil : NSObject {}
  38 + (void) _getMTLConfigInfo: (NSMutableArray *)argValue;
  39 @end
  40 
  41 // REMIND: Using an NSOpenGLPixelBuffer as the scratch surface has been
  42 // problematic thus far (seeing garbage and flickering when switching
  43 // between an NSView and the scratch surface), so the following enables
  44 // an alternate codepath that uses a hidden NSWindow/NSView as the scratch
  45 // surface, for the purposes of making a context current in certain
  46 // situations.  It appears that calling [NSOpenGLContext setView] too
  47 // frequently contributes to the bad behavior, so we should try to avoid
  48 // switching to the scratch surface whenever possible.
  49 
  50 /* Do we need this if we are using all off-screen drawing ? */
  51 #define USE_NSVIEW_FOR_SCRATCH 1
  52 
  53 /* Uncomment to have an additional CAOGLLayer instance tied to
  54  * each instance, which can be used to test remoting the layer
  55  * to an out of process window. The additional layer is needed
  56  * because a layer can only be attached to one context (view/window).
  57  * This is only for testing purposes and can be removed if/when no
  58  * longer needed.
  59  */
  60 
  61 
  62 /**
  63  * The MTLGraphicsConfigInfo structure contains information specific to a
  64  * given CGLGraphicsConfig (pixel format).
  65  *
  66  *     jint screen;
  67  * The screen and PixelFormat for the associated CGLGraphicsConfig.
  68  *
  69  *     NSOpenGLPixelFormat *pixfmt;
  70  * The pixel format of the native NSOpenGL context.
  71  *
  72  *     MTLContext *context;
  73  * The context associated with this CGLGraphicsConfig.
  74  */
  75 typedef struct _MTLGraphicsConfigInfo {
  76     jint                screen;
  77     NSOpenGLPixelFormat *pixfmt;
  78     MTLContext          *context;
  79 } MTLGraphicsConfigInfo;
  80 
  81 #endif /* MTLGraphicsConfig_h_Included */