2 Simple DirectMedia Layer
3 Copyright (C) 2017, Mark Callow
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.
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:
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.
25 * Header file for functions to creating Vulkan surfaces on SDL windows.
31 #include "SDL_video.h"
33 #include "begin_code.h"
34 /* Set up for C function definitions, even when using C++ */
39 /* Avoid including vulkan.h, don't define VkInstance if it's already included */
41 #define NO_SDL_VULKAN_TYPEDEFS
43 #ifndef NO_SDL_VULKAN_TYPEDEFS
44 #define VK_DEFINE_HANDLE(object) typedef struct object##_T* object;
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;
49 #define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object) typedef uint64_t object;
52 VK_DEFINE_HANDLE(VkInstance)
53 VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkSurfaceKHR)
55 #endif /* !NO_SDL_VULKAN_TYPEDEFS */
57 typedef VkInstance SDL_vulkanInstance;
58 typedef VkSurfaceKHR SDL_vulkanSurface; /* for compatibility with Tizen */
61 * \name Vulkan support functions
63 * \note SDL_Vulkan_GetInstanceExtensions & SDL_Vulkan_CreateSurface API
64 * is compatable with Tizen's implementation of Vulkan in SDL.
69 * \brief Dynamically load a Vulkan loader library.
71 * \param [in] path The platform dependent Vulkan loader library name, or
74 * \return \c 0 on success, or \c -1 if the library couldn't be loaded.
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
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.
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.
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
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 * \c MoltenVK.framework/MoltenVK and \c libMoltenVK.dylib in that order.
102 * On iOS SDL will attempt to load \c libMoltenVK.dylib. Applications
103 * using a dynamic framework or .dylib must ensure it is included in its
104 * application bundle.
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.
110 * \note This function will fail if there are no working Vulkan drivers
113 * \sa SDL_Vulkan_GetVkGetInstanceProcAddr()
114 * \sa SDL_Vulkan_UnloadLibrary()
116 extern DECLSPEC int SDLCALL SDL_Vulkan_LoadLibrary(const char *path);
119 * \brief Get the address of the \c vkGetInstanceProcAddr function.
121 * \note This should be called after either calling SDL_Vulkan_LoadLibrary
122 * or creating an SDL_Window with the SDL_WINDOW_VULKAN flag.
124 extern DECLSPEC void *SDLCALL SDL_Vulkan_GetVkGetInstanceProcAddr(void);
127 * \brief Unload the Vulkan loader library previously loaded by
128 * \c SDL_Vulkan_LoadLibrary().
130 * \sa SDL_Vulkan_LoadLibrary()
132 extern DECLSPEC void SDLCALL SDL_Vulkan_UnloadLibrary(void);
135 * \brief Get the names of the Vulkan instance extensions needed to create
136 * a surface with \c SDL_Vulkan_CreateSurface().
138 * \param [in] window Window for which the required Vulkan instance
139 * extensions should be retrieved
140 * \param [in,out] count pointer to an \c unsigned related to the number of
141 * required Vulkan instance extensions
142 * \param [out] names \c NULL or a pointer to an array to be filled with the
143 * required Vulkan instance extensions
145 * \return \c SDL_TRUE on success, \c SDL_FALSE on error.
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.
157 * \note The returned list of extensions will contain \c VK_KHR_surface
158 * and zero or more platform specific extensions
160 * \note The extension names queried here must be enabled when calling
161 * VkCreateInstance, otherwise surface creation will fail.
163 * \note \c window should have been created with the \c SDL_WINDOW_VULKAN flag.
166 * unsigned int count;
167 * // get count of required extensions
168 * if(!SDL_Vulkan_GetInstanceExtensions(window, &count, NULL))
171 * static const char *const additionalExtensions[] =
173 * VK_EXT_DEBUG_REPORT_EXTENSION_NAME, // example additional extension
175 * size_t additionalExtensionsCount = sizeof(additionalExtensions) / sizeof(additionalExtensions[0]);
176 * size_t extensionCount = count + additionalExtensionsCount;
177 * const char **names = malloc(sizeof(const char *) * extensionCount);
181 * // get names of required extensions
182 * if(!SDL_Vulkan_GetInstanceExtensions(window, &count, names))
185 * // copy additional extensions after required extensions
186 * for(size_t i = 0; i < additionalExtensionsCount; i++)
187 * names[i + count] = additionalExtensions[i];
189 * VkInstanceCreateInfo instanceCreateInfo = {};
190 * instanceCreateInfo.enabledExtensionCount = extensionCount;
191 * instanceCreateInfo.ppEnabledExtensionNames = names;
192 * // fill in rest of instanceCreateInfo
194 * VkInstance instance;
195 * // create the Vulkan instance
196 * VkResult result = vkCreateInstance(&instanceCreateInfo, NULL, &instance);
200 * \sa SDL_Vulkan_CreateSurface()
202 extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_GetInstanceExtensions(
204 unsigned int *pCount,
205 const char **pNames);
208 * \brief Create a Vulkan rendering surface for a window.
210 * \param [in] window SDL_Window to which to attach the rendering surface.
211 * \param [in] instance handle to the Vulkan instance to use.
212 * \param [out] surface pointer to a VkSurfaceKHR handle to receive the
213 * handle of the newly created surface.
215 * \return \c SDL_TRUE on success, \c SDL_FALSE on error.
218 * VkInstance instance;
219 * SDL_Window *window;
221 * // create instance and window
223 * // create the Vulkan surface
224 * VkSurfaceKHR surface;
225 * if(!SDL_Vulkan_CreateSurface(window, instance, &surface))
229 * \note \a window should have been created with the \c SDL_WINDOW_VULKAN flag.
231 * \note \a instance should have been created with the extensions returned
232 * by \c SDL_Vulkan_CreateSurface() enabled.
234 * \sa SDL_Vulkan_GetInstanceExtensions()
236 extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_CreateSurface(
239 VkSurfaceKHR* surface);
242 * \brief Get the size of a window's underlying drawable in pixels (for use
243 * with setting viewport, scissor & etc).
245 * \param window SDL_Window from which the drawable size should be queried
246 * \param w Pointer to variable for storing the width in pixels,
248 * \param h Pointer to variable for storing the height in pixels,
251 * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI
252 * drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a
253 * platform with high-DPI support (Apple calls this "Retina"), and not disabled
254 * by the \c SDL_HINT_VIDEO_HIGHDPI_DISABLED hint.
256 * \note On macOS high-DPI support must be enabled for an application by
257 * setting NSHighResolutionCapable to true in its Info.plist.
259 * \sa SDL_GetWindowSize()
260 * \sa SDL_CreateWindow()
262 extern DECLSPEC void SDLCALL SDL_Vulkan_GetDrawableSize(SDL_Window * window,
265 /* @} *//* Vulkan support functions */
267 /* Ends C function definitions when using C++ */
271 #include "close_code.h"
273 #endif /* SDL_vulkan_h_ */