annotate src/vulkan_helpers.nim @ 473:04b8471bdab4

did: cleanup up a bit
author Sam <sam@basx.dev>
date Tue, 27 Dec 2022 20:47:48 +0700
parents 9eeaeb35eb1c
children b40466fa446a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
462
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
1 import std/tables
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
2 import std/strutils
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
3 import std/strformat
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
4 import std/logging
471
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
5 import std/macros
462
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
6
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
7 import ./glslang/glslang
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
8 import ./vulkan
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
9 import ./window
462
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
10
471
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
11
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
12 const ENABLEVULKANVALIDATIONLAYERS* = not defined(release)
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
13
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
14
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
15 template checkVkResult*(call: untyped) =
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
16 when defined(release):
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
17 discard call
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
18 else:
471
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
19 debug "CALLING vulkan: ", astToStr(call)
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
20 let value = call
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
21 if value != VK_SUCCESS:
471
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
22 error "Vulkan error: ", astToStr(call), " returned ", $value
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
23 raise newException(Exception, "Vulkan error: " & astToStr(call) & " returned " & $value)
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
24
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
25 func addrOrNil[T](obj: var openArray[T]): ptr T =
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
26 if obj.len > 0: addr(obj[0]) else: nil
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
27
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
28 proc VK_MAKE_API_VERSION*(variant: uint32, major: uint32, minor: uint32, patch: uint32): uint32 {.compileTime.} =
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
29 (variant shl 29) or (major shl 22) or (minor shl 12) or patch
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
30
462
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
31
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
32 proc filterForSurfaceFormat*(formats: seq[VkSurfaceFormatKHR]): seq[VkSurfaceFormatKHR] =
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
33 for format in formats:
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
34 if format.format == VK_FORMAT_B8G8R8A8_SRGB and format.colorSpace == VK_COLOR_SPACE_SRGB_NONLINEAR_KHR:
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
35 result.add(format)
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
36
465
2fcb9268072b did: refactor, add resizing, proper cleanup
Sam <sam@basx.dev>
parents: 463
diff changeset
37 proc getSuitableSurfaceFormat*(formats: seq[VkSurfaceFormatKHR]): VkSurfaceFormatKHR =
2fcb9268072b did: refactor, add resizing, proper cleanup
Sam <sam@basx.dev>
parents: 463
diff changeset
38 let usableSurfaceFormats = filterForSurfaceFormat(formats)
2fcb9268072b did: refactor, add resizing, proper cleanup
Sam <sam@basx.dev>
parents: 463
diff changeset
39 if len(usableSurfaceFormats) == 0:
2fcb9268072b did: refactor, add resizing, proper cleanup
Sam <sam@basx.dev>
parents: 463
diff changeset
40 raise newException(Exception, "No suitable surface formats found")
2fcb9268072b did: refactor, add resizing, proper cleanup
Sam <sam@basx.dev>
parents: 463
diff changeset
41 return usableSurfaceFormats[0]
2fcb9268072b did: refactor, add resizing, proper cleanup
Sam <sam@basx.dev>
parents: 463
diff changeset
42
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
43
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
44 proc cleanString*(str: openArray[char]): string =
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
45 for i in 0 ..< len(str):
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
46 if str[i] == char(0):
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
47 result = join(str[0 ..< i])
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
48 break
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
49
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
50 proc getInstanceExtensions*(): seq[string] =
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
51 var extensionCount: uint32
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
52 checkVkResult vkEnumerateInstanceExtensionProperties(nil, addr(extensionCount), nil)
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
53 var extensions = newSeq[VkExtensionProperties](extensionCount)
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
54 checkVkResult vkEnumerateInstanceExtensionProperties(nil, addr(extensionCount), addrOrNil(extensions))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
55
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
56 for extension in extensions:
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
57 result.add(cleanString(extension.extensionName))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
58
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
59
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
60 proc getDeviceExtensions*(device: VkPhysicalDevice): seq[string] =
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
61 var extensionCount: uint32
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
62 checkVkResult vkEnumerateDeviceExtensionProperties(device, nil, addr(extensionCount), nil)
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
63 var extensions = newSeq[VkExtensionProperties](extensionCount)
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
64 checkVkResult vkEnumerateDeviceExtensionProperties(device, nil, addr(extensionCount), addrOrNil(extensions))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
65
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
66 for extension in extensions:
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
67 result.add(cleanString(extension.extensionName))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
68
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
69
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
70 proc getValidationLayers*(): seq[string] =
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
71 var n_layers: uint32
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
72 checkVkResult vkEnumerateInstanceLayerProperties(addr(n_layers), nil)
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
73 var layers = newSeq[VkLayerProperties](n_layers)
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
74 checkVkResult vkEnumerateInstanceLayerProperties(addr(n_layers), addrOrNil(layers))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
75
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
76 for layer in layers:
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
77 result.add(cleanString(layer.layerName))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
78
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
79
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
80 proc getVulkanPhysicalDevices*(instance: VkInstance): seq[VkPhysicalDevice] =
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
81 var n_devices: uint32
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
82 checkVkResult vkEnumeratePhysicalDevices(instance, addr(n_devices), nil)
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
83 result = newSeq[VkPhysicalDevice](n_devices)
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
84 checkVkResult vkEnumeratePhysicalDevices(instance, addr(n_devices), addrOrNil(result))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
85
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
86
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
87 proc getQueueFamilies*(device: VkPhysicalDevice): seq[VkQueueFamilyProperties] =
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
88 var n_queuefamilies: uint32
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
89 vkGetPhysicalDeviceQueueFamilyProperties(device, addr(n_queuefamilies), nil)
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
90 result = newSeq[VkQueueFamilyProperties](n_queuefamilies)
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
91 vkGetPhysicalDeviceQueueFamilyProperties(device, addr(n_queuefamilies), addrOrNil(result))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
92
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
93
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
94 proc getDeviceSurfaceFormats*(device: VkPhysicalDevice, surface: VkSurfaceKHR): seq[VkSurfaceFormatKHR] =
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
95 var n_formats: uint32
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
96 checkVkResult vkGetPhysicalDeviceSurfaceFormatsKHR(device, surface, addr(n_formats), nil);
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
97 result = newSeq[VkSurfaceFormatKHR](n_formats)
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
98 checkVkResult vkGetPhysicalDeviceSurfaceFormatsKHR(device, surface, addr(n_formats), addrOrNil(result))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
99
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
100
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
101 proc getDeviceSurfacePresentModes*(device: VkPhysicalDevice, surface: VkSurfaceKHR): seq[VkPresentModeKHR] =
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
102 var n_modes: uint32
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
103 checkVkResult vkGetPhysicalDeviceSurfacePresentModesKHR(device, surface, addr(n_modes), nil);
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
104 result = newSeq[VkPresentModeKHR](n_modes)
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
105 checkVkResult vkGetPhysicalDeviceSurfacePresentModesKHR(device, surface, addr(n_modes), addrOrNil(result))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
106
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
107
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
108 proc getSwapChainImages*(device: VkDevice, swapChain: VkSwapchainKHR): seq[VkImage] =
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
109 var n_images: uint32
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
110 checkVkResult vkGetSwapchainImagesKHR(device, swapChain, addr(n_images), nil);
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
111 result = newSeq[VkImage](n_images)
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
112 checkVkResult vkGetSwapchainImagesKHR(device, swapChain, addr(n_images), addrOrNil(result));
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
113
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
114
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
115 proc getPresentMode*(modes: seq[VkPresentModeKHR]): VkPresentModeKHR =
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
116 let preferredModes = [
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
117 VK_PRESENT_MODE_MAILBOX_KHR, # triple buffering
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
118 VK_PRESENT_MODE_FIFO_RELAXED_KHR, # double duffering
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
119 VK_PRESENT_MODE_FIFO_KHR, # double duffering
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
120 VK_PRESENT_MODE_IMMEDIATE_KHR, # single buffering
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
121 ]
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
122 for preferredMode in preferredModes:
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
123 for mode in modes:
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
124 if preferredMode == mode:
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
125 return mode
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
126 # should never be reached, but seems to be garuanteed by vulkan specs to always be available
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
127 return VK_PRESENT_MODE_FIFO_KHR
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
128
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
129
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
130 proc createVulkanInstance*(vulkanVersion: uint32): VkInstance =
471
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
131
473
04b8471bdab4 did: cleanup up a bit
Sam <sam@basx.dev>
parents: 471
diff changeset
132 var requiredExtensions = @["VK_KHR_surface".cstring]
471
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
133 when defined(linux):
473
04b8471bdab4 did: cleanup up a bit
Sam <sam@basx.dev>
parents: 471
diff changeset
134 requiredExtensions.add("VK_KHR_xlib_surface".cstring)
471
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
135 when defined(windows):
473
04b8471bdab4 did: cleanup up a bit
Sam <sam@basx.dev>
parents: 471
diff changeset
136 requiredExtensions.add("VK_KHR_win32_surface".cstring)
04b8471bdab4 did: cleanup up a bit
Sam <sam@basx.dev>
parents: 471
diff changeset
137 when ENABLEVULKANVALIDATIONLAYERS:
04b8471bdab4 did: cleanup up a bit
Sam <sam@basx.dev>
parents: 471
diff changeset
138 requiredExtensions.add("VK_EXT_debug_utils".cstring)
471
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
139
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
140 let availableExtensions = getInstanceExtensions()
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
141 for extension in requiredExtensions:
471
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
142 assert $extension in availableExtensions, $extension
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
143
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
144 let availableLayers = getValidationLayers()
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
145 var usableLayers = newSeq[cstring]()
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
146
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
147 when ENABLEVULKANVALIDATIONLAYERS:
473
04b8471bdab4 did: cleanup up a bit
Sam <sam@basx.dev>
parents: 471
diff changeset
148 const desiredLayers = ["VK_LAYER_KHRONOS_validation".cstring, "VK_LAYER_MESA_overlay".cstring]
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
149 for layer in desiredLayers:
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
150 if $layer in availableLayers:
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
151 usableLayers.add(layer)
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
152
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
153 echo "Available validation layers: ", availableLayers
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
154 echo "Using validation layers: ", usableLayers
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
155 echo "Available extensions: ", availableExtensions
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
156 echo "Using extensions: ", requiredExtensions
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
157
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
158 var appinfo = VkApplicationInfo(
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
159 sType: VK_STRUCTURE_TYPE_APPLICATION_INFO,
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
160 pApplicationName: "Hello Triangle",
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
161 pEngineName: "Custom engine",
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
162 apiVersion: vulkanVersion,
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
163 )
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
164 var createinfo = VkInstanceCreateInfo(
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
165 sType: VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO,
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
166 pApplicationInfo: addr(appinfo),
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
167 enabledLayerCount: usableLayers.len.uint32,
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
168 ppEnabledLayerNames: cast[ptr UncheckedArray[cstring]](addrOrNil(usableLayers)),
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
169 enabledExtensionCount: requiredExtensions.len.uint32,
473
04b8471bdab4 did: cleanup up a bit
Sam <sam@basx.dev>
parents: 471
diff changeset
170 ppEnabledExtensionNames: cast[ptr UncheckedArray[cstring]](addr(requiredExtensions[0]))
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
171 )
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
172 checkVkResult vkCreateInstance(addr(createinfo), nil, addr(result))
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
173
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
174 loadVK_KHR_surface()
471
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
175 when defined(linux):
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
176 loadVK_KHR_xlib_surface()
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
177 when defined(windows):
9eeaeb35eb1c did: make it work on windows
sam <sam@basx.dev>
parents: 466
diff changeset
178 loadVK_KHR_win32_surface()
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
179 loadVK_KHR_swapchain()
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
180 when ENABLEVULKANVALIDATIONLAYERS:
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
181 loadVK_EXT_debug_utils(result)
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
182
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
183
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
184 proc getVulcanDevice*(
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
185 physicalDevice: var VkPhysicalDevice,
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
186 features: var VkPhysicalDeviceFeatures,
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
187 graphicsQueueFamily: uint32,
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
188 presentationQueueFamily: uint32,
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
189 ): (VkDevice, VkQueue, VkQueue) =
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
190 # setup queue and device
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
191 # TODO: need check this, possibly wrong logic, see Vulkan tutorial
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
192 var priority = 1.0'f32
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
193 var queueCreateInfo = [
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
194 VkDeviceQueueCreateInfo(
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
195 sType: VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO,
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
196 queueFamilyIndex: graphicsQueueFamily,
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
197 queueCount: 1,
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
198 pQueuePriorities: addr(priority),
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
199 ),
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
200 ]
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
201
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
202 var requiredExtensions = ["VK_KHR_swapchain".cstring]
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
203 var deviceCreateInfo = VkDeviceCreateInfo(
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
204 sType: VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO,
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
205 queueCreateInfoCount: uint32(queueCreateInfo.len),
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
206 pQueueCreateInfos: addrOrNil(queueCreateInfo),
461
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
207 pEnabledFeatures: addr(features),
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
208 enabledExtensionCount: requiredExtensions.len.uint32,
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
209 ppEnabledExtensionNames: cast[ptr UncheckedArray[cstring]](addr(requiredExtensions))
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
210 )
59d861a6a5c4 add: initial version
Sam <sam@basx.dev>
parents:
diff changeset
211 checkVkResult vkCreateDevice(physicalDevice, addr(deviceCreateInfo), nil, addr(result[0]))
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
212 vkGetDeviceQueue(result[0], graphicsQueueFamily, 0'u32, addr(result[1]));
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
213 vkGetDeviceQueue(result[0], presentationQueueFamily, 0'u32, addr(result[2]));
462
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
214
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
215 proc createShaderStage*(device: VkDevice, stage: VkShaderStageFlagBits, shader: string): VkPipelineShaderStageCreateInfo =
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
216 const VK_GLSL_MAP = {
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
217 VK_SHADER_STAGE_VERTEX_BIT: GLSLANG_STAGE_VERTEX,
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
218 VK_SHADER_STAGE_FRAGMENT_BIT: GLSLANG_STAGE_FRAGMENT,
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
219 }.toTable()
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
220 var code = compileGLSLToSPIRV(VK_GLSL_MAP[stage], shader, "<memory-shader>")
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
221 var createInfo = VkShaderModuleCreateInfo(
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
222 sType: VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO,
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
223 codeSize: uint(code.len * sizeof(uint32)),
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
224 pCode: addrOrNil(code),
462
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
225 )
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
226 var shaderModule: VkShaderModule
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
227 checkVkResult vkCreateShaderModule(device, addr(createInfo), nil, addr(shaderModule))
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
228
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
229 return VkPipelineShaderStageCreateInfo(
462
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
230 sType: VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO,
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
231 stage: stage,
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
232 module: shaderModule,
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
233 pName: "main", # entry point for shader
0bc8643cfe25 add: more steps in setup
Sam <sam@basx.dev>
parents: 461
diff changeset
234 )
463
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
235
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
236 proc debugCallback*(
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
237 messageSeverity: VkDebugUtilsMessageSeverityFlagBitsEXT,
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
238 messageTypes: VkDebugUtilsMessageTypeFlagsEXT,
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
239 pCallbackData: VkDebugUtilsMessengerCallbackDataEXT,
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
240 userData: pointer
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
241 ): VkBool32 {.cdecl.} =
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
242 echo &"{messageSeverity}: {VkDebugUtilsMessageTypeFlagBitsEXT(messageTypes)}: {pCallbackData.pMessage}"
91544fc1afe5 did: hello world triangle, a bit of code organization
Sam <sam@basx.dev>
parents: 462
diff changeset
243 return VK_FALSE
466
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
244
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
245 proc getSurfaceCapabilities*(device: VkPhysicalDevice, surface: VkSurfaceKHR): VkSurfaceCapabilitiesKHR =
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
246 checkVkResult device.vkGetPhysicalDeviceSurfaceCapabilitiesKHR(surface, addr(result))
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
247
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
248 when defined(linux):
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
249 proc createVulkanSurface*(instance: VkInstance, window: NativeWindow): VkSurfaceKHR =
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
250 var surfaceCreateInfo = VkXlibSurfaceCreateInfoKHR(
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
251 sType: VK_STRUCTURE_TYPE_XLIB_SURFACE_CREATE_INFO_KHR,
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
252 dpy: window.display,
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
253 window: window.window,
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
254 )
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
255 checkVkResult vkCreateXlibSurfaceKHR(instance, addr(surfaceCreateInfo), nil, addr(result))
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
256 when defined(windows):
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
257 proc createVulkanSurface*(instance: VkInstance, window: NativeWindow): VkSurfaceKHR =
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
258 var surfaceCreateInfo = VkWin32SurfaceCreateInfoKHR(
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
259 sType: VK_STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR,
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
260 hinstance: window.hinstance,
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
261 hwnd: window.hwnd,
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
262 )
1dd9e2393a9e add: structure code for crossplatform, add some input handling + bugfixes
Sam <sam@basx.dev>
parents: 465
diff changeset
263 checkVkResult vkCreateWin32SurfaceKHR(instance, addr(surfaceCreateInfo), nil, addr(result))