在Vulkan-hpp中有助于將錯(cuò)誤轉(zhuǎn)移到編譯時(shí)的特性

在專業(yè)軟件開發(fā)中，最重要的一個(gè)方面就是盡早發(fā)現(xiàn)錯(cuò)誤。當(dāng)然，最好的情況是我們甚至不能編寫錯(cuò)誤的代碼。其次最好的是編譯器可以檢測到的錯(cuò)誤。

最壞的情況是運(yùn)行時(shí)錯(cuò)誤。最難的部分隱藏在只在特定情況下運(yùn)行的代碼中。墨菲定律說，這種情況首次發(fā)生在顧客的環(huán)境中。

如果您使用的是 Vulkan ，有幾種方法可以創(chuàng)建運(yùn)行時(shí)錯(cuò)誤。即使 Vulkan 提供了很好的驗(yàn)證層，您也必須運(yùn)行這部分代碼來檢測此類錯(cuò)誤。順便說一句，我建議你不要在沒有使用驗(yàn)證層的情況下用 Vulkan 編程！

當(dāng)使用 Vulkan – hpp 時(shí)，一些運(yùn)行時(shí)錯(cuò)誤變成編譯時(shí)錯(cuò)誤 。 Vulkan -HPP 是針對 Vulkan API 的頭報(bào)頭 C ++綁定。它由 Khronos 維護(hù)，作為 Vulkan 生態(tài)系統(tǒng)的一部分，可以在 GitHub 上找到 Khronos Group / Vulkan – hpp 。它也是 LunargVulkan SDK 的一部分。

有助于將錯(cuò)誤轉(zhuǎn)移到編譯時(shí)的特性

Vulkan -hpp 通過以下功能幫助消除運(yùn)行時(shí)錯(cuò)誤：

枚舉類與普通枚舉比較

幫助程序類 vk：：Flags

結(jié)構(gòu) 常量成員 sType

vk：：StructureChain

處理 32 位版本中的 類型安全

枚舉類

使用 Vulkan ，可以得到很多枚舉類型。除了 VkResult ，它們都是使用以下命名方案構(gòu)造的：

typedef enum VkEnumName {
 VK_ENUM_NAME_VALUE_A = 0,
 VK_ENUM_NAME_VALUE_B = 1,
 …
} VkEnumName;

使用 Vulkan -hpp ，可以為這些枚舉類型中的每一種獲得一個(gè)枚舉類：

namespace vk
{
 …
 enum class EnumName
 {
 eValueA = VK_ENUM_NAME_VALUE_A,
 eValueB = VK_ENUM_NAME_VALUE_B,
 …
 };
 …
}

首先，它們都位于名稱空間 vk 。您可以通過定義 VULKAN_HPP_NAMESPACE 來調(diào)整該命名空間。 enum 類本身沒有前綴 Vk ，因?yàn)檫@對于命名空間來說是多余的。最后，一個(gè) enum 類的每個(gè)值都跳過前綴 VK_ENUM_NAME ，因?yàn)檫@個(gè)前綴又與命名空間和枚舉類名冗余。它們以小寫字母“ e ”作為前綴，并包含實(shí)際枚舉值名稱的 camelCase 版本。枚舉類值不允許以數(shù)字開頭，因此“ e ”前綴阻止了這一點(diǎn)。例如，無論你在 C 代碼中使用 VK_ENUM_NAME_VALUE_A ，都使用 vk：：EnumName：：eValueA 代替 C ++代碼。

那么，你從 Vulkan -hpp 中的 enum 類得到了什么呢？畢竟，由于 Vulkan 中的枚舉值命名方案，不可能有兩個(gè)同名的枚舉值。這根本不是你的問題，而是 Khronos 的 Vulkan 人的問題。此外，您不太可能希望將變量或函數(shù)作為枚舉值之一命名，即使這些名稱已導(dǎo)出到全局范圍。誰知道呢？有人喜歡函數(shù)名，比如 MIG 。

這里重要的一點(diǎn)是，在 Vulkan -hpp 中，沒有隱式轉(zhuǎn)換到 int 。不能將枚舉類值賦給 int 類型，至少不會(huì)意外。也不能比較來自不同枚舉類的兩個(gè)枚舉類值。當(dāng)您比較兩個(gè)枚舉器中的兩個(gè)枚舉值時(shí)，會(huì)產(chǎn)生警告。 MIG 是依賴于編譯器的，當(dāng)然，一個(gè)警告比錯(cuò)誤更容易被忽略。

助手類 vk ：： Flags

對于 Vulkan ，有兩個(gè)數(shù)據(jù)類型對，使用以下命名方案：

typedef enum VkEnumNameFlagBits = {
 VK_ENUM_NAME_VALUE_A_BIT = 0x00000001,
 VK_ENUM_NAME_VALUE_B_BIT = 0x00000002,
 …
} VkEnumNameFlagBits;
typedef VkFlags VkEnumNameFlags;

這里， VkFlags 只是一個(gè) uint32_t ，并且 VkEnumNameFlags 應(yīng)該通過從 VkEnumNameFlagBits 中對適當(dāng)?shù)拿杜e值進(jìn)行排序來保存相應(yīng)枚舉 VkEnumNameFlagBits 的零個(gè)或多個(gè)值。由于* FlagBits 和* Flags 之間除了它們的公共名稱部分之外，沒有真正的聯(lián)系，編譯器對此無能為力。允許對任意枚舉值或整數(shù)應(yīng)用位運(yùn)算符。如果錯(cuò)誤組合的* Flags 值恰好是位的有效組合，即使它們可能不是您所希望的那樣，即使驗(yàn)證層 MIG ht 也無法捕捉到這一點(diǎn)。它 MIG 感覺你像是在未定義的行為領(lǐng)域，即使程序完全按照你告訴它做的去做。這不是你想讓它做的。

使用 Vulkan -hpp ，可以得到相應(yīng)的對：

namespace vk
{
 …
 enum class EnumNameFlagBits : VkEnumNameFlagBits
 {
 eValueA = VK_ENUM_NAME_VALUE_A_BIT,
 eValueB = VK_ENUM_NAME_VALUE_B_BIT,
 …
 };
 using EnumNameFlags = Flags;
 …
}

有了這個(gè)結(jié)構(gòu)，這樣的尷尬局面就不會(huì)發(fā)生了。不能對枚舉類值應(yīng)用位運(yùn)算符。 vk：：EnumNameFlags 枚舉知道相應(yīng)的 vk：：EnumNameFlagBits 。 helper 類 vk：：Flags 提供的功能允許您對來自同一個(gè)枚舉類的枚舉類值應(yīng)用位運(yùn)算符，但僅對這些值應(yīng)用這些值。不能將它們與來自不同枚舉類的值組合。在編譯時(shí)，只使用允許的標(biāo)志位構(gòu)造標(biāo)志。

結(jié)構(gòu)的 sType 成員

稍微遠(yuǎn)離枚舉， Vulkan 中有許多結(jié)構(gòu)將枚舉類型 VkStructureType 的成員 sType 作為第一個(gè)元素。對于這些結(jié)構(gòu)中的每一個(gè)，都必須將該成員設(shè)置為為為該結(jié)構(gòu)指定的值。在下面的代碼示例中，成員 sType 必須設(shè)置為 VK_STRUCTURE_TYPE_STRUCT_NAME 。

typedef struct VkStructName {
 VkStructureType sType;
 …
} VkStructName;

沒那么難，但你必須做對。不要忘記設(shè)置它，也不要通過從代碼中的另一個(gè)位置復(fù)制來將其設(shè)置為錯(cuò)誤的值。例如，以下值在視覺上接近：

• VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO
• VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO

對于 Vulkan -hpp ，在結(jié)構(gòu)上有以下限制：

namespace vk
{
 …
 struct StructName
 {
 …
 const vk::StructureType sType = vk::StructureType::eStructName;
 …
 };
 …
}

就這么簡單。當(dāng)您實(shí)例化類型為 StructName 的結(jié)構(gòu)時(shí)，您不必?fù)?dān)心為成員 sType 設(shè)置正確的值，因?yàn)樗呀?jīng)設(shè)置好了。因?yàn)樗浅Ａ砍蓡T，所以不能意外地覆蓋它。

對于感興趣的模板元程序員來說： struct StructName 還提供了一個(gè)靜態(tài)成員 structureType ，即 vk：：StructureType 值。有一個(gè)名為 CppType 的類型特征，它從 vk：：StructureType 值中獲取結(jié)構(gòu)的類型。

幫助程序類 vk ：： StructureChain

Vulkan 中的許多結(jié)構(gòu)都有 pNext 作為第二個(gè)成員：

typedef struct VkStructName {
 VkStructureType sType;
 const void* pNext;
 …
} VkStructName;

某些結(jié)構(gòu)被指定為延伸其他結(jié)構(gòu)。pNext指針用于創(chuàng)建結(jié)構(gòu)鏈。有些結(jié)構(gòu)可以多次成為該鏈的一部分，具有不同的實(shí)例。您的代碼 MIG ht 如下所示：

ChainedStruct chained = {};
chained.sType = VK_STRUCTURE_TYPE_CHAINED_STRUCT;
// set other values of chained

AnchorStruct anchor = {};
anchor.sType = VK_STRUCTURE_TYPE_ANCHOR_STRUCT;
anchor.pNext = &chained;
// set other values of anchor

使用這種方法，有幾個(gè)潛在的錯(cuò)誤。例如， MIG ht 將一個(gè)結(jié)構(gòu)鏈到 AnchorStruct 實(shí)例，該實(shí)例沒有指定在鏈中?；蛘吣馔獾劓溄恿艘粋€(gè)結(jié)構(gòu)的多個(gè)實(shí)例，其中只允許一個(gè)實(shí)例。甚至內(nèi)存管理也會(huì)導(dǎo)致意外行為。例如，當(dāng)您有一個(gè)使用局部變量創(chuàng)建鏈的函數(shù)時(shí)，就像前面的代碼示例中那樣，當(dāng)該函數(shù)最終按值返回錨點(diǎn)時(shí)，您已經(jīng)注定要失敗了。 MIG 指出的鏈?zhǔn)浇Y(jié)構(gòu)已經(jīng)消失。

對于 Vulkan -hpp ，該代碼看起來幾乎相同：

namespace vk
{
 …
 struct StructName
 {
 …
 const vk::StructureType sType = vk::StructureType::eStructName;
 const void * pNext = {};
 …
 }
 …
}

您可以使用與 Vulkan 相同的方法來使用它，潛在錯(cuò)誤的來源相同。 helper 類vk::StructureChain在這里幫助編譯器，如下面的代碼示例所示：

vk::StructureChain chain
(
 { /* set other values of anchor */ }
 { /* set other values of chained */ }
);

當(dāng)然，這條鏈會(huì)變得任意長。編譯器可以檢查是否所有鏈?zhǔn)浇Y(jié)構(gòu)都指定為擴(kuò)展 MIG 。如果同一個(gè)鏈?zhǔn)浇Y(jié)構(gòu)多次出現(xiàn)，編譯器會(huì)檢查是否允許。訪問這樣一個(gè)鏈的元素將與您習(xí)慣于使用純 C 型結(jié)構(gòu)鏈略有不同：

vk::AnchorStruct const & anchorStruct = chain.get();
vk::ChainedStruct const & chainedStruct = chain.get();

如果必須在運(yùn)行時(shí)從結(jié)構(gòu)鏈中刪除元素，可以使用成員函數(shù) vk：：StructureChain：：unlink 來執(zhí)行此操作。這樣，結(jié)構(gòu)鏈的內(nèi)存占用不會(huì)改變，但是現(xiàn)在未使用的部分將被跳過，因?yàn)樵撴溨械娜魏?pNext 指針都不會(huì)指向這些部分。要重新鏈接，請使用 vk：：StructureChain：：relink 。

型式安全

最后，我們來看一個(gè)稍微不同的主題，類型安全。這是 Vulkan 的一個(gè)問題，尤其是對于 32 位構(gòu)建。在 32 位內(nèi)部版本中，所有不可分派的句柄（如 VkBuffer 、 VkImage 和 VkSemaphore 都只是 uint64_t 上的 typedef ：

#define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object) typedef uint64_t object;
…
VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkBuffer)
VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkImage)

您可以調(diào)用 vkCreateBuffer 并傳入指向 VkImage 的指針作為最后一個(gè)參數(shù)。您還可以將 VkImage 分配給 VkBuffer 或?qū)λ鼈冞M(jìn)行比較，沒有任何錯(cuò)誤！

由于 Vulkan -hpp 中的相應(yīng)類型是獨(dú)立的類，沒有任何繼承關(guān)系，編譯器不允許這些操作中的任何一個(gè)。你不會(huì)弄錯(cuò)的。

與運(yùn)行時(shí)錯(cuò)誤相比，更傾向于編輯時(shí)錯(cuò)誤預(yù)防

正如我前面所說，最好的情況是甚至不能編寫錯(cuò)誤的代碼。 Vulkan -hpp ，可能與所有現(xiàn)代 IDE 一起幫助您設(shè)置結(jié)構(gòu)的成員。因?yàn)槊總€(gè) vk ：： struct 都有一個(gè)構(gòu)造函數(shù)，該構(gòu)造函數(shù)的每個(gè)成員都有一個(gè)參數(shù)列表，除了前面提到的 sType 和 pNext ， IDE 可能會(huì)在編輯時(shí)引導(dǎo)您遍歷所有這些參數(shù)，從而更難忽略任何錯(cuò)誤。

把您的 Vulkan 的項(xiàng)目切換到 C ++

這些是 Vulkan -hpp 的一些特性，它們極大地簡化了用 Vulkan 進(jìn)行編碼的工作。這些特性在運(yùn)行時(shí)開銷為零的情況下可用。只是編譯器需要多工作一點(diǎn)。您仍然必須（幾乎）像使用 plainVulkan 一樣顯式地編程，但是編譯器可以更好地檢查代碼。這樣可以節(jié)省你很多時(shí)間！

關(guān)于作者

Andreas Sü?enbach 是 NVIDIA 的高級(jí)軟件開發(fā)人員。他是 Vulkan.hpp 的發(fā)明者之一，并不斷努力使之更進(jìn)一步。

審核編輯：郭婷