KhronosGroup / KhronosGroup/Vulkan-Docs
Accompanying destruction functions are not easily accessible in the spec
- Dominant language
- JavaScript
- Stars
- 3.3k
- Forks
- 549
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 2
Description
Hello!
In online registry pages like this one: https://www.khronos.org/registry/vulkan/specs/1.0/man/html/vkCreateImage.html
or in the spec pages, the accompanying destruction functions are not referenced near to the creation functions. They could only be accessed if to go to the upper level (through the **See also** section):
https://www.khronos.org/registry/vulkan/specs/1.0/man/html/VkImage.html
and then reference to `vkDestroyImage` will be somewhere in the middle of **See also** block, not immediately obvious too.
So the suggestion would be to:
1. add accompanying destruction functions to the **See also** section of the creation function and vice versa for the destruction functions (i.e. `vkCreateImage` will reference `vkDestroyImage`, and `vkDestroyImage` will reference `vkCreateImage`);
2. put the lifetime management functions at the beginning of the **See also** block of the object itself (e. g. `VkImage` **See also** block will have `vkCreateImage` as a first reference and `vkDestroyImage` as a second)
3. maybe even have a separate subsection in the **See also** section, specifically for the lifetime management functions where applicable
Thank you!
Contributor guide
Assessment
This issue has not been assessed yet.