/
SDL_cocoavulkan.m
245 lines (210 loc) · 8.46 KB
1
2
/*
Simple DirectMedia Layer
3
Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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.
*/
22
/*
23
24
25
26
27
28
* @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
#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>
42
43
44
const char* defaultPaths[] = {
"vulkan.framework/vulkan",
"libvulkan.1.dylib",
45
"libvulkan.dylib",
46
47
48
49
"MoltenVK.framework/MoltenVK",
"libMoltenVK.dylib"
};
50
51
52
53
54
55
56
57
58
59
/* 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;
60
61
if (_this->vulkan_config.loader_handle) {
62
return SDL_SetError("Vulkan Portability library is already loaded.");
63
64
65
}
/* Load the Vulkan loader library */
66
if (!path) {
67
path = SDL_getenv("SDL_VULKAN_LIBRARY");
68
}
69
70
if (!path) {
71
/* Handle the case where Vulkan Portability is linked statically. */
72
73
74
75
vkGetInstanceProcAddr =
(PFN_vkGetInstanceProcAddr)dlsym(DEFAULT_HANDLE,
"vkGetInstanceProcAddr");
}
76
77
if (vkGetInstanceProcAddr) {
78
_this->vulkan_config.loader_handle = DEFAULT_HANDLE;
79
} else {
80
const char** paths;
81
const char *foundPath = NULL;
82
83
84
85
86
87
88
89
90
91
92
int numPaths;
int i;
if (path) {
paths = &path;
numPaths = 1;
} else {
/* Look for framework or .dylib packaged with the application
* instead. */
paths = defaultPaths;
numPaths = SDL_arraysize(defaultPaths);
93
}
94
95
96
97
98
99
100
for (i = 0; i < numPaths && _this->vulkan_config.loader_handle == NULL; i++) {
foundPath = paths[i];
_this->vulkan_config.loader_handle = SDL_LoadObject(foundPath);
}
if (_this->vulkan_config.loader_handle == NULL) {
101
return SDL_SetError("Failed to load Vulkan Portability library");
102
}
103
104
SDL_strlcpy(_this->vulkan_config.loader_path, foundPath,
105
SDL_arraysize(_this->vulkan_config.loader_path));
106
vkGetInstanceProcAddr = (PFN_vkGetInstanceProcAddr)SDL_LoadFunction(
107
108
_this->vulkan_config.loader_handle, "vkGetInstanceProcAddr");
}
109
110
if (!vkGetInstanceProcAddr) {
111
112
SDL_SetError("Failed to find %s in either executable or %s: %s",
"vkGetInstanceProcAddr",
113
_this->vulkan_config.loader_path,
114
115
116
117
(const char *) dlerror());
goto fail;
}
118
_this->vulkan_config.vkGetInstanceProcAddr = (void *)vkGetInstanceProcAddr;
119
_this->vulkan_config.vkEnumerateInstanceExtensionProperties =
120
(void *)((PFN_vkGetInstanceProcAddr)_this->vulkan_config.vkGetInstanceProcAddr)(
121
VK_NULL_HANDLE, "vkEnumerateInstanceExtensionProperties");
122
if (!_this->vulkan_config.vkEnumerateInstanceExtensionProperties) {
123
goto fail;
124
}
125
126
127
128
extensions = SDL_Vulkan_CreateInstanceExtensionsList(
(PFN_vkEnumerateInstanceExtensionProperties)
_this->vulkan_config.vkEnumerateInstanceExtensionProperties,
&extensionCount);
129
if (!extensions) {
130
goto fail;
131
132
133
}
for (Uint32 i = 0; i < extensionCount; i++) {
if (SDL_strcmp(VK_KHR_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
134
hasSurfaceExtension = SDL_TRUE;
135
} else if (SDL_strcmp(VK_MVK_MACOS_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
136
hasMacOSSurfaceExtension = SDL_TRUE;
137
}
138
139
}
SDL_free(extensions);
140
if (!hasSurfaceExtension) {
141
SDL_SetError("Installed Vulkan Portability library doesn't implement the "
142
143
VK_KHR_SURFACE_EXTENSION_NAME " extension");
goto fail;
144
} else if (!hasMacOSSurfaceExtension) {
145
SDL_SetError("Installed Vulkan Portability library doesn't implement the "
146
147
148
149
150
151
152
153
154
155
156
157
158
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)
{
159
160
if (_this->vulkan_config.loader_handle) {
if (_this->vulkan_config.loader_handle != DEFAULT_HANDLE) {
161
SDL_UnloadObject(_this->vulkan_config.loader_handle);
162
}
163
164
165
166
167
168
169
170
171
172
173
174
_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
};
175
if (!_this->vulkan_config.loader_handle) {
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
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;
197
SDL_MetalView metalview;
198
199
if (!_this->vulkan_config.loader_handle) {
200
201
202
203
SDL_SetError("Vulkan is not loaded");
return SDL_FALSE;
}
204
if (!vkCreateMacOSSurfaceMVK) {
205
206
207
208
SDL_SetError(VK_MVK_MACOS_SURFACE_EXTENSION_NAME
" extension is not enabled in the Vulkan instance.");
return SDL_FALSE;
}
209
210
211
212
213
214
metalview = Cocoa_Metal_CreateView(_this, window);
if (metalview == NULL) {
return SDL_FALSE;
}
215
216
217
createInfo.sType = VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK;
createInfo.pNext = NULL;
createInfo.flags = 0;
218
createInfo.pView = (const void *)metalview;
219
220
result = vkCreateMacOSSurfaceMVK(instance, &createInfo,
NULL, surface);
221
if (result != VK_SUCCESS) {
222
Cocoa_Metal_DestroyView(_this, metalview);
223
224
225
226
SDL_SetError("vkCreateMacOSSurfaceMVK failed: %s",
SDL_Vulkan_GetResultString(result));
return SDL_FALSE;
}
227
228
229
230
231
232
233
234
/* Unfortunately there's no SDL_Vulkan_DestroySurface function we can call
* Metal_DestroyView from. Right now the metal view's ref count is +2 (one
* from returning a new view object in CreateView, and one because it's
* a subview of the window.) If we release the view here to make it +1, it
* will be destroyed when the window is destroyed. */
CFBridgingRelease(metalview);
235
236
237
238
239
return SDL_TRUE;
}
void Cocoa_Vulkan_GetDrawableSize(_THIS, SDL_Window *window, int *w, int *h)
{
240
Cocoa_Metal_GetDrawableSize(window, w, h);
241
242
243
244
245
}
#endif
/* vim: set ts=4 sw=4 expandtab: */