summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPetr Kraus <petr_kraus@email.cz>2017-10-26 18:23:29 +0200
committerPetr Kraus <petr_kraus@email.cz>2017-10-26 18:23:29 +0200
commit4feecf97cd25ad766819ea6ba792371ae55b878b (patch)
tree7dd8aea1943f1da7a769ef9e6ecfb6b375244bd8
parent7e848ee40e764b11ad2c9a5c48f6990263d1454c (diff)
downloadvulkan-spec-4feecf97cd25ad766819ea6ba792371ae55b878b.zip
vulkan-spec-4feecf97cd25ad766819ea6ba792371ae55b878b.tar.xz
Restyle some VkImageSubresource* VUs
-rw-r--r--doc/specs/vulkan/chapters/clears.txt46
-rw-r--r--doc/specs/vulkan/chapters/copies.txt128
-rw-r--r--doc/specs/vulkan/chapters/resources.txt28
-rw-r--r--doc/specs/vulkan/chapters/sparsemem.txt14
-rw-r--r--doc/specs/vulkan/chapters/synchronization.txt24
5 files changed, 108 insertions, 132 deletions
diff --git a/doc/specs/vulkan/chapters/clears.txt b/doc/specs/vulkan/chapters/clears.txt
index 83e33c3..2a47247 100644
--- a/doc/specs/vulkan/chapters/clears.txt
+++ b/doc/specs/vulkan/chapters/clears.txt
@@ -88,24 +88,21 @@ endif::VK_KHR_shared_presentable_image[]
elements of the pname:pRanges array must: each be less than the
pname:mipLevels specified in slink:VkImageCreateInfo when pname:image
was created
- * If the slink:VkImageSubresourceRange::pname:levelCount member of any
- element of the pname:pRanges array is not ename:VK_REMAINING_MIP_LEVELS,
- [eq]#slink:VkImageSubresourceRange::pname:baseMipLevel {plus}
- slink:VkImageSubresourceRange::pname:levelCount# for that element of the
- pname:pRanges array must: be less than or equal to the pname:mipLevels
- specified in slink:VkImageCreateInfo when pname:image was created
+ * For each slink:VkImageSubresourceRange element of pname:pRanges, if
+ the pname:levelCount member is not ename:VK_REMAINING_MIP_LEVELS, then
+ [eq]#pname:baseMipLevel {plus} pname:levelCount# must: be less than the
+ pname:mipLevels specified in slink:VkImageCreateInfo when pname:image
+ was created
* [[VUID-vkCmdClearColorImage-baseArrayLayer-01472]]
The slink:VkImageSubresourceRange::pname:baseArrayLayer members of the
elements of the pname:pRanges array must: each be less than the
pname:arrayLayers specified in slink:VkImageCreateInfo when pname:image
was created
- * If the slink:VkImageSubresourceRange::pname:layerCount member of any
- element of the pname:pRanges array is not
- ename:VK_REMAINING_ARRAY_LAYERS,
- [eq]#slink:VkImageSubresourceRange::pname:baseArrayLayer {plus}
- slink:VkImageSubresourceRange::pname:layerCount# for that element of the
- pname:pRanges array must: be less than or equal to the pname:arrayLayers
- specified in slink:VkImageCreateInfo when pname:image was created
+ * For each slink:VkImageSubresourceRange element of pname:pRanges, if
+ the pname:layerCount member is not ename:VK_REMAINING_ARRAY_LAYERS, then
+ [eq]#pname:baseArrayLayer {plus} pname:layerCount# must: be less than
+ the pname:arrayLayers specified in slink:VkImageCreateInfo when
+ pname:image was created
* [[VUID-vkCmdClearColorImage-image-00007]]
pname:image must: not have a compressed or depth/stencil format
****
@@ -173,24 +170,21 @@ endif::VK_KHR_maintenance1[]
elements of the pname:pRanges array must: each be less than the
pname:mipLevels specified in slink:VkImageCreateInfo when pname:image
was created
- * If the slink:VkImageSubresourceRange::pname:levelCount member of any
- element of the pname:pRanges array is not ename:VK_REMAINING_MIP_LEVELS,
- [eq]#slink:VkImageSubresourceRange::pname:baseMipLevel {plus}
- slink:VkImageSubresourceRange::pname:levelCount# for that element of the
- pname:pRanges array must: be less than or equal to the pname:mipLevels
- specified in slink:VkImageCreateInfo when pname:image was created
+ * For each slink:VkImageSubresourceRange element of pname:pRanges, if
+ the pname:levelCount member is not ename:VK_REMAINING_MIP_LEVELS, then
+ [eq]#pname:baseMipLevel {plus} pname:levelCount# must: be less than the
+ pname:mipLevels specified in slink:VkImageCreateInfo when pname:image
+ was created
* [[VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476]]
The slink:VkImageSubresourceRange::pname:baseArrayLayer members of the
elements of the pname:pRanges array must: each be less than the
pname:arrayLayers specified in slink:VkImageCreateInfo when pname:image
was created
- * If the slink:VkImageSubresourceRange::pname:layerCount member of any
- element of the pname:pRanges array is not
- ename:VK_REMAINING_ARRAY_LAYERS,
- [eq]#slink:VkImageSubresourceRange::pname:baseArrayLayer {plus}
- slink:VkImageSubresourceRange::pname:layerCount# for that element of the
- pname:pRanges array must: be less than or equal to the pname:arrayLayers
- specified in slink:VkImageCreateInfo when pname:image was created
+ * For each slink:VkImageSubresourceRange element of pname:pRanges, if
+ the pname:layerCount member is not ename:VK_REMAINING_ARRAY_LAYERS, then
+ [eq]#pname:baseArrayLayer {plus} pname:layerCount# must: be less than
+ the pname:arrayLayers specified in slink:VkImageCreateInfo when
+ pname:image was created
* [[VUID-vkCmdClearDepthStencilImage-image-00014]]
pname:image must: have a depth/stencil format
****
diff --git a/doc/specs/vulkan/chapters/copies.txt b/doc/specs/vulkan/chapters/copies.txt
index 99cc817..2778d30 100644
--- a/doc/specs/vulkan/chapters/copies.txt
+++ b/doc/specs/vulkan/chapters/copies.txt
@@ -436,24 +436,20 @@ ifdef::VK_KHR_sampler_ycbcr_conversion[]
endif::VK_KHR_sampler_ycbcr_conversion[]
* [[VUID-vkCmdCopyImage-srcImage-00136]]
The sample count of pname:srcImage and pname:dstImage must: match
- * The slink:VkImageCopy::pname:srcSubresource::pname:mipLevel members of
- the elements of the pname:pRegions array must: each be less than the
- pname:mipLevels specified in slink:VkImageCreateInfo when pname:srcImage
- was created
- * The slink:VkImageCopy::pname:dstSubresource::pname:mipLevel members of
- the elements of the pname:pRegions array must: each be less than the
- pname:mipLevels specified in slink:VkImageCreateInfo when pname:dstImage
- was created
- * The slink:VkImageCopy::pname:srcSubresource members of the elements of
- the pname:pRegions array must: each have
- [eq]#pname:baseArrayLayer {plus} pname:layerCount# less than or equal to
- the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:srcImage was created
- * The slink:VkImageCopy::pname:dstSubresource members of the elements of
- the pname:pRegions array must: each have
- [eq]#pname:baseArrayLayer {plus} pname:layerCount# less than or equal to
- the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:dstImage was created
+ * The pname:srcSubresource.mipLevel member of each element of
+ pname:pRegions must: be less than the pname:mipLevels specified in
+ slink:VkImageCreateInfo when pname:srcImage was created
+ * The pname:dstSubresource.mipLevel member of each element of
+ pname:pRegions must: be less than the pname:mipLevels specified in
+ slink:VkImageCreateInfo when pname:dstImage was created
+ * The [eq]#pname:srcSubresource.baseArrayLayer {plus}
+ pname:srcSubresource.layerCount# of each element of pname:pRegions must:
+ be less than or equal to the pname:arrayLayers specified in
+ slink:VkImageCreateInfo when pname:srcImage was created
+ * The [eq]#pname:dstSubresource.baseArrayLayer {plus}
+ pname:dstSubresource.layerCount# of each element of pname:pRegions must:
+ be less than or equal to the pname:arrayLayers specified in
+ slink:VkImageCreateInfo when pname:dstImage was created
****
include::../validity/protos/vkCmdCopyImage.txt[]
@@ -830,15 +826,13 @@ ifdef::VK_KHR_shared_presentable_image[]
ename:VK_IMAGE_LAYOUT_GENERAL, or
ename:VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
endif::VK_KHR_shared_presentable_image[]
- * The slink:VkBufferImageCopy::pname:imageSubresource::pname:mipLevel
- members of the elements of the pname:pRegions array must: each be less
- than the pname:mipLevels specified in slink:VkImageCreateInfo when
- pname:dstImage was created
- * The slink:VkBufferImageCopy::pname:imageSubresource members of the elements of
- the pname:pRegions array must: each have
- [eq]#pname:baseArrayLayer {plus} pname:layerCount# less than or equal to
- the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:dstImage was created
+ * The pname:imageSubresource.mipLevel member of each element of
+ pname:pRegions must: be less than the pname:mipLevels specified in
+ slink:VkImageCreateInfo when pname:dstImage was created
+ * The [eq]#pname:imageSubresource.baseArrayLayer {plus}
+ pname:imageSubresource.layerCount# of each element of pname:pRegions
+ must: be less than or equal to the pname:arrayLayers specified in
+ slink:VkImageCreateInfo when pname:dstImage was created
****
include::../validity/protos/vkCmdCopyBufferToImage.txt[]
@@ -940,15 +934,13 @@ endif::VK_KHR_shared_presentable_image[]
* [[VUID-vkCmdCopyImageToBuffer-dstBuffer-00192]]
If pname:dstBuffer is non-sparse then it must: be bound completely and
contiguously to a single sname:VkDeviceMemory object
- * The slink:VkBufferImageCopy::pname:imageSubresource::pname:mipLevel
- members of the elements of the pname:pRegions array must: each be less
- than the pname:mipLevels specified in slink:VkImageCreateInfo when
- pname:srcImage was created
- * The slink:VkBufferImageCopy::pname:imageSubresource members of the elements of
- the pname:pRegions array must: each have
- [eq]#pname:baseArrayLayer {plus} pname:layerCount# less than or equal to
- the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:srcImage was created
+ * The pname:imageSubresource.mipLevel member of each element of
+ pname:pRegions must: be less than the pname:mipLevels specified in
+ slink:VkImageCreateInfo when pname:srcImage was created
+ * The [eq]#pname:imageSubresource.baseArrayLayer {plus}
+ pname:imageSubresource.layerCount# of each element of pname:pRegions
+ must: be less than or equal to the pname:arrayLayers specified in
+ slink:VkImageCreateInfo when pname:srcImage was created
****
include::../validity/protos/vkCmdCopyImageToBuffer.txt[]
@@ -1480,24 +1472,20 @@ ifdef::VK_IMG_filter_cubic[]
If pname:filter is ename:VK_FILTER_CUBIC_IMG, pname:srcImage must: have
a elink:VkImageType of ename:VK_IMAGE_TYPE_3D
endif::VK_IMG_filter_cubic[]
- * The slink:VkImageBlit::pname:srcSubresource::pname:mipLevel members of
- the elements of the pname:pRegions array must: each be less than the
- pname:mipLevels specified in slink:VkImageCreateInfo when pname:srcImage
- was created
- * The slink:VkImageBlit::pname:dstSubresource::pname:mipLevel members of
- the elements of the pname:pRegions array must: each be less than the
- pname:mipLevels specified in slink:VkImageCreateInfo when pname:dstImage
- was created
- * The slink:VkImageBlit::pname:srcSubresource members of the elements of
- the pname:pRegions array must: each have
- [eq]#pname:baseArrayLayer {plus} pname:layerCount# less than or equal to
- the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:srcImage was created
- * The slink:VkImageBlit::pname:dstSubresource members of the elements of
- the pname:pRegions array must: each have
- [eq]#pname:baseArrayLayer {plus} pname:layerCount# less than or equal to
- the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:dstImage was created
+ * The pname:srcSubresource.mipLevel member of each element of
+ pname:pRegions must: be less than the pname:mipLevels specified in
+ slink:VkImageCreateInfo when pname:srcImage was created
+ * The pname:dstSubresource.mipLevel member of each element of
+ pname:pRegions must: be less than the pname:mipLevels specified in
+ slink:VkImageCreateInfo when pname:dstImage was created
+ * The [eq]#pname:srcSubresource.baseArrayLayer {plus}
+ pname:srcSubresource.layerCount# of each element of pname:pRegions must:
+ be less than or equal to the pname:arrayLayers specified in
+ slink:VkImageCreateInfo when pname:srcImage was created
+ * The [eq]#pname:dstSubresource.baseArrayLayer {plus}
+ pname:dstSubresource.layerCount# of each element of pname:pRegions must:
+ be less than or equal to the pname:arrayLayers specified in
+ slink:VkImageCreateInfo when pname:dstImage was created
****
include::../validity/protos/vkCmdBlitImage.txt[]
@@ -1698,24 +1686,20 @@ endif::VK_KHR_shared_presentable_image[]
* [[VUID-vkCmdResolveImage-srcImage-01386]]
pname:srcImage and pname:dstImage must: have been created with the same
image format
- * The slink:VkImageResolve::pname:srcSubresource::pname:mipLevel members of
- the elements of the pname:pRegions array must: each be less than the
- pname:mipLevels specified in slink:VkImageCreateInfo when pname:srcImage
- was created
- * The slink:VkImageResolve::pname:dstSubresource::pname:mipLevel members of
- the elements of the pname:pRegions array must: each be less than the
- pname:mipLevels specified in slink:VkImageCreateInfo when pname:dstImage
- was created
- * The slink:VkImageResolve::pname:srcSubresource members of the elements of
- the pname:pRegions array must: each have
- [eq]#pname:baseArrayLayer {plus} pname:layerCount# less than or equal to
- the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:srcImage was created
- * The slink:VkImageResolve::pname:dstSubresource members of the elements of
- the pname:pRegions array must: each have
- [eq]#pname:baseArrayLayer {plus} pname:layerCount# less than or equal to
- the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:dstImage was created
+ * The pname:srcSubresource.mipLevel member of each element of
+ pname:pRegions must: be less than the pname:mipLevels specified in
+ slink:VkImageCreateInfo when pname:srcImage was created
+ * The pname:dstSubresource.mipLevel member of each element of
+ pname:pRegions must: be less than the pname:mipLevels specified in
+ slink:VkImageCreateInfo when pname:dstImage was created
+ * The [eq]#pname:srcSubresource.baseArrayLayer {plus}
+ pname:srcSubresource.layerCount# of each element of pname:pRegions must:
+ be less than or equal to the pname:arrayLayers specified in
+ slink:VkImageCreateInfo when pname:srcImage was created
+ * The [eq]#pname:dstSubresource.baseArrayLayer {plus}
+ pname:dstSubresource.layerCount# of each element of pname:pRegions must:
+ be less than or equal to the pname:arrayLayers specified in
+ slink:VkImageCreateInfo when pname:dstImage was created
****
include::../validity/protos/vkCmdResolveImage.txt[]
diff --git a/doc/specs/vulkan/chapters/resources.txt b/doc/specs/vulkan/chapters/resources.txt
index 103b27d..4ab97c0 100644
--- a/doc/specs/vulkan/chapters/resources.txt
+++ b/doc/specs/vulkan/chapters/resources.txt
@@ -2139,26 +2139,26 @@ endif::VK_KHR_maintenance1[]
by fname:vkGetPhysicalDeviceFormatProperties with the same value of
pname:format
* [[VUID-VkImageViewCreateInfo-subresourceRange-01478]]
- pname:subresourceRange::pname:baseMipLevel must: be less than the
+ pname:subresourceRange.baseMipLevel must: be less than the
pname:mipLevels specified in slink:VkImageCreateInfo when pname:image
was created
- * If pname:subresourceRange::pname:levelCount is not
+ * If pname:subresourceRange.levelCount is not
ename:VK_REMAINING_MIP_LEVELS,
- [eq]#pname:subresourceRange::pname:baseMipLevel
- {plus} pname:subresourceRange::pname:levelCount# must: be less than or
- equal to the pname:mipLevels specified in slink:VkImageCreateInfo when
- pname:image was created
+ [eq]#pname:subresourceRange.baseMipLevel {plus}
+ pname:subresourceRange.levelCount# must: be less than or equal to the
+ pname:mipLevels specified in slink:VkImageCreateInfo when pname:image
+ was created
ifndef::VK_KHR_maintenance1[]
* [[VUID-VkImageViewCreateInfo-subresourceRange-01480]]
- pname:subresourceRange::pname:baseArrayLayer must: be less than the
+ pname:subresourceRange.baseArrayLayer must: be less than the
pname:arrayLayers specified in slink:VkImageCreateInfo when pname:image
was created
- * If pname:subresourceRange::pname:layerCount is not
+ * If pname:subresourceRange.layerCount is not
ename:VK_REMAINING_ARRAY_LAYERS,
- [eq]#pname:subresourceRange::pname:baseArrayLayer {plus}
- pname:subresourceRange::pname:layerCount# must: be less than or equal to
- the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:image was created
+ [eq]#pname:subresourceRange.baseArrayLayer {plus}
+ pname:subresourceRange.layerCount# must: be less than or equal to the
+ pname:arrayLayers specified in slink:VkImageCreateInfo when pname:image
+ was created
endif::VK_KHR_maintenance1[]
ifdef::VK_KHR_maintenance1[]
* [[VUID-VkImageViewCreateInfo-image-01482]]
@@ -2418,9 +2418,9 @@ endif::VK_KHR_sampler_ycbcr_conversion[]
.Valid Usage
****
* If pname:levelCount is not ename:VK_REMAINING_MIP_LEVELS, it must:
- be greater than 0
+ be greater than `0`
* If pname:layerCount is not ename:VK_REMAINING_ARRAY_LAYERS, it must:
- be greater than 0
+ be greater than `0`
* [[VUID-VkImageSubresourceRange-aspectMask-01670]]
If pname:aspectMask includes ename:VK_IMAGE_ASPECT_COLOR_BIT, then it
must: not include any of ename:VK_IMAGE_ASPECT_PLANE_0_BIT_KHR,
diff --git a/doc/specs/vulkan/chapters/sparsemem.txt b/doc/specs/vulkan/chapters/sparsemem.txt
index 2eb74d0..7890d06 100644
--- a/doc/specs/vulkan/chapters/sparsemem.txt
+++ b/doc/specs/vulkan/chapters/sparsemem.txt
@@ -1392,14 +1392,12 @@ include::../api/structs/VkSparseImageMemoryBindInfo.txt[]
.Valid Usage
****
- * The slink:VkSparseImageMemoryBind::pname:subresource::pname:mipLevel
- members of the elements of the pname:pBinds array must: each be less
- than the pname:mipLevels specified in slink:VkImageCreateInfo when
- pname:image was created
- * The slink:VkSparseImageMemoryBind::pname:subresource::pname:arrayLayer
- members of the elements of the pname:pBinds array must: each be less
- than the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:image was created
+ * The pname:subresource.mipLevel member of each element of pname:pBinds
+ must: be less than the pname:mipLevels specified in
+ slink:VkImageCreateInfo when pname:image was created
+ * The pname:subresource.arrayLayer member of each element of pname:pBinds
+ must: be less than the pname:arrayLayers specified in
+ slink:VkImageCreateInfo when pname:image was created
****
include::../validity/structs/VkSparseImageMemoryBindInfo.txt[]
diff --git a/doc/specs/vulkan/chapters/synchronization.txt b/doc/specs/vulkan/chapters/synchronization.txt
index c68e3ac..c581d2c 100644
--- a/doc/specs/vulkan/chapters/synchronization.txt
+++ b/doc/specs/vulkan/chapters/synchronization.txt
@@ -3785,25 +3785,25 @@ endif::VK_KHR_external_memory[]
least one of them must: be the same as the family of the queue that will
execute this barrier
* [[VUID-VkImageMemoryBarrier-subresourceRange-01486]]
- pname:subresourceRange::pname:baseMipLevel must: be less than the
+ pname:subresourceRange.baseMipLevel must: be less than the
pname:mipLevels specified in slink:VkImageCreateInfo when pname:image
was created
- * If pname:subresourceRange::pname:levelCount is not
+ * If pname:subresourceRange.levelCount is not
ename:VK_REMAINING_MIP_LEVELS,
- [eq]#pname:subresourceRange::pname:baseMipLevel
- {plus} pname:subresourceRange::pname:levelCount# must: be less than or
- equal to the pname:mipLevels specified in slink:VkImageCreateInfo when
- pname:image was created
+ [eq]#pname:subresourceRange.baseMipLevel {plus}
+ pname:subresourceRange.levelCount# must: be less than or equal to the
+ pname:mipLevels specified in slink:VkImageCreateInfo when pname:image
+ was created
* [[VUID-VkImageMemoryBarrier-subresourceRange-01488]]
- pname:subresourceRange::pname:baseArrayLayer must: be less than the
+ pname:subresourceRange.baseArrayLayer must: be less than the
pname:arrayLayers specified in slink:VkImageCreateInfo when pname:image
was created
- * If pname:subresourceRange::pname:layerCount is not
+ * If pname:subresourceRange.layerCount is not
ename:VK_REMAINING_ARRAY_LAYERS,
- [eq]#pname:subresourceRange::pname:baseArrayLayer {plus}
- pname:subresourceRange::pname:layerCount# must: be less than or equal to
- the pname:arrayLayers specified in slink:VkImageCreateInfo when
- pname:image was created
+ [eq]#pname:subresourceRange.baseArrayLayer {plus}
+ pname:subresourceRange.layerCount# must: be less than or equal to the
+ pname:arrayLayers specified in slink:VkImageCreateInfo when pname:image
+ was created
* [[VUID-VkImageMemoryBarrier-image-01207]]
If pname:image has a depth/stencil format with both depth and stencil
components, then the pname:aspectMask member of pname:subresourceRange