Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Should vkWaitSemaphores() list synchronization scopes and exclude access scopes? #2463

Open
MarijnS95 opened this issue Nov 14, 2024 · 0 comments

Comments

@MarijnS95
Copy link
Contributor

When reading the synchronization chapter, host write ordering guarantees (i.e. access scopes) for queue submits are clarified. vkWaitForFences() only defines synchronization scopes, but no access scopes. This is expected, because a note is included that precludes any memory order:

Note

Signaling a fence and waiting on the host does not guarantee that the results of memory accesses will be visible to the host, as the access scope of a memory dependency defined by a fence only includes device access. A memory barrier or other memory dependency must be used to guarantee this. See the description of host access types for more information.

For vkSignalSemaphore(), only synchronization scopes are listed, but such a note on memory order appears to be missing.

Finally, vkWaitSemaphores() is entirely missing synchronization scopes, as well as a note on memory ordering: I assume excludes any memory ordering guarantees like vkWaitForFences()?


On a separate note, documentation pages like this are slightly hard to read when the last paragraph for one command like vkWaitSemaphores() flows directly into the first paragraph (description) of the next command like vkSignalSemaphore() without a clear separator like a horizontal line. Is that something that can be added?

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

No branches or pull requests

1 participant