Migrate OSX to GLFW3+

build_tools/waf_dynamo.py

@@ -86,6 +86,11 @@ def platform_setup_vars(ctx, build_util):
 def transform_runnable_path(platform, path):
  return waf_dynamo_vendor.transform_runnable_path(platform, path)
 
+def platform_glfw_version(platform):
+ if platform in ['x86_64-macos', 'arm64-macos']:
+ return 3
+ return 2
+
 # Note that some of these version numbers are also present in build.py (TODO: put in a waf_versions.py or similar)
 # The goal is to put the sdk versions in sdk.py
 SDK_ROOT=sdk.SDK_ROOT
@@ -1838,10 +1843,14 @@ def detect(conf):
  conf.env['STLIB_GRAPHICS_VULKAN'] = ['graphics_vulkan', 'graphics_transcoder_basisu', 'basis_transcoder']
  conf.env['STLIB_GRAPHICS_NULL'] = ['graphics_null', 'graphics_transcoder_null']
 
- conf.env['STLIB_PLATFORM'] = ['platform']
- conf.env['STLIB_PLATFORM_NULL'] = ['platform_null']
+ conf.env['STLIB_PLATFORM'] = ['platform']
+ conf.env['STLIB_PLATFORM_VULKAN'] = ['platform_vulkan']
+ conf.env['STLIB_PLATFORM_NULL'] = ['platform_null']
 
- conf.env['STLIB_DMGLFW'] = 'dmglfw'
+ if platform_glfw_version(platform) == 3:
+ conf.env['STLIB_DMGLFW'] = 'glfw3'
+ else:
+ conf.env['STLIB_DMGLFW'] = 'dmglfw'
 
  if platform in ('x86_64-macos','arm64-macos'):
  conf.env['STLIB_VULKAN'] = Options.options.with_vulkan_validation and 'vulkan' or 'MoltenVK'

editor/src/clj/editor/app_manifest.clj

@@ -345,6 +345,8 @@
 
 (def vulkan-toggles
  (concat
+ (exclude-libs-toggles [:x86_64-osx :arm64-osx] ["platform"])
+ (libs-toggles [:x86_64-osx :arm64-osx] ["platform_vulkan"])
  (libs-toggles [:x86_64-osx :arm64-osx :arm64-ios] ["graphics_vulkan" "MoltenVK"])
  (libs-toggles android ["graphics_vulkan"])
  (libs-toggles windows ["graphics_vulkan" "vulkan"])

editor/test/resources/test_project/app_manifest/vulkan.appmanifest

@@ -3,19 +3,19 @@
 platforms:
  arm64-osx:
  context:
- excludeLibs: ["graphics"]
+ excludeLibs: ["graphics", "platform"]
  excludeSymbols: ["GraphicsAdapterOpenGL"]
  symbols: ["GraphicsAdapterVulkan"]
- libs: ["graphics_vulkan","MoltenVK"]
+ libs: ["graphics_vulkan", "platform_vulkan", "MoltenVK"]
  frameworks: ["Metal","IOSurface","QuartzCore"]
  linkFlags: []
 
  x86_64-osx:
  context:
- excludeLibs: ["graphics"]
+ excludeLibs: ["graphics", "platform"]
  excludeSymbols: ["GraphicsAdapterOpenGL"]
  symbols: ["GraphicsAdapterVulkan"]
- libs: ["graphics_vulkan","MoltenVK"]
+ libs: ["graphics_vulkan", "platform_vulkan", "MoltenVK"]
  frameworks: ["Metal","IOSurface","QuartzCore"]
  linkFlags: []
 

editor/test/resources/test_project/app_manifest/vulkan_and_opengl.appmanifest

@@ -3,19 +3,19 @@
 platforms:
  arm64-osx:
  context:
- excludeLibs: []
+ excludeLibs: ["platform"]
  excludeSymbols: []
  symbols: ["GraphicsAdapterVulkan"]
- libs: ["graphics_vulkan","MoltenVK"]
+ libs: ["graphics_vulkan", "platform_vulkan", "MoltenVK"]
  frameworks: ["Metal","IOSurface","QuartzCore"]
  linkFlags: []
 
  x86_64-osx:
  context:
- excludeLibs: []
+ excludeLibs: ["platform"]
  excludeSymbols: []
  symbols: ["GraphicsAdapterVulkan"]
- libs: ["graphics_vulkan","MoltenVK"]
+ libs: ["graphics_vulkan", "platform_vulkan", "MoltenVK"]
  frameworks: ["Metal","IOSurface","QuartzCore"]
  linkFlags: []
 

engine/engine/wscript

@@ -71,19 +71,28 @@ def configure(conf):
  architecture = build_util.get_target_architecture()
 
  sound_lib = 'sound'
+ glfw_lib = 'dmglfw'
+ platform_lib = 'platform'
 
  if operating_sys == 'macos':
  conf.env.append_value('LINKFLAGS', ['-framework', 'Cocoa', '-framework', 'OpenGL', '-framework', 'OpenAL', '-framework', 'AGL', '-framework', 'IOKit', '-framework', 'Carbon', '-framework', 'CoreVideo', '-framework', 'QuartzCore'])
 
+ glfw_lib = "glfw3"
+
  # For Vulkan/MoltenVK
- if waflib.Options.options.with_vulkan and architecture == 'x86_64':
- conf.env.append_value('LINKFLAGS', ['-framework', 'Metal', '-framework', 'Foundation', '-framework', 'IOSurface'])
+ if waflib.Options.options.with_vulkan:
+
+ platform_lib = "platform_vulkan"
 
- # Link with vulkan.dylib if the flag has been set (see graphics/vulkan/README.md) for more information
- conf.env.append_value('LINKFLAGS', ['-l', waflib.Options.options.with_vulkan_validation and 'vulkan' or 'MoltenVK'])
+ # JG: for now, we only support validation layers on macos for x86_64 archs. I'll fix this later when/if needed.
+ if architecture == 'x86_64':
+ conf.env.append_value('LINKFLAGS', ['-framework', 'Metal', '-framework', 'Foundation', '-framework', 'IOSurface'])
 
- # Metal deps requires libc++ stdlib. Remove once we've updated to use libc++ std
- conf.env.append_value('LINKFLAGS', ['-l', 'c++'])
+ # Link with vulkan.dylib if the flag has been set (see graphics/vulkan/README.md) for more information
+ conf.env.append_value('LINKFLAGS', ['-l', waflib.Options.options.with_vulkan_validation and 'vulkan' or 'MoltenVK'])
+
+ # Metal deps requires libc++ stdlib. Remove once we've updated to use libc++ std
+ conf.env.append_value('LINKFLAGS', ['-l', 'c++'])
 
  elif operating_sys == 'ios':
  conf.env.append_value('LINKFLAGS', ['-framework', 'UIKit', '-framework', 'OpenGLES', '-framework', 'QuartzCore', '-framework', 'CoreGraphics', '-framework', 'OpenAL', '-framework', 'AudioToolbox'])
@@ -113,10 +122,10 @@ def configure(conf):
  conf.env['STLIB_GAMESYS'] = 'gamesys script_box2d'.split()
  conf.env['STLIB_GAMEOBJECT'] = 'gameobject'
  conf.env['STLIB_SCRIPT'] = 'script'
- conf.env['STLIB_DMGLFW'] = 'dmglfw'
+ conf.env['STLIB_DMGLFW'] = glfw_lib
  conf.env['STLIB_GUI'] = 'gui'
  conf.env['STLIB_PARTICLE'] = 'particle'
- conf.env['STLIB_PLATFORM'] = 'platform'
+ conf.env['STLIB_PLATFORM'] = platform_lib
  conf.env['STLIB_PLATFORM_NULL'] = 'platform_null'
  conf.env['STLIB_RIG'] = 'rig'
  conf.env['STLIB_SOUND'] = sound_lib
@@ -127,7 +136,6 @@ def configure(conf):
  conf.env['STLIB_HID_NULL'] = 'hid_null'
  conf.env['STLIB_INPUT'] = 'input'
  conf.env['STLIB_LIVEUPDATE'] = 'liveupdate'
- conf.env['STLIB_PLATFORM_NULL'] = 'platform_null'
 
  if operating_sys != "macos":
  conf.env['STLIB_UNWIND'] = 'unwind'

engine/graphics/src/graphics.cpp

@@ -72,7 +72,8 @@ namespace dmGraphics
 
  while(next)
  {
- if (next->m_Priority < selected->m_Priority && next->m_IsSupportedCb())
+ bool is_supported = next->m_IsSupportedCb();
+ if (next->m_Priority < selected->m_Priority && is_supported)
  {
  selected = next;
  }

engine/graphics/src/opengl/graphics_opengl.cpp

@@ -31,19 +31,45 @@
  #include <emscripten/html5.h>
 #endif
 
+#include <platform/platform_window_opengl.h>
+
 #include "graphics_opengl_defines.h"
 #include "../graphics_private.h"
 #include "../graphics_native.h"
 #include "../graphics_adapter.h"
 #include "graphics_opengl_private.h"
 
 #if defined(DM_PLATFORM_MACOS)
-// Potential name clash with ddf. If included before ddf/ddf.h (TYPE_BOOL)
-#include <Carbon/Carbon.h>
+ // Potential name clash with ddf. If included before ddf/ddf.h (TYPE_BOOL)
+ #include <Carbon/Carbon.h>
 #endif
 
-#include <glfw/glfw.h>
-#include <glfw/glfw_native.h>
+/* Include standard OpenGL headers: GLFW uses GL_FALSE/GL_TRUE, and it is
+ * convenient for the user to only have to include <GL/glfw.h>. This also
+ * solves the problem with Windows <GL/gl.h> and <GL/glu.h> needing some
+ * special defines which normally requires the user to include <windows.h>
+ * (which is not a nice solution for portable programs).
+ */
+#if defined(__APPLE_CC__)
+ #if defined(DM_PLATFORM_IOS)
+ #include <platform/platform_window_ios.h>
+ #include <OpenGLES/ES3/gl.h>
+ #else
+ #include <OpenGL/gl3.h>
+ #ifndef GLFW_NO_GLU
+ #include <OpenGL/glu.h>
+ #endif
+ #endif
+#elif defined(ANDROID)
+ #include <platform/platform_window_android.h>
+ #include <EGL/egl.h>
+ #include <GLES/gl.h>
+#else
+ #include <GL/gl.h>
+ #ifndef GLFW_NO_GLU
+ #include <GL/glu.h>
+ #endif
+#endif
 
 #if defined(__linux__) && !defined(ANDROID)
  #include <GL/glext.h>
@@ -184,28 +210,30 @@ namespace dmGraphics
 {
  using namespace dmVMath;
 
-static void LogGLError(GLint err, const char* fnname, int line)
-{
-#if defined(GL_ES_VERSION_2_0)
- const char* error_str = "<unknown-gl-error>";
- switch(err)
+ #define TO_STR_CASE(x) case x: return #x;
+ static const char* GetGLErrorLiteral(GLint err)
  {
- case GL_INVALID_ENUM:
- error_str = "GL_INVALID_ENUM";
- break;
- case GL_INVALID_VALUE:
- error_str = "GL_INVALID_VALUE";
- break;
- case GL_INVALID_OPERATION:
- error_str = "GL_INVALID_OPERATION";
- break;
- default:break;
+ switch(err)
+ {
+ TO_STR_CASE(GL_NO_ERROR);
+ TO_STR_CASE(GL_INVALID_ENUM);
+ TO_STR_CASE(GL_INVALID_VALUE);
+ TO_STR_CASE(GL_INVALID_OPERATION);
+ TO_STR_CASE(GL_INVALID_FRAMEBUFFER_OPERATION);
+ TO_STR_CASE(GL_OUT_OF_MEMORY);
+ // These are not available by the gl headers we are using currently
+ // but left for posterity
+ // TO_STR_CASE(GL_STACK_UNDERFLOW);
+ // TO_STR_CASE(GL_STACK_OVERFLOW);
+ }
+ return "<unknown-gl-error>";
+ }
+ #undef TO_STR_CASE
+
+ static inline void LogGLError(GLint err, const char* fnname, int line)
+ {
+ dmLogError("%s(%d): gl error %d: %s\n", fnname, line, err, GetGLErrorLiteral(err));
  }
- dmLogError("%s(%d): gl error %d: %s\n", fnname, line, err, error_str);
-#else
- dmLogError("%s(%d): gl error %d: %s\n", fnname, line, err, gluErrorString(err));
-#endif
-}
 
 // We use defines here so that we get a callstack from the correct function
 
@@ -237,7 +265,7 @@ static void LogGLError(GLint err, const char* fnname, int line)
  LogGLError(err, __FUNCTION__, __LINE__); \
  if (err == GL_OUT_OF_MEMORY) { \
  dmLogWarning("Signs of surface being destroyed. skipping assert.");\
- if (glfwAndroidVerifySurface()) { \
+ if (dmPlatform::AndroidVerifySurface(g_Context->m_Window)) { \
  assert(0); \
  } \
  } else { \
@@ -344,7 +372,8 @@ static void LogFrameBufferError(GLenum status)
  {
  ChooseEAGLView() {
  // Let's us choose the CAEAGLLayer
- glfwSetViewType(GLFW_OPENGL_API);
+ // Note: We don't need a valid window here (and we don't have access to one)
+ dmPlatform::iOSSetViewTypeOpenGL((dmPlatform::HWindow) 0);
  }
  } g_ChooseEAGLView;
  #endif
@@ -587,7 +616,7 @@ static void LogFrameBufferError(GLenum status)
 
  static bool OpenGLIsSupported()
  {
- return (glfwInit() == GL_TRUE);
+ return true;
  }
 
  static void OpenGLFinalize()
@@ -653,6 +682,8 @@ static void LogFrameBufferError(GLenum status)
 
  static uintptr_t GetExtProcAddress(const char* name, const char* extension_name, const char* core_name, HContext context)
  {
+ dmPlatform::HWindow window = GetWindow(context);
+
  /*
  Check in order
  1) ARB - Extensions officially approved by the OpenGL Architecture Review Board
@@ -673,7 +704,7 @@ static void LogFrameBufferError(GLenum status)
  continue;
  l = dmStrlCpy(proc_str, name, 255);
  dmStrlCpy(proc_str + l, proc_name_postfix_str[i], 256-l);
- func = (uintptr_t) glfwGetProcAddress(proc_str);
+ func = dmPlatform::GetProcAddress(window, proc_str);
  if(func != 0x0)
  {
  break;
@@ -683,7 +714,7 @@ static void LogFrameBufferError(GLenum status)
  if(func == 0 && core_name)
  {
  // On OpenGL, optionally check for core driver support if extension wasn't found (i.e extension has become part of core OpenGL)
- func = (uintptr_t) glfwGetProcAddress(core_name);
+ func = dmPlatform::GetProcAddress(window, core_name);
  }
  #endif
 
@@ -748,7 +779,7 @@ static void LogFrameBufferError(GLenum status)
 
  glBindTexture(GL_TEXTURE_2D, 0);
  CHECK_GL_ERROR;
- glBindFramebuffer(GL_FRAMEBUFFER, glfwGetDefaultFramebuffer());
+ glBindFramebuffer(GL_FRAMEBUFFER, dmPlatform::OpenGLGetDefaultFramebufferId());
  CHECK_GL_ERROR;
  glDeleteFramebuffers(1, &osfb);
  DeleteTexture(texture_handle);
@@ -956,6 +987,8 @@ static void LogFrameBufferError(GLenum status)
 #if !(defined(__EMSCRIPTEN__) || defined(GL_ES_VERSION_2_0))
  GLint n;
  glGetIntegerv(GL_NUM_EXTENSIONS, &n);
+ CHECK_GL_ERROR;
+
  if (n > 0)
  {
  int max_len = 0;
@@ -1407,15 +1440,15 @@ static void LogFrameBufferError(GLenum status)
  static void OpenGLBeginFrame(HContext context)
  {
 #if defined(ANDROID)
- glfwAndroidBeginFrame();
+ dmPlatform::AndroidBeginFrame(((OpenGLContext*) context)->m_Window);
 #endif
  }
 
  static void OpenGLFlip(HContext context)
  {
  DM_PROFILE(__FUNCTION__);
  PostDeleteTextures((OpenGLContext*) context, false);
- glfwSwapBuffers();
+ dmPlatform::SwapBuffers(((OpenGLContext*) context)->m_Window);
  CHECK_GL_ERROR;
  }
 
@@ -2532,7 +2565,7 @@ static void LogFrameBufferError(GLenum status)
  }
 
  CHECK_GL_FRAMEBUFFER_ERROR;
- glBindFramebuffer(GL_FRAMEBUFFER, glfwGetDefaultFramebuffer());
+ glBindFramebuffer(GL_FRAMEBUFFER, dmPlatform::OpenGLGetDefaultFramebufferId());
  CHECK_GL_ERROR;
 
  return StoreAssetInContainer(context->m_AssetHandleContainer, rt, ASSET_TYPE_RENDER_TARGET);
@@ -2615,7 +2648,7 @@ static void LogFrameBufferError(GLenum status)
  context->m_FrameBufferInvalidateAttachments = rt != NULL;
 #endif
  }
- glBindFramebuffer(GL_FRAMEBUFFER, rt == NULL ? glfwGetDefaultFramebuffer() : rt->m_Id);
+ glBindFramebuffer(GL_FRAMEBUFFER, rt == NULL ? dmPlatform::OpenGLGetDefaultFramebufferId() : rt->m_Id);
  CHECK_GL_ERROR;
 
  #if __EMSCRIPTEN__