-
Notifications
You must be signed in to change notification settings - Fork 158
/
Copy pathvulkaninfo.h
1944 lines (1671 loc) · 82.8 KB
/
vulkaninfo.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2015-2021 The Khronos Group Inc.
* Copyright (c) 2015-2021 Valve Corporation
* Copyright (c) 2015-2021 LunarG, Inc.
* Copyright (c) 2023-2024 RasterGrid Kft.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Author: Courtney Goeltzenleuchter <[email protected]>
* Author: David Pinedo <[email protected]>
* Author: Mark Lobodzinski <[email protected]>
* Author: Rene Lindsay <[email protected]>
* Author: Jeremy Kniager <[email protected]>
* Author: Shannon McPherson <[email protected]>
* Author: Bob Ellison <[email protected]>
* Author: Charles Giessen <[email protected]>
*
*/
#pragma once
#include <algorithm>
#include <array>
#include <exception>
#include <iostream>
#include <fstream>
#include <memory>
#include <ostream>
#include <set>
#include <string>
#include <unordered_map>
#include <set>
#include <vector>
#include <utility>
#include <functional>
#include <assert.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <cstring>
#ifdef __GNUC__
#ifndef _POSIX_C_SOURCE
#define _POSIX_C_SOURCE 200809L
#endif
#else
#define strndup(p, n) strdup(p)
#endif
#if defined(_WIN32)
#include <fcntl.h>
#include <io.h>
#ifndef NOMINMAX
#define NOMINMAX
#endif
#include <windows.h>
#if _MSC_VER == 1900
#pragma warning(disable : 4800)
#endif
#endif // _WIN32
#if defined(VK_USE_PLATFORM_XLIB_KHR) || defined(VK_USE_PLATFORM_XCB_KHR)
#include <X11/Xlib.h>
#include <X11/Xutil.h>
#endif
#if defined(VK_USE_PLATFORM_MACOS_MVK) || defined(VK_USE_PLATFORM_METAL_EXT)
#include "metal_view.h"
#endif
#if defined(VK_USE_PLATFORM_WAYLAND_KHR)
#include <wayland-client.h>
#endif
#include <vulkan/vulkan.h>
#define VOLK_IMPLEMENTATION
#include "volk.h"
static std::string VkResultString(VkResult err);
// General error: Get file + line and a short message
struct FileLineException : std::runtime_error {
FileLineException(const std::string &arg, const char *file, int line) : runtime_error(arg) {
msg = std::string(file) + ":" + std::to_string(line) + ": " + arg;
}
~FileLineException() throw() {}
const char *what() const throw() { return msg.c_str(); }
private:
std::string msg;
};
#define THROW_ERR(arg) throw FileLineException(arg, __FILE__, __LINE__);
// Vulkan function error: Get name of function, file, line, and the error code returned by the function
struct VulkanException : std::runtime_error {
VulkanException(const std::string &function, const char *file, int line, VkResult err) : runtime_error(function) {
msg = std::string(file) + ":" + std::to_string(line) + ":" + function + " failed with " + VkResultString(err);
}
~VulkanException() throw() {}
const char *what() const throw() { return msg.c_str(); }
private:
std::string msg;
};
#define THROW_VK_ERR(func_name, err) throw VulkanException(func_name, __FILE__, __LINE__, err);
#ifdef _WIN32
#define strdup _strdup
// Returns nonzero if the console is used only for this process. Will return
// zero if another process (such as cmd.exe) is also attached.
static int ConsoleIsExclusive(void) {
DWORD pids[2];
DWORD num_pids = GetConsoleProcessList(pids, ARRAYSIZE(pids));
return num_pids <= 1;
}
void wait_for_console_destroy() {
if (ConsoleIsExclusive()) Sleep(INFINITE);
}
// User32 function declarations
using PFN_AdjustWindowRect = WINUSERAPI BOOL(WINAPI *)(_Inout_ LPRECT, _In_ DWORD, _In_ BOOL);
using PFN_CreateWindowExA = WINUSERAPI HWND(WINAPI *)(_In_ DWORD, _In_opt_ LPCSTR, _In_opt_ LPCSTR, _In_ DWORD, _In_ int, _In_ int,
_In_ int, _In_ int, _In_opt_ HWND, _In_opt_ HMENU, _In_opt_ HINSTANCE,
_In_opt_ LPVOID);
using PFN_DefWindowProcA = WINUSERAPI LRESULT(WINAPI *)(_In_ HWND, _In_ UINT, _In_ WPARAM, _In_ LPARAM);
using PFN_DestroyWindow = WINUSERAPI BOOL(WINAPI *)(_In_ HWND);
using PFN_LoadIconA = WINUSERAPI HICON(WINAPI *)(_In_opt_ HINSTANCE, _In_ LPCSTR);
using PFN_RegisterClassExA = WINUSERAPI ATOM(WINAPI *)(_In_ CONST WNDCLASSEXA *);
struct User32Handles {
// User32 dll handle
HMODULE user32DllHandle = nullptr;
// User32 function pointers
PFN_AdjustWindowRect pfnAdjustWindowRect = nullptr;
PFN_CreateWindowExA pfnCreateWindowExA = nullptr;
PFN_DefWindowProcA pfnDefWindowProcA = nullptr;
PFN_DestroyWindow pfnDestroyWindow = nullptr;
PFN_LoadIconA pfnLoadIconA = nullptr;
PFN_RegisterClassExA pfnRegisterClassExA = nullptr;
User32Handles() noexcept {}
~User32Handles() noexcept {
if (user32DllHandle != nullptr) {
FreeLibrary(user32DllHandle);
}
}
// Don't allow moving of this class
User32Handles(User32Handles const &) = delete;
User32Handles &operator=(User32Handles const &) = delete;
User32Handles(User32Handles &&) = delete;
User32Handles &operator=(User32Handles &&) = delete;
bool load() {
user32DllHandle = LoadLibraryExA("user32.dll", nullptr, 0);
if (user32DllHandle == nullptr) return false;
if (!load_function(pfnAdjustWindowRect, "AdjustWindowRect")) return false;
if (!load_function(pfnCreateWindowExA, "CreateWindowExA")) return false;
if (!load_function(pfnDefWindowProcA, "DefWindowProcA")) return false;
if (!load_function(pfnDestroyWindow, "DestroyWindow")) return false;
if (!load_function(pfnLoadIconA, "LoadIconA")) return false;
if (!load_function(pfnRegisterClassExA, "RegisterClassExA")) return false;
return true;
}
private:
template <typename T>
bool load_function(T &function_pointer, const char *function_name) {
function_pointer = reinterpret_cast<T>(GetProcAddress(user32DllHandle, function_name));
if (function_pointer == nullptr) {
fprintf(stderr, "Failed to load function: %s\n", function_name);
return false;
}
return true;
}
};
// Global user handles function used in windows callback and code
User32Handles *user32_handles;
#endif // _WIN32
#define APP_SHORT_NAME "vulkaninfo"
#define APP_UPPER_CASE_NAME "VULKANINFO"
#define API_NAME "Vulkan"
std::vector<const char *> get_c_str_array(std::vector<std::string> const &vec) {
std::vector<const char *> ret;
for (auto &str : vec) ret.push_back(str.c_str());
return ret;
}
static const char *VkDebugReportFlagsEXTString(const VkDebugReportFlagsEXT flags) {
switch (flags) {
case VK_DEBUG_REPORT_ERROR_BIT_EXT:
return "ERROR";
case VK_DEBUG_REPORT_WARNING_BIT_EXT:
return "WARNING";
case VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT:
return "PERF";
case VK_DEBUG_REPORT_INFORMATION_BIT_EXT:
return "INFO";
case VK_DEBUG_REPORT_DEBUG_BIT_EXT:
return "DEBUG";
default:
return "UNKNOWN";
}
}
static VKAPI_ATTR VkBool32 VKAPI_CALL DbgCallback(VkDebugReportFlagsEXT msgFlags, VkDebugReportObjectTypeEXT objType,
uint64_t srcObject, size_t location, int32_t msgCode, const char *pLayerPrefix,
const char *pMsg, void *pUserData) {
std::cerr << VkDebugReportFlagsEXTString(msgFlags) << ": [" << pLayerPrefix << "] Code " << msgCode << " : " << pMsg << "\n";
// True is reserved for layer developers, and MAY mean calls are not distributed down the layer chain after validation
// error. False SHOULD always be returned by apps:
return VK_FALSE;
}
// Helper for robustly executing the two-call pattern
template <typename T, typename F, typename... Ts>
auto GetVectorInit(const char *func_name, F &&f, T init, Ts &&...ts) -> std::vector<T> {
uint32_t count = 32; // Preallocate enough so that most calls only happen once
std::vector<T> results;
VkResult err;
uint32_t iteration_count = 0;
uint32_t max_iterations = 5;
do {
count *= 2;
results.resize(count, init);
err = f(ts..., &count, results.data());
results.resize(count);
iteration_count++;
} while (err == VK_INCOMPLETE && iteration_count < max_iterations);
if (err) THROW_VK_ERR(func_name, err);
return results;
}
template <typename T, typename F, typename... Ts>
auto GetVector(const char *func_name, F &&f, Ts &&...ts) -> std::vector<T> {
return GetVectorInit(func_name, f, T(), ts...);
}
// Forward declarations for pNext chains
struct phys_device_props2_chain;
struct phys_device_mem_props2_chain;
struct phys_device_features2_chain;
struct surface_capabilities2_chain;
struct format_properties2_chain;
struct queue_properties2_chain;
struct video_profile_info_chain;
struct video_capabilities_chain;
struct video_format_properties_chain;
struct AppInstance;
struct AppGpu;
struct AppVideoProfile;
void setup_phys_device_props2_chain(VkPhysicalDeviceProperties2 &start, std::unique_ptr<phys_device_props2_chain> &chain,
AppInstance &inst, AppGpu &gpu, bool show_promoted_structs);
void setup_phys_device_mem_props2_chain(VkPhysicalDeviceMemoryProperties2 &start,
std::unique_ptr<phys_device_mem_props2_chain> &chain, AppGpu &gpu);
void setup_phys_device_features2_chain(VkPhysicalDeviceFeatures2 &start, std::unique_ptr<phys_device_features2_chain> &chain,
AppGpu &gpu, bool show_promoted_structs);
void setup_surface_capabilities2_chain(VkSurfaceCapabilities2KHR &start, std::unique_ptr<surface_capabilities2_chain> &chain,
AppInstance &inst, AppGpu &gpu);
void setup_format_properties2_chain(VkFormatProperties2 &start, std::unique_ptr<format_properties2_chain> &chain, AppGpu &gpu);
void setup_queue_properties2_chain(VkQueueFamilyProperties2 &start, std::unique_ptr<queue_properties2_chain> &chain, AppGpu &gpu);
bool prepare_phys_device_props2_twocall_chain_vectors(std::unique_ptr<phys_device_props2_chain> &chain);
bool is_video_format_same(const VkVideoFormatPropertiesKHR &format_a, const VkVideoFormatPropertiesKHR &format_b);
std::vector<std::unique_ptr<AppVideoProfile>> enumerate_supported_video_profiles(AppGpu &gpu);
/* An ptional contains either a value or nothing. The optional asserts if a value is trying to be gotten but none exist.
* The interface is taken from C++17's <optional> with many aspects removed.
* This class assumes the template type is 'trivial'
*/
namespace util {
template <typename T>
struct vulkaninfo_optional {
using value_type = T;
bool _contains_value = false;
value_type _value;
vulkaninfo_optional() noexcept : _contains_value(false), _value({}) {}
vulkaninfo_optional(T value) noexcept : _contains_value(true), _value(value) {}
explicit operator bool() const noexcept { return _contains_value; }
bool has_value() const noexcept { return _contains_value; }
value_type value() const noexcept {
assert(_contains_value);
return _value;
}
// clang-format off
const value_type* operator->() const { assert(_contains_value); return _value;}
value_type* operator->() { assert(_contains_value); return &_value;}
const value_type& operator*() const& { assert(_contains_value); return _value;}
value_type& operator*() & { assert(_contains_value); return _value;}
const value_type&& operator*() const&& { assert(_contains_value); return _value;}
value_type&& operator*() && { assert(_contains_value); return _value;}
// clang-format on
}; // namespace util
} // namespace util
struct LayerExtensionList {
VkLayerProperties layer_properties;
std::vector<VkExtensionProperties> extension_properties;
};
struct AppInstance;
struct SurfaceExtension {
std::string name;
void (*create_window)(AppInstance &) = nullptr;
VkSurfaceKHR (*create_surface)(AppInstance &) = nullptr;
void (*destroy_window)(AppInstance &) = nullptr;
VkSurfaceKHR surface = VK_NULL_HANDLE;
bool operator==(const SurfaceExtension &other) { return name == other.name && surface == other.surface; }
};
struct AppVideoProfile {
bool supported;
std::string name;
VkVideoProfileInfoKHR profile_info;
std::unique_ptr<video_profile_info_chain> profile_info_chain;
VkVideoCapabilitiesKHR capabilities;
std::unique_ptr<video_capabilities_chain> capabilities_chain;
struct Format {
VkVideoFormatPropertiesKHR properties;
std::unique_ptr<video_format_properties_chain> properties_chain;
};
std::vector<Format> formats;
std::unordered_map<std::string, std::vector<VkVideoFormatPropertiesKHR>> formats_by_category;
using CreateProfileInfoChainCb = std::function<std::unique_ptr<video_profile_info_chain>(const void **)>;
using CreateCapabilitiesChainCb = std::function<std::unique_ptr<video_capabilities_chain>(void **)>;
struct CreateFormatPropertiesChainCb {
std::string format_name;
VkImageUsageFlags image_usage_flags;
std::function<bool(const VkVideoCapabilitiesKHR &capabilities)> check_required_caps;
std::function<std::unique_ptr<video_format_properties_chain>(void **)> callback;
};
using CreateFormatPropertiesChainCbList = std::vector<CreateFormatPropertiesChainCb>;
using InitProfileCb = std::function<void(AppVideoProfile &)>;
AppVideoProfile(AppGpu &gpu, VkPhysicalDevice phys_device, const std::string &in_name,
const VkVideoProfileInfoKHR &in_profile_info, CreateProfileInfoChainCb create_profile_info_chain,
CreateCapabilitiesChainCb create_capabilities_chain,
const CreateFormatPropertiesChainCbList &create_format_properties_chain_list, InitProfileCb init_profile)
: supported(true), name(in_name), profile_info(in_profile_info) {
profile_info_chain = create_profile_info_chain(&profile_info.pNext);
if (profile_info_chain == nullptr) {
supported = false;
return;
}
capabilities.sType = VK_STRUCTURE_TYPE_VIDEO_CAPABILITIES_KHR;
capabilities.pNext = nullptr;
capabilities_chain = create_capabilities_chain(&capabilities.pNext);
if (capabilities_chain == nullptr) {
supported = false;
return;
}
init_profile(*this);
VkResult result = vkGetPhysicalDeviceVideoCapabilitiesKHR(phys_device, &profile_info, &capabilities);
if (result != VK_SUCCESS) {
supported = false;
return;
}
VkVideoProfileListInfoKHR profile_list = {VK_STRUCTURE_TYPE_VIDEO_PROFILE_LIST_INFO_KHR, nullptr, 1, &profile_info};
std::vector<VkVideoFormatPropertiesKHR> video_format_props{};
std::vector<std::unique_ptr<video_format_properties_chain>> video_format_props_chains{};
for (const auto &create_format_properties_chain_info : create_format_properties_chain_list) {
if (!create_format_properties_chain_info.check_required_caps(capabilities)) {
continue;
}
VkPhysicalDeviceVideoFormatInfoKHR video_format_info = {VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VIDEO_FORMAT_INFO_KHR,
&profile_list,
create_format_properties_chain_info.image_usage_flags};
uint32_t video_format_property_count = 0;
result =
vkGetPhysicalDeviceVideoFormatPropertiesKHR(phys_device, &video_format_info, &video_format_property_count, nullptr);
if (result != VK_SUCCESS) {
continue;
}
video_format_props.resize(video_format_property_count);
video_format_props_chains.resize(video_format_property_count);
for (uint32_t i = 0; i < video_format_property_count; ++i) {
video_format_props[i].sType = VK_STRUCTURE_TYPE_VIDEO_FORMAT_PROPERTIES_KHR;
video_format_props_chains[i] = create_format_properties_chain_info.callback(&video_format_props[i].pNext);
}
result = vkGetPhysicalDeviceVideoFormatPropertiesKHR(phys_device, &video_format_info, &video_format_property_count,
video_format_props.data());
if (result == VK_SUCCESS) {
for (uint32_t i = 0; i < video_format_property_count; ++i) {
const VkVideoFormatPropertiesKHR *existing_format = nullptr;
for (const auto &format : formats) {
if (is_video_format_same(format.properties, video_format_props[i])) {
existing_format = &format.properties;
break;
}
}
if (existing_format == nullptr) {
formats.push_back(Format{video_format_props[i], std::move(video_format_props_chains[i])});
formats_by_category[create_format_properties_chain_info.format_name].push_back(video_format_props[i]);
} else {
formats_by_category[create_format_properties_chain_info.format_name].push_back(*existing_format);
}
}
}
video_format_props.clear();
video_format_props_chains.clear();
}
}
};
class APIVersion {
public:
APIVersion() : api_version_(VK_API_VERSION_1_0) {}
APIVersion(uint32_t api_version) : api_version_(api_version) {}
void SetPatch(uint32_t patch) { api_version_ = api_version_ - Patch() + VK_API_VERSION_PATCH(patch); }
uint32_t Major() const { return VK_API_VERSION_MAJOR(api_version_); }
uint32_t Minor() const { return VK_API_VERSION_MINOR(api_version_); }
uint32_t Patch() const { return VK_API_VERSION_PATCH(api_version_); }
bool operator<(APIVersion api_version) const { return api_version_ < api_version.api_version_; }
bool operator<=(APIVersion api_version) const { return api_version_ <= api_version.api_version_; }
bool operator>(APIVersion api_version) const { return api_version_ > api_version.api_version_; }
bool operator>=(APIVersion api_version) const { return api_version_ >= api_version.api_version_; }
bool operator==(APIVersion api_version) const { return api_version_ == api_version.api_version_; }
bool operator!=(APIVersion api_version) const { return api_version_ != api_version.api_version_; }
std::string str() { return std::to_string(Major()) + "." + std::to_string(Minor()) + "." + std::to_string(Patch()); }
operator std::string() { return str(); }
private:
uint32_t api_version_;
};
std::ostream &operator<<(std::ostream &out, const APIVersion &v) {
return out << v.Major() << "." << v.Minor() << "." << v.Patch();
}
struct AppInstance {
VkInstance instance;
APIVersion api_version;
VkDebugReportCallbackEXT debug_callback = VK_NULL_HANDLE;
std::vector<LayerExtensionList> global_layers;
std::vector<VkExtensionProperties> global_extensions; // Instance Extensions
std::vector<std::string> inst_extensions;
std::vector<SurfaceExtension> surface_extensions;
int width = 256, height = 256;
VkSurfaceCapabilitiesKHR surface_capabilities;
#ifdef VK_USE_PLATFORM_WIN32_KHR
HINSTANCE h_instance; // Windows Instance
HWND h_wnd; // window handle
#endif
#ifdef VK_USE_PLATFORM_XCB_KHR
xcb_connection_t *xcb_connection;
xcb_screen_t *xcb_screen;
xcb_window_t xcb_window;
#endif
#ifdef VK_USE_PLATFORM_XLIB_KHR
Display *xlib_display;
Window xlib_window;
#endif
#ifdef VK_USE_PLATFORM_MACOS_MVK
void *macos_window;
#endif
#ifdef VK_USE_PLATFORM_METAL_EXT
void *metal_window;
#endif
#ifdef VK_USE_PLATFORM_WAYLAND_KHR
wl_display *wayland_display;
wl_surface *wayland_surface;
#endif
#ifdef VK_USE_PLATFORM_DIRECTFB_EXT
IDirectFB *dfb;
IDirectFBSurface *directfb_surface;
#endif
#ifdef VK_USE_PLATFORM_ANDROID_KHR // TODO
ANativeWindow *window;
#endif
#ifdef VK_USE_PLATFORM_SCREEN_QNX
struct _screen_context *context;
struct _screen_window *window;
#endif
AppInstance() {
VkResult dllErr = volkInitialize();
if (dllErr != VK_SUCCESS) {
THROW_ERR("Failed to initialize: " API_NAME " loader is not installed, not found, or failed to load.");
}
uint32_t instance_version = VK_API_VERSION_1_0;
if (vkEnumerateInstanceVersion) {
const VkResult err = vkEnumerateInstanceVersion(&instance_version);
if (err) THROW_VK_ERR("vkEnumerateInstanceVersion", err);
}
api_version = APIVersion(instance_version);
// fallback to baked header version if loader returns 0 for the patch version
if (api_version.Patch() == 0) api_version.SetPatch(VK_HEADER_VERSION);
AppGetInstanceExtensions();
const VkDebugReportCallbackCreateInfoEXT dbg_info = {VK_STRUCTURE_TYPE_DEBUG_REPORT_CALLBACK_CREATE_INFO_EXT, nullptr,
VK_DEBUG_REPORT_ERROR_BIT_EXT | VK_DEBUG_REPORT_WARNING_BIT_EXT,
DbgCallback};
const VkApplicationInfo app_info = {
VK_STRUCTURE_TYPE_APPLICATION_INFO, nullptr, APP_SHORT_NAME, 1, nullptr, 0, instance_version};
AppCompileInstanceExtensionsToEnable();
std::vector<const char *> inst_exts;
for (const auto &ext : inst_extensions) {
inst_exts.push_back(ext.c_str());
}
const VkInstanceCreateInfo inst_info = {
VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO,
&dbg_info,
(CheckExtensionEnabled(VK_KHR_PORTABILITY_ENUMERATION_EXTENSION_NAME)
? static_cast<VkInstanceCreateFlags>(VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR)
: 0),
&app_info,
0,
nullptr,
static_cast<uint32_t>(inst_exts.size()),
inst_exts.data()};
VkResult err = vkCreateInstance(&inst_info, nullptr, &instance);
if (err == VK_ERROR_INCOMPATIBLE_DRIVER) {
std::cerr << "Cannot create " API_NAME " instance.\n";
std::cerr << "This problem is often caused by a faulty installation of the " API_NAME
" driver or attempting to use a GPU "
"that does not support " API_NAME ".\n";
THROW_VK_ERR("vkCreateInstance", err);
} else if (err) {
THROW_VK_ERR("vkCreateInstance", err);
}
volkLoadInstance(instance);
err = vkCreateDebugReportCallbackEXT(instance, &dbg_info, nullptr, &debug_callback);
if (err != VK_SUCCESS) {
THROW_VK_ERR("vkCreateDebugReportCallbackEXT", err);
}
}
~AppInstance() {
if (debug_callback) vkDestroyDebugReportCallbackEXT(instance, debug_callback, nullptr);
if (vkDestroyInstance) vkDestroyInstance(instance, nullptr);
volkFinalize();
}
AppInstance(const AppInstance &) = delete;
const AppInstance &operator=(const AppInstance &) = delete;
bool CheckExtensionEnabled(std::string extension_to_check) const {
return std::any_of(inst_extensions.begin(), inst_extensions.end(),
[extension_to_check](std::string str) { return str == extension_to_check; });
}
/* Gets a list of layer and instance extensions */
void AppGetInstanceExtensions() {
/* Scan layers */
auto global_layer_properties =
GetVector<VkLayerProperties>("vkEnumerateInstanceLayerProperties", vkEnumerateInstanceLayerProperties);
for (const auto &layer : global_layer_properties) {
global_layers.push_back(LayerExtensionList{layer, AppGetGlobalLayerExtensions(layer.layerName)});
}
// Collect global extensions
// Gets instance extensions, if no layer was specified in the first paramteter
global_extensions = AppGetGlobalLayerExtensions(nullptr);
}
void AppCompileInstanceExtensionsToEnable() {
#if defined(VK_USE_PLATFORM_MACOS_MVK) || defined(VK_USE_PLATFORM_IOS_MVK)
bool metal_surface_available = false;
for (const auto &ext : global_extensions) {
if (strcmp("VK_EXT_metal_surface", ext.extensionName) == 0) {
metal_surface_available = true;
}
}
#endif
for (const auto &ext : global_extensions) {
if (strcmp(VK_EXT_DEBUG_REPORT_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
if (strcmp(VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
if (strcmp(VK_KHR_PORTABILITY_ENUMERATION_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
if (strcmp(VK_KHR_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#ifdef VK_USE_PLATFORM_ANDROID_KHR
if (strcmp(VK_KHR_ANDROID_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_FUCHSIA
if (strcmp(VK_FUCHSIA_IMAGEPIPE_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_IOS_MVK
if (strcmp(VK_MVK_IOS_SURFACE_EXTENSION_NAME, ext.extensionName) == 0 && !metal_surface_available) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_MACOS_MVK
if (strcmp(VK_MVK_MACOS_SURFACE_EXTENSION_NAME, ext.extensionName) == 0 && !metal_surface_available) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_METAL_EXT
if (strcmp(VK_EXT_METAL_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_VI_NN
if (strcmp(VK_NN_VI_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_WAYLAND_KHR
if (strcmp(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_WIN32_KHR
if (strcmp(VK_KHR_WIN32_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_XCB_KHR
if (strcmp(VK_KHR_XCB_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_XLIB_KHR
if (strcmp(VK_KHR_XLIB_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_DIRECTFB_EXT
if (strcmp(VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_GGP
if (strcmp(VK_GGP_STREAM_DESCRIPTOR_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
#ifdef VK_USE_PLATFORM_SCREEN_QNX
if (strcmp(VK_QNX_SCREEN_SURFACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
#endif
if (strcmp(VK_KHR_GET_SURFACE_CAPABILITIES_2_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
if (strcmp(VK_KHR_SURFACE_PROTECTED_CAPABILITIES_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
if (strcmp(VK_EXT_SWAPCHAIN_COLOR_SPACE_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
if (strcmp(VK_EXT_SURFACE_MAINTENANCE_1_EXTENSION_NAME, ext.extensionName) == 0) {
inst_extensions.push_back(ext.extensionName);
}
}
}
void AddSurfaceExtension(SurfaceExtension ext) { surface_extensions.push_back(ext); }
std::vector<VkExtensionProperties> AppGetGlobalLayerExtensions(const char *layer_name) {
return GetVector<VkExtensionProperties>("vkEnumerateInstanceExtensionProperties", vkEnumerateInstanceExtensionProperties,
layer_name);
}
std::vector<VkPhysicalDevice> FindPhysicalDevices() {
return GetVector<VkPhysicalDevice>("vkEnumeratePhysicalDevices", vkEnumeratePhysicalDevices, instance);
}
std::vector<VkExtensionProperties> AppGetPhysicalDeviceLayerExtensions(VkPhysicalDevice phys_device, const char *layer_name) {
return GetVector<VkExtensionProperties>("vkEnumerateDeviceExtensionProperties", vkEnumerateDeviceExtensionProperties,
phys_device, layer_name);
}
};
// --------- Platform Specific Presentation Calls --------- //
#if defined(VK_USE_PLATFORM_XCB_KHR) || defined(VK_USE_PLATFORM_XLIB_KHR) || defined(VK_USE_PLATFORM_WIN32_KHR) || \
defined(VK_USE_PLATFORM_MACOS_MVK) || defined(VK_USE_PLATFORM_METAL_EXT) || defined(VK_USE_PLATFORM_WAYLAND_KHR) || \
defined(VK_USE_PLATFORM_DIRECTFB_EXT) || defined(VK_USE_PLATFORM_GGP) || defined(VK_USE_PLATFORM_SCREEN_QNX)
#define VULKANINFO_WSI_ENABLED
#endif
//-----------------------------------------------------------
#if defined(VULKANINFO_WSI_ENABLED)
static void AppDestroySurface(AppInstance &inst, VkSurfaceKHR surface) { // same for all platforms
vkDestroySurfaceKHR(inst.instance, surface, nullptr);
}
#endif // defined(VULKANINFO_WSI_ENABLED)
//-----------------------------------------------------------
//---------------------------Win32---------------------------
#ifdef VK_USE_PLATFORM_WIN32_KHR
// MS-Windows event handling function:
LRESULT CALLBACK WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam) {
return user32_handles->pfnDefWindowProcA(hWnd, uMsg, wParam, lParam);
}
static void AppCreateWin32Window(AppInstance &inst) {
inst.h_instance = GetModuleHandle(nullptr);
WNDCLASSEX win_class;
// Initialize the window class structure:
win_class.cbSize = sizeof(WNDCLASSEX);
win_class.style = CS_HREDRAW | CS_VREDRAW;
win_class.lpfnWndProc = WndProc;
win_class.cbClsExtra = 0;
win_class.cbWndExtra = 0;
win_class.hInstance = inst.h_instance;
win_class.hIcon = user32_handles->pfnLoadIconA(nullptr, IDI_APPLICATION);
win_class.hCursor = LoadCursor(nullptr, IDC_ARROW);
win_class.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH);
win_class.lpszMenuName = nullptr;
win_class.lpszClassName = APP_SHORT_NAME;
win_class.hInstance = inst.h_instance;
win_class.hIconSm = user32_handles->pfnLoadIconA(nullptr, IDI_WINLOGO);
// Register window class:
if (!user32_handles->pfnRegisterClassExA(&win_class)) {
// It didn't work, so try to give a useful error:
THROW_ERR("Failed to register the window class!");
}
// Create window with the registered class:
RECT wr = {0, 0, inst.width, inst.height};
user32_handles->pfnAdjustWindowRect(&wr, WS_OVERLAPPEDWINDOW, FALSE);
inst.h_wnd = user32_handles->pfnCreateWindowExA(0,
APP_SHORT_NAME, // class name
APP_SHORT_NAME, // app name
// WS_VISIBLE | WS_SYSMENU |
WS_OVERLAPPEDWINDOW, // window style
100, 100, // x/y coords
wr.right - wr.left, // width
wr.bottom - wr.top, // height
nullptr, // handle to parent
nullptr, // handle to menu
inst.h_instance, // hInstance
nullptr); // no extra parameters
if (!inst.h_wnd) {
// It didn't work, so try to give a useful error:
THROW_ERR("Failed to create a window!");
}
}
static VkSurfaceKHR AppCreateWin32Surface(AppInstance &inst) {
VkWin32SurfaceCreateInfoKHR createInfo;
createInfo.sType = VK_STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR;
createInfo.pNext = nullptr;
createInfo.flags = 0;
createInfo.hinstance = inst.h_instance;
createInfo.hwnd = inst.h_wnd;
VkSurfaceKHR surface;
VkResult err = vkCreateWin32SurfaceKHR(inst.instance, &createInfo, nullptr, &surface);
if (err) THROW_VK_ERR("vkCreateWin32SurfaceKHR", err);
return surface;
}
static void AppDestroyWin32Window(AppInstance &inst) { user32_handles->pfnDestroyWindow(inst.h_wnd); }
#endif // VK_USE_PLATFORM_WIN32_KHR
//-----------------------------------------------------------
//----------------------------XCB----------------------------
#ifdef VK_USE_PLATFORM_XCB_KHR
static void AppCreateXcbWindow(AppInstance &inst) {
//--Init Connection--
const xcb_setup_t *setup;
xcb_screen_iterator_t iter;
int scr;
// API guarantees non-null xcb_connection
inst.xcb_connection = xcb_connect(nullptr, &scr);
int conn_error = xcb_connection_has_error(inst.xcb_connection);
if (conn_error) {
fprintf(stderr, "XCB failed to connect to the X server due to error:%d.\n", conn_error);
fflush(stderr);
xcb_disconnect(inst.xcb_connection);
inst.xcb_connection = nullptr;
return;
}
setup = xcb_get_setup(inst.xcb_connection);
iter = xcb_setup_roots_iterator(setup);
while (scr-- > 0) {
xcb_screen_next(&iter);
}
inst.xcb_screen = iter.data;
//-------------------
inst.xcb_window = xcb_generate_id(inst.xcb_connection);
xcb_create_window(inst.xcb_connection, XCB_COPY_FROM_PARENT, inst.xcb_window, inst.xcb_screen->root, 0, 0, inst.width,
inst.height, 0, XCB_WINDOW_CLASS_INPUT_OUTPUT, inst.xcb_screen->root_visual, 0, nullptr);
xcb_intern_atom_cookie_t cookie = xcb_intern_atom(inst.xcb_connection, 1, 12, "WM_PROTOCOLS");
xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(inst.xcb_connection, cookie, 0);
free(reply);
}
static VkSurfaceKHR AppCreateXcbSurface(AppInstance &inst) {
if (!inst.xcb_connection) {
THROW_ERR("AppCreateXcbSurface failed to establish connection");
}
VkXcbSurfaceCreateInfoKHR xcb_createInfo;
xcb_createInfo.sType = VK_STRUCTURE_TYPE_XCB_SURFACE_CREATE_INFO_KHR;
xcb_createInfo.pNext = nullptr;
xcb_createInfo.flags = 0;
xcb_createInfo.connection = inst.xcb_connection;
xcb_createInfo.window = inst.xcb_window;
VkSurfaceKHR surface;
VkResult err = vkCreateXcbSurfaceKHR(inst.instance, &xcb_createInfo, nullptr, &surface);
if (err) THROW_VK_ERR("vkCreateXcbSurfaceKHR", err);
return surface;
}
static void AppDestroyXcbWindow(AppInstance &inst) {
if (!inst.xcb_connection) {
return; // Nothing to destroy
}
xcb_destroy_window(inst.xcb_connection, inst.xcb_window);
xcb_disconnect(inst.xcb_connection);
}
#endif // VK_USE_PLATFORM_XCB_KHR
//-----------------------------------------------------------
//----------------------------XLib---------------------------
#ifdef VK_USE_PLATFORM_XLIB_KHR
static void AppCreateXlibWindow(AppInstance &inst) {
long visualMask = VisualScreenMask;
int numberOfVisuals{};
inst.xlib_display = XOpenDisplay(nullptr);
if (inst.xlib_display == nullptr) {
THROW_ERR("XLib failed to connect to the X server.\nExiting...");
}
XVisualInfo vInfoTemplate = {};
vInfoTemplate.screen = DefaultScreen(inst.xlib_display);
XVisualInfo *visualInfoBegin = XGetVisualInfo(inst.xlib_display, visualMask, &vInfoTemplate, &numberOfVisuals);
XVisualInfo *visualInfoEnd = visualInfoBegin + numberOfVisuals;
const Visual *rootVisual = DefaultVisual(inst.xlib_display, vInfoTemplate.screen);
const XVisualInfo *foundVisualInfo =
std::find_if(visualInfoBegin, visualInfoEnd, [rootVisual](const XVisualInfo &vi) { return vi.visual == rootVisual; });
const XVisualInfo *visualInfo = foundVisualInfo == visualInfoEnd ? visualInfoBegin : foundVisualInfo;
inst.xlib_window = XCreateWindow(inst.xlib_display, RootWindow(inst.xlib_display, vInfoTemplate.screen), 0, 0, inst.width,
inst.height, 0, visualInfo->depth, InputOutput, visualInfo->visual, 0, nullptr);
XSync(inst.xlib_display, false);
XFree(visualInfoBegin);
}
static VkSurfaceKHR AppCreateXlibSurface(AppInstance &inst) {
VkXlibSurfaceCreateInfoKHR createInfo;
createInfo.sType = VK_STRUCTURE_TYPE_XLIB_SURFACE_CREATE_INFO_KHR;
createInfo.pNext = nullptr;
createInfo.flags = 0;
createInfo.dpy = inst.xlib_display;
createInfo.window = inst.xlib_window;
VkSurfaceKHR surface;
VkResult err = vkCreateXlibSurfaceKHR(inst.instance, &createInfo, nullptr, &surface);
if (err) THROW_VK_ERR("vkCreateXlibSurfaceKHR", err);
return surface;
}
static void AppDestroyXlibWindow(AppInstance &inst) {
XDestroyWindow(inst.xlib_display, inst.xlib_window);
XCloseDisplay(inst.xlib_display);
}
#endif // VK_USE_PLATFORM_XLIB_KHR
//-----------------------------------------------------------
//------------------------MACOS_MVK--------------------------
#ifdef VK_USE_PLATFORM_MACOS_MVK
static void AppCreateMacOSWindow(AppInstance &inst) {
inst.macos_window = CreateMetalView(inst.width, inst.height);
if (inst.macos_window == nullptr) {
THROW_ERR("Could not create a native Metal view.\nExiting...");
}
}
static VkSurfaceKHR AppCreateMacOSSurface(AppInstance &inst) {
VkMacOSSurfaceCreateInfoMVK createInfo;
createInfo.sType = VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK;
createInfo.pNext = nullptr;
createInfo.flags = 0;
createInfo.pView = inst.macos_window;
VkSurfaceKHR surface;
VkResult err = vkCreateMacOSSurfaceMVK(inst.instance, &createInfo, nullptr, &surface);
if (err) THROW_VK_ERR("vkCreateMacOSSurfaceMVK", err);
return surface;
}
static void AppDestroyMacOSWindow(AppInstance &inst) { DestroyMetalView(inst.macos_window); }
#endif // VK_USE_PLATFORM_MACOS_MVK
//-----------------------------------------------------------
//------------------------METAL_EXT--------------------------
#ifdef VK_USE_PLATFORM_METAL_EXT
static void AppCreateMetalWindow(AppInstance &inst) {
inst.metal_window = CreateMetalView(inst.width, inst.height);
if (inst.metal_window == nullptr) {
THROW_ERR("Could not create a native Metal view.\nExiting...");
}
}
static VkSurfaceKHR AppCreateMetalSurface(AppInstance &inst) {
VkMetalSurfaceCreateInfoEXT createInfo;
createInfo.sType = VK_STRUCTURE_TYPE_METAL_SURFACE_CREATE_INFO_EXT;
createInfo.pNext = nullptr;
createInfo.flags = 0;
createInfo.pLayer = static_cast<CAMetalLayer *>(GetCAMetalLayerFromMetalView(inst.metal_window));
VkSurfaceKHR surface;
VkResult err = vkCreateMetalSurfaceEXT(inst.instance, &createInfo, nullptr, &surface);
if (err) THROW_VK_ERR("vkCreateMetalSurfaceEXT", err);
return surface;
}
static void AppDestroyMetalWindow(AppInstance &inst) { DestroyMetalView(inst.metal_window); }
#endif // VK_USE_PLATFORM_METAL_EXT
//-----------------------------------------------------------
//-------------------------WAYLAND---------------------------
#ifdef VK_USE_PLATFORM_WAYLAND_KHR
static void wayland_registry_global(void *data, struct wl_registry *registry, uint32_t id, const char *interface,
uint32_t version) {
AppInstance &inst = *static_cast<AppInstance *>(data);
if (strcmp(interface, "wl_compositor") == 0) {
struct wl_compositor *compositor = (struct wl_compositor *)wl_registry_bind(registry, id, &wl_compositor_interface, 1);
inst.wayland_surface = wl_compositor_create_surface(compositor);
}
}
static void wayland_registry_global_remove(void *data, struct wl_registry *registry, uint32_t id) {}
static const struct wl_registry_listener wayland_registry_listener = {wayland_registry_global, wayland_registry_global_remove};