Vulkan: What is the point of sType in vk*CreateInfo structs?
They have one so that the pNext
field actually works.
Yes, the API takes a struct with a proper C type, so both the caller and the receiver agree on what type that struct is. But especially nowadays, many such structs have linked lists of structures that provide additional information to the implementation. These extension structures (though many are core in Vulkan 1.1/2) are just like all other structures, with their own sType
field.
These fields are crucial because the linked lists are built with pNext
pointers... which are void*
s. They have no set type. The way the implementation determines what a non-NULL pNext
pointer points to is by examining the first 4 bytes stored there. This is the sType
field; it allows the implementation to know what type to cast the pointer to.
Of course, the primary struct that an API takes doesn't strictly need an sType
field, since its type is part of the API itself. However, there is a hypothetical reason to do so (it hasn't panned out in Vulkan releases).
A later version of Vulkan could expand on the creation of, for example, command buffer pools. But how would it do that? Well, they could add a whole new entrypoint: vkCreateCommandPool2
. But this function would have almost the exact same signature as vkCreateCommandPool
; the only difference is that they take different pCreateInfo
structures.
So instead, all you have to do is declare a VkCommandPoolCreateInfo2
structure. And then declare that vkCreateCommandPool
can take either one. How would the implementation tell which one you passed in?
Because the first 4 bytes of any such structure is sType
. They can test that value. If the value is VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO
, then it's the old structure. If it's VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO_2
, then it's the new one.
Of course, as previously stated, this hasn't panned out; post-1.0 Vulkan versions opted to incorporate extension structs rather than replacing existing ones. But the option is there.