KhronosGroup / KhronosGroup/Vulkan-Docs

Some more suspicious swapchain RFC keyword usage

Open
#1,586 2 comments 0 reactions 1 assignee Assigned to @cubanismo View on GitHub
System Integration
Dominant language
JavaScript
Stars
3.3k
Forks
549
Avg merge
5d 5h
Merged PRs (30d)
2

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.