annotate svk/api.nim @ 1486:0ba3f0b2be2e default tip main

did: more
author sam <sam@basx.dev>
date Sat, 03 May 2025 20:16:04 +0700
parents 6e062a84c157
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
1 import std/strutils
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
2 import std/logging
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
3 import std/os
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
4
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
5 include ./vkapi
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
6
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
7 const VULKAN_VERSION = VK_MAKE_API_VERSION(0, 1, 3, 0)
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
8
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
9 template checkVkResult*(call: untyped) =
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
10 when defined(release):
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
11 discard call
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
12 else:
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
13 # yes, a bit cheap, but this is only for nice debug output
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
14 var callstr = astToStr(call).replace("\n", "")
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
15 while callstr.find(" ") >= 0:
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
16 callstr = callstr.replace(" ", " ")
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
17 debug "Calling vulkan: ", callstr
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
18 let value = call
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
19 if value != VK_SUCCESS:
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
20 error "Vulkan error: ", astToStr(call), " returned ", $value
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
21 raise newException(
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
22 Exception, "Vulkan error: " & astToStr(call) & " returned " & $value
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
23 )
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
24
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
25 type SVkInstance* = object
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
26 vkInstance: VkInstance
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
27 debugMessenger: VkDebugUtilsMessengerEXT
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
28
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
29 proc `=copy`(a: var SVkInstance, b: SVkInstance) {.error.}
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
30
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
31 proc `=destroy`(a: SVkInstance) =
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
32 if a.vkInstance.pointer != nil:
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
33 if a.debugMessenger.pointer != nil:
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
34 vkDestroyDebugUtilsMessengerEXT(a.vkInstance, a.debugMessenger, nil)
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
35 a.vkInstance.vkDestroyInstance(nil)
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
36
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
37 proc debugCallback(
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
38 messageSeverity: VkDebugUtilsMessageSeverityFlagBitsEXT,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
39 messageTypes: VkDebugUtilsMessageTypeFlagsEXT,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
40 pCallbackData: ptr VkDebugUtilsMessengerCallbackDataEXT,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
41 userData: pointer,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
42 ): VkBool32 {.cdecl.} =
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
43 const LOG_LEVEL_MAPPING = {
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
44 VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT: lvlDebug,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
45 VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT: lvlInfo,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
46 VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT: lvlWarn,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
47 VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT: lvlError,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
48 }.toTable
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
49 log LOG_LEVEL_MAPPING[messageSeverity]
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
50 if messageSeverity == VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT:
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
51 # stderr.write getStackTrace()
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
52 # stderr.writeLine LOG_LEVEL_MAPPING[messageSeverity], &"{toEnums messageTypes}: {pCallbackData.pMessage}"
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
53 let errorMsg = $pCallbackData.pMessage & ": " & getStackTrace()
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
54 raise newException(Exception, errorMsg)
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
55 return VK_FALSE
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
56
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
57 proc svkCreateInstance*(
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
58 applicationName: string,
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
59 enabledLayers: openArray[string] = [],
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
60 enabledExtensions: openArray[string] =
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
61 if defined(release):
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
62 @["VK_KHR_surface"]
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
63 else:
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
64 @["VK_KHR_surface", "VK_EXT_debug_utils"],
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
65 engineName = "semicongine",
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
66 withSwapchain = true,
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
67 ): SVkInstance =
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
68 putEnv("VK_LOADER_LAYERS_ENABLE", "*validation")
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
69 putEnv(
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
70 "VK_LAYER_ENABLES",
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
71 "VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_AMD,VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_NVIDIA,VK_VALIDATION_FEATURE_ENABLE_SYNCHRONIZATION_VALIDATION_EXTVK_VALIDATION_FEATURE_ENABLE_GPU_ASSISTED_EXT,VK_VALIDATION_FEATURE_ENABLE_SYNCHRONIZATION_VALIDATION_EXT",
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
72 )
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
73 initVulkanLoader()
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
74
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
75 let
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
76 appinfo = VkApplicationInfo(
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
77 pApplicationName: applicationName,
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
78 pEngineName: engineName,
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
79 apiVersion: VULKAN_VERSION,
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
80 )
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
81 enabledLayersC = allocCStringArray(enabledLayers)
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
82 enabledExtensionsC = allocCStringArray(enabledExtensions)
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
83 createinfo = VkInstanceCreateInfo(
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
84 pApplicationInfo: addr appinfo,
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
85 enabledLayerCount: enabledLayers.len.uint32,
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
86 ppEnabledLayerNames: enabledLayersC,
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
87 enabledExtensionCount: enabledExtensions.len.uint32,
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
88 ppEnabledExtensionNames: enabledExtensionsC,
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
89 )
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
90 # this one we will load manually
1485
6e062a84c157 add: more api-starting
sam <sam@basx.dev>
parents:
diff changeset
91 checkVkResult vkCreateInstance(addr createinfo, nil, addr result.vkInstance)
1486
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
92
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
93 enabledLayersC.deallocCStringArray()
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
94 enabledExtensionsC.deallocCStringArray()
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
95
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
96 load_VK_VERSION_1_0(result.vkInstance)
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
97 load_VK_VERSION_1_1(result.vkInstance)
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
98 load_VK_VERSION_1_2(result.vkInstance)
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
99 load_VK_VERSION_1_3(result.vkInstance)
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
100
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
101 for extension in enabledExtensions:
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
102 loadExtension(result.vkInstance, extension)
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
103 if withSwapchain:
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
104 load_VK_KHR_swapchain(result.vkInstance)
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
105
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
106 when not defined(release):
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
107 var debugMessengerCreateInfo = VkDebugUtilsMessengerCreateInfoEXT(
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
108 messageSeverity: VkDebugUtilsMessageSeverityFlagBitsEXT.items.toSeq.toBits,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
109 messageType: VkDebugUtilsMessageTypeFlagBitsEXT.items.toSeq.toBits,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
110 pfnUserCallback: debugCallback,
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
111 )
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
112 checkVkResult vkCreateDebugUtilsMessengerEXT(
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
113 result.vkInstance, addr debugMessengerCreateInfo, nil, addr result.debugMessenger
0ba3f0b2be2e did: more
sam <sam@basx.dev>
parents: 1485
diff changeset
114 )