doc: clarify VkStructureType naming derivation to avoid double underscores#2698
Merged
oddhack merged 2 commits intoKhronosGroup:mainfrom Mar 12, 2026
Merged
doc: clarify VkStructureType naming derivation to avoid double underscores#2698oddhack merged 2 commits intoKhronosGroup:mainfrom
oddhack merged 2 commits intoKhronosGroup:mainfrom
Conversation
Clarify that the underscore prefix applies to capital letters except the first one, aligning the description with actual enumerant naming.
|
|
Contributor
|
That's a good catch - thanks. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The current specification states that VkStructureType names are derived by "prefixing each capital letter with _". If followed literally, a structure like VkImageCreateInfo (after stripping Vk) would become _Image_Create_Info, leading to VK_STRUCTURE_TYPE__IMAGE_CREATE_INFO with a double underscore.
Updated the description to "prefixing each capital letter except the first with _". This aligns the text with the actual naming convention used throughout the Vulkan API and removes any ambiguity for developers.