vulkan.c 11.5 KB
Newer Older
Camilla Berglund's avatar
Camilla Berglund committed
1
//========================================================================
Camilla Berglund's avatar
Camilla Berglund committed
2
// GLFW 3.3 - www.glfw.org
Camilla Berglund's avatar
Camilla Berglund committed
3
4
//------------------------------------------------------------------------
// Copyright (c) 2002-2006 Marcus Geelnard
Camilla Löwy's avatar
Camilla Löwy committed
5
// Copyright (c) 2006-2018 Camilla Löwy <elmindreda@glfw.org>
Camilla Berglund's avatar
Camilla Berglund committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
//
// 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.
//
//========================================================================
27
28
// Please use C89 style variable declarations in this file because VS 2010
//========================================================================
Camilla Berglund's avatar
Camilla Berglund committed
29
30
31
32
33
34
35

#include "internal.h"

#include <assert.h>
#include <string.h>
#include <stdlib.h>

36
37
38
#define _GLFW_FIND_LOADER    1
#define _GLFW_REQUIRE_LOADER 2

Camilla Berglund's avatar
Camilla Berglund committed
39
40
41
42
43

//////////////////////////////////////////////////////////////////////////
//////                       GLFW internal API                      //////
//////////////////////////////////////////////////////////////////////////

44
GLFWbool _glfwInitVulkan(int mode)
Camilla Berglund's avatar
Camilla Berglund committed
45
46
47
{
    VkResult err;
    VkExtensionProperties* ep;
48
    uint32_t i, count;
49

50
51
52
    if (_glfw.vk.available)
        return GLFW_TRUE;

53
#if !defined(_GLFW_VULKAN_STATIC)
54
55
56
#if defined(_GLFW_VULKAN_LIBRARY)
    _glfw.vk.handle = _glfw_dlopen(_GLFW_VULKAN_LIBRARY);
#elif defined(_GLFW_WIN32)
57
58
    _glfw.vk.handle = _glfw_dlopen("vulkan-1.dll");
#elif defined(_GLFW_COCOA)
59
    _glfw.vk.handle = _glfw_dlopen("libvulkan.1.dylib");
Camilla Berglund's avatar
Camilla Berglund committed
60
#else
61
    _glfw.vk.handle = _glfw_dlopen("libvulkan.so.1");
Camilla Berglund's avatar
Camilla Berglund committed
62
63
#endif
    if (!_glfw.vk.handle)
64
65
66
67
    {
        if (mode == _GLFW_REQUIRE_LOADER)
            _glfwInputError(GLFW_API_UNAVAILABLE, "Vulkan: Loader not found");

68
        return GLFW_FALSE;
69
    }
Camilla Berglund's avatar
Camilla Berglund committed
70
71
72
73
74
75
76

    _glfw.vk.GetInstanceProcAddr = (PFN_vkGetInstanceProcAddr)
        _glfw_dlsym(_glfw.vk.handle, "vkGetInstanceProcAddr");
    if (!_glfw.vk.GetInstanceProcAddr)
    {
        _glfwInputError(GLFW_API_UNAVAILABLE,
                        "Vulkan: Loader does not export vkGetInstanceProcAddr");
77
78
79

        _glfwTerminateVulkan();
        return GLFW_FALSE;
Camilla Berglund's avatar
Camilla Berglund committed
80
81
82
    }

    _glfw.vk.EnumerateInstanceExtensionProperties = (PFN_vkEnumerateInstanceExtensionProperties)
Camilla Berglund's avatar
Camilla Berglund committed
83
        vkGetInstanceProcAddr(NULL, "vkEnumerateInstanceExtensionProperties");
Camilla Berglund's avatar
Camilla Berglund committed
84
85
86
87
    if (!_glfw.vk.EnumerateInstanceExtensionProperties)
    {
        _glfwInputError(GLFW_API_UNAVAILABLE,
                        "Vulkan: Failed to retrieve vkEnumerateInstanceExtensionProperties");
88
89
90

        _glfwTerminateVulkan();
        return GLFW_FALSE;
Camilla Berglund's avatar
Camilla Berglund committed
91
    }
92
93
#endif // _GLFW_VULKAN_STATIC

Camilla Berglund's avatar
Camilla Berglund committed
94
95
96
    err = vkEnumerateInstanceExtensionProperties(NULL, &count, NULL);
    if (err)
    {
97
98
99
        // NOTE: This happens on systems with a loader but without any Vulkan ICD
        if (mode == _GLFW_REQUIRE_LOADER)
        {
100
            _glfwInputError(GLFW_API_UNAVAILABLE,
101
102
103
                            "Vulkan: Failed to query instance extension count: %s",
                            _glfwGetVulkanResultString(err));
        }
104
105
106

        _glfwTerminateVulkan();
        return GLFW_FALSE;
Camilla Berglund's avatar
Camilla Berglund committed
107
108
109
110
111
112
113
    }

    ep = calloc(count, sizeof(VkExtensionProperties));

    err = vkEnumerateInstanceExtensionProperties(NULL, &count, ep);
    if (err)
    {
114
        _glfwInputError(GLFW_API_UNAVAILABLE,
Camilla Berglund's avatar
Camilla Berglund committed
115
116
117
118
                        "Vulkan: Failed to query instance extensions: %s",
                        _glfwGetVulkanResultString(err));

        free(ep);
119
120
        _glfwTerminateVulkan();
        return GLFW_FALSE;
Camilla Berglund's avatar
Camilla Berglund committed
121
122
123
124
125
126
    }

    for (i = 0;  i < count;  i++)
    {
        if (strcmp(ep[i].extensionName, "VK_KHR_surface") == 0)
            _glfw.vk.KHR_surface = GLFW_TRUE;
127
#if defined(_GLFW_WIN32)
128
        else if (strcmp(ep[i].extensionName, "VK_KHR_win32_surface") == 0)
Camilla Berglund's avatar
Camilla Berglund committed
129
            _glfw.vk.KHR_win32_surface = GLFW_TRUE;
130
#elif defined(_GLFW_COCOA)
131
    #if defined(VK_USE_PLATFORM_MACOS_MVK)
132
133
        else if (strcmp(ep[i].extensionName, "VK_MVK_macos_surface") == 0)
            _glfw.vk.MVK_macos_surface = GLFW_TRUE;
134
135
136
137
    #elif defined(VK_USE_PLATFORM_METAL_EXT)
        else if (strcmp(ep[i].extensionName, "VK_EXT_metal_surface") == 0)
            _glfw.vk.EXT_metal_surface = GLFW_TRUE;
    #endif
138
#elif defined(_GLFW_X11)
139
        else if (strcmp(ep[i].extensionName, "VK_KHR_xlib_surface") == 0)
Camilla Berglund's avatar
Camilla Berglund committed
140
            _glfw.vk.KHR_xlib_surface = GLFW_TRUE;
141
        else if (strcmp(ep[i].extensionName, "VK_KHR_xcb_surface") == 0)
Camilla Berglund's avatar
Camilla Berglund committed
142
            _glfw.vk.KHR_xcb_surface = GLFW_TRUE;
143
#elif defined(_GLFW_WAYLAND)
144
        else if (strcmp(ep[i].extensionName, "VK_KHR_wayland_surface") == 0)
Camilla Berglund's avatar
Camilla Berglund committed
145
            _glfw.vk.KHR_wayland_surface = GLFW_TRUE;
146
#endif
Camilla Berglund's avatar
Camilla Berglund committed
147
148
149
150
151
152
    }

    free(ep);

    _glfw.vk.available = GLFW_TRUE;

153
    _glfwPlatformGetRequiredInstanceExtensions(_glfw.vk.extensions);
Camilla Berglund's avatar
Camilla Berglund committed
154

155
    return GLFW_TRUE;
Camilla Berglund's avatar
Camilla Berglund committed
156
157
158
159
}

void _glfwTerminateVulkan(void)
{
160
#if !defined(_GLFW_VULKAN_STATIC)
Camilla Berglund's avatar
Camilla Berglund committed
161
162
    if (_glfw.vk.handle)
        _glfw_dlclose(_glfw.vk.handle);
163
#endif
Camilla Berglund's avatar
Camilla Berglund committed
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
}

const char* _glfwGetVulkanResultString(VkResult result)
{
    switch (result)
    {
        case VK_SUCCESS:
            return "Success";
        case VK_NOT_READY:
            return "A fence or query has not yet completed";
        case VK_TIMEOUT:
            return "A wait operation has not completed in the specified time";
        case VK_EVENT_SET:
            return "An event is signaled";
        case VK_EVENT_RESET:
            return "An event is unsignaled";
        case VK_INCOMPLETE:
            return "A return array was too small for the result";
        case VK_ERROR_OUT_OF_HOST_MEMORY:
            return "A host memory allocation has failed";
        case VK_ERROR_OUT_OF_DEVICE_MEMORY:
            return "A device memory allocation has failed";
        case VK_ERROR_INITIALIZATION_FAILED:
            return "Initialization of an object could not be completed for implementation-specific reasons";
        case VK_ERROR_DEVICE_LOST:
            return "The logical or physical device has been lost";
        case VK_ERROR_MEMORY_MAP_FAILED:
            return "Mapping of a memory object has failed";
        case VK_ERROR_LAYER_NOT_PRESENT:
            return "A requested layer is not present or could not be loaded";
        case VK_ERROR_EXTENSION_NOT_PRESENT:
            return "A requested extension is not supported";
        case VK_ERROR_FEATURE_NOT_PRESENT:
            return "A requested feature is not supported";
        case VK_ERROR_INCOMPATIBLE_DRIVER:
            return "The requested version of Vulkan is not supported by the driver or is otherwise incompatible";
        case VK_ERROR_TOO_MANY_OBJECTS:
            return "Too many objects of the type have already been created";
        case VK_ERROR_FORMAT_NOT_SUPPORTED:
            return "A requested format is not supported on this device";
        case VK_ERROR_SURFACE_LOST_KHR:
            return "A surface is no longer available";
        case VK_SUBOPTIMAL_KHR:
            return "A swapchain no longer matches the surface properties exactly, but can still be used";
        case VK_ERROR_OUT_OF_DATE_KHR:
            return "A surface has changed in such a way that it is no longer compatible with the swapchain";
        case VK_ERROR_INCOMPATIBLE_DISPLAY_KHR:
            return "The display used by a swapchain does not use the same presentable image layout";
        case VK_ERROR_NATIVE_WINDOW_IN_USE_KHR:
            return "The requested window is already connected to a VkSurfaceKHR, or to some other non-Vulkan API";
        case VK_ERROR_VALIDATION_FAILED_EXT:
            return "A validation layer found an error";
        default:
Camilla Berglund's avatar
Cleanup    
Camilla Berglund committed
217
            return "ERROR: UNKNOWN VULKAN ERROR";
Camilla Berglund's avatar
Camilla Berglund committed
218
219
220
221
222
223
224
225
226
227
228
    }
}


//////////////////////////////////////////////////////////////////////////
//////                        GLFW public API                       //////
//////////////////////////////////////////////////////////////////////////

GLFWAPI int glfwVulkanSupported(void)
{
    _GLFW_REQUIRE_INIT_OR_RETURN(GLFW_FALSE);
229
    return _glfwInitVulkan(_GLFW_FIND_LOADER);
Camilla Berglund's avatar
Camilla Berglund committed
230
231
}

232
GLFWAPI const char** glfwGetRequiredInstanceExtensions(uint32_t* count)
Camilla Berglund's avatar
Camilla Berglund committed
233
{
Camilla Löwy's avatar
Camilla Löwy committed
234
235
    assert(count != NULL);

Camilla Berglund's avatar
Camilla Berglund committed
236
237
238
239
    *count = 0;

    _GLFW_REQUIRE_INIT_OR_RETURN(NULL);

240
    if (!_glfwInitVulkan(_GLFW_REQUIRE_LOADER))
Camilla Berglund's avatar
Camilla Berglund committed
241
242
        return NULL;

243
244
245
    if (!_glfw.vk.extensions[0])
        return NULL;

246
    *count = 2;
Camilla Berglund's avatar
Camilla Berglund committed
247
248
249
250
251
252
253
    return (const char**) _glfw.vk.extensions;
}

GLFWAPI GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance,
                                              const char* procname)
{
    GLFWvkproc proc;
Camilla Löwy's avatar
Camilla Löwy committed
254
    assert(procname != NULL);
Camilla Berglund's avatar
Camilla Berglund committed
255
256
257

    _GLFW_REQUIRE_INIT_OR_RETURN(NULL);

258
    if (!_glfwInitVulkan(_GLFW_REQUIRE_LOADER))
Camilla Berglund's avatar
Camilla Berglund committed
259
260
261
        return NULL;

    proc = (GLFWvkproc) vkGetInstanceProcAddr(instance, procname);
262
263
264
265
266
267
268
#if defined(_GLFW_VULKAN_STATIC)
    if (!proc)
    {
        if (strcmp(procname, "vkGetInstanceProcAddr") == 0)
            return (GLFWvkproc) vkGetInstanceProcAddr;
    }
#else
Camilla Berglund's avatar
Camilla Berglund committed
269
270
    if (!proc)
        proc = (GLFWvkproc) _glfw_dlsym(_glfw.vk.handle, procname);
271
#endif
Camilla Berglund's avatar
Camilla Berglund committed
272
273
274
275
276
277
278
279

    return proc;
}

GLFWAPI int glfwGetPhysicalDevicePresentationSupport(VkInstance instance,
                                                     VkPhysicalDevice device,
                                                     uint32_t queuefamily)
{
Camilla Löwy's avatar
Camilla Löwy committed
280
281
282
    assert(instance != VK_NULL_HANDLE);
    assert(device != VK_NULL_HANDLE);

Camilla Berglund's avatar
Camilla Berglund committed
283
284
    _GLFW_REQUIRE_INIT_OR_RETURN(GLFW_FALSE);

285
    if (!_glfwInitVulkan(_GLFW_REQUIRE_LOADER))
Camilla Berglund's avatar
Camilla Berglund committed
286
287
        return GLFW_FALSE;

288
    if (!_glfw.vk.extensions[0])
Camilla Berglund's avatar
Camilla Berglund committed
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
    {
        _glfwInputError(GLFW_API_UNAVAILABLE,
                        "Vulkan: Window surface creation extensions not found");
        return GLFW_FALSE;
    }

    return _glfwPlatformGetPhysicalDevicePresentationSupport(instance,
                                                             device,
                                                             queuefamily);
}

GLFWAPI VkResult glfwCreateWindowSurface(VkInstance instance,
                                         GLFWwindow* handle,
                                         const VkAllocationCallbacks* allocator,
                                         VkSurfaceKHR* surface)
{
    _GLFWwindow* window = (_GLFWwindow*) handle;
Camilla Löwy's avatar
Camilla Löwy committed
306
    assert(instance != VK_NULL_HANDLE);
Camilla Berglund's avatar
Camilla Berglund committed
307
308
    assert(window != NULL);
    assert(surface != NULL);
Camilla Berglund's avatar
Camilla Berglund committed
309

Camilla Berglund's avatar
Camilla Berglund committed
310
311
312
313
    *surface = VK_NULL_HANDLE;

    _GLFW_REQUIRE_INIT_OR_RETURN(VK_ERROR_INITIALIZATION_FAILED);

314
    if (!_glfwInitVulkan(_GLFW_REQUIRE_LOADER))
Camilla Berglund's avatar
Camilla Berglund committed
315
316
        return VK_ERROR_INITIALIZATION_FAILED;

317
    if (!_glfw.vk.extensions[0])
Camilla Berglund's avatar
Camilla Berglund committed
318
319
320
321
322
323
    {
        _glfwInputError(GLFW_API_UNAVAILABLE,
                        "Vulkan: Window surface creation extensions not found");
        return VK_ERROR_EXTENSION_NOT_PRESENT;
    }

324
325
326
327
328
329
330
    if (window->context.client != GLFW_NO_API)
    {
        _glfwInputError(GLFW_INVALID_VALUE,
                        "Vulkan: Window surface creation requires the window to have the client API set to GLFW_NO_API");
        return VK_ERROR_NATIVE_WINDOW_IN_USE_KHR;
    }

Camilla Berglund's avatar
Camilla Berglund committed
331
332
333
    return _glfwPlatformCreateWindowSurface(instance, window, allocator, surface);
}