SDL_vulkan.h (10797B)
1/* 2 Simple DirectMedia Layer 3 Copyright (C) 2017, Mark Callow 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 * \file SDL_vulkan.h 24 * 25 * Header file for functions to creating Vulkan surfaces on SDL windows. 26 */ 27 28#ifndef SDL_vulkan_h_ 29#define SDL_vulkan_h_ 30 31#include "SDL_video.h" 32 33#include "begin_code.h" 34/* Set up for C function definitions, even when using C++ */ 35#ifdef __cplusplus 36extern "C" { 37#endif 38 39/* Avoid including vulkan.h, don't define VkInstance if it's already included */ 40#ifdef VULKAN_H_ 41#define NO_SDL_VULKAN_TYPEDEFS 42#endif 43#ifndef NO_SDL_VULKAN_TYPEDEFS 44#define VK_DEFINE_HANDLE(object) typedef struct object##_T* object; 45 46#if defined(__LP64__) || defined(_WIN64) || defined(__x86_64__) || defined(_M_X64) || defined(__ia64) || defined (_M_IA64) || defined(__aarch64__) || defined(__powerpc64__) 47#define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object) typedef struct object##_T *object; 48#else 49#define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object) typedef uint64_t object; 50#endif 51 52VK_DEFINE_HANDLE(VkInstance) 53VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkSurfaceKHR) 54 55#endif /* !NO_SDL_VULKAN_TYPEDEFS */ 56 57typedef VkInstance SDL_vulkanInstance; 58typedef VkSurfaceKHR SDL_vulkanSurface; /* for compatibility with Tizen */ 59 60/** 61 * \name Vulkan support functions 62 * 63 * \note SDL_Vulkan_GetInstanceExtensions & SDL_Vulkan_CreateSurface API 64 * is compatable with Tizen's implementation of Vulkan in SDL. 65 */ 66/* @{ */ 67 68/** 69 * \brief Dynamically load a Vulkan loader library. 70 * 71 * \param [in] path The platform dependent Vulkan loader library name, or 72 * \c NULL. 73 * 74 * \return \c 0 on success, or \c -1 if the library couldn't be loaded. 75 * 76 * If \a path is NULL SDL will use the value of the environment variable 77 * \c SDL_VULKAN_LIBRARY, if set, otherwise it loads the default Vulkan 78 * loader library. 79 * 80 * This should be called after initializing the video driver, but before 81 * creating any Vulkan windows. If no Vulkan loader library is loaded, the 82 * default library will be loaded upon creation of the first Vulkan window. 83 * 84 * \note It is fairly common for Vulkan applications to link with \a libvulkan 85 * instead of explicitly loading it at run time. This will work with 86 * SDL provided the application links to a dynamic library and both it 87 * and SDL use the same search path. 88 * 89 * \note If you specify a non-NULL \c path, an application should retrieve all 90 * of the Vulkan functions it uses from the dynamic library using 91 * \c SDL_Vulkan_GetVkGetInstanceProcAddr() unless you can guarantee 92 * \c path points to the same vulkan loader library the application 93 * linked to. 94 * 95 * \note On Apple devices, if \a path is NULL, SDL will attempt to find 96 * the vkGetInstanceProcAddr address within all the mach-o images of 97 * the current process. This is because it is fairly common for Vulkan 98 * applications to link with libvulkan (and historically MoltenVK was 99 * provided as a static library). If it is not found then, on macOS, SDL 100 * will attempt to load \c vulkan.framework/vulkan, \c libvulkan.1.dylib, 101 * followed by \c libvulkan.dylib, in that order. 102 * On iOS SDL will attempt to load \c libvulkan.dylib only. Applications 103 * using a dynamic framework or .dylib must ensure it is included in its 104 * application bundle. 105 * 106 * \note On non-Apple devices, application linking with a static libvulkan is 107 * not supported. Either do not link to the Vulkan loader or link to a 108 * dynamic library version. 109 * 110 * \note This function will fail if there are no working Vulkan drivers 111 * installed. 112 * 113 * \sa SDL_Vulkan_GetVkGetInstanceProcAddr() 114 * \sa SDL_Vulkan_UnloadLibrary() 115 */ 116extern DECLSPEC int SDLCALL SDL_Vulkan_LoadLibrary(const char *path); 117 118/** 119 * \brief Get the address of the \c vkGetInstanceProcAddr function. 120 * 121 * \note This should be called after either calling SDL_Vulkan_LoadLibrary 122 * or creating an SDL_Window with the SDL_WINDOW_VULKAN flag. 123 */ 124extern DECLSPEC void *SDLCALL SDL_Vulkan_GetVkGetInstanceProcAddr(void); 125 126/** 127 * \brief Unload the Vulkan loader library previously loaded by 128 * \c SDL_Vulkan_LoadLibrary(). 129 * 130 * \sa SDL_Vulkan_LoadLibrary() 131 */ 132extern DECLSPEC void SDLCALL SDL_Vulkan_UnloadLibrary(void); 133 134/** 135 * \brief Get the names of the Vulkan instance extensions needed to create 136 * a surface with \c SDL_Vulkan_CreateSurface(). 137 * 138 * \param [in] \c NULL or window Window for which the required Vulkan instance 139 * extensions should be retrieved 140 * \param [in,out] pCount pointer to an \c unsigned related to the number of 141 * required Vulkan instance extensions 142 * \param [out] pNames \c NULL or a pointer to an array to be filled with the 143 * required Vulkan instance extensions 144 * 145 * \return \c SDL_TRUE on success, \c SDL_FALSE on error. 146 * 147 * If \a pNames is \c NULL, then the number of required Vulkan instance 148 * extensions is returned in pCount. Otherwise, \a pCount must point to a 149 * variable set to the number of elements in the \a pNames array, and on 150 * return the variable is overwritten with the number of names actually 151 * written to \a pNames. If \a pCount is less than the number of required 152 * extensions, at most \a pCount structures will be written. If \a pCount 153 * is smaller than the number of required extensions, \c SDL_FALSE will be 154 * returned instead of \c SDL_TRUE, to indicate that not all the required 155 * extensions were returned. 156 * 157 * \note If \c window is not NULL, it will be checked against its creation 158 * flags to ensure that the Vulkan flag is present. This parameter 159 * will be removed in a future major release. 160 * 161 * \note The returned list of extensions will contain \c VK_KHR_surface 162 * and zero or more platform specific extensions 163 * 164 * \note The extension names queried here must be enabled when calling 165 * VkCreateInstance, otherwise surface creation will fail. 166 * 167 * \note \c window should have been created with the \c SDL_WINDOW_VULKAN flag 168 * or be \c NULL 169 * 170 * \code 171 * unsigned int count; 172 * // get count of required extensions 173 * if(!SDL_Vulkan_GetInstanceExtensions(NULL, &count, NULL)) 174 * handle_error(); 175 * 176 * static const char *const additionalExtensions[] = 177 * { 178 * VK_EXT_DEBUG_REPORT_EXTENSION_NAME, // example additional extension 179 * }; 180 * size_t additionalExtensionsCount = sizeof(additionalExtensions) / sizeof(additionalExtensions[0]); 181 * size_t extensionCount = count + additionalExtensionsCount; 182 * const char **names = malloc(sizeof(const char *) * extensionCount); 183 * if(!names) 184 * handle_error(); 185 * 186 * // get names of required extensions 187 * if(!SDL_Vulkan_GetInstanceExtensions(NULL, &count, names)) 188 * handle_error(); 189 * 190 * // copy additional extensions after required extensions 191 * for(size_t i = 0; i < additionalExtensionsCount; i++) 192 * names[i + count] = additionalExtensions[i]; 193 * 194 * VkInstanceCreateInfo instanceCreateInfo = {}; 195 * instanceCreateInfo.enabledExtensionCount = extensionCount; 196 * instanceCreateInfo.ppEnabledExtensionNames = names; 197 * // fill in rest of instanceCreateInfo 198 * 199 * VkInstance instance; 200 * // create the Vulkan instance 201 * VkResult result = vkCreateInstance(&instanceCreateInfo, NULL, &instance); 202 * free(names); 203 * \endcode 204 * 205 * \sa SDL_Vulkan_CreateSurface() 206 */ 207extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_GetInstanceExtensions( 208 SDL_Window *window, 209 unsigned int *pCount, 210 const char **pNames); 211 212/** 213 * \brief Create a Vulkan rendering surface for a window. 214 * 215 * \param [in] window SDL_Window to which to attach the rendering surface. 216 * \param [in] instance handle to the Vulkan instance to use. 217 * \param [out] surface pointer to a VkSurfaceKHR handle to receive the 218 * handle of the newly created surface. 219 * 220 * \return \c SDL_TRUE on success, \c SDL_FALSE on error. 221 * 222 * \code 223 * VkInstance instance; 224 * SDL_Window *window; 225 * 226 * // create instance and window 227 * 228 * // create the Vulkan surface 229 * VkSurfaceKHR surface; 230 * if(!SDL_Vulkan_CreateSurface(window, instance, &surface)) 231 * handle_error(); 232 * \endcode 233 * 234 * \note \a window should have been created with the \c SDL_WINDOW_VULKAN flag. 235 * 236 * \note \a instance should have been created with the extensions returned 237 * by \c SDL_Vulkan_CreateSurface() enabled. 238 * 239 * \sa SDL_Vulkan_GetInstanceExtensions() 240 */ 241extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_CreateSurface( 242 SDL_Window *window, 243 VkInstance instance, 244 VkSurfaceKHR* surface); 245 246/** 247 * \brief Get the size of a window's underlying drawable in pixels (for use 248 * with setting viewport, scissor & etc). 249 * 250 * \param window SDL_Window from which the drawable size should be queried 251 * \param w Pointer to variable for storing the width in pixels, 252 * may be NULL 253 * \param h Pointer to variable for storing the height in pixels, 254 * may be NULL 255 * 256 * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI 257 * drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a 258 * platform with high-DPI support (Apple calls this "Retina"), and not disabled 259 * by the \c SDL_HINT_VIDEO_HIGHDPI_DISABLED hint. 260 * 261 * \note On macOS high-DPI support must be enabled for an application by 262 * setting NSHighResolutionCapable to true in its Info.plist. 263 * 264 * \sa SDL_GetWindowSize() 265 * \sa SDL_CreateWindow() 266 */ 267extern DECLSPEC void SDLCALL SDL_Vulkan_GetDrawableSize(SDL_Window * window, 268 int *w, int *h); 269 270/* @} *//* Vulkan support functions */ 271 272/* Ends C function definitions when using C++ */ 273#ifdef __cplusplus 274} 275#endif 276#include "close_code.h" 277 278#endif /* SDL_vulkan_h_ */