SDL  2.0
SDL_cocoavulkan.m
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 
22 /*
23  * @author Mark Callow, www.edgewise-consulting.com. Based on Jacob Lifshay's
24  * SDL_x11vulkan.c.
25  */
26 
27 #include "../../SDL_internal.h"
28 
29 #if SDL_VIDEO_VULKAN && SDL_VIDEO_DRIVER_COCOA
30 
31 #include "SDL_cocoavideo.h"
32 #include "SDL_cocoawindow.h"
33 #include "SDL_assert.h"
34 
35 #include "SDL_loadso.h"
36 #include "SDL_cocoametalview.h"
37 #include "SDL_cocoavulkan.h"
38 #include "SDL_syswm.h"
39 
40 #include <dlfcn.h>
41 
42 const char* defaultPaths[] = {
43  "vulkan.framework/vulkan",
44  "libvulkan.1.dylib",
45  "MoltenVK.framework/MoltenVK",
46  "libMoltenVK.dylib"
47 };
48 
49 /* Since libSDL is most likely a .dylib, need RTLD_DEFAULT not RTLD_SELF. */
50 #define DEFAULT_HANDLE RTLD_DEFAULT
51 
52 int Cocoa_Vulkan_LoadLibrary(_THIS, const char *path)
53 {
54  VkExtensionProperties *extensions = NULL;
55  Uint32 extensionCount = 0;
56  SDL_bool hasSurfaceExtension = SDL_FALSE;
57  SDL_bool hasMacOSSurfaceExtension = SDL_FALSE;
59 
61  SDL_SetError("Vulkan/MoltenVK already loaded");
62  return -1;
63  }
64 
65  /* Load the Vulkan loader library */
66  if (!path) {
67  path = SDL_getenv("SDL_VULKAN_LIBRARY");
68  }
69 
70  if (!path) {
71  /* MoltenVK framework, currently, v0.17.0, has a static library and is
72  * the recommended way to use the package. There is likely no object to
73  * load. */
74  vkGetInstanceProcAddr =
75  (PFN_vkGetInstanceProcAddr)dlsym(DEFAULT_HANDLE,
76  "vkGetInstanceProcAddr");
77  }
78 
79  if (vkGetInstanceProcAddr) {
80  _this->vulkan_config.loader_handle = DEFAULT_HANDLE;
81  } else {
82  const char** paths;
83  int numPaths;
84  int i;
85 
86  if (path) {
87  paths = &path;
88  numPaths = 1;
89  } else {
90  /* Look for framework or .dylib packaged with the application
91  * instead. */
92  paths = defaultPaths;
93  numPaths = SDL_arraysize(defaultPaths);
94  }
95 
96  for (i=0; i < numPaths; i++) {
99  break;
100  else
101  continue;
102  }
103  if (i == numPaths)
104  return -1;
105 
108  vkGetInstanceProcAddr = (PFN_vkGetInstanceProcAddr)SDL_LoadFunction(
109  _this->vulkan_config.loader_handle, "vkGetInstanceProcAddr");
110  }
111 
112  if (!vkGetInstanceProcAddr) {
113  SDL_SetError("Failed to find %s in either executable or %s: %s",
114  "vkGetInstanceProcAddr",
116  (const char *) dlerror());
117  goto fail;
118  }
119 
120  _this->vulkan_config.vkGetInstanceProcAddr = (void *)vkGetInstanceProcAddr;
123  VK_NULL_HANDLE, "vkEnumerateInstanceExtensionProperties");
125  goto fail;
126  }
127  extensions = SDL_Vulkan_CreateInstanceExtensionsList(
130  &extensionCount);
131  if (!extensions) {
132  goto fail;
133  }
134  for (Uint32 i = 0; i < extensionCount; i++) {
135  if (SDL_strcmp(VK_KHR_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
136  hasSurfaceExtension = SDL_TRUE;
137  } else if (SDL_strcmp(VK_MVK_MACOS_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
138  hasMacOSSurfaceExtension = SDL_TRUE;
139  }
140  }
141  SDL_free(extensions);
142  if (!hasSurfaceExtension) {
143  SDL_SetError("Installed MoltenVK/Vulkan doesn't implement the "
144  VK_KHR_SURFACE_EXTENSION_NAME " extension");
145  goto fail;
146  } else if (!hasMacOSSurfaceExtension) {
147  SDL_SetError("Installed MoltenVK/Vulkan doesn't implement the "
148  VK_MVK_MACOS_SURFACE_EXTENSION_NAME "extension");
149  goto fail;
150  }
151  return 0;
152 
153 fail:
156  return -1;
157 }
158 
159 void Cocoa_Vulkan_UnloadLibrary(_THIS)
160 {
162  if (_this->vulkan_config.loader_handle != DEFAULT_HANDLE) {
164  }
166  }
167 }
168 
169 SDL_bool Cocoa_Vulkan_GetInstanceExtensions(_THIS,
171  unsigned *count,
172  const char **names)
173 {
174  static const char *const extensionsForCocoa[] = {
175  VK_KHR_SURFACE_EXTENSION_NAME, VK_MVK_MACOS_SURFACE_EXTENSION_NAME
176  };
178  SDL_SetError("Vulkan is not loaded");
179  return SDL_FALSE;
180  }
181  return SDL_Vulkan_GetInstanceExtensions_Helper(
182  count, names, SDL_arraysize(extensionsForCocoa),
183  extensionsForCocoa);
184 }
185 
186 SDL_bool Cocoa_Vulkan_CreateSurface(_THIS,
187  SDL_Window *window,
188  VkInstance instance,
189  VkSurfaceKHR *surface)
190 {
191  PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr =
193  PFN_vkCreateMacOSSurfaceMVK vkCreateMacOSSurfaceMVK =
194  (PFN_vkCreateMacOSSurfaceMVK)vkGetInstanceProcAddr(
195  (VkInstance)instance,
196  "vkCreateMacOSSurfaceMVK");
197  VkMacOSSurfaceCreateInfoMVK createInfo = {};
199 
201  SDL_SetError("Vulkan is not loaded");
202  return SDL_FALSE;
203  }
204 
205  if (!vkCreateMacOSSurfaceMVK) {
206  SDL_SetError(VK_MVK_MACOS_SURFACE_EXTENSION_NAME
207  " extension is not enabled in the Vulkan instance.");
208  return SDL_FALSE;
209  }
211  createInfo.pNext = NULL;
212  createInfo.flags = 0;
213  createInfo.pView = Cocoa_Mtl_AddMetalView(window);
214  result = vkCreateMacOSSurfaceMVK(instance, &createInfo,
215  NULL, surface);
216  if (result != VK_SUCCESS) {
217  SDL_SetError("vkCreateMacOSSurfaceMVK failed: %s",
218  SDL_Vulkan_GetResultString(result));
219  return SDL_FALSE;
220  }
221  return SDL_TRUE;
222 }
223 
224 void Cocoa_Vulkan_GetDrawableSize(_THIS, SDL_Window *window, int *w, int *h)
225 {
226  Cocoa_Mtl_GetDrawableSize(window, w, h);
227 }
228 
229 #endif
230 
231 /* vim: set ts=4 sw=4 expandtab: */
#define SDL_strlcpy
#define VK_KHR_SURFACE_EXTENSION_NAME
Definition: vulkan.h:3416
struct SDL_VideoDevice::@35 vulkan_config
GLuint64EXT * result
GLuint GLuint * names
GLuint GLuint GLsizei count
Definition: SDL_opengl.h:1571
GLfloat GLfloat GLfloat GLfloat h
EGLSurface surface
Definition: eglext.h:248
VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *pName)
uint32_t Uint32
Definition: SDL_stdinc.h:181
#define SDL_LoadObject
#define SDL_UnloadObject
PFN_vkVoidFunction(VKAPI_PTR * PFN_vkGetInstanceProcAddr)(VkInstance instance, const char *pName)
Definition: vulkan.h:2484
#define VK_NULL_HANDLE
Definition: vulkan.h:49
VkResult
Definition: vulkan.h:122
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
char loader_path[256]
Definition: SDL_sysvideo.h:371
#define _THIS
#define SDL_free
GLubyte GLubyte GLubyte GLubyte w
PP_Instance instance
Definition: SDL_naclvideo.h:57
#define SDL_getenv
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
#define NULL
Definition: begin_code.h:164
SDL_bool
Definition: SDL_stdinc.h:139
#define SDL_SetError
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
PFN_vkEnumerateInstanceExtensionProperties vkEnumerateInstanceExtensionProperties
Definition: SDL_sysvideo.h:369
The type used to identify a window.
Definition: SDL_sysvideo.h:73
PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr
Definition: SDL_sysvideo.h:368
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:93
GLsizei const GLchar *const * path
#define SDL_strcmp
void * SDL_LoadFunction(void *handle, const char *name)
GLsizei const GLuint * paths
GLsizei numPaths
VkResult(VKAPI_PTR * PFN_vkEnumerateInstanceExtensionProperties)(const char *pLayerName, uint32_t *pPropertyCount, VkExtensionProperties *pProperties)
Definition: vulkan.h:2488
void * loader_handle
Definition: SDL_sysvideo.h:372