From 0329fb33982ba2d34306e63af6bccafb96ea9007 Mon Sep 17 00:00:00 2001 From: Jeff Vigil Date: Mon, 8 Nov 2021 15:42:16 -0700 Subject: [PATCH 1/7] Update wsi.txt Change "should be interpreted as follows" to " indicates the following" --- chapters/VK_KHR_shared_presentable_image/wsi.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chapters/VK_KHR_shared_presentable_image/wsi.txt b/chapters/VK_KHR_shared_presentable_image/wsi.txt index 4718b2f00a..559ed6fc55 100644 --- a/chapters/VK_KHR_shared_presentable_image/wsi.txt +++ b/chapters/VK_KHR_shared_presentable_image/wsi.txt @@ -55,7 +55,7 @@ include::{generated}/api/protos/vkGetSwapchainStatusKHR.txt[] include::{generated}/validity/protos/vkGetSwapchainStatusKHR.txt[] -- -The possible return values for fname:vkGetSwapchainStatusKHR should: be +The possible return values for fname:vkGetSwapchainStatusKHR should be interpreted as follows: * ename:VK_SUCCESS specifies the presentation engine is presenting the From 5c24ec732a767a7476d5bbe0790a372b39f9f993 Mon Sep 17 00:00:00 2001 From: Jeff Vigil Date: Mon, 8 Nov 2021 15:46:37 -0700 Subject: [PATCH 2/7] Update swapchain_counters.txt "may" change to "must" --- chapters/VK_EXT_display_control/swapchain_counters.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chapters/VK_EXT_display_control/swapchain_counters.txt b/chapters/VK_EXT_display_control/swapchain_counters.txt index 0c37461625..238d283ac8 100644 --- a/chapters/VK_EXT_display_control/swapchain_counters.txt +++ b/chapters/VK_EXT_display_control/swapchain_counters.txt @@ -43,7 +43,7 @@ include::{generated}/api/protos/vkGetSwapchainCounterEXT.txt[] * pname:pCounterValue will return the current value of the counter. If a counter is not available because the swapchain is out of date, the -implementation may: return ename:VK_ERROR_OUT_OF_DATE_KHR. +implementation must: return ename:VK_ERROR_OUT_OF_DATE_KHR. .Valid Usage **** From 41150d504fb57215bd2e1c67d9e5452f0f140ed9 Mon Sep 17 00:00:00 2001 From: Jeff Vigil Date: Mon, 8 Nov 2021 15:50:26 -0700 Subject: [PATCH 3/7] Update wsi.txt "may" change to "must" --- chapters/VK_KHR_swapchain/wsi.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chapters/VK_KHR_swapchain/wsi.txt b/chapters/VK_KHR_swapchain/wsi.txt index 64b5160791..b4f7db8b70 100644 --- a/chapters/VK_KHR_swapchain/wsi.txt +++ b/chapters/VK_KHR_swapchain/wsi.txt @@ -258,7 +258,7 @@ flink:vkQueuePresentKHR any images it had already acquired from pname:oldSwapchain. E.g., an application may present an image from the old swapchain before an image from the new swapchain is ready to be presented. -As usual, flink:vkQueuePresentKHR may: fail if pname:oldSwapchain has +As usual, flink:vkQueuePresentKHR must: fail if pname:oldSwapchain has entered a state that causes ename:VK_ERROR_OUT_OF_DATE_KHR to be returned. ifdef::VK_KHR_shared_presentable_image[] From e36c231b5ddcb2734306c346d92514a327d7c0af Mon Sep 17 00:00:00 2001 From: Jeff Vigil Date: Mon, 6 Dec 2021 14:56:15 -0700 Subject: [PATCH 4/7] vkGetSwapchainStatusKHR codes --- chapters/VK_KHR_shared_presentable_image/wsi.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/chapters/VK_KHR_shared_presentable_image/wsi.txt b/chapters/VK_KHR_shared_presentable_image/wsi.txt index 559ed6fc55..6a7a17f26a 100644 --- a/chapters/VK_KHR_shared_presentable_image/wsi.txt +++ b/chapters/VK_KHR_shared_presentable_image/wsi.txt @@ -55,8 +55,7 @@ include::{generated}/api/protos/vkGetSwapchainStatusKHR.txt[] include::{generated}/validity/protos/vkGetSwapchainStatusKHR.txt[] -- -The possible return values for fname:vkGetSwapchainStatusKHR should be -interpreted as follows: +The meanings of status codes returned by flink:vkGetSwapchainStatusKHR are: * ename:VK_SUCCESS specifies the presentation engine is presenting the contents of the shared presentable image, as per the swapchain's From f12c4132a6dfe6de2b596f512d6ebaa9fbb06642 Mon Sep 17 00:00:00 2001 From: Jeff Vigil Date: Mon, 6 Dec 2021 14:57:27 -0700 Subject: [PATCH 5/7] Removed as-usual text --- chapters/VK_KHR_swapchain/wsi.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chapters/VK_KHR_swapchain/wsi.txt b/chapters/VK_KHR_swapchain/wsi.txt index b4f7db8b70..5d6679294e 100644 --- a/chapters/VK_KHR_swapchain/wsi.txt +++ b/chapters/VK_KHR_swapchain/wsi.txt @@ -258,7 +258,7 @@ flink:vkQueuePresentKHR any images it had already acquired from pname:oldSwapchain. E.g., an application may present an image from the old swapchain before an image from the new swapchain is ready to be presented. -As usual, flink:vkQueuePresentKHR must: fail if pname:oldSwapchain has +flink:vkQueuePresentKHR must: fail if pname:oldSwapchain has entered a state that causes ename:VK_ERROR_OUT_OF_DATE_KHR to be returned. ifdef::VK_KHR_shared_presentable_image[] From 6cdf707f8e11fba0cab1bf50dd15e65ca1953f78 Mon Sep 17 00:00:00 2001 From: Jeff Vigil Date: Fri, 4 Feb 2022 16:19:08 -0700 Subject: [PATCH 6/7] Change Status code line Change to read better --- chapters/VK_KHR_shared_presentable_image/wsi.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chapters/VK_KHR_shared_presentable_image/wsi.txt b/chapters/VK_KHR_shared_presentable_image/wsi.txt index 6a7a17f26a..e8f5ca91a9 100644 --- a/chapters/VK_KHR_shared_presentable_image/wsi.txt +++ b/chapters/VK_KHR_shared_presentable_image/wsi.txt @@ -55,7 +55,7 @@ include::{generated}/api/protos/vkGetSwapchainStatusKHR.txt[] include::{generated}/validity/protos/vkGetSwapchainStatusKHR.txt[] -- -The meanings of status codes returned by flink:vkGetSwapchainStatusKHR are: +Status codes returned by flink:vkGetSwapchainStatusKHR have the following meaning: * ename:VK_SUCCESS specifies the presentation engine is presenting the contents of the shared presentable image, as per the swapchain's From b64bd1f81fb45a32b34e972e467d2d6cdb3522ef Mon Sep 17 00:00:00 2001 From: Jeff Vigil Date: Fri, 4 Feb 2022 16:27:56 -0700 Subject: [PATCH 7/7] Reword return from retired oldSwapchain on vkQueuePresent Try a little better wording --- chapters/VK_KHR_swapchain/wsi.txt | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/chapters/VK_KHR_swapchain/wsi.txt b/chapters/VK_KHR_swapchain/wsi.txt index a4d6c16659..b5b6a743a3 100644 --- a/chapters/VK_KHR_swapchain/wsi.txt +++ b/chapters/VK_KHR_swapchain/wsi.txt @@ -255,11 +255,7 @@ outnumber calls to flink:vkDestroySwapchainKHR. After pname:oldSwapchain is retired, the application can: pass to flink:vkQueuePresentKHR any images it had already acquired from -pname:oldSwapchain. -E.g., an application may present an image from the old swapchain before an -image from the new swapchain is ready to be presented. -flink:vkQueuePresentKHR must: fail if pname:oldSwapchain has -entered a state that causes ename:VK_ERROR_OUT_OF_DATE_KHR to be returned. +pname:oldSwapchain. flink:vkQueuePresentKHR must: return ename:VK_ERROR_OUT_OF_DATE_KHR. ifdef::VK_KHR_shared_presentable_image[] The application can: continue to use a shared presentable image obtained