KhronosGroup / KhronosGroup/Vulkan-Tutorial

Add emphasis on the difference between imageIndex and currentFrame

Open
#57 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
418
Forks
126
Avg merge
11d 6h
Merged PRs (30d)
31

Description

I've witnessed people in the past having a hard time understanding the difference between the swap chain image index and the index you would use for your frames in flight. This tutorial does properly separate the two, but I feel like it needs a stronger emphasis on the difference between them, to make it less easy to screw up.

I think [this part](https://github.com/KhronosGroup/Vulkan-Tutorial/blob/main/en/03_Drawing_a_triangle/03_Drawing/03_Frames_in_flight.adoc) is a great place to include such information, since this is where the concept of FiF is introduced.

Also this is something I'd be happy to make a PR for

Contributor guide

Open the contributing guide

Research direction

Start by reading en/03_Drawing_a_triangle/03_Drawing/03_Frames_in_flight.adoc, especially where frames in flight are introduced. Clarify the distinction between the swap chain image index and the frame-in-flight index in that section; the work is done when the two indices and their separate uses are unambiguous to readers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.