SDL  2.0
SDL_cocoavulkan.m
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2020 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 #include "../../SDL_internal.h"
27 
28 #if SDL_VIDEO_VULKAN && SDL_VIDEO_DRIVER_COCOA
29 
30 #include "SDL_cocoavideo.h"
31 #include "SDL_cocoawindow.h"
32 #include "SDL_assert.h"
33 
34 #include "SDL_loadso.h"
35 #include "SDL_cocoametalview.h"
36 #include "SDL_cocoavulkan.h"
37 #include "SDL_syswm.h"
38 
39 #include <dlfcn.h>
40 
41 const char* defaultPaths[] = {
42  "vulkan.framework/vulkan",
43  "libvulkan.1.dylib",
44  "libvulkan.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  return SDL_SetError("Vulkan Portability library is already loaded.");
62  }
63 
64  /* Load the Vulkan loader library */
65  if (!path) {
66  path = SDL_getenv("SDL_VULKAN_LIBRARY");
67  }
68 
69  if (!path) {
70  /* Handle the case where Vulkan Portability is linked statically. */
72  (PFN_vkGetInstanceProcAddr)dlsym(DEFAULT_HANDLE,
73  "vkGetInstanceProcAddr");
74  }
75 
77  _this->vulkan_config.loader_handle = DEFAULT_HANDLE;
78  } else {
79  const char** paths;
80  const char *foundPath = NULL;
81  int numPaths;
82  int i;
83 
84  if (path) {
85  paths = &path;
86  numPaths = 1;
87  } else {
88  /* Look for framework or .dylib packaged with the application
89  * instead. */
90  paths = defaultPaths;
91  numPaths = SDL_arraysize(defaultPaths);
92  }
93 
94  for (i = 0; i < numPaths && _this->vulkan_config.loader_handle == NULL; i++) {
95  foundPath = paths[i];
97  }
98 
100  return SDL_SetError("Failed to load Vulkan Portability library");
101  }
102 
106  _this->vulkan_config.loader_handle, "vkGetInstanceProcAddr");
107  }
108 
109  if (!vkGetInstanceProcAddr) {
110  SDL_SetError("Failed to find %s in either executable or %s: %s",
111  "vkGetInstanceProcAddr",
113  (const char *) dlerror());
114  goto fail;
115  }
116 
120  VK_NULL_HANDLE, "vkEnumerateInstanceExtensionProperties");
122  goto fail;
123  }
124  extensions = SDL_Vulkan_CreateInstanceExtensionsList(
127  &extensionCount);
128  if (!extensions) {
129  goto fail;
130  }
131  for (Uint32 i = 0; i < extensionCount; i++) {
132  if (SDL_strcmp(VK_KHR_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
133  hasSurfaceExtension = SDL_TRUE;
134  } else if (SDL_strcmp(VK_MVK_MACOS_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
135  hasMacOSSurfaceExtension = SDL_TRUE;
136  }
137  }
138  SDL_free(extensions);
139  if (!hasSurfaceExtension) {
140  SDL_SetError("Installed Vulkan Portability library doesn't implement the "
141  VK_KHR_SURFACE_EXTENSION_NAME " extension");
142  goto fail;
143  } else if (!hasMacOSSurfaceExtension) {
144  SDL_SetError("Installed Vulkan Portability library doesn't implement the "
146  goto fail;
147  }
148  return 0;
149 
150 fail:
153  return -1;
154 }
155 
156 void Cocoa_Vulkan_UnloadLibrary(_THIS)
157 {
159  if (_this->vulkan_config.loader_handle != DEFAULT_HANDLE) {
161  }
163  }
164 }
165 
166 SDL_bool Cocoa_Vulkan_GetInstanceExtensions(_THIS,
168  unsigned *count,
169  const char **names)
170 {
171  static const char *const extensionsForCocoa[] = {
173  };
175  SDL_SetError("Vulkan is not loaded");
176  return SDL_FALSE;
177  }
178  return SDL_Vulkan_GetInstanceExtensions_Helper(
179  count, names, SDL_arraysize(extensionsForCocoa),
180  extensionsForCocoa);
181 }
182 
183 SDL_bool Cocoa_Vulkan_CreateSurface(_THIS,
185  VkInstance instance,
186  VkSurfaceKHR *surface)
187 {
192  (VkInstance)instance,
193  "vkCreateMacOSSurfaceMVK");
194  VkMacOSSurfaceCreateInfoMVK createInfo = {};
196  SDL_MetalView metalview;
197 
199  SDL_SetError("Vulkan is not loaded");
200  return SDL_FALSE;
201  }
202 
205  " extension is not enabled in the Vulkan instance.");
206  return SDL_FALSE;
207  }
208 
209  metalview = Cocoa_Metal_CreateView(_this, window);
210  if (metalview == NULL) {
211  return SDL_FALSE;
212  }
213 
215  createInfo.pNext = NULL;
216  createInfo.flags = 0;
217  createInfo.pView = (const void *)metalview;
218  result = vkCreateMacOSSurfaceMVK(instance, &createInfo,
219  NULL, surface);
220  if (result != VK_SUCCESS) {
221  Cocoa_Metal_DestroyView(_this, metalview);
222  SDL_SetError("vkCreateMacOSSurfaceMVK failed: %s",
223  SDL_Vulkan_GetResultString(result));
224  return SDL_FALSE;
225  }
226 
227  /* Unfortunately there's no SDL_Vulkan_DestroySurface function we can call
228  * Metal_DestroyView from. Right now the metal view's ref count is +2 (one
229  * from returning a new view object in CreateView, and one because it's
230  * a subview of the window.) If we release the view here to make it +1, it
231  * will be destroyed when the window is destroyed. */
232  CFBridgingRelease(metalview);
233 
234  return SDL_TRUE;
235 }
236 
237 void Cocoa_Vulkan_GetDrawableSize(_THIS, SDL_Window *window, int *w, int *h)
238 {
239  Cocoa_Metal_GetDrawableSize(window, w, h);
240 }
241 
242 #endif
243 
244 /* vim: set ts=4 sw=4 expandtab: */
VK_MVK_MACOS_SURFACE_EXTENSION_NAME
#define VK_MVK_MACOS_SURFACE_EXTENSION_NAME
Definition: vulkan_macos.h:32
VkMacOSSurfaceCreateInfoMVK::pView
const void * pView
Definition: vulkan_macos.h:40
SDL_strlcpy
#define SDL_strlcpy
Definition: SDL_dynapi_overrides.h:394
SDL_VideoDevice::vkGetInstanceProcAddr
PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr
Definition: SDL_sysvideo.h:380
PFN_vkGetInstanceProcAddr
PFN_vkVoidFunction(VKAPI_PTR * PFN_vkGetInstanceProcAddr)(VkInstance instance, const char *pName)
Definition: vulkan_core.h:2859
NULL
#define NULL
Definition: begin_code.h:167
surface
EGLSurface surface
Definition: eglext.h:248
VkMacOSSurfaceCreateInfoMVK::flags
VkMacOSSurfaceCreateFlagsMVK flags
Definition: vulkan_macos.h:39
vkCreateMacOSSurfaceMVK
VKAPI_ATTR VkResult VKAPI_CALL vkCreateMacOSSurfaceMVK(VkInstance instance, const VkMacOSSurfaceCreateInfoMVK *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface)
count
GLuint GLuint GLsizei count
Definition: SDL_opengl.h:1571
SDL_VideoDevice::vulkan_config
struct SDL_VideoDevice::@256 vulkan_config
SDL_cocoawindow.h
vkGetInstanceProcAddr
VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *pName)
VkMacOSSurfaceCreateInfoMVK::pNext
const void * pNext
Definition: vulkan_macos.h:38
SDL_UnloadObject
#define SDL_UnloadObject
Definition: SDL_dynapi_overrides.h:234
Uint32
uint32_t Uint32
Definition: SDL_stdinc.h:203
path
GLsizei const GLchar *const * path
Definition: SDL_opengl_glext.h:3733
numPaths
GLsizei numPaths
Definition: SDL_opengl_glext.h:9165
SDL_cocoavideo.h
h
GLfloat GLfloat GLfloat GLfloat h
Definition: SDL_opengl_glext.h:1949
result
GLuint64EXT * result
Definition: SDL_opengl_glext.h:9435
SDL_LoadObject
#define SDL_LoadObject
Definition: SDL_dynapi_overrides.h:232
SDL_MetalView
void * SDL_MetalView
A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
Definition: SDL_metal.h:44
SDL_Window
The type used to identify a window.
Definition: SDL_sysvideo.h:75
SDL_cocoavulkan.h
VK_KHR_SURFACE_EXTENSION_NAME
#define VK_KHR_SURFACE_EXTENSION_NAME
Definition: vulkan_core.h:4669
VK_SUCCESS
@ VK_SUCCESS
Definition: vulkan_core.h:121
VK_NULL_HANDLE
#define VK_NULL_HANDLE
Definition: vulkan_core.h:49
_this
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_VideoData::instance
PP_Instance instance
Definition: SDL_naclvideo.h:57
paths
GLsizei const GLuint * paths
Definition: SDL_opengl_glext.h:9165
window
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
VkResult
VkResult
Definition: vulkan_core.h:120
PFN_vkEnumerateInstanceExtensionProperties
VkResult(VKAPI_PTR * PFN_vkEnumerateInstanceExtensionProperties)(const char *pLayerName, uint32_t *pPropertyCount, VkExtensionProperties *pProperties)
Definition: vulkan_core.h:2863
SDL_free
#define SDL_free
Definition: SDL_dynapi_overrides.h:377
SDL_VideoDevice::loader_handle
void * loader_handle
Definition: SDL_sysvideo.h:384
SDL_VideoDevice::loader_path
char loader_path[256]
Definition: SDL_sysvideo.h:383
SDL_assert.h
VkMacOSSurfaceCreateInfoMVK::sType
VkStructureType sType
Definition: vulkan_macos.h:37
_THIS
#define _THIS
Definition: SDL_alsa_audio.h:31
names
GLuint GLuint * names
Definition: SDL_opengl_glext.h:4959
SDL_TRUE
@ SDL_TRUE
Definition: SDL_stdinc.h:164
SDL_VideoDevice::vkEnumerateInstanceExtensionProperties
PFN_vkEnumerateInstanceExtensionProperties vkEnumerateInstanceExtensionProperties
Definition: SDL_sysvideo.h:381
SDL_arraysize
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:115
SDL_getenv
#define SDL_getenv
Definition: SDL_dynapi_overrides.h:378
SDL_SetError
#define SDL_SetError
Definition: SDL_dynapi_overrides.h:30
SDL_cocoametalview.h
SDL_LoadFunction
void * SDL_LoadFunction(void *handle, const char *name)
PFN_vkCreateMacOSSurfaceMVK
VkResult(VKAPI_PTR * PFN_vkCreateMacOSSurfaceMVK)(VkInstance instance, const VkMacOSSurfaceCreateInfoMVK *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface)
Definition: vulkan_macos.h:44
SDL_bool
SDL_bool
Definition: SDL_stdinc.h:162
SDL_FALSE
@ SDL_FALSE
Definition: SDL_stdinc.h:163
VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK
@ VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK
Definition: vulkan_core.h:373
VkExtensionProperties
Definition: vulkan_core.h:2047
VkMacOSSurfaceCreateInfoMVK
Definition: vulkan_macos.h:36
SDL_strcmp
#define SDL_strcmp
Definition: SDL_dynapi_overrides.h:417
SDL_loadso.h
i
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
SDL_syswm.h
w
GLubyte GLubyte GLubyte GLubyte w
Definition: SDL_opengl_glext.h:734