Add emphasis on the difference between imageIndex and currentFrame

Open

#57 opened on Feb 7, 2025 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 1/5
Estimated time: 1-3 hours
Newbie friendliness: 35/100

Issue type: Documentation
Clarity: Clearly specified
Activity status: Stale
Domain: documentation

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.

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 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

Dominant language: C++
Stars: 424
Forks: 127
Avg merge: 2d 22h
Merged PRs (30d): 7

Contributor guide

Open 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.

Similar issues

Use 4:4:4 for multichannel AVIF and HEIF gain maps Open

Difficulty 2/5 1-3 hours Newbie friendliness 70/100

google/libultrahdr#485 · Opened Sep 24, 2026
Missing tile warnings in TileMap dock display with wrong texture filter Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

godotengine/godot#123776 · Opened Sep 23, 2026
if(cond,a,b) treats any nonzero cond as true in every bngsim backend (ExprTk interpreter, C codegen, SSA), which contradicts docs/reference/expressions.md ('true when > 0.5') and BNG's run_network. A non-boolean condition in (-inf,0) or... Open

bug

Difficulty 1/5 Under an hour Newbie friendliness 60/100

lanl/bngsim#774 · Opened Sep 23, 2026
Delete ament_export_include_directories() and ament_export_libraries() calls Open

good first issue

Difficulty 1/5 Under an hour Newbie friendliness 90/100

ros2/rosbag2#2509 · Opened Sep 23, 2026
Delete ament_export_include_directories() and ament_export_libraries() calls Open

good first issue

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

ros2/common_interfaces#344 · Opened Sep 23, 2026

More C++ issues