Stale GLSL-specific wording in the Vertex Input Description chapter
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- cpp
- Domain
- documentation
Research direction
Read the Vertex Input Description chapter, especially the Attribute Descriptions section, and compare its wording with the shown Slang VSInput and C++ VertexInputAttributeDescription locations. Confirm how the tutorial’s Slang example maps vertex inputs to locations, then clarify the text or make locations explicit with [[vk::location(N)]]. Done when the explanation matches the example and no longer implies absent GLSL annotations.
Written by the indexing model from the issue text.
Description
In the Vertex Input Description chapter, the following sentence appears:
The location parameter references the location directive of the input in the vertex shader.
However, the tutorial now uses Slang, and the vertex shader does not contain any explicit location annotations:
struct VSInput {
float2 inPosition;
float3 inColor;
};
Meanwhile, the C++ code explicitly uses locations 0 and 1 in VertexInputAttributeDescription.
The current wording seems to refer to GLSL's layout(location = N) syntax, which is not present in the Slang example.
It might be helpful to update this section to explain how Slang assigns vertex input locations implicitly, or alternatively, make the locations explicit using [[vk::location(N)]].
- Dominant language
- C++
- Stars
- 444
- Forks
- 145
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from KhronosGroup/Vulkan-Tutorial
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
KhronosGroup/Vulkan-Tutorial#551 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
KhronosGroup/Vulkan-Tutorial#545 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 76/100
KhronosGroup/Vulkan-Tutorial#544 ·
Maintainers usually reply within 1 day
-
Clarify front-face culling when using a negative viewport heightPossibly taken @1sgtpepper claimed this 18 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
KhronosGroup/Vulkan-Tutorial#534 ·
Maintainers usually reply within 1 day
-
Clarify vertex input bindingsPossibly taken @SaschaWillems claimed this 27 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
KhronosGroup/Vulkan-Tutorial#527 · 1 assignee ·
Maintainers usually reply within 1 day
All issues in KhronosGroup/Vulkan-Tutorial
Similar issues
-
Documentation: Fix parameter markup, legacy branch link, and phrasing in Detachable Joints and Model Command tutorialsPossibly taken @patelshivani2283-lab claimed this today. Open
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Niko1221/Strata#6071 · 2 comments ·
Maintainers usually reply within 4 days
-
pumpOpen
Difficulty 1/5 Under an hour Newbie friendliness 68/100
dewenni/ESP_Buderus_KM271#191 ·