Skip to content

Fix waitForFences usage and documentation#246

Merged
SaschaWillems merged 3 commits intomainfrom
wait_fence_code_cleanup
Dec 16, 2025
Merged

Fix waitForFences usage and documentation#246
SaschaWillems merged 3 commits intomainfrom
wait_fence_code_cleanup

Conversation

@SaschaWillems
Copy link
Copy Markdown
Collaborator

@SaschaWillems SaschaWillems commented Dec 7, 2025

This PR fixes the odd loop-formatting used for fence waits. It replaces it with proper result code checking, which the tutorial didn't do before. So timeouts for fences are now properly handled.

Also fixes several documentation related issues, like a errors and code differences in the presentation chapter and the code in the multi threading chapter not matching the actual code.

Refs #121
Fixes #124
Fixes #244

Properly check return value and throw on error
Fix Rendering and presentation chapter paragraph
Adjust documentation for multi threading chapter to actuall match code
@SaschaWillems
Copy link
Copy Markdown
Collaborator Author

@gpx1000: What should we do with mixing of C++ and C-Syntax? When fixing documentation, or adding stuff, I try to stay as close to the code as possible and use C++-Syntax in the documentation. That leads to a not-so-nice mix of vulkan-hpp and vulkan-h terms and names in some of the chapters. Shouldn't we just update all of them to vulkan-hpp instead?

Copy link
Copy Markdown
Contributor

@asuessenbach asuessenbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: the only other success code of waitForFences is vk::Result::eTimeout.
All other results are error codes, and throw anyways.

Besides that: LGTM

@SaschaWillems SaschaWillems merged commit 407ed51 into main Dec 16, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Result codes not always checked Odd formatting for while loops

2 participants