KhronosGroup / KhronosGroup/Vulkan-Docs
how to reliably determine if a function parameter is an in, inout, out argument in vk.xml?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3.3k
- Forks
- 549
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 2
Description
How to reliably determine if a function parameter is an in, inout, out argument in vk.xml? Most of them can be detected from looking at const-ness, length and pointer-ness combined with the prefix of the function name. Then there are some, say "xcb_connection_t*" and others, that are not out arguments even though they are marked pointer-to-non-const.
This kind of information is necessary if one wishes to generate API that tries to utilize return type over out arguments.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading vk.xml and comparing parameter const-ness, length, pointer-ness, and function-name conventions. Check how cases such as xcb_connection_t* are represented, then determine whether the metadata already distinguishes in, inout, and out parameters. Done means the direction can be determined reliably for API generation or the required representation is clearly specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- xml
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100