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

Some more suspicious swapchain RFC keyword usage #1586

Open
krOoze opened this issue Jul 19, 2021 · 1 comment · May be fixed by #1680
Open

Some more suspicious swapchain RFC keyword usage #1586

krOoze opened this issue Jul 19, 2021 · 1 comment · May be fixed by #1680
Assignees

Comments

@krOoze
Copy link
Contributor

krOoze commented Jul 19, 2021

I notice some more suspicious swapchain RFC keyword usage:

The possible return values for vkGetSwapchainStatusKHR should be interpreted as follows:

The "should" feels odd here and colloquial. Should be refrazed in the form of what the implementation must return.

If a counter is not available because the swapchain is out of date, the implementation may return VK_ERROR_OUT_OF_DATE_KHR.

"may" feels suspicious here. Posibly supposed to be "must".

As usual, vkQueuePresentKHR may fail if oldSwapchain has entered a state that causes VK_ERROR_OUT_OF_DATE_KHR to be returned.

The "may" is weird, because tautologically if VK_ERROR_OUT_OF_DATE_KHR is returned, then it did fail.

@stonesthrow
Copy link
Contributor

Recommendation:

  1. This text is directed to application not implementation. Change "should be interpreted as follows" to " indicates the following"

  2. "may" change to "must"

  3. "may" change to "must"

@stonesthrow stonesthrow linked a pull request Nov 8, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants