SDL 2.0
SDL_uikitvulkan.m
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2019 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_UIKIT
30
31#include "SDL_uikitvideo.h"
32#include "SDL_uikitwindow.h"
33#include "SDL_assert.h"
34
35#include "SDL_loadso.h"
36#include "SDL_uikitvulkan.h"
37#include "SDL_uikitmetalview.h"
38#include "SDL_syswm.h"
39
40#include <dlfcn.h>
41
42const char* defaultPaths[] = {
43 "libvulkan.dylib",
44};
45
46/* Since libSDL is static, could use RTLD_SELF. Using RTLD_DEFAULT is future
47 * proofing. */
48#define DEFAULT_HANDLE RTLD_DEFAULT
49
50int UIKit_Vulkan_LoadLibrary(_THIS, const char *path)
51{
52 VkExtensionProperties *extensions = NULL;
53 Uint32 extensionCount = 0;
54 SDL_bool hasSurfaceExtension = SDL_FALSE;
55 SDL_bool hasIOSSurfaceExtension = SDL_FALSE;
57
59 return SDL_SetError("Vulkan Portability library is already loaded.");
60 }
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. */
70 (PFN_vkGetInstanceProcAddr)dlsym(DEFAULT_HANDLE,
71 "vkGetInstanceProcAddr");
72 }
73
75 _this->vulkan_config.loader_handle = DEFAULT_HANDLE;
76 } else {
77 const char** paths;
78 const char *foundPath = NULL;
79 int numPaths;
80 int i;
81
82 if (path) {
83 paths = &path;
84 numPaths = 1;
85 } else {
86 /* Look for the .dylib packaged with the application instead. */
87 paths = defaultPaths;
88 numPaths = SDL_arraysize(defaultPaths);
89 }
90
91 for (i = 0; i < numPaths && _this->vulkan_config.loader_handle == NULL; i++) {
92 foundPath = paths[i];
94 }
95
97 return SDL_SetError("Failed to load Vulkan Portability library");
98 }
99
105 "vkGetInstanceProcAddr");
106 }
107
109 SDL_SetError("Failed to find %s in either executable or %s: %s",
110 "vkGetInstanceProcAddr",
111 "linked Vulkan Portability library",
112 (const char *) dlerror());
113 goto fail;
114 }
115
119 VK_NULL_HANDLE, "vkEnumerateInstanceExtensionProperties");
120
122 SDL_SetError("No vkEnumerateInstanceExtensionProperties found.");
123 goto fail;
124 }
125
126 extensions = SDL_Vulkan_CreateInstanceExtensionsList(
129 &extensionCount);
130
131 if (!extensions) {
132 goto fail;
133 }
134
135 for (Uint32 i = 0; i < extensionCount; i++) {
136 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;
140 }
141 }
142
143 SDL_free(extensions);
144
145 if (!hasSurfaceExtension) {
146 SDL_SetError("Installed Vulkan Portability doesn't implement the "
147 VK_KHR_SURFACE_EXTENSION_NAME " extension");
148 goto fail;
149 } else if (!hasIOSSurfaceExtension) {
150 SDL_SetError("Installed Vulkan Portability doesn't implement the "
152 goto fail;
153 }
154
155 return 0;
156
157fail:
159 return -1;
160}
161
162void UIKit_Vulkan_UnloadLibrary(_THIS)
163{
165 if (_this->vulkan_config.loader_handle != DEFAULT_HANDLE) {
167 }
169 }
170}
171
172SDL_bool UIKit_Vulkan_GetInstanceExtensions(_THIS,
174 unsigned *count,
175 const char **names)
176{
177 static const char *const extensionsForUIKit[] = {
179 };
181 SDL_SetError("Vulkan is not loaded");
182 return SDL_FALSE;
183 }
184
185 return SDL_Vulkan_GetInstanceExtensions_Helper(
186 count, names, SDL_arraysize(extensionsForUIKit),
187 extensionsForUIKit);
188}
189
190SDL_bool UIKit_Vulkan_CreateSurface(_THIS,
192 VkInstance instance,
193 VkSurfaceKHR *surface)
194{
199 (VkInstance)instance,
200 "vkCreateIOSSurfaceMVK");
201 VkIOSSurfaceCreateInfoMVK createInfo = {};
203
205 SDL_SetError("Vulkan is not loaded");
206 return SDL_FALSE;
207 }
208
211 " extension is not enabled in the Vulkan instance.");
212 return SDL_FALSE;
213 }
214
216 createInfo.pNext = NULL;
217 createInfo.flags = 0;
218 createInfo.pView = (__bridge void *)UIKit_Mtl_AddMetalView(window);
219 result = vkCreateIOSSurfaceMVK(instance, &createInfo,
220 NULL, surface);
221 if (result != VK_SUCCESS) {
222 SDL_SetError("vkCreateIOSSurfaceMVK failed: %s",
223 SDL_Vulkan_GetResultString(result));
224 return SDL_FALSE;
225 }
226
227 return SDL_TRUE;
228}
229
230void UIKit_Vulkan_GetDrawableSize(_THIS, SDL_Window *window, int *w, int *h)
231{
232 UIKit_Mtl_GetDrawableSize(window, w, h);
233}
234
235#endif
236
237/* vi: set ts=4 sw=4 expandtab: */
#define _THIS
#define SDL_SetError
#define SDL_LoadObject
#define SDL_UnloadObject
#define SDL_getenv
#define SDL_strlcpy
#define SDL_free
#define SDL_strcmp
void * SDL_LoadFunction(void *handle, const char *name)
GLuint GLuint GLsizei count
Definition: SDL_opengl.h:1571
GLuint64EXT * result
GLuint GLuint * names
GLsizei numPaths
GLsizei const GLuint * paths
GLsizei const GLchar *const * path
GLfloat GLfloat GLfloat GLfloat h
GLubyte GLubyte GLubyte GLubyte w
SDL_bool
Definition: SDL_stdinc.h:162
@ SDL_TRUE
Definition: SDL_stdinc.h:164
@ SDL_FALSE
Definition: SDL_stdinc.h:163
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:115
uint32_t Uint32
Definition: SDL_stdinc.h:203
static SDL_VideoDevice * _this
Definition: SDL_video.c:118
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:167
EGLSurface surface
Definition: eglext.h:248
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr
Definition: SDL_sysvideo.h:372
PFN_vkEnumerateInstanceExtensionProperties vkEnumerateInstanceExtensionProperties
Definition: SDL_sysvideo.h:373
char loader_path[256]
Definition: SDL_sysvideo.h:375
struct SDL_VideoDevice::@263 vulkan_config
void * loader_handle
Definition: SDL_sysvideo.h:376
The type used to identify a window.
Definition: SDL_sysvideo.h:74
VkIOSSurfaceCreateFlagsMVK flags
Definition: vulkan_ios.h:39
VkStructureType sType
Definition: vulkan_ios.h:37
VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *pName)
#define VK_KHR_SURFACE_EXTENSION_NAME
Definition: vulkan_core.h:4669
VkResult
Definition: vulkan_core.h:120
@ VK_SUCCESS
Definition: vulkan_core.h:121
VkResult(VKAPI_PTR * PFN_vkEnumerateInstanceExtensionProperties)(const char *pLayerName, uint32_t *pPropertyCount, VkExtensionProperties *pProperties)
Definition: vulkan_core.h:2863
#define VK_NULL_HANDLE
Definition: vulkan_core.h:49
PFN_vkVoidFunction(VKAPI_PTR * PFN_vkGetInstanceProcAddr)(VkInstance instance, const char *pName)
Definition: vulkan_core.h:2859
@ VK_STRUCTURE_TYPE_IOS_SURFACE_CREATE_INFO_MVK
Definition: vulkan_core.h:372
#define VK_MVK_IOS_SURFACE_EXTENSION_NAME
Definition: vulkan_ios.h:32
VkResult(VKAPI_PTR * PFN_vkCreateIOSSurfaceMVK)(VkInstance instance, const VkIOSSurfaceCreateInfoMVK *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface)
Definition: vulkan_ios.h:44
VKAPI_ATTR VkResult VKAPI_CALL vkCreateIOSSurfaceMVK(VkInstance instance, const VkIOSSurfaceCreateInfoMVK *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface)