SDL_cocoavulkan.m
1
2
/*
Simple DirectMedia Layer
3
Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/*
* @author Mark Callow, www.edgewise-consulting.com. Based on Jacob Lifshay's
* SDL_x11vulkan.c.
*/
#include "../../SDL_internal.h"
29
#if SDL_VIDEO_VULKAN && SDL_VIDEO_DRIVER_COCOA
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
#include "SDL_cocoavideo.h"
#include "SDL_cocoawindow.h"
#include "SDL_assert.h"
#include "SDL_loadso.h"
#include "SDL_cocoametalview.h"
#include "SDL_cocoavulkan.h"
#include "SDL_syswm.h"
#include <dlfcn.h>
#define DEFAULT_MOLTENVK "libMoltenVK.dylib"
/* Since libSDL is most likely a .dylib, need RTLD_DEFAULT not RTLD_SELF. */
#define DEFAULT_HANDLE RTLD_DEFAULT
int Cocoa_Vulkan_LoadLibrary(_THIS, const char *path)
{
VkExtensionProperties *extensions = NULL;
Uint32 extensionCount = 0;
SDL_bool hasSurfaceExtension = SDL_FALSE;
SDL_bool hasMacOSSurfaceExtension = SDL_FALSE;
PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr = NULL;
53
54
if (_this->vulkan_config.loader_handle) {
55
56
57
58
59
SDL_SetError("MoltenVK/Vulkan already loaded");
return -1;
}
/* Load the Vulkan loader library */
60
if (!path) {
61
path = SDL_getenv("SDL_VULKAN_LIBRARY");
62
63
}
if (!path) {
64
65
66
67
68
69
70
71
/* MoltenVK framework, currently, v0.17.0, has a static library and is
* the recommended way to use the package. There is likely no object to
* load. */
vkGetInstanceProcAddr =
(PFN_vkGetInstanceProcAddr)dlsym(DEFAULT_HANDLE,
"vkGetInstanceProcAddr");
}
72
if (vkGetInstanceProcAddr) {
73
_this->vulkan_config.loader_handle = DEFAULT_HANDLE;
74
75
} else {
if (!path) {
76
77
78
79
80
/* Look for the .dylib packaged with the application instead. */
path = DEFAULT_MOLTENVK;
}
_this->vulkan_config.loader_handle = SDL_LoadObject(path);
81
if (!_this->vulkan_config.loader_handle) {
82
return -1;
84
85
SDL_strlcpy(_this->vulkan_config.loader_path, path,
SDL_arraysize(_this->vulkan_config.loader_path));
86
*(void**)&vkGetInstanceProcAddr = SDL_LoadFunction(
87
88
_this->vulkan_config.loader_handle, "vkGetInstanceProcAddr");
}
89
90
if (!vkGetInstanceProcAddr) {
91
92
93
94
95
96
97
SDL_SetError("Failed to find %s in either executable or %s: %s",
"vkGetInstanceProcAddr",
DEFAULT_MOLTENVK,
(const char *) dlerror());
goto fail;
}
98
_this->vulkan_config.vkGetInstanceProcAddr = vkGetInstanceProcAddr;
99
_this->vulkan_config.vkEnumerateInstanceExtensionProperties =
100
(PFN_vkEnumerateInstanceExtensionProperties)_this->vulkan_config.vkGetInstanceProcAddr(
101
VK_NULL_HANDLE, "vkEnumerateInstanceExtensionProperties");
102
if (!_this->vulkan_config.vkEnumerateInstanceExtensionProperties) {
103
goto fail;
105
106
107
108
extensions = SDL_Vulkan_CreateInstanceExtensionsList(
(PFN_vkEnumerateInstanceExtensionProperties)
_this->vulkan_config.vkEnumerateInstanceExtensionProperties,
&extensionCount);
109
if (!extensions) {
110
goto fail;
111
112
113
}
for (Uint32 i = 0; i < extensionCount; i++) {
if (SDL_strcmp(VK_KHR_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
114
hasSurfaceExtension = SDL_TRUE;
115
} else if (SDL_strcmp(VK_MVK_MACOS_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
116
hasMacOSSurfaceExtension = SDL_TRUE;
118
119
}
SDL_free(extensions);
120
if (!hasSurfaceExtension) {
121
122
123
SDL_SetError("Installed MoltenVK/Vulkan doesn't implement the "
VK_KHR_SURFACE_EXTENSION_NAME " extension");
goto fail;
124
} else if (!hasMacOSSurfaceExtension) {
125
126
127
128
129
130
131
132
133
134
135
136
137
138
SDL_SetError("Installed MoltenVK/Vulkan doesn't implement the "
VK_MVK_MACOS_SURFACE_EXTENSION_NAME "extension");
goto fail;
}
return 0;
fail:
SDL_UnloadObject(_this->vulkan_config.loader_handle);
_this->vulkan_config.loader_handle = NULL;
return -1;
}
void Cocoa_Vulkan_UnloadLibrary(_THIS)
{
139
140
if (_this->vulkan_config.loader_handle) {
if (_this->vulkan_config.loader_handle != DEFAULT_HANDLE) {
141
SDL_UnloadObject(_this->vulkan_config.loader_handle);
143
144
145
146
147
148
149
150
151
152
153
154
_this->vulkan_config.loader_handle = NULL;
}
}
SDL_bool Cocoa_Vulkan_GetInstanceExtensions(_THIS,
SDL_Window *window,
unsigned *count,
const char **names)
{
static const char *const extensionsForCocoa[] = {
VK_KHR_SURFACE_EXTENSION_NAME, VK_MVK_MACOS_SURFACE_EXTENSION_NAME
};
155
if (!_this->vulkan_config.loader_handle) {
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
SDL_SetError("Vulkan is not loaded");
return SDL_FALSE;
}
return SDL_Vulkan_GetInstanceExtensions_Helper(
count, names, SDL_arraysize(extensionsForCocoa),
extensionsForCocoa);
}
SDL_bool Cocoa_Vulkan_CreateSurface(_THIS,
SDL_Window *window,
VkInstance instance,
VkSurfaceKHR *surface)
{
PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr =
(PFN_vkGetInstanceProcAddr)_this->vulkan_config.vkGetInstanceProcAddr;
PFN_vkCreateMacOSSurfaceMVK vkCreateMacOSSurfaceMVK =
(PFN_vkCreateMacOSSurfaceMVK)vkGetInstanceProcAddr(
(VkInstance)instance,
"vkCreateMacOSSurfaceMVK");
VkMacOSSurfaceCreateInfoMVK createInfo = {};
VkResult result;
178
if (!_this->vulkan_config.loader_handle) {
179
180
181
182
SDL_SetError("Vulkan is not loaded");
return SDL_FALSE;
}
183
if (!vkCreateMacOSSurfaceMVK) {
184
185
186
187
188
189
190
191
192
193
SDL_SetError(VK_MVK_MACOS_SURFACE_EXTENSION_NAME
" extension is not enabled in the Vulkan instance.");
return SDL_FALSE;
}
createInfo.sType = VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK;
createInfo.pNext = NULL;
createInfo.flags = 0;
createInfo.pView = Cocoa_Mtl_AddMetalView(window);
result = vkCreateMacOSSurfaceMVK(instance, &createInfo,
NULL, surface);
194
if (result != VK_SUCCESS) {
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
SDL_SetError("vkCreateMacOSSurfaceMVK failed: %s",
SDL_Vulkan_GetResultString(result));
return SDL_FALSE;
}
return SDL_TRUE;
}
void Cocoa_Vulkan_GetDrawableSize(_THIS, SDL_Window *window, int *w, int *h)
{
Cocoa_Mtl_GetDrawableSize(window, w, h);
}
#endif
/* vim: set ts=4 sw=4 expandtab: */