From 27e43d72f476c5395e5543201ad96db8d6d307c1 Mon Sep 17 00:00:00 2001 From: William Henning Date: Mon, 6 Aug 2018 01:10:55 -0600 Subject: [PATCH 1/4] Fix small typos --- chapters/cmdbuffers.txt | 2 +- chapters/resources.txt | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/chapters/cmdbuffers.txt b/chapters/cmdbuffers.txt index b3789418..a02b6f7f 100644 --- a/chapters/cmdbuffers.txt +++ b/chapters/cmdbuffers.txt @@ -453,7 +453,7 @@ include::../api/structs/VkCommandBufferAllocateInfo.txt[] * pname:pNext is `NULL` or a pointer to an extension-specific structure. * pname:commandPool is the command pool from which the command buffers are allocated. - * pname:level is an elink:VkCommandBufferLevel value specifying the + * pname:level is a elink:VkCommandBufferLevel value specifying the command buffer level. * pname:commandBufferCount is the number of command buffers to allocate from the pool. diff --git a/chapters/resources.txt b/chapters/resources.txt index 5a655c6e..2a5fe2cd 100644 --- a/chapters/resources.txt +++ b/chapters/resources.txt @@ -1960,7 +1960,7 @@ include::../api/structs/VkImageViewCreateInfo.txt[] * pname:pNext is `NULL` or a pointer to an extension-specific structure. * pname:flags is reserved for future use. * pname:image is a slink:VkImage on which the view will be created. - * pname:viewType is an elink:VkImageViewType value specifying the type of + * pname:viewType is a elink:VkImageViewType value specifying the type of the image view. * pname:format is a elink:VkFormat describing the format and type used to interpret data elements in the image. @@ -4504,7 +4504,7 @@ with the following modifications: * Both must: have been created with the ename:VK_IMAGE_CREATE_DISJOINT_BIT flag. - * The single-plane image must: have an elink:VkFormat that is + * The single-plane image must: have a elink:VkFormat that is <> to that of the multi-planar image's individual plane. * The single-plane image and the individual plane of the multi-planar From 74fc29a0d6240a1fc1563eeef48ccf9c95d3fc50 Mon Sep 17 00:00:00 2001 From: William Henning Date: Mon, 6 Aug 2018 16:59:12 -0600 Subject: [PATCH 2/4] Fix several more "a" vs "an" typos --- .../indirectcommands.txt | 4 ++-- .../objecttable.txt | 2 +- chapters/copies.txt | 2 +- chapters/descriptorsets.txt | 6 ++--- chapters/extensions.txt | 2 +- chapters/features.txt | 24 +++++++++---------- chapters/initialization.txt | 2 +- chapters/memory.txt | 2 +- chapters/resources.txt | 8 +++---- chapters/synchronization.txt | 4 ++-- 10 files changed, 28 insertions(+), 28 deletions(-) diff --git a/chapters/VK_NVX_device_generated_commands/indirectcommands.txt b/chapters/VK_NVX_device_generated_commands/indirectcommands.txt index 9bbd568c..e7fe2d73 100644 --- a/chapters/VK_NVX_device_generated_commands/indirectcommands.txt +++ b/chapters/VK_NVX_device_generated_commands/indirectcommands.txt @@ -313,7 +313,7 @@ void cmdProcessAllSequences(cmd, objectTable, indirectCommandsLayout, pIndirectC include::../../validity/structs/VkIndirectCommandsLayoutCreateInfoNVX.txt[] -- -[open,refpage='VkIndirectCommandsLayoutUsageFlagBitsNVX',desc='Bitmask specifying allowed usage of a indirect commands layout',type='enums'] +[open,refpage='VkIndirectCommandsLayoutUsageFlagBitsNVX',desc='Bitmask specifying allowed usage of an indirect commands layout',type='enums'] -- Bits which can: be set in @@ -347,7 +347,7 @@ sname:VkIndirectCommandsLayoutUsageFlagsNVX is a bitmask type for setting a mask of zero or more slink:VkIndirectCommandsLayoutUsageFlagBitsNVX. -- -[open,refpage='vkDestroyIndirectCommandsLayoutNVX',desc='Destroy a object table',type='protos'] +[open,refpage='vkDestroyIndirectCommandsLayoutNVX',desc='Destroy an object table',type='protos'] -- Indirect command layouts are destroyed by: diff --git a/chapters/VK_NVX_device_generated_commands/objecttable.txt b/chapters/VK_NVX_device_generated_commands/objecttable.txt index 33f73549..e1460680 100644 --- a/chapters/VK_NVX_device_generated_commands/objecttable.txt +++ b/chapters/VK_NVX_device_generated_commands/objecttable.txt @@ -160,7 +160,7 @@ sname:VkObjectEntryUsageFlagsNVX is a bitmask type for setting a mask of zero or more slink:VkObjectEntryUsageFlagBitsNVX. -- -[open,refpage='vkDestroyObjectTableNVX',desc='Destroy a object table',type='protos'] +[open,refpage='vkDestroyObjectTableNVX',desc='Destroy an object table',type='protos'] -- To destroy an object table, call: diff --git a/chapters/copies.txt b/chapters/copies.txt index 3506ced8..27f6aaed 100644 --- a/chapters/copies.txt +++ b/chapters/copies.txt @@ -780,7 +780,7 @@ endif::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] include::../validity/structs/VkImageCopy.txt[] -- -[open,refpage='VkImageSubresourceLayers',desc='Structure specifying a image subresource layers',type='structs'] +[open,refpage='VkImageSubresourceLayers',desc='Structure specifying an image subresource layers',type='structs'] -- The sname:VkImageSubresourceLayers structure is defined as: diff --git a/chapters/descriptorsets.txt b/chapters/descriptorsets.txt index 70a2f3dd..437f5749 100644 --- a/chapters/descriptorsets.txt +++ b/chapters/descriptorsets.txt @@ -2361,7 +2361,7 @@ ifdef::VULKAN_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and pname:dstSet was allocated with a layout that included immutable samplers for pname:dstBinding, then the pname:imageView member of each element of - pname:pImageInfo which corresponds to a immutable sampler that enables + pname:pImageInfo which corresponds to an immutable sampler that enables <> must: have been created with a sname:VkSamplerYcbcrConversionInfo structure in its pname:pNext chain with an _identically defined_ @@ -3104,7 +3104,7 @@ const VkDescriptorUpdateTemplateEntry descriptorUpdateTemplateEntries[] = }, }; -// create an descriptor update template for descriptor set updates +// create a descriptor update template for descriptor set updates const VkDescriptorUpdateTemplateCreateInfo createInfo = { VK_STRUCTURE_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_CREATE_INFO, // sType @@ -3443,7 +3443,7 @@ const VkDescriptorUpdateTemplateEntry descriptorUpdateTemplateEntries[] = }; -// create an descriptor update template for descriptor set updates +// create a descriptor update template for descriptor set updates const VkDescriptorUpdateTemplateCreateInfo createInfo = { VK_STRUCTURE_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_CREATE_INFO, // sType diff --git a/chapters/extensions.txt b/chapters/extensions.txt index c1bced1a..6fe154e7 100644 --- a/chapters/extensions.txt +++ b/chapters/extensions.txt @@ -308,7 +308,7 @@ by that layer are returned. include::../validity/protos/vkEnumerateDeviceExtensionProperties.txt[] -- -[open,refpage='VkExtensionProperties',desc='Structure specifying a extension properties',type='structs'] +[open,refpage='VkExtensionProperties',desc='Structure specifying an extension properties',type='structs'] -- The sname:VkExtensionProperties structure is defined as: diff --git a/chapters/features.txt b/chapters/features.txt index a1d6d37d..71db73bd 100755 --- a/chapters/features.txt +++ b/chapters/features.txt @@ -4236,7 +4236,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2{times}1 compressed texel block. - * ename:VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM specifies a unsigned + * ename:VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM specifies an unsigned normalized _multi-planar format_ that has an 8-bit G component in plane 0, an 8-bit B component in plane 1, and an 8-bit R component in plane 2. The horizontal and vertical dimensions of the R and B planes are halved @@ -4251,7 +4251,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must: be defined with a width and height that is a multiple of two. - * ename:VK_FORMAT_G8_B8R8_2PLANE_420_UNORM specifies a unsigned normalized + * ename:VK_FORMAT_G8_B8R8_2PLANE_420_UNORM specifies an unsigned normalized _multi-planar format_ that has an 8-bit G component in plane 0, and a two-component, 16-bit BR plane 1 consisting of an 8-bit B component in byte 0 and an 8-bit R component in byte 1. @@ -4265,7 +4265,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must: be defined with a width and height that is a multiple of two. - * ename:VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM specifies a unsigned + * ename:VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM specifies an unsigned normalized _multi-planar format_ that has an 8-bit G component in plane 0, an 8-bit B component in plane 1, and an 8-bit R component in plane 2. The horizontal dimension of the R and B plane is halved relative to the @@ -4278,7 +4278,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must: be defined with a width that is a multiple of two. - * ename:VK_FORMAT_G8_B8R8_2PLANE_422_UNORM specifies a unsigned normalized + * ename:VK_FORMAT_G8_B8R8_2PLANE_422_UNORM specifies an unsigned normalized _multi-planar format_ that has an 8-bit G component in plane 0, and a two-component, 16-bit BR plane 1 consisting of an 8-bit B component in byte 0 and an 8-bit R component in byte 1. @@ -4291,7 +4291,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must: be defined with a width that is a multiple of two. - * ename:VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM specifies a unsigned + * ename:VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM specifies an unsigned normalized _multi-planar format_ that has an 8-bit G component in plane 0, an 8-bit B component in plane 1, and an 8-bit R component in plane 2. Each plane has the same dimensions and each R, G and B component @@ -4585,7 +4585,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2{times}1 compressed texel block. - * ename:VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM specifies a unsigned + * ename:VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM specifies an unsigned normalized _multi-planar format_ that has a 16-bit G component in each 16-bit word of plane 0, a 16-bit B component in each 16-bit word of plane 1, and a 16-bit R component in each 16-bit word of plane 2. @@ -4601,7 +4601,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must: be defined with a width and height that is a multiple of two. - * ename:VK_FORMAT_G16_B16R16_2PLANE_420_UNORM specifies a unsigned + * ename:VK_FORMAT_G16_B16R16_2PLANE_420_UNORM specifies an unsigned normalized _multi-planar format_ that has a 16-bit G component in each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 16-bit B component in the word in bytes 0..1, and a @@ -4616,7 +4616,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must: be defined with a width and height that is a multiple of two. - * ename:VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM specifies a unsigned + * ename:VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM specifies an unsigned normalized _multi-planar format_ that has a 16-bit G component in each 16-bit word of plane 0, a 16-bit B component in each 16-bit word of plane 1, and a 16-bit R component in each 16-bit word of plane 2. @@ -4630,7 +4630,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must: be defined with a width that is a multiple of two. - * ename:VK_FORMAT_G16_B16R16_2PLANE_422_UNORM specifies a unsigned + * ename:VK_FORMAT_G16_B16R16_2PLANE_422_UNORM specifies an unsigned normalized _multi-planar format_ that has a 16-bit G component in each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 16-bit B component in the word in bytes 0..1, and a @@ -4644,7 +4644,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must: be defined with a width that is a multiple of two. - * ename:VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM specifies a unsigned + * ename:VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM specifies an unsigned normalized _multi-planar format_ that has a 16-bit G component in each 16-bit word of plane 0, a 16-bit B component in each 16-bit word of plane 1, and a 16-bit R component in each 16-bit word of plane 2. @@ -6295,7 +6295,7 @@ pname:format, pname:type, and pname:tiling. include::../validity/protos/vkGetPhysicalDeviceImageFormatProperties.txt[] -- -[open,refpage='VkImageFormatProperties',desc='Structure specifying a image format properties',type='structs'] +[open,refpage='VkImageFormatProperties',desc='Structure specifying an image format properties',type='structs'] -- The sname:VkImageFormatProperties structure is defined as: @@ -6453,7 +6453,7 @@ pname:sType and pname:pNext added for extensibility. include::../validity/structs/VkPhysicalDeviceImageFormatInfo2.txt[] -- -[open,refpage='VkImageFormatProperties2',desc='Structure specifying a image format properties',type='structs'] +[open,refpage='VkImageFormatProperties2',desc='Structure specifying an image format properties',type='structs'] -- The sname:VkImageFormatProperties2 structure is defined as: diff --git a/chapters/initialization.txt b/chapters/initialization.txt index dbba3424..0d519a30 100644 --- a/chapters/initialization.txt +++ b/chapters/initialization.txt @@ -163,7 +163,7 @@ endif::VK_VERSION_1_1,VK_KHR_get_physical_device_properties2[] [[initialization-instances]] == Instances -[open,refpage='VkInstance',desc='Opaque handle to a instance object',type='handles'] +[open,refpage='VkInstance',desc='Opaque handle to an instance object',type='handles'] -- There is no global state in Vulkan and all per-application state is stored diff --git a/chapters/memory.txt b/chapters/memory.txt index 46c37b29..2c561a8f 100644 --- a/chapters/memory.txt +++ b/chapters/memory.txt @@ -2783,7 +2783,7 @@ representation, images with external formats must: only be used as sampled images, must: only be sampled with a sampler that has Y'C~B~C~R~ conversion enabled, and must: have optimal tiling. -Images that will be backed by a Android hardware buffer can: use an external +Images that will be backed by an Android hardware buffer can: use an external format by setting slink:VkImageCreateInfo::pname:format to ename:VK_FORMAT_UNDEFINED and including an instance of slink:VkExternalFormatANDROID in the pname:pNext chain. diff --git a/chapters/resources.txt b/chapters/resources.txt index 2a5fe2cd..928f04c4 100644 --- a/chapters/resources.txt +++ b/chapters/resources.txt @@ -504,7 +504,7 @@ include::../validity/protos/vkDestroyBufferView.txt[] [[resources-images]] == Images -[open,refpage='VkImage',desc='Opaque handle to a image object',type='handles'] +[open,refpage='VkImage',desc='Opaque handle to an image object',type='handles'] -- Images represent multidimensional - up to 3 - arrays of data which can: be @@ -1506,7 +1506,7 @@ endif::VK_ANDROID_external_memory_android_hardware_buffer[] include::../validity/protos/vkGetImageSubresourceLayout.txt[] -- -[open,refpage='VkImageSubresource',desc='Structure specifying a image subresource',type='structs'] +[open,refpage='VkImageSubresource',desc='Structure specifying an image subresource',type='structs'] -- The sname:VkImageSubresource structure is defined as: @@ -1885,7 +1885,7 @@ endif::VK_EXT_sample_locations[] [[resources-image-views]] == Image Views -[open,refpage='VkImageView',desc='Opaque handle to a image view object',type='handles'] +[open,refpage='VkImageView',desc='Opaque handle to an image view object',type='handles'] -- Image objects are not directly accessed by pipeline shaders for reading or @@ -2609,7 +2609,7 @@ include::../validity/structs/VkImageViewUsageCreateInfo.txt[] endif::VK_VERSION_1_1,VK_KHR_maintenance2[] -[open,refpage='VkImageSubresourceRange',desc='Structure specifying a image subresource range',type='structs'] +[open,refpage='VkImageSubresourceRange',desc='Structure specifying an image subresource range',type='structs'] -- The sname:VkImageSubresourceRange structure is defined as: diff --git a/chapters/synchronization.txt b/chapters/synchronization.txt index 4d921330..c7c8c296 100644 --- a/chapters/synchronization.txt +++ b/chapters/synchronization.txt @@ -2843,7 +2843,7 @@ endif::VK_VERSION_1_1,VK_KHR_external_semaphore[] [[synchronization-events]] == Events -[open,refpage='VkEvent',desc='Opaque handle to a event object',type='handles'] +[open,refpage='VkEvent',desc='Opaque handle to an event object',type='handles'] -- Events are a synchronization primitive that can: be used to insert a @@ -3626,7 +3626,7 @@ include::../validity/structs/VkMemoryBarrier.txt[] Buffer memory barriers only apply to memory accesses involving a specific buffer range. -That is, a memory dependency formed from an buffer memory barrier is +That is, a memory dependency formed from a buffer memory barrier is <> to access via the specified buffer range. Buffer memory barriers can: also be used to define a From c7a2fcf5ecc184c758f9ac451e01a64e3a2e87b0 Mon Sep 17 00:00:00 2001 From: William Henning Date: Mon, 6 Aug 2018 17:18:20 -0600 Subject: [PATCH 3/4] Fix "a" vs "an" typos occuring across two lines --- .../generatedcommands.txt | 2 +- chapters/features.txt | 20 +++++++++---------- chapters/memory.txt | 2 +- chapters/renderpass.txt | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/chapters/VK_NVX_device_generated_commands/generatedcommands.txt b/chapters/VK_NVX_device_generated_commands/generatedcommands.txt index bc785318..3916336e 100644 --- a/chapters/VK_NVX_device_generated_commands/generatedcommands.txt +++ b/chapters/VK_NVX_device_generated_commands/generatedcommands.txt @@ -5,7 +5,7 @@ This chapter discusses the generation of command buffer content on the device. These principle steps are to be taken to generate commands on the device: - * Make resource bindings accessible for the device via registering in an + * Make resource bindings accessible for the device via registering in a sname:VkObjectTableNVX. * Define via sname:VkIndirectCommandsLayoutNVX the sequence of commands which should be generated. diff --git a/chapters/features.txt b/chapters/features.txt index 71db73bd..e7ac42d4 100755 --- a/chapters/features.txt +++ b/chapters/features.txt @@ -4350,7 +4350,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2{times}1 compressed texel block. - * ename:VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16 specifies a + * ename:VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16 specifies an unsigned normalized _multi-planar format_ that has a 10-bit G component in the top 10 bits of each 16-bit word of plane 0, a 10-bit B component in the top 10 bits of each 16-bit word of plane 1, and a 10-bit R @@ -4368,7 +4368,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must: be defined with a width and height that is a multiple of two. - * ename:VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16 specifies a + * ename:VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16 specifies an unsigned normalized _multi-planar format_ that has a 10-bit G component in the top 10 bits of each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 10-bit B component in the top 10 bits @@ -4384,7 +4384,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must: be defined with a width and height that is a multiple of two. - * ename:VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16 specifies a + * ename:VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16 specifies an unsigned normalized _multi-planar format_ that has a 10-bit G component in the top 10 bits of each 16-bit word of plane 0, a 10-bit B component in the top 10 bits of each 16-bit word of plane 1, and a 10-bit R @@ -4400,7 +4400,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must: be defined with a width that is a multiple of two. - * ename:VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16 specifies a + * ename:VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16 specifies an unsigned normalized _multi-planar format_ that has a 10-bit G component in the top 10 bits of each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 10-bit B component in the top 10 bits @@ -4415,7 +4415,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must: be defined with a width that is a multiple of two. - * ename:VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16 specifies a + * ename:VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16 specifies an unsigned normalized _multi-planar format_ that has a 10-bit G component in the top 10 bits of each 16-bit word of plane 0, a 10-bit B component in the top 10 bits of each 16-bit word of plane 1, and a 10-bit R @@ -4477,7 +4477,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2{times}1 compressed texel block. - * ename:VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16 specifies a + * ename:VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16 specifies an unsigned normalized _multi-planar format_ that has a 12-bit G component in the top 12 bits of each 16-bit word of plane 0, a 12-bit B component in the top 12 bits of each 16-bit word of plane 1, and a 12-bit R @@ -4495,7 +4495,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must: be defined with a width and height that is a multiple of two. - * ename:VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16 specifies a + * ename:VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16 specifies an unsigned normalized _multi-planar format_ that has a 12-bit G component in the top 12 bits of each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 12-bit B component in the top 12 bits @@ -4511,7 +4511,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must: be defined with a width and height that is a multiple of two. - * ename:VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16 specifies a + * ename:VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16 specifies an unsigned normalized _multi-planar format_ that has a 12-bit G component in the top 12 bits of each 16-bit word of plane 0, a 12-bit B component in the top 12 bits of each 16-bit word of plane 1, and a 12-bit R @@ -4527,7 +4527,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must: be defined with a width that is a multiple of two. - * ename:VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16 specifies a + * ename:VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16 specifies an unsigned normalized _multi-planar format_ that has a 12-bit G component in the top 12 bits of each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 12-bit B component in the top 12 bits @@ -4542,7 +4542,7 @@ ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[] ename:VK_IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must: be defined with a width that is a multiple of two. - * ename:VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16 specifies a + * ename:VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16 specifies an unsigned normalized _multi-planar format_ that has a 12-bit G component in the top 12 bits of each 16-bit word of plane 0, a 12-bit B component in the top 12 bits of each 16-bit word of plane 1, and a 12-bit R diff --git a/chapters/memory.txt b/chapters/memory.txt index 2c561a8f..fbd2bbe3 100644 --- a/chapters/memory.txt +++ b/chapters/memory.txt @@ -356,7 +356,7 @@ If synchronization is needed, the callbacks must: provide it themselves. The informational callbacks are subject to the same restrictions as the allocation callbacks. -If an implementation intends to make calls through an +If an implementation intends to make calls through a sname:VkAllocationCallbacks structure between the time a ftext:vkCreate* command returns and the time a corresponding ftext:vkDestroy* command begins, that implementation must: save a copy of the allocator before the diff --git a/chapters/renderpass.txt b/chapters/renderpass.txt index 194f5af4..16700b7a 100644 --- a/chapters/renderpass.txt +++ b/chapters/renderpass.txt @@ -1053,7 +1053,7 @@ pname:srcStageMask/pname:dstStageMask parameters). The only difference being that its scopes are limited to the identified subpasses rather than potentially affecting everything before and after. -For attachments however, subpass dependencies work more like an +For attachments however, subpass dependencies work more like a slink:VkImageMemoryBarrier defined similarly to the slink:VkMemoryBarrier above, the queue family indices set to ename:VK_QUEUE_FAMILY_IGNORED, and layouts as follows: From 969fb50f312c067af438a21a5abd0ae8ff98ef5a Mon Sep 17 00:00:00 2001 From: William Henning Date: Mon, 6 Aug 2018 20:19:01 -0600 Subject: [PATCH 4/4] Remove doubly typed word typos --- chapters/VK_EXT_debug_utils.txt | 2 +- chapters/VK_GOOGLE_display_timing/queries.txt | 4 +-- .../platformCreateSurface_vi.txt | 2 +- chapters/copies.txt | 2 +- chapters/drawing.txt | 28 +++++++++---------- chapters/features.txt | 4 +-- chapters/fxvertex.txt | 2 +- 7 files changed, 22 insertions(+), 22 deletions(-) diff --git a/chapters/VK_EXT_debug_utils.txt b/chapters/VK_EXT_debug_utils.txt index fa10a3e5..c15431f8 100644 --- a/chapters/VK_EXT_debug_utils.txt +++ b/chapters/VK_EXT_debug_utils.txt @@ -553,7 +553,7 @@ include::../api/structs/VkDebugUtilsMessengerCallbackDataEXT.txt[] * pname:sType is the type of this structure. * pname:pNext is `NULL` or a pointer to an extension-specific structure. * pname:flags is 0 and reserved for future use. - * pname:pMessageIdName is a null-terminated string that identifies the the + * pname:pMessageIdName is a null-terminated string that identifies the particular message ID that is associated with the provided message. If the message corresponds to a validation layer message, then this string may contain the portion of the Vulkan specification that is diff --git a/chapters/VK_GOOGLE_display_timing/queries.txt b/chapters/VK_GOOGLE_display_timing/queries.txt index 64557f75..99df00f2 100644 --- a/chapters/VK_GOOGLE_display_timing/queries.txt +++ b/chapters/VK_GOOGLE_display_timing/queries.txt @@ -141,7 +141,7 @@ include::../../api/protos/vkGetPastPresentationTimingGOOGLE.txt[] * pname:pPresentationTimingCount is a pointer to an integer related to the number of sname:VkPastPresentationTimingGOOGLE structures to query, as described below. - * pname:pPresentationTimings is either `NULL` or a pointer to an an array + * pname:pPresentationTimings is either `NULL` or a pointer to an array of sname:VkPastPresentationTimingGOOGLE structures. If pname:pPresentationTimings is `NULL`, then the number of newly-available @@ -244,7 +244,7 @@ The semantics for other present modes are as follows: when the image was displayed. For images that are not displayed to the user, fname:vkGetPastPresentationTimingGOOGLE may: not return a - sname:VkPastPresentationTimingGOOGLE structure, or it may: return return + sname:VkPastPresentationTimingGOOGLE structure, or it may: return a sname:VkPastPresentationTimingGOOGLE structure with the value of zero for both sname:VkPastPresentationTimingGOOGLE::pname:actualPresentTime and sname:VkPastPresentationTimingGOOGLE::pname:earliestPresentTime. diff --git a/chapters/VK_NN_vi_surface/platformCreateSurface_vi.txt b/chapters/VK_NN_vi_surface/platformCreateSurface_vi.txt index 579a40f0..476b768f 100644 --- a/chapters/VK_NN_vi_surface/platformCreateSurface_vi.txt +++ b/chapters/VK_NN_vi_surface/platformCreateSurface_vi.txt @@ -29,7 +29,7 @@ mechanisms will have undefined results. The pname:currentExtent of a VI surface is always undefined. Applications are expected to choose an appropriate size for the swapchain's -pname:imageExtent (e.g., by matching the the result of a call to +pname:imageExtent (e.g., by matching the result of a call to code:nn::code:vi::code:GetDisplayResolution). include::../../validity/protos/vkCreateViSurfaceNN.txt[] diff --git a/chapters/copies.txt b/chapters/copies.txt index 27f6aaed..9932c3ad 100644 --- a/chapters/copies.txt +++ b/chapters/copies.txt @@ -638,7 +638,7 @@ endif::VK_VERSION_1_1,VK_KHR_maintenance1[] ifdef::VK_VERSION_1_1,VK_KHR_maintenance1[] * [[VUID-VkImageCopy-srcImage-01790]] If both pname:srcImage and pname:dstImage are of type - ename:VK_IMAGE_TYPE_2D then then pname:extent.depth must: be `1`. + ename:VK_IMAGE_TYPE_2D then pname:extent.depth must: be `1`. * [[VUID-VkImageCopy-srcImage-01791]] If the calling command's pname:srcImage is of type ename:VK_IMAGE_TYPE_2D, and the pname:dstImage is of type diff --git a/chapters/drawing.txt b/chapters/drawing.txt index 7895200e..dc4f522e 100644 --- a/chapters/drawing.txt +++ b/chapters/drawing.txt @@ -601,13 +601,13 @@ The assembled primitives execute the bound graphics pipeline. Image subresources used as attachments in the current render pass must: not be accessed in any way other than as an attachment by this command. * [[VUID-vkCmdDraw-None-02009]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_LINEAR as a + If a sname:VkImageView is sampled with ename:VK_FILTER_LINEAR as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT. ifdef::VK_IMG_filter_cubic[] * [[VUID-vkCmdDraw-None-02010]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_CUBIC_IMG as + If a sname:VkImageView is sampled with ename:VK_FILTER_CUBIC_IMG as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG. @@ -784,7 +784,7 @@ The assembled primitives execute the bound graphics pipeline. buffer, it must: not access values outside of the range of that buffer specified in the bound descriptor set * [[VUID-vkCmdDrawIndexed-None-02011]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_LINEAR as a + If a sname:VkImageView is sampled with ename:VK_FILTER_LINEAR as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT. @@ -793,7 +793,7 @@ The assembled primitives execute the bound graphics pipeline. not be accessed in any way other than as an attachment by this command. ifdef::VK_IMG_filter_cubic[] * [[VUID-vkCmdDrawIndexed-None-02012]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_CUBIC_IMG as + If a sname:VkImageView is sampled with ename:VK_FILTER_CUBIC_IMG as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG. @@ -979,7 +979,7 @@ If pname:drawCount is less than or equal to one, pname:stride is ignored. buffer, it must: not access values outside of the range of that buffer specified in the bound descriptor set * [[VUID-vkCmdDrawIndirect-None-02013]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_LINEAR as a + If a sname:VkImageView is sampled with ename:VK_FILTER_LINEAR as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT. @@ -988,7 +988,7 @@ If pname:drawCount is less than or equal to one, pname:stride is ignored. not be accessed in any way other than as an attachment by this command. ifdef::VK_IMG_filter_cubic[] * [[VUID-vkCmdDrawIndirect-None-02014]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_CUBIC_IMG as + If a sname:VkImageView is sampled with ename:VK_FILTER_CUBIC_IMG as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG. @@ -1219,7 +1219,7 @@ located at pname:countBufferOffset and use this as the draw count. buffer, it must: not access values outside of the range of that buffer specified in the bound descriptor set * [[VUID-vkCmdDrawIndirectCountKHR-None-02015]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_LINEAR as a + If a sname:VkImageView is sampled with ename:VK_FILTER_LINEAR as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT. @@ -1228,7 +1228,7 @@ located at pname:countBufferOffset and use this as the draw count. not be accessed in any way other than as an attachment by this command. ifdef::VK_IMG_filter_cubic[] * [[VUID-vkCmdDrawIndirectCountKHR-None-02016]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_CUBIC_IMG as + If a sname:VkImageView is sampled with ename:VK_FILTER_CUBIC_IMG as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG. @@ -1430,7 +1430,7 @@ located at pname:countBufferOffset and use this as the draw count. buffer, it must: not access values outside of the range of that buffer specified in the bound descriptor set * [[VUID-vkCmdDrawIndirectCountAMD-None-02017]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_LINEAR as a + If a sname:VkImageView is sampled with ename:VK_FILTER_LINEAR as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT. @@ -1616,7 +1616,7 @@ If pname:drawCount is less than or equal to one, pname:stride is ignored. buffer, it must: not access values outside of the range of that buffer specified in the bound descriptor set * [[VUID-vkCmdDrawIndexedIndirect-None-02018]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_LINEAR as a + If a sname:VkImageView is sampled with ename:VK_FILTER_LINEAR as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT. @@ -1625,7 +1625,7 @@ If pname:drawCount is less than or equal to one, pname:stride is ignored. not be accessed in any way other than as an attachment by this command. ifdef::VK_IMG_filter_cubic[] * [[VUID-vkCmdDrawIndexedIndirect-None-02019]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_CUBIC_IMG as + If a sname:VkImageView is sampled with ename:VK_FILTER_CUBIC_IMG as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG. @@ -1864,7 +1864,7 @@ located at pname:countBufferOffset and use this as the draw count. buffer, it must: not access values outside of the range of that buffer specified in the bound descriptor set * [[VUID-vkCmdDrawIndexedIndirectCountKHR-None-02020]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_LINEAR as a + If a sname:VkImageView is sampled with ename:VK_FILTER_LINEAR as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT. @@ -1873,7 +1873,7 @@ located at pname:countBufferOffset and use this as the draw count. not be accessed in any way other than as an attachment by this command. ifdef::VK_IMG_filter_cubic[] * [[VUID-vkCmdDrawIndexedIndirectCountKHR-None-02021]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_CUBIC_IMG as + If a sname:VkImageView is sampled with ename:VK_FILTER_CUBIC_IMG as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG. @@ -2076,7 +2076,7 @@ located at pname:countBufferOffset and use this as the draw count. buffer, it must: not access values outside of the range of that buffer specified in the bound descriptor set * [[VUID-vkCmdDrawIndexedIndirectCountAMD-None-02022]] - If a sname:VkImageView is sampled with with ename:VK_FILTER_LINEAR as a + If a sname:VkImageView is sampled with ename:VK_FILTER_LINEAR as a result of this command, then the image view's <> must: contain ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT. diff --git a/chapters/features.txt b/chapters/features.txt index e7ac42d4..6471e73b 100755 --- a/chapters/features.txt +++ b/chapters/features.txt @@ -2450,7 +2450,7 @@ describe the following implementation-dependent limits: * pname:supportedStages is a bitfield of elink:VkShaderStageFlagBits describing the shader stages that subgroup operations are supported in. pname:supportedStages will have the ename:VK_SHADER_STAGE_COMPUTE_BIT - bit set if any of any of the physical device's queues support + bit set if any of the physical device's queues support ename:VK_QUEUE_COMPUTE_BIT. * pname:supportedOperations is a bitmask of elink:VkSubgroupFeatureFlagBits specifying the sets of subgroup @@ -6891,7 +6891,7 @@ include::../api/structs/VkAndroidHardwareBufferUsageANDROID.txt[] * pname:sType is the type of this structure. * pname:pNext is `NULL` or a pointer to an extension-specific structure. - * pname:androidHardwareBufferUsage returns the the Android hardware buffer + * pname:androidHardwareBufferUsage returns the Android hardware buffer usage flags. The pname:androidHardwareBufferUsage field must: include Android hardware diff --git a/chapters/fxvertex.txt b/chapters/fxvertex.txt index b784ceaf..1175babd 100644 --- a/chapters/fxvertex.txt +++ b/chapters/fxvertex.txt @@ -490,7 +490,7 @@ as: include::../api/structs/VkVertexInputBindingDivisorDescriptionEXT.txt[] * pname:binding is the binding number for which the divisor is specified. - * pname:divisor is the the number of successive instances that will use + * pname:divisor is the number of successive instances that will use the same value of the vertex attribute when instanced rendering is enabled. For example, if the divisor is N, the same vertex attribute will applied