GDK-Win32: Add wrapper functions for calling core wgl* functions
authorChun-wei Fan <fanchunwei@src.gnome.org>
Fri, 24 Mar 2023 03:08:26 +0000 (11:08 +0800)
committerChun-wei Fan <fanchunwei@src.gnome.org>
Fri, 24 Mar 2023 10:43:23 +0000 (18:43 +0800)
We might be dealing with GL contexts from different threads, which have more
gotchas when we are using libepoxy, so in case the function pointers for
these are invalidated by wglMakeCurrent() calls outside of GTK/GDK, such as
in GstGL, we want to use these functions that are directly linked to
opengl32.dll provided by the system/ICD, by linking to opengl32.lib.

This will ensure that we will indeed call the "correct" wgl* functions that
we need.

This should help fix issue #5685.

gdk/win32/gdkglcontext-win32-wgl-private.c [new file with mode: 0644]
gdk/win32/gdkglcontext-win32-wgl.c
gdk/win32/gdkglcontext-win32.h
gdk/win32/meson.build

diff --git a/gdk/win32/gdkglcontext-win32-wgl-private.c b/gdk/win32/gdkglcontext-win32-wgl-private.c
new file mode 100644 (file)
index 0000000..7da5016
--- /dev/null
@@ -0,0 +1,56 @@
+/* GDK - The GIMP Drawing Kit
+ *
+ * gdkglcontext-win32-wgl-private.c: Win32 specific OpenGL wrappers
+ *
+ * Copyright © 2023 Chun-wei Fan
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * These wrapper functions are used when we don't want to use the wgl*() core functions
+ * that we acquire via libepoxy (such as when we are disposing the Gdk(W)GLContext from,
+ * different threads, so for these calls, we are actually linking to the system's/ICD
+ * opengl32.dll directly, so that we are guaranteed that the "right" versions of these
+ * WGL calls are carried out.  This must be a separate source file because we can't include
+ * the system's GL/gl.h with epoxy/(w)gl.h together in a single source file.  We should not
+ * need to use these when we are creating/initializing a WGL context in GDK, since we should
+ * be in the same thread at this point.
+ */
+
+#define DONT_INCLUDE_LIBEPOXY
+#define WIN32_LEAN_AND_MEAN
+#include <windows.h>
+#include <GL/gl.h>
+
+#include "gdkglcontext-win32.h"
+
+void
+gdk_win32_private_wglDeleteContext (HGLRC hglrc)
+{
+  wglDeleteContext (hglrc);
+}
+
+HGLRC
+gdk_win32_private_wglGetCurrentContext (void)
+{
+  return wglGetCurrentContext ();
+}
+
+BOOL
+gdk_win32_private_wglMakeCurrent (HDC   hdc,
+                                  HGLRC hglrc)
+{
+  return wglMakeCurrent (hdc, hglrc);
+}
index 4c32a74f887e3d0bcbf56f883450ae3aab57a738..572c2f37b7fbf6b165977cc853fb9e830d2408c4 100644 (file)
@@ -60,12 +60,12 @@ gdk_win32_gl_context_wgl_dispose (GObject *gobject)
 
   if (context_wgl->wgl_context != NULL)
     {
-      if (wglGetCurrentContext () == context_wgl->wgl_context)
-        wglMakeCurrent (NULL, NULL);
+      if (gdk_win32_private_wglGetCurrentContext () == context_wgl->wgl_context)
+        gdk_win32_private_wglMakeCurrent (NULL, NULL);
 
       GDK_NOTE (OPENGL, g_print ("Destroying WGL context\n"));
 
-      wglDeleteContext (context_wgl->wgl_context);
+      gdk_win32_private_wglDeleteContext (context_wgl->wgl_context);
       context_wgl->wgl_context = NULL;
     }
 
@@ -628,7 +628,7 @@ gdk_win32_gl_context_wgl_realize (GdkGLContext *context,
 static gboolean
 gdk_win32_gl_context_wgl_clear_current (GdkGLContext *context)
 {
-  return wglMakeCurrent (NULL, NULL);
+  return gdk_win32_private_wglMakeCurrent (NULL, NULL);
 }
 
 static gboolean
@@ -636,7 +636,7 @@ gdk_win32_gl_context_wgl_is_current (GdkGLContext *context)
 {
   GdkWin32GLContextWGL *self = GDK_WIN32_GL_CONTEXT_WGL (context);
 
-  return self->wgl_context == wglGetCurrentContext ();
+  return self->wgl_context == gdk_win32_private_wglGetCurrentContext ();
 }
 
 static gboolean
@@ -654,7 +654,7 @@ gdk_win32_gl_context_wgl_make_current (GdkGLContext *context,
   else
     hdc = GDK_WIN32_SURFACE (surface)->hdc;
 
-  if (!wglMakeCurrent (hdc, context_wgl->wgl_context))
+  if (!gdk_win32_private_wglMakeCurrent (hdc, context_wgl->wgl_context))
     return FALSE;
 
   if (!surfaceless && display_win32->hasWglEXTSwapControl)
index 77995671cec8e3573452b79cc9aeae1399e4840b..787c8b1a0962be8927ad206e290896919a78b0fe 100644 (file)
@@ -21,6 +21,7 @@
 #ifndef __GDK_WIN32_GL_CONTEXT__
 #define __GDK_WIN32_GL_CONTEXT__
 
+#ifndef DONT_INCLUDE_LIBEPOXY
 #include <epoxy/gl.h>
 #include <epoxy/wgl.h>
 
 #include "gdkglcontextprivate.h"
 #include "gdkdisplayprivate.h"
 #include "gdksurface.h"
+#else
+# define WIN32_LEAN_AND_MEAN
+# include <windows.h>
+# include <GL/gl.h>
+
+# include <glib.h>
+#endif
 
 G_BEGIN_DECLS
 
+#ifndef DONT_INCLUDE_LIBEPOXY
+
 #define GDK_WIN32_GL_CONTEXT_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_WIN32_GL_CONTEXT, GdkWin32GLContextClass))
 #define GDK_WIN32_GL_CONTEXT_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_WIN32_GL_CONTEXT, GdkWin32GLContextClass))
 #define GDK_WIN32_IS_GL_CONTEXT_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_WIN32_GL_CONTEXT))
@@ -78,6 +88,13 @@ GType     gdk_win32_gl_context_egl_get_type         (void) G_GNUC_CONST;
 void
 _gdk_win32_surface_invalidate_egl_framebuffer (GdkSurface *surface);
 
+#endif /* !DONT_INCLUDE_LIBEPOXY */
+
+HGLRC     gdk_win32_private_wglGetCurrentContext (void);
+BOOL      gdk_win32_private_wglMakeCurrent       (HDC hdc,
+                                                  HGLRC hglrc);
+void      gdk_win32_private_wglDeleteContext     (HGLRC hglrc);
+
 G_END_DECLS
 
 #endif /* __GDK_WIN32_GL_CONTEXT__ */
index bcf7d7c78ff80db51b4ad7a3fae3cbac8875d899..3dc16aabb6c6e38fbd4d491ea5967696f4fc2d51 100644 (file)
@@ -23,6 +23,7 @@ gdk_win32_sources = gdk_win32_public_sources + files([
   'gdkdevice-wintab.c',
   'gdkdrop-win32.c',
   'gdkglobals-win32.c',
+  'gdkglcontext-win32-wgl-private.c',
   'gdkhdataoutputstream-win32.c',
   'gdkinput-dmanipulation.c',
   'gdkinput-winpointer.c',
@@ -59,6 +60,7 @@ endif
 gdk_win32_deps = [
   pangowin32_dep, # FIXME
   cc.find_library('hid'),
+  cc.find_library('opengl32'),
 ]
 
 libgdk_win32 = static_library('gdk-win32',