mirror of
https://github.com/Relintai/sdl2_frt.git
synced 2025-02-08 22:20:05 +01:00
Caleb Cornett's comments: "A few weeks ago, Alex added a partial Metal API to SDL2: https://hg.libsdl.org/SDL/rev/22c8e7cd8d38 I noticed it was missing a few features that would help Metal become a first-class citizen in SDL, so I went ahead and wrote them! Here are the new APIs: 1. SDL_WINDOW_METAL flag for SDL_CreateWindow(). This allows the programmer to specify that they intend to create a window for use with SDL_MetalView. The flag is used to ensure correct usage of the API and to prevent accidentally defaulting to OpenGL on iOS. 2. SDL_Metal_GetLayer(). This function takes a SDL_MetalView and returns a pointer to the view's backing CAMetalLayer. This simplifies things considerably, since in the current version of the SDL_Metal API the programmer is required to bridge-cast a SDL_MetalView handle to an NSView or UIView (depending on the platform) and then extract the layer from there. SDL_Metal_GetLayer automatically handles all of that, making the operation simple and cross-platform. 3. SDL_Metal_GetDrawableSize(). This function already exists in the current SDL_Metal API (and is used behind-the-scenes for SDL_Vulkan_GetDrawableSize on Apple platforms) but was not publicly exposed. My patch exposes this function for public use. It works just like you'd expect. Tested on macOS 10.14 and iOS 12.4." Fixes Bugzilla #4796.
252 lines
8.4 KiB
Objective-C
252 lines
8.4 KiB
Objective-C
/*
|
|
Simple DirectMedia Layer
|
|
Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
|
|
|
|
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"
|
|
|
|
#if SDL_VIDEO_VULKAN && SDL_VIDEO_DRIVER_UIKIT
|
|
|
|
#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>
|
|
|
|
const char* defaultPaths[] = {
|
|
"libvulkan.dylib",
|
|
};
|
|
|
|
/* 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;
|
|
|
|
if (_this->vulkan_config.loader_handle) {
|
|
return SDL_SetError("Vulkan Portability library is already loaded.");
|
|
}
|
|
|
|
/* Load the Vulkan loader library */
|
|
if (!path) {
|
|
path = SDL_getenv("SDL_VULKAN_LIBRARY");
|
|
}
|
|
|
|
if (!path) {
|
|
/* Handle the case where Vulkan Portability is linked statically. */
|
|
vkGetInstanceProcAddr =
|
|
(PFN_vkGetInstanceProcAddr)dlsym(DEFAULT_HANDLE,
|
|
"vkGetInstanceProcAddr");
|
|
}
|
|
|
|
if (vkGetInstanceProcAddr) {
|
|
_this->vulkan_config.loader_handle = DEFAULT_HANDLE;
|
|
} else {
|
|
const char** paths;
|
|
const char *foundPath = NULL;
|
|
int numPaths;
|
|
int i;
|
|
|
|
if (path) {
|
|
paths = &path;
|
|
numPaths = 1;
|
|
} else {
|
|
/* Look for the .dylib packaged with the application instead. */
|
|
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);
|
|
}
|
|
|
|
if (_this->vulkan_config.loader_handle == NULL) {
|
|
return SDL_SetError("Failed to load Vulkan Portability library");
|
|
}
|
|
|
|
SDL_strlcpy(_this->vulkan_config.loader_path, path,
|
|
SDL_arraysize(_this->vulkan_config.loader_path));
|
|
vkGetInstanceProcAddr =
|
|
(PFN_vkGetInstanceProcAddr)SDL_LoadFunction(
|
|
_this->vulkan_config.loader_handle,
|
|
"vkGetInstanceProcAddr");
|
|
}
|
|
|
|
if (!vkGetInstanceProcAddr) {
|
|
SDL_SetError("Failed to find %s in either executable or %s: %s",
|
|
"vkGetInstanceProcAddr",
|
|
"linked Vulkan Portability library",
|
|
(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");
|
|
|
|
if (!_this->vulkan_config.vkEnumerateInstanceExtensionProperties) {
|
|
SDL_SetError("No vkEnumerateInstanceExtensionProperties found.");
|
|
goto fail;
|
|
}
|
|
|
|
extensions = SDL_Vulkan_CreateInstanceExtensionsList(
|
|
(PFN_vkEnumerateInstanceExtensionProperties)
|
|
_this->vulkan_config.vkEnumerateInstanceExtensionProperties,
|
|
&extensionCount);
|
|
|
|
if (!extensions) {
|
|
goto fail;
|
|
}
|
|
|
|
for (Uint32 i = 0; i < extensionCount; i++) {
|
|
if (SDL_strcmp(VK_KHR_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
|
|
hasSurfaceExtension = SDL_TRUE;
|
|
} else if (SDL_strcmp(VK_MVK_IOS_SURFACE_EXTENSION_NAME, extensions[i].extensionName) == 0) {
|
|
hasIOSSurfaceExtension = SDL_TRUE;
|
|
}
|
|
}
|
|
|
|
SDL_free(extensions);
|
|
|
|
if (!hasSurfaceExtension) {
|
|
SDL_SetError("Installed Vulkan Portability doesn't implement the "
|
|
VK_KHR_SURFACE_EXTENSION_NAME " extension");
|
|
goto fail;
|
|
} else if (!hasIOSSurfaceExtension) {
|
|
SDL_SetError("Installed Vulkan Portability doesn't implement the "
|
|
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)
|
|
{
|
|
if (_this->vulkan_config.loader_handle) {
|
|
if (_this->vulkan_config.loader_handle != DEFAULT_HANDLE) {
|
|
SDL_UnloadObject(_this->vulkan_config.loader_handle);
|
|
}
|
|
_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
|
|
};
|
|
if (!_this->vulkan_config.loader_handle) {
|
|
SDL_SetError("Vulkan is not loaded");
|
|
return SDL_FALSE;
|
|
}
|
|
|
|
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;
|
|
SDL_MetalView metalview;
|
|
|
|
if (!_this->vulkan_config.loader_handle) {
|
|
SDL_SetError("Vulkan is not loaded");
|
|
return SDL_FALSE;
|
|
}
|
|
|
|
if (!vkCreateIOSSurfaceMVK) {
|
|
SDL_SetError(VK_MVK_IOS_SURFACE_EXTENSION_NAME
|
|
" extension is not enabled in the Vulkan instance.");
|
|
return SDL_FALSE;
|
|
}
|
|
|
|
metalview = UIKit_Metal_CreateView(_this, window);
|
|
if (metalview == NULL) {
|
|
return SDL_FALSE;
|
|
}
|
|
|
|
createInfo.sType = VK_STRUCTURE_TYPE_IOS_SURFACE_CREATE_INFO_MVK;
|
|
createInfo.pNext = NULL;
|
|
createInfo.flags = 0;
|
|
createInfo.pView = (const void *)metalview;
|
|
result = vkCreateIOSSurfaceMVK(instance, &createInfo,
|
|
NULL, surface);
|
|
if (result != VK_SUCCESS) {
|
|
UIKit_Metal_DestroyView(_this, metalview);
|
|
SDL_SetError("vkCreateIOSSurfaceMVK failed: %s",
|
|
SDL_Vulkan_GetResultString(result));
|
|
return SDL_FALSE;
|
|
}
|
|
|
|
/* 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);
|
|
|
|
return SDL_TRUE;
|
|
}
|
|
|
|
void UIKit_Vulkan_GetDrawableSize(_THIS, SDL_Window *window, int *w, int *h)
|
|
{
|
|
UIKit_Metal_GetDrawableSize(_this, window, w, h);
|
|
}
|
|
|
|
#endif
|
|
|
|
/* vi: set ts=4 sw=4 expandtab: */
|