SDL_uikitvulkan.m
1
2
/*
Simple DirectMedia Layer
3
Copyright (C) 1997-2020 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_UIKIT
30
31
32
33
34
35
36
37
38
39
40
41
#include "SDL_uikitvideo.h"
#include "SDL_uikitwindow.h"
#include "SDL_assert.h"
#include "SDL_loadso.h"
#include "SDL_uikitvulkan.h"
#include "SDL_uikitmetalview.h"
#include "SDL_syswm.h"
#include <dlfcn.h>
42
43
44
45
const char* defaultPaths[] = {
"libvulkan.dylib",
};
46
47
48
49
50
51
52
53
54
55
56
57
/* Since libSDL is static, could use RTLD_SELF. Using RTLD_DEFAULT is future
* proofing. */
#define DEFAULT_HANDLE RTLD_DEFAULT
int UIKit_Vulkan_LoadLibrary(_THIS, const char *path)
{
VkExtensionProperties *extensions = NULL;
Uint32 extensionCount = 0;
SDL_bool hasSurfaceExtension = SDL_FALSE;
SDL_bool hasIOSSurfaceExtension = SDL_FALSE;
PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr = NULL;
58
if (_this->vulkan_config.loader_handle) {
59
return SDL_SetError("Vulkan Portability library is already loaded.");
61
62
/* Load the Vulkan loader library */
63
if (!path) {
64
path = SDL_getenv("SDL_VULKAN_LIBRARY");
65
66
67
}
if (!path) {
68
/* Handle the case where Vulkan Portability is linked statically. */
69
70
71
72
vkGetInstanceProcAddr =
(PFN_vkGetInstanceProcAddr)dlsym(DEFAULT_HANDLE,
"vkGetInstanceProcAddr");
}
73
74
if (vkGetInstanceProcAddr) {
75
_this->vulkan_config.loader_handle = DEFAULT_HANDLE;
76
} else {
77
78
79
80
81
82
83
84
85
const char** paths;
const char *foundPath = NULL;
int numPaths;
int i;
if (path) {
paths = &path;
numPaths = 1;
} else {
86
/* Look for the .dylib packaged with the application instead. */
87
88
89
90
91
92
93
paths = defaultPaths;
numPaths = SDL_arraysize(defaultPaths);
}
for (i = 0; i < numPaths && _this->vulkan_config.loader_handle == NULL; i++) {
foundPath = paths[i];
_this->vulkan_config.loader_handle = SDL_LoadObject(foundPath);
96
97
if (_this->vulkan_config.loader_handle == NULL) {
return SDL_SetError("Failed to load Vulkan Portability library");
100
101
SDL_strlcpy(_this->vulkan_config.loader_path, path,
SDL_arraysize(_this->vulkan_config.loader_path));
102
103
vkGetInstanceProcAddr =
(PFN_vkGetInstanceProcAddr)SDL_LoadFunction(
104
105
106
_this->vulkan_config.loader_handle,
"vkGetInstanceProcAddr");
}
107
108
if (!vkGetInstanceProcAddr) {
109
110
SDL_SetError("Failed to find %s in either executable or %s: %s",
"vkGetInstanceProcAddr",
111
"linked Vulkan Portability library",
112
113
114
115
116
117
118
119
(const char *) dlerror());
goto fail;
}
_this->vulkan_config.vkGetInstanceProcAddr = (void *)vkGetInstanceProcAddr;
_this->vulkan_config.vkEnumerateInstanceExtensionProperties =
(void *)((PFN_vkGetInstanceProcAddr)_this->vulkan_config.vkGetInstanceProcAddr)(
VK_NULL_HANDLE, "vkEnumerateInstanceExtensionProperties");
120
121
if (!_this->vulkan_config.vkEnumerateInstanceExtensionProperties) {
122
123
124
SDL_SetError("No vkEnumerateInstanceExtensionProperties found.");
goto fail;
}
126
127
128
129
extensions = SDL_Vulkan_CreateInstanceExtensionsList(
(PFN_vkEnumerateInstanceExtensionProperties)
_this->vulkan_config.vkEnumerateInstanceExtensionProperties,
&extensionCount);
130
131
if (!extensions) {
132
goto fail;
133
134
135
136
}
for (Uint32 i = 0; i < extensionCount; i++) {
if (SDL_strcmp(VK_KHR_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
137
hasSurfaceExtension = SDL_TRUE;
138
} else if (SDL_strcmp(VK_MVK_IOS_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
139
hasIOSSurfaceExtension = SDL_TRUE;
143
SDL_free(extensions);
144
145
if (!hasSurfaceExtension) {
146
SDL_SetError("Installed Vulkan Portability doesn't implement the "
147
148
VK_KHR_SURFACE_EXTENSION_NAME " extension");
goto fail;
149
} else if (!hasIOSSurfaceExtension) {
150
SDL_SetError("Installed Vulkan Portability doesn't implement the "
151
152
153
154
155
156
157
158
159
160
161
162
163
VK_MVK_IOS_SURFACE_EXTENSION_NAME "extension");
goto fail;
}
return 0;
fail:
_this->vulkan_config.loader_handle = NULL;
return -1;
}
void UIKit_Vulkan_UnloadLibrary(_THIS)
{
164
165
if (_this->vulkan_config.loader_handle) {
if (_this->vulkan_config.loader_handle != DEFAULT_HANDLE) {
166
SDL_UnloadObject(_this->vulkan_config.loader_handle);
168
169
170
171
172
173
174
175
176
177
178
179
_this->vulkan_config.loader_handle = NULL;
}
}
SDL_bool UIKit_Vulkan_GetInstanceExtensions(_THIS,
SDL_Window *window,
unsigned *count,
const char **names)
{
static const char *const extensionsForUIKit[] = {
VK_KHR_SURFACE_EXTENSION_NAME, VK_MVK_IOS_SURFACE_EXTENSION_NAME
};
180
if (!_this->vulkan_config.loader_handle) {
181
182
183
SDL_SetError("Vulkan is not loaded");
return SDL_FALSE;
}
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
return SDL_Vulkan_GetInstanceExtensions_Helper(
count, names, SDL_arraysize(extensionsForUIKit),
extensionsForUIKit);
}
SDL_bool UIKit_Vulkan_CreateSurface(_THIS,
SDL_Window *window,
VkInstance instance,
VkSurfaceKHR *surface)
{
PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr =
(PFN_vkGetInstanceProcAddr)_this->vulkan_config.vkGetInstanceProcAddr;
PFN_vkCreateIOSSurfaceMVK vkCreateIOSSurfaceMVK =
(PFN_vkCreateIOSSurfaceMVK)vkGetInstanceProcAddr(
(VkInstance)instance,
"vkCreateIOSSurfaceMVK");
VkIOSSurfaceCreateInfoMVK createInfo = {};
VkResult result;
203
SDL_MetalView metalview;
205
if (!_this->vulkan_config.loader_handle) {
206
207
208
209
SDL_SetError("Vulkan is not loaded");
return SDL_FALSE;
}
210
if (!vkCreateIOSSurfaceMVK) {
211
212
213
214
SDL_SetError(VK_MVK_IOS_SURFACE_EXTENSION_NAME
" extension is not enabled in the Vulkan instance.");
return SDL_FALSE;
}
216
217
218
219
220
metalview = UIKit_Metal_CreateView(_this, window);
if (metalview == NULL) {
return SDL_FALSE;
}
221
222
223
createInfo.sType = VK_STRUCTURE_TYPE_IOS_SURFACE_CREATE_INFO_MVK;
createInfo.pNext = NULL;
createInfo.flags = 0;
224
createInfo.pView = (const void *)metalview;
225
226
result = vkCreateIOSSurfaceMVK(instance, &createInfo,
NULL, surface);
227
if (result != VK_SUCCESS) {
228
UIKit_Metal_DestroyView(_this, metalview);
229
230
231
232
SDL_SetError("vkCreateIOSSurfaceMVK failed: %s",
SDL_Vulkan_GetResultString(result));
return SDL_FALSE;
}
234
235
236
237
238
239
240
/* 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);
241
242
243
244
245
return SDL_TRUE;
}
void UIKit_Vulkan_GetDrawableSize(_THIS, SDL_Window *window, int *w, int *h)
{
246
UIKit_Metal_GetDrawableSize(window, w, h);
247
248
249
250
251
}
#endif
/* vi: set ts=4 sw=4 expandtab: */