From 712755f6883af760b325bc795c23050cac3255b6 Mon Sep 17 00:00:00 2001 From: Jon Leech Date: Sun, 16 Jul 2017 17:20:08 -0700 Subject: [PATCH] Change log for July 15, 2017 Vulkan 1.0.55 spec update: * Bump API patch number and header version number to 55 for this update. Github Issues: * Removed unintended optional parameter in +vk.xml+ from the pname:pWaitSemaphores member of slink:VkPresentInfoKHR, which resulted in the generation of an incorrect implicit valid usage clause allowing pname:pWaitSemaphores to be NULL even when pname:waitSemaphoreCount is non-zero (public issue 491). * Add missing attribute to +vk.xml+ documenting that slink:VkSwapchainCounterCreateInfoEXT extends slink:VkSwapchainCreateInfo (public issue 510). * Add const qualifier for some `VK_EXT_debug_market` extension command parameters that were missing it (public issue 513). * Fix definition of q and level~base~ in <> (public issue 515). * Clarify lifetime requirement for slink:VkRenderPass objects used in object creation (public issue 516). * Fix link to floating/normalized fixed-point conversion from <> (public issue 521). Internal Issues: * Update the style guide to include the general structure of a Vulkan command name, the specific rule for using "`Get`" vs. "`Enumerate`" in names, and a table of verbs commonly used in command names (spinoff of internal issue 753). * Clarified the behavior of automatic layout transitions in case of attachment views that are 2D or 2D array views of 3D images. In addition, restructured the valid usage clauses corresponding to the members of the slink:VkImageSubresourceRange structure and added missing valid usage clauses for its pname:baseMipLevel and pname:baseArrayLayer members (internal issues 803, 849). * Modify `GL_KHR_vulkan_glsl` specification to allow explicit std430 on a push_constant declaration (internal issue 919). Other Commits: * Modify <> to use synchronization scope terminology. * Add ename:VK_COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT to the `VK_EXT_swapchain_colorspace` extension. * Replace XML comments with `comment` attributes and/or tags, to enable tools which transform the XML without loss of information. * Replace `validextensionstructs` with `structextends`, which is tagged in the child structure instead of the parent. This makes it slightly simpler to add new structs to the XML, causes fewer merge conflicts, and the information is kept localized to the extension structures where it belongs. The old `validextensionstructs` attributes will be retained until we're certain this doesn't cause problems with known consumers of +vk.xml+. --- ChangeLog.txt | 58 + doc/specs/misc/GL_KHR_vulkan_glsl.txt | 14 +- .../VK_EXT_sampler_filter_minmax.txt | 4 +- .../VK_EXT_swapchain_colorspace.txt | 11 +- .../vulkan/chapters/VK_KHR_surface/wsi.txt | 17 +- doc/specs/vulkan/chapters/clears.txt | 58 +- doc/specs/vulkan/chapters/fundamentals.txt | 6 + doc/specs/vulkan/chapters/interfaces.txt | 4 +- doc/specs/vulkan/chapters/renderpass.txt | 13 +- doc/specs/vulkan/chapters/resources.txt | 164 +- doc/specs/vulkan/chapters/synchronization.txt | 39 +- doc/specs/vulkan/chapters/textures.txt | 6 +- doc/specs/vulkan/reflow.py | 2 +- doc/specs/vulkan/registry.txt | 416 ++-- doc/specs/vulkan/style/extensions.txt | 4 +- doc/specs/vulkan/style/naming.txt | 138 +- src/ext_loader/vulkan_ext.c | 8 +- src/spec/generator.py | 7 + src/spec/reg.py | 14 + src/spec/registry.rnc | 52 +- src/spec/validitygenerator.py | 16 +- src/spec/vk.xml | 1823 +++++++++-------- src/vulkan/vulkan.h | 25 +- 23 files changed, 1694 insertions(+), 1205 deletions(-) diff --git a/ChangeLog.txt b/ChangeLog.txt index 3f30b38cac..0eacf58004 100644 --- a/ChangeLog.txt +++ b/ChangeLog.txt @@ -8,6 +8,64 @@ public issues. ----------------------------------------------------- +Change log for July 15, 2017 Vulkan 1.0.55 spec update: + + * Bump API patch number and header version number to 55 for this update. + +Github Issues: + + * Removed unintended optional parameter in +vk.xml+ from the + pname:pWaitSemaphores member of slink:VkPresentInfoKHR, which resulted + in the generation of an incorrect implicit valid usage clause allowing + pname:pWaitSemaphores to be NULL even when pname:waitSemaphoreCount is + non-zero (public issue 491). + * Add missing attribute to +vk.xml+ documenting that + slink:VkSwapchainCounterCreateInfoEXT extends + slink:VkSwapchainCreateInfo (public issue 510). + * Add const qualifier for some `VK_EXT_debug_market` extension command + parameters that were missing it (public issue 513). + * Fix definition of q and level~base~ in + <> (public + issue 515). + * Clarify lifetime requirement for slink:VkRenderPass objects used in + object creation (public issue 516). + * Fix link to floating/normalized fixed-point conversion from + <> (public issue + 521). + +Internal Issues: + + * Update the style guide to include the general structure of a Vulkan + command name, the specific rule for using "`Get`" vs. "`Enumerate`" in + names, and a table of verbs commonly used in command names (spinoff of + internal issue 753). + * Clarified the behavior of automatic layout transitions in case of + attachment views that are 2D or 2D array views of 3D images. In + addition, restructured the valid usage clauses corresponding to the + members of the slink:VkImageSubresourceRange structure and added missing + valid usage clauses for its pname:baseMipLevel and pname:baseArrayLayer + members (internal issues 803, 849). + * Modify `GL_KHR_vulkan_glsl` specification to allow explicit std430 on a + push_constant declaration (internal issue 919). + +Other Commits: + + * Modify <> to use synchronization scope terminology. + * Add ename:VK_COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT to the + `VK_EXT_swapchain_colorspace` extension. + * Replace XML comments with `comment` attributes and/or tags, to enable + tools which transform the XML without loss of information. + * Replace `validextensionstructs` with `structextends`, which is tagged in + the child structure instead of the parent. This makes it slightly + simpler to add new structs to the XML, causes fewer merge conflicts, and + the information is kept localized to the extension structures where it + belongs. The old `validextensionstructs` attributes will be retained + until we're certain this doesn't cause problems with known consumers of + +vk.xml+. + +----------------------------------------------------- + Change log for July 13, 2017 Vulkan 1.0.54 spec update: * Bump API patch number and header version number to 54 for this update. diff --git a/doc/specs/misc/GL_KHR_vulkan_glsl.txt b/doc/specs/misc/GL_KHR_vulkan_glsl.txt index 1bc769feae..d94639e2e9 100644 --- a/doc/specs/misc/GL_KHR_vulkan_glsl.txt +++ b/doc/specs/misc/GL_KHR_vulkan_glsl.txt @@ -33,8 +33,8 @@ Status Version - Last Modified Date: 21-May-2017 - Revision: 40 + Last Modified Date: 05-Jul-2017 + Revision: 41 Number @@ -914,6 +914,15 @@ Changes to Chapter 4 of the OpenGL Shading Language Specification "However, when push_constant is declared, the default layout of the buffer will be std430. There is no method to globally set this default." + Add to this statement: + + "The std430 qualifier is supported only for shader storage blocks; using + std430 on a uniform block will result in a compile-time error" + + the following phrase: + + "unless it is also declared with push_constant" + Add to section 4.4.5 Uniform and Shader Storage Block Layout Qualifiers, for versions not having 'offset' and 'align' description language, or replace with the following for versions that do have 'offset' and @@ -1371,6 +1380,7 @@ Revision History Rev. Date Author Changes ---- ----------- ------- -------------------------------------------- + 41 05-Jul-2017 JohnK allow std430 on push_constant declarations 40 21-May-2017 JohnK Require in/out explicit locations 39 14-Apr-2017 JohnK Update overview for StorageBuffer storage class. diff --git a/doc/specs/vulkan/appendices/VK_EXT_sampler_filter_minmax.txt b/doc/specs/vulkan/appendices/VK_EXT_sampler_filter_minmax.txt index a053023080..e67c44128a 100644 --- a/doc/specs/vulkan/appendices/VK_EXT_sampler_filter_minmax.txt +++ b/doc/specs/vulkan/appendices/VK_EXT_sampler_filter_minmax.txt @@ -25,8 +25,8 @@ - Jeff Bolz (jbolz 'at' nvidia.com) In unextended Vulkan, minification and magnification filters such as LINEAR -allow sampled image lookups to returned a filtered texel value produced by -computing an weighted average of a collection of texels in the neighborhood +allow sampled image lookups to return a filtered texel value produced by +computing a weighted average of a collection of texels in the neighborhood of the texture coordinate provided. This extension provides a new sampler parameter which allows applications to diff --git a/doc/specs/vulkan/appendices/VK_EXT_swapchain_colorspace.txt b/doc/specs/vulkan/appendices/VK_EXT_swapchain_colorspace.txt index 01245b126c..e851570e66 100644 --- a/doc/specs/vulkan/appendices/VK_EXT_swapchain_colorspace.txt +++ b/doc/specs/vulkan/appendices/VK_EXT_swapchain_colorspace.txt @@ -25,15 +25,17 @@ * Extending elink:VkColorSpaceKHR: ** ename:VK_COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT - supports the Display-P3 - color space and applies an sRGB-like OETF. + color space and applies an sRGB-like transfer function. ** ename:VK_COLOR_SPACE_EXTENDED_SRGB_LINEAR_EXT - supports the extended - sRGB color space and applies a linear OETF. + sRGB color space and applies a linear transfer function. + ** ename:VK_COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT - supports the + extended sRGB color space with an sRGB nonlinear transfer function. ** ename:VK_COLOR_SPACE_DCI_P3_LINEAR_EXT - supports the DCI-P3 color space and applies a linear OETF. ** ename:VK_COLOR_SPACE_DCI_P3_NONLINEAR_EXT - supports the DCI-P3 color space and applies the Gamma 2.6 OETF. ** ename:VK_COLOR_SPACE_BT709_LINEAR_EXT - supports the BT709 color space - and applies a linear OETF. + and applies a linear transfer function. ** ename:VK_COLOR_SPACE_BT709_NONLINEAR_EXT - supports the BT709 color space and applies the SMPTE 170M OETF. ** ename:VK_COLOR_SPACE_BT2020_LINEAR_EXT - supports the BT2020 color @@ -81,3 +83,6 @@ described by separate extension. * Revision 2, 2017-01-19 (Courtney Goeltzenleuchter) - Add pass through and multiple options for BT2020. - Clean up some issues with equations not displaying properly. + + * Revision 3, 2017-06-23 (Courtney Goeltzenleuchter) + - Add extended sRGB non-linear enum. diff --git a/doc/specs/vulkan/chapters/VK_KHR_surface/wsi.txt b/doc/specs/vulkan/chapters/VK_KHR_surface/wsi.txt index a77aed81de..e679f00370 100644 --- a/doc/specs/vulkan/chapters/VK_KHR_surface/wsi.txt +++ b/doc/specs/vulkan/chapters/VK_KHR_surface/wsi.txt @@ -647,9 +647,12 @@ include::../../api/enums/VkColorSpaceKHR.txt[] color space. ifdef::VK_EXT_swapchain_colorspace[] * ename:VK_COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT indicates support for the - Display-P3 color space and applies an sRGB-like OETF (defined below). + Display-P3 color space and applies an sRGB-like transfer function + (defined below). * ename:VK_COLOR_SPACE_EXTENDED_SRGB_LINEAR_EXT indicates support for the - extended sRGB color space and applies a linear OETF. + extended sRGB color space and applies a linear transfer function. + * ename:VK_COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT indicates support for + the extended sRGB color space and applies an sRGB transfer function. * ename:VK_COLOR_SPACE_DCI_P3_LINEAR_EXT indicates support for the DCI-P3 color space and applies a linear OETF. * ename:VK_COLOR_SPACE_DCI_P3_NONLINEAR_EXT indicates support for the @@ -679,8 +682,8 @@ ifdef::VK_EXT_swapchain_colorspace[] The color components of Non-linear color space swap chain images have had the appropriate transfer function applied. -Vulkan requires that all implementations support the sRGB OETF and EOTF -transfer functions when using an SRGB pixel format. +Vulkan requires that all implementations support the sRGB transfer function +when using an SRGB pixel format. Other transfer functions, such as SMPTE 170M or SMPTE2084, must: not be performed by the implementation, but can: be performed by the application shader. @@ -691,7 +694,7 @@ the following color spaces:: .Color Spaces and Attributes [options="header"] |==== -| Name | Red Primary | Green Primary | Blue Primary | White-point | OETF +| Name | Red Primary | Green Primary | Blue Primary | White-point | Transfer function | DCI-P3 | 0.680, 0.320 | 0.265, 0.690 | 0.150, 0.060 | 0.3127, 0.3290 (D65) | Gamma 2.6 | Display-P3 | 0.680, 0.320 | 0.265, 0.690 | 0.150, 0.060 | 0.3127, 0.3290 (D65) | Display-P3 | BT709 | 0.640, 0.330 | 0.300, 0.600 | 0.150, 0.060 | 0.3127, 0.3290 (D65) | SMPTE 170M @@ -719,7 +722,7 @@ endif::VK_EXT_swapchain_colorspace[] ifdef::VK_EXT_swapchain_colorspace[] -=== sRGB OETF +=== sRGB transfer function [latexmath] +++++++++++++++++++ @@ -852,7 +855,7 @@ latexmath:[a = 0.17883277 \text{ and } b = 0.28466892 \text{, and } c = 0.55991073] -=== AdobeRGB OETF +=== Adobe RGB (1998) OETF latexmath:[E = L^\frac{1}{2.19921875}] diff --git a/doc/specs/vulkan/chapters/clears.txt b/doc/specs/vulkan/chapters/clears.txt index c77d283b4e..5e00a8ad9d 100644 --- a/doc/specs/vulkan/chapters/clears.txt +++ b/doc/specs/vulkan/chapters/clears.txt @@ -78,9 +78,32 @@ 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[] - * [[VUID-vkCmdClearColorImage-pRanges-00006]] - The image range of any given element of pname:pRanges must: be an image - subresource range that is contained within pname:image + * [[VUID-vkCmdClearColorImage-baseMipLevel-01470]] + The slink:VkImageSubresourceRange::pname:baseMipLevel members of the + elements of the pname:pRanges array must: each be less than the + pname:mipLevels specified in slink:VkImageCreateInfo when pname:image + was created + * [[VUID-vkCmdClearColorImage-levelCount-01471]] + If the slink:VkImageSubresourceRange::pname:levelCount member of any + element of the pname:pRanges array is not ename:VK_REMAINING_MIP_LEVELS, + it must: be non-zero and + [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 + * [[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 + * [[VUID-vkCmdClearColorImage-layerCount-01473]] + If the slink:VkImageSubresourceRange::pname:layerCount member of any + element of the pname:pRanges array is not + ename:VK_REMAINING_ARRAY_LAYERS, it must: be non-zero and + [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 * [[VUID-vkCmdClearColorImage-image-00007]] pname:image must: not have a compressed or depth/stencil format **** @@ -143,9 +166,32 @@ endif::VK_KHR_maintenance1[] pname:imageLayout must: be either of ename:VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL or ename:VK_IMAGE_LAYOUT_GENERAL - * [[VUID-vkCmdClearDepthStencilImage-pRanges-00013]] - The image range of any given element of pname:pRanges must: be an image - subresource range that is contained within pname:image + * [[VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474]] + The slink:VkImageSubresourceRange::pname:baseMipLevel members of the + elements of the pname:pRanges array must: each be less than the + pname:mipLevels specified in slink:VkImageCreateInfo when pname:image + was created + * [[VUID-vkCmdClearDepthStencilImage-levelCount-01475]] + If the slink:VkImageSubresourceRange::pname:levelCount member of any + element of the pname:pRanges array is not ename:VK_REMAINING_MIP_LEVELS, + it must: be non-zero and + [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 + * [[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 + * [[VUID-vkCmdClearDepthStencilImage-layerCount-01477]] + If the slink:VkImageSubresourceRange::pname:layerCount member of any + element of the pname:pRanges array is not + ename:VK_REMAINING_ARRAY_LAYERS, it must: be non-zero and + [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 * [[VUID-vkCmdClearDepthStencilImage-image-00014]] pname:image must: have a depth/stencil format **** diff --git a/doc/specs/vulkan/chapters/fundamentals.txt b/doc/specs/vulkan/chapters/fundamentals.txt index 2cfe0f13a1..1bed718f7d 100644 --- a/doc/specs/vulkan/chapters/fundamentals.txt +++ b/doc/specs/vulkan/chapters/fundamentals.txt @@ -297,6 +297,12 @@ passed into: * sname:VkShaderModule * sname:VkPipelineCache +A sname:VkRenderPass object passed as a parameter to create another object +is not further accessed by that object after the duration of the command it +is passed into. +A sname:VkRenderPass used in a command buffer follows the rules described +below. + A sname:VkPipelineLayout object must: not be destroyed while any command buffer that uses it is in the recording state. diff --git a/doc/specs/vulkan/chapters/interfaces.txt b/doc/specs/vulkan/chapters/interfaces.txt index 1325b68b74..aeb17f2ecd 100644 --- a/doc/specs/vulkan/chapters/interfaces.txt +++ b/doc/specs/vulkan/chapters/interfaces.txt @@ -380,8 +380,8 @@ endif::VK_KHR_16bit_storage[] Composites of these types are also permitted. If the color attachment has a signed or unsigned normalized fixed-point format, color values are assumed to be floating-point and are converted to -fixed-point as described in <>; otherwise no type -conversion is applied. +fixed-point as described in <>; otherwise no +type conversion is applied. If the type of the values written by the fragment shader do not match the format of the corresponding color attachment, the result is undefined for those components. diff --git a/doc/specs/vulkan/chapters/renderpass.txt b/doc/specs/vulkan/chapters/renderpass.txt index b5f5774c40..0e6df21f85 100644 --- a/doc/specs/vulkan/chapters/renderpass.txt +++ b/doc/specs/vulkan/chapters/renderpass.txt @@ -1055,6 +1055,15 @@ The implementation then must: execute layout transitions between subpasses in order to guarantee that the images are in the layouts required by each subpass, and in the final layout at the end of the render pass. +Automatic layout transitions apply to the entire image subresource attached +to the framebuffer. +ifdef::VK_KHR_maintenance1[] +If the attachment view is a 2D or 2D array view of a 3D image, even if the +attachment view only refers to a subset of the slices of the selected mip +level of the 3D image, automatic layout transitions apply to the entire +subresource referenced which is the entire mip level in this case. +endif::VK_KHR_maintenance1[] + Automatic layout transitions away from the layout used in a subpass happen-after the availability operations for all dependencies with that subpass as the pname:srcSubpass. @@ -1669,7 +1678,9 @@ The conditions leading to an optimal pname:renderArea are: slink:VkRenderPassBeginInfo. Subpass dependencies are not affected by the render area, and apply to the -entire image subresources attached to the framebuffer. +entire image subresources attached to the framebuffer as specified in the +description of <>. Similarly, pipeline barriers are valid even if their effect extends outside the render area. diff --git a/doc/specs/vulkan/chapters/resources.txt b/doc/specs/vulkan/chapters/resources.txt index 1d3ee036e1..6160bd880b 100644 --- a/doc/specs/vulkan/chapters/resources.txt +++ b/doc/specs/vulkan/chapters/resources.txt @@ -557,7 +557,7 @@ Implementations may: support additional limits and capabilities beyond those listed above. To query an implementation's specific capabilities for a given combination -of pname:format, pname:type, pname:tiling, pname:usage, +of pname:format, pname:imageType, pname:tiling, pname:usage, ifdef::VK_KHR_external_memory_capabilities[] slink:VkExternalMemoryImageCreateInfoKHR::pname:handleTypes endif::VK_KHR_external_memory_capabilities[] @@ -580,10 +580,11 @@ flink:vkGetPhysicalDeviceFormatProperties. .Valid Usage **** * [[VUID-VkImageCreateInfo-format-00940]] - The combination of pname:format, pname:type, pname:tiling, pname:usage, - and pname:flags must: be supported, as indicated by a ename:VK_SUCCESS - return value from fname:vkGetPhysicalDeviceImageFormatProperties invoked - with the same values passed to the corresponding parameters. + The combination of pname:format, pname:imageType, pname:tiling, + pname:usage, and pname:flags must: be supported, as indicated by a + ename:VK_SUCCESS return value from + fname:vkGetPhysicalDeviceImageFormatProperties invoked with the same + values passed to the corresponding parameters. * [[VUID-VkImageCreateInfo-sharingMode-00941]] If pname:sharingMode is ename:VK_SHARING_MODE_CONCURRENT, pname:pQueueFamilyIndices must: be a pointer to an array of @@ -635,8 +636,8 @@ endif::VK_KHR_maintenance1[] sname:VkPhysicalDeviceLimits::pname:maxImageDimension1D, or sname:VkImageFormatProperties::pname:maxExtent.width (as returned by fname:vkGetPhysicalDeviceImageFormatProperties with pname:format, - pname:type, pname:tiling, pname:usage, and pname:flags equal to those in - this structure) - whichever is higher + pname:imageType, pname:tiling, pname:usage, and pname:flags equal to + those in this structure) - whichever is higher * [[VUID-VkImageCreateInfo-imageType-00952]] If pname:imageType is ename:VK_IMAGE_TYPE_2D and pname:flags does not contain ename:VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT, pname:extent.width @@ -644,8 +645,8 @@ endif::VK_KHR_maintenance1[] sname:VkPhysicalDeviceLimits::pname:maxImageDimension2D, or sname:VkImageFormatProperties::pname:maxExtent.width/height (as returned by fname:vkGetPhysicalDeviceImageFormatProperties with pname:format, - pname:type, pname:tiling, pname:usage, and pname:flags equal to those in - this structure) - whichever is higher + pname:imageType, pname:tiling, pname:usage, and pname:flags equal to + those in this structure) - whichever is higher * [[VUID-VkImageCreateInfo-imageType-00953]] If pname:imageType is ename:VK_IMAGE_TYPE_2D and pname:flags contains ename:VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT, pname:extent.width and @@ -653,8 +654,8 @@ endif::VK_KHR_maintenance1[] sname:VkPhysicalDeviceLimits::pname:maxImageDimensionCube, or sname:VkImageFormatProperties::pname:maxExtent.width/height (as returned by fname:vkGetPhysicalDeviceImageFormatProperties with pname:format, - pname:type, pname:tiling, pname:usage, and pname:flags equal to those in - this structure) - whichever is higher + pname:imageType, pname:tiling, pname:usage, and pname:flags equal to + those in this structure) - whichever is higher * [[VUID-VkImageCreateInfo-imageType-00954]] If pname:imageType is ename:VK_IMAGE_TYPE_2D and pname:flags contains ename:VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT, pname:extent.width and @@ -666,8 +667,8 @@ endif::VK_KHR_maintenance1[] to sname:VkPhysicalDeviceLimits::pname:maxImageDimension3D, or sname:VkImageFormatProperties::pname:maxExtent.width/height/depth (as returned by fname:vkGetPhysicalDeviceImageFormatProperties with - pname:format, pname:type, pname:tiling, pname:usage, and pname:flags - equal to those in this structure) - whichever is higher + pname:format, pname:imageType, pname:tiling, pname:usage, and + pname:flags equal to those in this structure) - whichever is higher * [[VUID-VkImageCreateInfo-imageType-00956]] If pname:imageType is ename:VK_IMAGE_TYPE_1D, both pname:extent.height and pname:extent.depth must: be `1` @@ -685,14 +686,14 @@ endif::VK_KHR_maintenance1[] must: be less than or equal to sname:VkImageFormatProperties::pname:maxMipLevels (as returned by fname:vkGetPhysicalDeviceImageFormatProperties with pname:format, - pname:type, pname:tiling, pname:usage, and pname:flags equal to those in - this structure) + pname:imageType, pname:tiling, pname:usage, and pname:flags equal to + those in this structure) * [[VUID-VkImageCreateInfo-arrayLayers-00960]] pname:arrayLayers must: be less than or equal to sname:VkImageFormatProperties::pname:maxArrayLayers (as returned by fname:vkGetPhysicalDeviceImageFormatProperties with pname:format, - pname:type, pname:tiling, pname:usage, and pname:flags equal to those in - this structure) + pname:imageType, pname:tiling, pname:usage, and pname:flags equal to + those in this structure) * [[VUID-VkImageCreateInfo-imageType-00961]] If pname:imageType is ename:VK_IMAGE_TYPE_3D, pname:arrayLayers must: be `1`. @@ -730,8 +731,8 @@ endif::VK_KHR_maintenance1[] pname:samples must: be a bit value that is set in sname:VkImageFormatProperties::pname:sampleCounts returned by fname:vkGetPhysicalDeviceImageFormatProperties with pname:format, - pname:type, pname:tiling, pname:usage, and pname:flags equal to those in - this structure + pname:imageType, pname:tiling, pname:usage, and pname:flags equal to + those in this structure * [[VUID-VkImageCreateInfo-usage-00968]] If the <> feature is not enabled, and pname:usage contains @@ -863,8 +864,8 @@ ifdef::VK_KHR_external_memory[] must: only contain bits that are also in slink:VkExternalImageFormatPropertiesKHR::pname:externalMemoryProperties::pname:compatibleHandleTypes, as returned by flink:vkGetPhysicalDeviceImageFormatProperties2KHR with - pname:format, pname:type, pname:tiling, pname:usage, and pname:flags - equal to those in this structure, and with an instance of + pname:format, pname:imageType, pname:tiling, pname:usage, and + pname:flags equal to those in this structure, and with an instance of slink:VkPhysicalDeviceExternalImageFormatInfoKHR in the pname:pNext chain, with a pname:handleType equal to any one of the handle types specified in slink:VkExternalMemoryImageCreateInfoKHR::pname:handleTypes @@ -876,7 +877,7 @@ ifdef::VK_NV_external_memory+VK_NV_external_memory_capabilities[] must: only contain bits that are also in slink:VkExternalImageFormatPropertiesNV::pname:externalMemoryProperties::pname:compatibleHandleTypes, as returned by flink:vkGetPhysicalDeviceExternalImageFormatPropertiesNV - with pname:format, pname:type, pname:tiling, pname:usage, and + with pname:format, pname:imageType, pname:tiling, pname:usage, and pname:flags equal to those in this structure, and with pname:externalHandleType equal to any one of the handle types specified in slink:VkExternalMemoryImageCreateInfoNV::pname:handleTypes @@ -1805,9 +1806,70 @@ endif::VK_KHR_maintenance1[] flag in sname:VkFormatProperties::pname:optimalTilingFeatures returned by fname:vkGetPhysicalDeviceFormatProperties with the same value of pname:format - * [[VUID-VkImageViewCreateInfo-subresourceRange-01017]] - pname:subresourceRange must: be a valid image subresource range for - pname:image (see <>) + * [[VUID-VkImageViewCreateInfo-subresourceRange-01478]] + pname:subresourceRange::pname:baseMipLevel must: be less than the + pname:mipLevels specified in slink:VkImageCreateInfo when pname:image + was created + * [[VUID-VkImageViewCreateInfo-subresourceRange-01479]] + If pname:subresourceRange::pname:levelCount is not + ename:VK_REMAINING_MIP_LEVELS, pname:subresourceRange::pname:levelCount + must: be non-zero and [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 +ifndef::VK_KHR_maintenance1[] + * [[VUID-VkImageViewCreateInfo-subresourceRange-01480]] + pname:subresourceRange::pname:baseArrayLayer must: be less than the + pname:arrayLayers specified in slink:VkImageCreateInfo when pname:image + was created + * [[VUID-VkImageViewCreateInfo-subresourceRange-01481]] + If pname:subresourceRange::pname:layerCount is not + ename:VK_REMAINING_ARRAY_LAYERS, + pname:subresourceRange::pname:layerCount must: be non-zero and + [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 +endif::VK_KHR_maintenance1[] +ifdef::VK_KHR_maintenance1[] + * [[VUID-VkImageViewCreateInfo-image-01482]] + If pname:image is not a 3D image created with + ename:VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR set, or pname:viewType + is not ename:VK_IMAGE_VIEW_TYPE_2D or ename:VK_IMAGE_VIEW_TYPE_2D_ARRAY, + pname:subresourceRange::pname:baseArrayLayer must: be less than the + pname:arrayLayers specified in slink:VkImageCreateInfo when pname:image + was created + * [[VUID-VkImageViewCreateInfo-subresourceRange-01483]] + If pname:subresourceRange::pname:layerCount is not + ename:VK_REMAINING_ARRAY_LAYERS, pname:image is not a 3D image created + with ename:VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR set, or + pname:viewType is not ename:VK_IMAGE_VIEW_TYPE_2D or + ename:VK_IMAGE_VIEW_TYPE_2D_ARRAY, + pname:subresourceRange::pname:layerCount must: be non-zero and + [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 + * [[VUID-VkImageViewCreateInfo-image-01484]] + If pname:image is a 3D image created with + ename:VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR set, and + pname:viewType is ename:VK_IMAGE_VIEW_TYPE_2D or + ename:VK_IMAGE_VIEW_TYPE_2D_ARRAY, + pname:subresourceRange::pname:baseArrayLayer must: be less than the + pname:extent.depth specified in slink:VkImageCreateInfo when pname:image + was created + * [[VUID-VkImageViewCreateInfo-subresourceRange-01485]] + If pname:subresourceRange::pname:layerCount is not + ename:VK_REMAINING_ARRAY_LAYERS, pname:image is a 3D image created with + ename:VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR set, and + pname:viewType is ename:VK_IMAGE_VIEW_TYPE_2D or + ename:VK_IMAGE_VIEW_TYPE_2D_ARRAY, + pname:subresourceRange::pname:layerCount must: be non-zero and + [eq]#pname:subresourceRange::pname:baseArrayLayer {plus} + pname:subresourceRange::pname:layerCount# must: be less than or equal to + the pname:extent.depth specified in slink:VkImageCreateInfo when + pname:image was created +endif::VK_KHR_maintenance1[] * [[VUID-VkImageViewCreateInfo-image-01018]] If pname:image was created with the ename:VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, pname:format must: be @@ -1873,6 +1935,20 @@ pname:aspectMask must: include at least one of ename:VK_IMAGE_ASPECT_DEPTH_BIT and ename:VK_IMAGE_ASPECT_STENCIL_BIT, and can: include both. +ifdef::VK_KHR_maintenance1[] +When the sname:VkImageSubresourceRange structure is used to select a subset +of the slices of a 3D image's mip level in order to create a 2D or 2D array +image view of a 3D image created with +ename:VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT, pname:baseArrayLayer and +pname:layerCount specify the first slice index and the number of slices to +include in the created image view. +Such an image view can: be used as a framebuffer attachment that refers only +to the specified range of slices of the selected mip level. +However, any layout transitions performed on such an attachment view during +a render pass instance still apply to the entire subresource referenced +which includes all the slices of the selected mip level. +endif::VK_KHR_maintenance1[] + When using an imageView of a depth/stencil image to populate a descriptor set (e.g. for sampling in the shader, or for use as an input attachment), the pname:aspectMask must: only include one bit and selects whether the @@ -1889,44 +1965,6 @@ vector returned by shader image instructions. This remapping must: be identity for storage image descriptors, input attachment descriptors, and framebuffer attachments. -.Valid Usage -**** - * [[VUID-VkImageSubresourceRange-levelCount-01022]] - If pname:levelCount is not ename:VK_REMAINING_MIP_LEVELS, - [eq]#pname:levelCount# must: be non-zero and [eq]#(pname:baseMipLevel - {plus} pname:levelCount)# must: be less than or equal to the - pname:mipLevels specified in slink:VkImageCreateInfo when the image was - created -ifndef::VK_KHR_maintenance1[] - * [[VUID-VkImageSubresourceRange-layerCount-01023]] - If pname:layerCount is not ename:VK_REMAINING_ARRAY_LAYERS, - [eq]#pname:layerCount# must: be non-zero and [eq]#(pname:baseArrayLayer - {plus} pname:layerCount)# must: be less than or equal to the - pname:arrayLayers specified in slink:VkImageCreateInfo when the image - was created -endif::VK_KHR_maintenance1[] -ifdef::VK_KHR_maintenance1[] - * [[VUID-VkImageSubresourceRange-imageType-01024]] - If the pname:imageType specified in slink:VkImageCreateInfo when the - image was created was ename:VK_IMAGE_TYPE_3D and the image view is - created with the pname:viewType of slink:VkImageViewCreateInfo set to - ename:VK_IMAGE_VIEW_TYPE_2D_ARRAY then pname:layerCount must: be - ename:VK_REMAINING_ARRAY_LAYERS, or [eq]#pname:layerCount# must: be - non-zero and [eq]#(pname:baseArrayLayer {plus} pname:layerCount)# must: - be less than or equal to the pname:extent.depth specified in - slink:VkImageCreateInfo when the image was created - * [[VUID-VkImageSubresourceRange-imageType-01025]] - If the pname:imageType specified in slink:VkImageCreateInfo when the - image was created was not ename:VK_IMAGE_TYPE_3D or the image view is - not created with the pname:viewType of slink:VkImageViewCreateInfo set - to ename:VK_IMAGE_VIEW_TYPE_2D_ARRAY then pname:layerCount must: be - ename:VK_REMAINING_ARRAY_LAYERS, or [eq]#pname:layerCount# must: be - non-zero and [eq]#(pname:baseArrayLayer {plus} pname:layerCount)# must: - be less than or equal to the pname:arrayLayers specified in - slink:VkImageCreateInfo when the image was created -endif::VK_KHR_maintenance1[] -**** - include::../validity/structs/VkImageSubresourceRange.txt[] -- diff --git a/doc/specs/vulkan/chapters/synchronization.txt b/doc/specs/vulkan/chapters/synchronization.txt index aed9510708..892849aeaa 100644 --- a/doc/specs/vulkan/chapters/synchronization.txt +++ b/doc/specs/vulkan/chapters/synchronization.txt @@ -725,15 +725,14 @@ framebuffer-global nor framebuffer-local. A _framebuffer region_ is a set of sample (x, y, layer, sample) coordinates that is a subset of the entire framebuffer. -A single framebuffer-local dependency guarantees that only for a single -framebuffer region, the first set of operations and availability operations -happen-before visibility operations and the second set of operations. +Both <> of a +framebuffer-local dependency include only operations on the same single +framebuffer region. No ordering guarantees are made between framebuffer regions for a framebuffer-local dependency. -A framebuffer-global dependency guarantees that the first set of operations -for all framebuffer regions happens-before the second set of operations for -any framebuffer region. +Both <> of a +framebuffer-global dependency include operations on all framebuffer-regions. .Note [NOTE] @@ -775,7 +774,7 @@ ifdef::VK_KHX_multiview[] === View-Local Dependencies In a render pass instance that has <> -enabled, dependencies can be either view-local or view-global. +enabled, dependencies can: be either view-local or view-global. A view-local dependency only includes operations from a single <> from the source subpass in @@ -3633,9 +3632,29 @@ endif::VK_KHR_external_memory[] pname:dstQueueFamilyIndex are not ename:VK_QUEUE_FAMILY_IGNORED, at least one of them must: be the same as the family of the queue that will execute this barrier - * [[VUID-VkImageMemoryBarrier-subresourceRange-01206]] - pname:subresourceRange must: be a valid image subresource range for the - image (see <>) + * [[VUID-VkImageMemoryBarrier-subresourceRange-01486]] + pname:subresourceRange::pname:baseMipLevel must: be less than the + pname:mipLevels specified in slink:VkImageCreateInfo when pname:image + was created + * [[VUID-VkImageMemoryBarrier-subresourceRange-01487]] + If pname:subresourceRange::pname:levelCount is not + ename:VK_REMAINING_MIP_LEVELS, pname:subresourceRange::pname:levelCount + must: be non-zero and [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 + * [[VUID-VkImageMemoryBarrier-subresourceRange-01488]] + pname:subresourceRange::pname:baseArrayLayer must: be less than the + pname:arrayLayers specified in slink:VkImageCreateInfo when pname:image + was created + * [[VUID-VkImageMemoryBarrier-subresourceRange-01489]] + If pname:subresourceRange::pname:layerCount is not + ename:VK_REMAINING_ARRAY_LAYERS, + pname:subresourceRange::pname:layerCount must: be non-zero and + [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 * [[VUID-VkImageMemoryBarrier-image-01207]] If pname:image has a depth/stencil format with both depth and stencil components, then pname:aspectMask member of pname:subresourceRange must: diff --git a/doc/specs/vulkan/chapters/textures.txt b/doc/specs/vulkan/chapters/textures.txt index 4643fb23b3..935b7f85a4 100644 --- a/doc/specs/vulkan/chapters/textures.txt +++ b/doc/specs/vulkan/chapters/textures.txt @@ -1312,9 +1312,11 @@ nearest(\lambda) & = and - :: [eq]#q = pname:levelCount - 1# + :: [eq]#level~base~ = pname:baseMipLevel# + :: [eq]#q = level~base~ + pname:levelCount - 1# -pname:levelCount is taken from the pname:subresourceRange of the image view. +pname:baseMipLevel and pname:levelCount are taken from the +pname:subresourceRange of the image view. If the sampler's pname:mipmapMode is ename:VK_SAMPLER_MIPMAP_MODE_LINEAR, two neighboring levels are selected: diff --git a/doc/specs/vulkan/reflow.py b/doc/specs/vulkan/reflow.py index 0312b98e4e..e0c0e1dbef 100755 --- a/doc/specs/vulkan/reflow.py +++ b/doc/specs/vulkan/reflow.py @@ -580,7 +580,7 @@ def reflowFile(filename, args): vuPat = re.compile('^(?P [*]+)( *)(?P.*)', re.DOTALL) # The value to start tagging VU statements at, unless overridden by -nextvu -startVUID = 1470 +startVUID = 1490 if __name__ == '__main__': parser = argparse.ArgumentParser() diff --git a/doc/specs/vulkan/registry.txt b/doc/specs/vulkan/registry.txt index d67b20c8da..354fb39b69 100644 --- a/doc/specs/vulkan/registry.txt +++ b/doc/specs/vulkan/registry.txt @@ -249,13 +249,36 @@ Zero or more of each of the following tags, normally in this order interfaces. Usually only one tag is used, wrapping many extensions. +[[tag-comment]] +=== Comment Tags (tag:comment tag) + +A tag:comment tag contains an arbitrary string, and is unused. +Comment tags may appear in multiple places in the schema, as described +below. +Comment tags are removed by output generators if they would otherwise appear +in generated headers, asciidoc include files, etc. + + [[tag-vendorids]] -= Vendor IDs (tag:vendorids tag) += Vendor ID Blocks (tag:vendorids tag) + +A tag:vendorids tag contains descriptions of vendor IDs for physical devices +which do not have PCI vendor IDs. + +== Attributes of tag:vendorids tags + + * attr:comment - optional. Arbitrary string (unused). + +== Contents of tag:vendorids tags -The tag:vendorids tag contains individual tag:vendorid tags defining -vendor IDs for physical devices which do not have PCI vendor IDs. +Zero or more tag:vendorid tags, in arbitrary order (though they are +typically ordered by sorting on the author ID). -Each tag:vendorid tag contains information defining a single vendor ID. + +[[tag-vendorid]] += Vendor IDs (tag:vendorid tag) + +A tag:vendorid tag describes a single vendor ID. == Attributes of tag:vendorid tags @@ -265,14 +288,31 @@ Each tag:vendorid tag contains information defining a single vendor ID. * attr:id - required. The reserved vendor ID, as a hexadecimal number. * attr:comment - optional. Arbitrary string (unused). +== Contents of tag:vendorid tags + +No contents are allowed. All information is contained in the attributes. + [[tag-tags]] -= Author IDs (tag:tags tag) += Author ID Blocks (tag:tags tag) + +A tag:tags tag contains tag:authorid tags describing reserved author IDs +used by extension and layer authors. + +== Attributes of tag:tags tags + + * attr:comment - optional. Arbitrary string (unused). -The tag:tags tag contains individual tag:tag tags defining each of the -reserved author IDs used by extension and layer authors. +== Contents of tag:tags tags -Each tag:tag tag contains information defining a single author ID. +Zero or more tag:tag tags, in arbitrary order (though they are typically +ordered by sorting on the author ID). + + +[[tag-tag]] += Author IDs (tag:tag tag) + +A tag:tag tag contains information defining a single author ID. == Attributes of tag:tag tags @@ -287,19 +327,36 @@ Each tag:tag tag contains information defining a single author ID. reach the contact such as individual name together with email address, Github username, or other contact information. +== Contents of tag:tag tags + +No contents are allowed. All information is contained in the attributes. + [[tag-types]] -= API types (tag:types tag) += API Type Blocks (tag:types tag) -The tag:types tag contains individual tag:type tags describing each -of the derived types used in the API. +A tag:types tag contains definitions of derived types used in the API. -Each tag:type tag contains information which can be used to generate C -code corresponding to the type. In many cases, this is simply legal C code -with attributes or embedded tags denoting the type name and other types used -in defining this type. In some cases, additional attribute and embedded type -information is used to generate more complicated C types. +== Attributes of tag:types tags + + * attr:comment - optional. Arbitrary string (unused). +== Contents of tag:types tags + +Zero or more tag:type and tag:comment tags, in arbitrary order (though they +are typically ordered by putting dependencies of other types earlier in the +list). +The tag:comment tags are used mostly to indicate grouping of related types. + + +[[tag-type]] += API Type (tag:type tag) + +A tag:type tag contains information which can be used to generate C code +corresponding to the type. In many cases, this is simply legal C code, with +attributes or embedded tags denoting the type name and other types used in +defining this type. In some cases, additional attribute and embedded type +information is used to generate more complicated C types. == Attributes of tag:type tags @@ -325,6 +382,15 @@ information is used to generate more complicated C types. `union`. Notes that this struct/union is going to be filled in by the API, rather than an application filling it out and passing it to the API. + * attr:structextends only applicable if category is `struct` or `union`. + This is a comma-separated list of structures whose `pNext` can include + this type. + This should usually only list the top-level structure that is + extended, for all possible chained structures - the chained structures + themselves should have their `pNext` tagged with attr:noautovalidity. + This will generate a validity statement on the top level structure + that validates the entire chain in one go, rather than each chained + structure repeating the list of valid structs. == Contents of tag:type tags @@ -341,11 +407,11 @@ declaration. === Structure types - attr:category `"struct"` or `"union"` -If the attr:category tag has the values `struct` or `union`, the -type is a C structure or union, respectively. In this case, the attr:name -attribute must be provided, and the contents of the tag:type tag are a -series of tag:member tags defining the members of the aggregate type, in -order. +If the attr:category tag has the values `struct` or `union`, the type is a C +structure or union, respectively. In this case, the attr:name attribute must +be provided, and the contents of the tag:type tag are a series of tag:member +tags defining the members of the aggregate type, in order, interleaved with +any number of tag:comment tags. ==== Structure member (tag:member) tags @@ -364,6 +430,12 @@ member. This will generate a validity statement on the top level structure that validates the entire chain in one go, rather than each chained structure repeating the list of valid structs. +[NOTE] +.Note +==== +attr:validextensionstructs is deprecated and replaced by attr:structextends. +They must be kept in sync until attr:validextensionstructs is removed. +==== * attr:values - only valid on the `sType` member of a struct. This is a comma-separated list of enumerant values that are valid for the structure type; usually there is only a single value. @@ -389,14 +461,21 @@ member. The text elements of a tag:member tag, with all other tags removed, is a legal C declaration of a struct or union member. In addition it may -contain two semantic tags: +contain several semantic tags: * The tag:type tag is optional. It contains text which is a valid type name found in another tag:type tag, and indicates that this type must be previously defined for the definition of the command to - succeed. Builtin C types should not be wrapper in tag:type tags. + succeed. Builtin C types should not be wrapped in tag:type tags. * The tag:name tag is required, and contains the struct/union member name being described. + * The tag:enum tag is optional. It contains text which is a valid + enumerant name found in another tag:type tag, and indicates that this + enumerant must be previously defined for the definition of the command + to succeed. Typically this is used to semantically tag static array + lengths. + * The tag:comment tag is optional. It contains an arbitrary string + (unused). === All other types @@ -422,7 +501,7 @@ together, and categories are generated in the order given by the following list. Therefore, types in a category should correspond to the intended purpose given for that category. If this recommendation is not followed, it is possible that the resulting header file will not compile due to -out-of-order type dependencies. +out-of-order type dependencies. The intended purpose of each category is: * `include` (`#include`) directives) * `define` (macro `#define` directives) @@ -446,8 +525,8 @@ out-of-order type dependencies. typedef ptrdiff_t VKlongint; - VkEnum srcEnum - VkEnum dstEnum + VkEnum srcEnum + VkEnum dstEnum @@ -492,6 +571,15 @@ the token names used in the API. In some cases these correspond to a C `enum`, and in some cases they are simply compile time constants (e.g. `#define`). +[NOTE] +.Note +==== +It would make more sense to call these `const` or `define` tags. +This is a historical hangover from the OpenGL XML format which this schema +was based on. +==== + + == Attributes of tag:enums tags * attr:name - optional. String naming the C `enum` type whose members are @@ -511,9 +599,9 @@ the token names used in the API. In some cases these correspond to a C == Contents of tag:enums tags -Each tag:enums block contains zero or more tag:enum and tag:unused tags, in -arbitrary order (although they are typically ordered by sorting on enumerant -values, to improve human readability). +Each tag:enums block contains zero or more tag:enum, tag:unused, and +tag:comment tags, in arbitrary order (although they are typically ordered by +sorting on enumerant values, to improve human readability). == Example of tag:enums tags @@ -534,8 +622,8 @@ required, this results in [source,c] -------------------------------------- -#define VK_MAX_EXTENSION_NAME 256 -#define VK_LOD_CLAMP_NONE MAX_FLOAT +#define VK_MAX_EXTENSION_NAME 256 +#define VK_LOD_CLAMP_NONE MAX_FLOAT -------------------------------------- @@ -580,6 +668,15 @@ Each tag:unused tag defines a range of enumerants which is allocated, but not yet assigned to specific enums. This just tracks the unused values for the Registrar's use, and is not used for header generation. +[NOTE] +.Note +==== +tag:unused tags could be generated and inserted automatically, which would +be a good way to avoid the attributes becoming out of date. However, they +are rarely used in the Vulkan XML schema, unlike the OpenGL XML schema it +was based on. +==== + == Attributes of tag:unused tags * attr:start - required, attr:end - optional. Integers defining the @@ -605,7 +702,7 @@ The tag:commands tag contains definitions of each of the functions == Attributes of tag:commands tags -None. + * attr:comment - optional. Arbitrary string (unused). == Contents of tag:commands tags @@ -766,9 +863,9 @@ addition it may contain two semantic tags: -------------------------------------- - VkResult vkCreateInstance - const VkInstanceCreateInfo* pCreateInfo - VkInstance* pInstance + VkResult vkCreateInstance + const VkInstanceCreateInfo* pCreateInfo + VkInstance* pInstance -------------------------------------- @@ -818,14 +915,14 @@ for, or removed from, this feature, as described below. -------------------------------------- - + - - + + - + -------------------------------------- @@ -836,13 +933,13 @@ When processed into a C header for Vulkan, this results in: -------------------------------------- #ifndef VK_VERSION_1_0 #define VK_VERSION_1_0 1 -#define VK_MAX_EXTENSION_NAME 256 -#define VK_LOD_CLAMP_NONE MAX_FLOAT +#define VK_MAX_EXTENSION_NAME 256 +#define VK_LOD_CLAMP_NONE MAX_FLOAT typedef VkResult (VKAPI_PTR *PFN_vkCreateInstance)(const VkInstanceCreateInfo* pCreateInfo, VkInstance* pInstance); #ifndef VK_NO_PROTOTYPES VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance( - const VkInstanceCreateInfo* pCreateInfo, - VkInstance* pInstance); + const VkInstanceCreateInfo* pCreateInfo, + VkInstance* pInstance); #endif #endif /* VK_VERSION_1_0 */ -------------------------------------- @@ -856,7 +953,7 @@ which are defined for the API. == Attributes of tag:extensions tags -None. + * attr:comment - optional. Arbitrary string (unused). == Contents of tag:extensions tags @@ -919,12 +1016,12 @@ for, or removed from, this extension, as described below. -------------------------------------- - - - - - + + + + + -------------------------------------- @@ -943,11 +1040,11 @@ tag:command elsewhere in the XML): #define VK_KHR_DISPLAY_SWAPCHAIN_EXTENSION_NAME "VK_KHR_display_swapchain" typedef struct VkDisplayPresentInfoKHR { - VkStructureType sType; - const void* pNext; - VkRect2D srcRect; - VkRect2D dstRect; - VkBool32 persistent; + VkStructureType sType; + const void* pNext; + VkRect2D srcRect; + VkRect2D dstRect; + VkBool32 persistent; } VkDisplayPresentInfoKHR; typedef VkResult (VKAPI_PTR *PFN_vkCreateSharedSwapchainsKHR)( @@ -958,11 +1055,11 @@ typedef VkResult (VKAPI_PTR *PFN_vkCreateSharedSwapchainsKHR)( #ifndef VK_NO_PROTOTYPES VKAPI_ATTR VkResult VKAPI_CALL vkCreateSharedSwapchainsKHR( - VkDevice device, - uint32_t swapchainCount, - const VkSwapchainCreateInfoKHR* pCreateInfos, - const VkAllocationCallbacks* pAllocator, - VkSwapchainKHR* pSwapchains); + VkDevice device, + uint32_t swapchainCount, + const VkSwapchainCreateInfoKHR* pCreateInfos, + const VkAllocationCallbacks* pAllocator, + VkSwapchainKHR* pSwapchains); #endif -------------------------------------- @@ -1003,6 +1100,10 @@ since tag:feature tags already define a specific API. Zero or more of the following tags, in any order: +=== Comment Tags + +<> (as described above). + === Command Tags tag:command specifies an required (or removed) command defined @@ -1089,16 +1190,16 @@ enumerants for Vulkan 1.0, 1.1, etc. -------------------------------------- - - - - - - - + + + + + + + -------------------------------------- @@ -1172,8 +1273,9 @@ for the following block of `vk.xml`: [source,xml] -------------------------------------- - - + + -------------------------------------- Inside the tag:feature tag are nested multiple tag:require tags. These @@ -1236,12 +1338,10 @@ correspond to the definitions found in the first tag:enums section of [source,xml] -------------------------------------- - - - - - - + + + ... -------------------------------------- @@ -1253,9 +1353,9 @@ tag:commands section of `vk.xml`: -------------------------------------- - VkResult vkCreateInstance - const VkInstanceCreateInfo* pCreateInfo - VkInstance* pInstance + VkResult vkCreateInstance + const VkInstanceCreateInfo* pCreateInfo + VkInstance* pInstance ... -------------------------------------- @@ -1276,11 +1376,14 @@ with the same name: [source,xml] -------------------------------------- - - - - - + + Return codes (positive values) + + + + ... + Error codes (negative values) + ... -------------------------------------- @@ -1289,12 +1392,12 @@ For `VkInstanceCreateInfo`, the required tag:type is: [source,xml] -------------------------------------- - VkStructureType sType - const void* pNext + VkStructureType sType + const void* pNext const VkApplicationInfo* pAppInfo const VkAllocCallbacks* pAllocCb - uint32_t extensionCount - const char*const* ppEnabledExtensionNames + uint32_t extensionCount + const char*const* ppEnabledExtensionNames -------------------------------------- @@ -1308,7 +1411,7 @@ required tag:type is: [source,xml] -------------------------------------- - + Types which can be void pointers or class pointers, selected at compile time VK_DEFINE_BASE_HANDLE(VkObject) VK_DEFINE_DISP_SUBCLASS_HANDLE(VkInstance, VkObject) -------------------------------------- @@ -1378,48 +1481,48 @@ typedef enum { ... } VKStructureType; typedef struct { - VkStructureType sType; - const void* pNext; - const char* pAppName; - uint32_t appVersion; - const char* pEngineName; - uint32_t engineVersion; - uint32_t apiVersion; + VkStructureType sType; + const void* pNext; + const char* pAppName; + uint32_t appVersion; + const char* pEngineName; + uint32_t engineVersion; + uint32_t apiVersion; } VkApplicationInfo; typedef enum { VK_SYSTEM_ALLOC_TYPE_API_OBJECT = 0, ... } VkSystemAllocType; typedef void* (VKAPI_PTR *PFN_vkAllocFunction)( - void* pUserData, - size_t size, - size_t alignment, - VkSystemAllocType allocType); + void* pUserData, + size_t size, + size_t alignment, + VkSystemAllocType allocType); typedef void (VKAPI_PTR *PFN_vkFreeFunction)( - void* pUserData, - void* pMem); + void* pUserData, + void* pMem); typedef struct { - void* pUserData; - PFN_vkAllocFunction pfnAlloc; - PFN_vkFreeFunction pfnFree; + void* pUserData; + PFN_vkAllocFunction pfnAlloc; + PFN_vkFreeFunction pfnFree; } VkAllocCallbacks; typedef struct { - VkStructureType sType; - const void* pNext; - const VkApplicationInfo* pAppInfo; - const VkAllocCallbacks* pAllocCb; - uint32_t extensionCount; - const char*const* ppEnabledExtensionNames; + VkStructureType sType; + const void* pNext; + const VkApplicationInfo* pAppInfo; + const VkAllocCallbacks* pAllocCb; + uint32_t extensionCount; + const char*const* ppEnabledExtensionNames; } VkInstanceCreateInfo; VK_DEFINE_BASE_HANDLE(VkObject) VK_DEFINE_DISP_SUBCLASS_HANDLE(VkInstance, VkObject) -#define VK_MAX_PHYSICAL_DEVICE_NAME 256 -#define VK_MAX_EXTENSION_NAME 256 +#define VK_MAX_PHYSICAL_DEVICE_NAME 256 +#define VK_MAX_EXTENSION_NAME 256 typedef VkResult (VKAPI_PTR *PFN_vkCreateInstance)(const VkInstanceCreateInfo* pCreateInfo, VkInstance* pInstance); #ifndef VK_NO_PROTOTYPES VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance( - const VkInstanceCreateInfo* pCreateInfo, - VkInstance* pInstance); + const VkInstanceCreateInfo* pCreateInfo, + VkInstance* pInstance); #endif #ifdef __cplusplus @@ -1463,7 +1566,7 @@ constant: [source,xml] -------------------------------------- - + -------------------------------------- @@ -1475,12 +1578,12 @@ corresponding to a C `struct` defined as follows: [source,c] -------------------------------------- typedef struct { - VkStructureType sType; - const void* pNext; + VkStructureType sType; + const void* pNext; const VkApplicationInfo* pAppInfo; const VkAllocCallbacks* pAllocCb; - uint32_t extensionCount; - const char*const* ppEnabledExtensionNames; + uint32_t extensionCount; + const char*const* ppEnabledExtensionNames; } VkInstanceCreateInfo; -------------------------------------- @@ -1496,7 +1599,7 @@ tag:types tag and search for the nested block labelled [source,xml] -------------------------------------- - + ... -------------------------------------- @@ -1518,22 +1621,22 @@ the corresponding comment, like this: -------------------------------------- ... - - - VkStructureType - sType - const void* - pNext - const VkApplicationInfo* - pAppInfo - const VkAllocCallbacks* - pAllocCb - uint32_t - extensionCount - const char*const* - ppEnabledExtensionNames - - ... + Struct types + + VkStructureType + sType + const void* + pNext + const VkApplicationInfo* + pAppInfo + const VkAllocCallbacks* + pAllocCb + uint32_t + extensionCount + const char*const* + ppEnabledExtensionNames + + ... -------------------------------------- If any of the member types are types also defined in the header, make sure @@ -1572,12 +1675,12 @@ Next, go to the line labelled [source,xml] -------------------------------------- - +Vulkan enumerant (token) definitions -------------------------------------- -Below this line, add an tag:enums tag whose attr:name attribute matches -the tag:type name `VkDeviceCreateFlagBits`, and whose contents -correspond to the individual fields of the enumerated type: +At an appropriate point below this line, add an tag:enums tag whose +attr:name attribute matches the tag:type name `VkDeviceCreateFlagBits`, and +whose contents correspond to the individual fields of the enumerated type: [source,xml] -------------------------------------- @@ -1610,8 +1713,8 @@ For this example, assume we want to define the command: [source,c] -------------------------------------- VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance( - const VkInstanceCreateInfo* pCreateInfo, - VkInstance* pInstance); + const VkInstanceCreateInfo* pCreateInfo, + VkInstance* pInstance); -------------------------------------- Commands must always be explicitly required in the tag:feature tag. In @@ -1622,11 +1725,10 @@ tag:command tag inside that block: [source,xml] -------------------------------------- - - + ... - + ... @@ -1644,16 +1746,15 @@ ease of reading, as follows: [source,xml] -------------------------------------- - - + ... - VkResult - vkCreateInstance - const VkInstanceCreateInfo* - pCreateInfo - VkInstance* - pInstance + VkResult + vkCreateInstance + const VkInstanceCreateInfo* + pCreateInfo + VkInstance* + pInstance ... @@ -1730,6 +1831,9 @@ files and Python scripts are logged in Github history. [[changelog]] = Change Log + * 2017-07-14 - add comment attributes or tags as valid content in several + places, replacing XML comments which could not be preserved by XML + transformation tools. * 2017-02-20 - change to asciidoctor markup and move into the specification source directory for ease of building. * 2016-09-27 - remove tag:validity and tag:usage tags, since these diff --git a/doc/specs/vulkan/style/extensions.txt b/doc/specs/vulkan/style/extensions.txt index e71cea892d..92b7e0f252 100644 --- a/doc/specs/vulkan/style/extensions.txt +++ b/doc/specs/vulkan/style/extensions.txt @@ -846,5 +846,5 @@ must define the required ordering and expected behavior as part of its specification. Validation of such extended structure chains is automatically generated from -the registry, as described in the description of attr:validextensionstructs -in link:registry.html[the registry document]. +the registry, as described in the description of attr:structextends in +link:registry.html[the registry document]. diff --git a/doc/specs/vulkan/style/naming.txt b/doc/specs/vulkan/style/naming.txt index c25b4c5f8a..a28b8a71b4 100644 --- a/doc/specs/vulkan/style/naming.txt +++ b/doc/specs/vulkan/style/naming.txt @@ -162,7 +162,7 @@ Each enumerant name is prefixed with `VK_`. Enumerants are prefixed with the exact name of the type it belongs to, converted to the correct case (e.g. `VkStructureType` -> -`VK_STRUCTURE_TYPE_APPLICATION_INFO`). +`VK_STRUCTURE_TYPE_*`). This rule applies to all enumerants, with one exception. @@ -191,33 +191,153 @@ typedef enum VkResult { ---- -== Function Names +== Command Names -Function names are declared with no separator between words. +Command names are declared with no separator between words. Each word starts with a capital letter, and every other character in each word is lower case. -Function names are prefixed with `vk`, with the exception of functions that -record commands into a command buffer and are instead prefixed with `vkCmd`. +The structure of a command name should be as follows: -This rule applies to all function declarations. +`__prefix Verb Object Property__` + +`_prefix_`:: + This is usually "vk", but will be "vkCmd" if it is a command used to + record into a command buffer, or "vkQueue" if it directly affects a + queue. + +`_Verb_`:: + The verb that describes the action being performed. + A list of most verbs used in Vulkan is available <>. + +`_Object_`:: + The name of the object being acted upon by the command. + +`_Property_`:: + The property of the object which is being acted upon by the command, and + is omitted in cases where the whole object is being acted upon (e.g. + creation commands). + +These rules apply to all command declarations. [source, c] .Example ---- -// Function call +// Creation command VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance( ... ); -// Command buffer function +// Command buffer recording command VKAPI_ATTR VkResult VKAPI_CALL vkCmdBindPipeline( ... ); + +// Get command +VKAPI_ATTR VkResult VKAPI_CALL vkGetQueryPoolResults( ... ); ---- +.Note +[NOTE] +==== +There are three exceptions to the above rule in the core Vulkan API: + + * vkDeviceWaitIdle + * vkCmdNextSubpass + * vkCmdPipelineBarrier + +These names are left as-is to maintain compatibility. + +There are additionally a number of exceptions in a few existing extensions. +==== + + +=== Query Commands + +A number of commands in the API are used to determine the properties of some +object in the implementation. + +The queried properties may either be invariant, or they may: change based on +application behaviour. +If the results are not invariant, the lifetime of the results should be +clearly described in the command description. +See <> in the specification for more information. + +These commands fall into two categories from a naming perspective: + +Capability Queries:: + +These are commands which query capabilities of objects that an +implementation can provide. +Such commands use the verb "Enumerate" to identify themselves. ++ +e.g. `vkEnumeratePhysicalDeviceProperties` ++ +Whilst these commands describe properties of the named object, they do not +accept a parameter of that object type - though they usually have a +parameter for the parent type. + +Object State Queries:: + +These commands are used to query the current properties of an object that +has been created. +Such commands use the verb "Get" to identify themselves. ++ +e.g. `vkGetPhysicalDeviceQueueFamilyProperties` ++ +These commands always have a parameter of the object type. + + +[[command-names-verbs]] +=== Command Verbs + +Below is a list of many of the verbs currently in use in core Vulkan and +KHR/KHX extensions, along with their meanings. +The list is not guaranteed to be up to date, but covers all core and KHR/KHX +verbs at the time of writing. + +[%autowidth,options="header"] +|=== +| Verb | Meaning +| Acquire | Acquire ownership of an object from an external source +| Allocate | Allocates memory in a pool or memory heap and creates object - paired with "Free" +| Begin | Start of a range of command buffer commands with different behaviour than those outside the range - "End" marks the end of the range +| Bind | Binds an object to another object +| Blit | Performs a filtered and scaled copy of pixels from one image to another +| Clear | Sets all pixels in an image to the same value +| Copy | A raw copy of data from one object to another with no transformation of the data +| Create | Creates an object - paired with "Destroy" +| Destroy | Destroys an object - paired with "Create" +| Dispatch | Kicks off a set of compute tasks +| Draw | Kicks off a set of rasterization tasks +| End | End of a range of command buffer commands with different behaviour than those outside the range - "Begin" marks the start of the range +| Enumerate | Queries the capabilities of objects that could be created, before creating them +| Execute | Executes commands recorded in another command buffer +| Fill | Sets all data units in a buffer to the same value +| Flush | Flushes data from the host to the device +| Free | Destroys an object and then frees memory back to a pool or memory heap - paired with "Allocate" +| Get | Queries the state of an existing object +| Import | Imports the payload from an external object into a Vulkan object +| Invalidate | Invalidates data on the host, forcing newer data on the device to be read +| Map | Maps an allocation into host memory - paired with "Unmap" +| Merge | Merges two objects +| Present | Presents an image to a surface +| Push | Pushes data to the device as part of a command stream +| Release | Releases ownership of an object to an external source +| Reset | Resets the state of an object to an initial state +| Resolve | Resolves multiple samples in a multisampled image to an image with one sample per pixel +| Set | Sets the state of an object +| Submit | Submits a set of commands to a queue +| Unmap | Unmaps an allocation from host memory - paired with "Map" +| Update | Updates entries in a descriptor set +| Wait | Waits for some signal +| Write | Writes values to an object +|=== + [[naming-funcpointers]] === Function Pointer Type Names Function pointer names are declared exactly as the equivalent statically -declared function would be declared, but prefixed with `PFN_`, standing for +declared command would be declared, but prefixed with `PFN_`, standing for "Pointer to FunctioN". [source, c] diff --git a/src/ext_loader/vulkan_ext.c b/src/ext_loader/vulkan_ext.c index 59f89d1dcc..97f8e9f51c 100644 --- a/src/ext_loader/vulkan_ext.c +++ b/src/ext_loader/vulkan_ext.c @@ -1019,7 +1019,7 @@ void vkDebugReportMessageEXT( static PFN_vkDebugMarkerSetObjectTagEXT pfn_vkDebugMarkerSetObjectTagEXT; VkResult vkDebugMarkerSetObjectTagEXT( VkDevice device, - VkDebugMarkerObjectTagInfoEXT* pTagInfo) + const VkDebugMarkerObjectTagInfoEXT* pTagInfo) { return pfn_vkDebugMarkerSetObjectTagEXT( device, @@ -1030,7 +1030,7 @@ VkResult vkDebugMarkerSetObjectTagEXT( static PFN_vkDebugMarkerSetObjectNameEXT pfn_vkDebugMarkerSetObjectNameEXT; VkResult vkDebugMarkerSetObjectNameEXT( VkDevice device, - VkDebugMarkerObjectNameInfoEXT* pNameInfo) + const VkDebugMarkerObjectNameInfoEXT* pNameInfo) { return pfn_vkDebugMarkerSetObjectNameEXT( device, @@ -1041,7 +1041,7 @@ VkResult vkDebugMarkerSetObjectNameEXT( static PFN_vkCmdDebugMarkerBeginEXT pfn_vkCmdDebugMarkerBeginEXT; void vkCmdDebugMarkerBeginEXT( VkCommandBuffer commandBuffer, - VkDebugMarkerMarkerInfoEXT* pMarkerInfo) + const VkDebugMarkerMarkerInfoEXT* pMarkerInfo) { pfn_vkCmdDebugMarkerBeginEXT( commandBuffer, @@ -1061,7 +1061,7 @@ void vkCmdDebugMarkerEndEXT( static PFN_vkCmdDebugMarkerInsertEXT pfn_vkCmdDebugMarkerInsertEXT; void vkCmdDebugMarkerInsertEXT( VkCommandBuffer commandBuffer, - VkDebugMarkerMarkerInfoEXT* pMarkerInfo) + const VkDebugMarkerMarkerInfoEXT* pMarkerInfo) { pfn_vkCmdDebugMarkerInsertEXT( commandBuffer, diff --git a/src/spec/generator.py b/src/spec/generator.py index e729b171c8..a9a7bd58d8 100644 --- a/src/spec/generator.py +++ b/src/spec/generator.py @@ -355,6 +355,13 @@ def genType(self, typeinfo, name): # Struct (e.g. C "struct" type) generation def genStruct(self, typeinfo, name): self.validateFeature('struct', name) + + # The mixed-mode tags may contain no-op tags. + # It is convenient to remove them here where all output generators + # will benefit. + for member in typeinfo.elem.findall('.//member'): + for comment in member.findall('comment'): + member.remove(comment) # # Group (e.g. C "enum" type) generation def genGroup(self, groupinfo, name): diff --git a/src/spec/reg.py b/src/spec/reg.py index 5c92d271b5..a591380bc2 100755 --- a/src/spec/reg.py +++ b/src/spec/reg.py @@ -16,6 +16,7 @@ import io,os,re,string,sys,copy import xml.etree.ElementTree as etree +from collections import defaultdict # matchAPIProfile - returns whether an API and profile # being generated matches an element's profile @@ -201,6 +202,7 @@ def __init__(self): self.apidict = {} self.extensions = [] self.requiredextensions = [] # Hack - can remove it after validity generator goes away + self.validextensionstructs = defaultdict(list) self.extdict = {} # A default output generator, so commands prior to apiGen can report # errors via the generator object. @@ -388,6 +390,18 @@ def parseTree(self): if (addEnumInfo): enumInfo = EnumInfo(enum) self.addElementInfo(enum, enumInfo, 'enum', self.enumdict) + # Construct a "validextensionstructs" list for parent structures + # based on "structextends" tags in child structures + for type in self.reg.findall('types/type'): + parentStructs = type.get('structextends') + if (parentStructs != None): + for parent in parentStructs.split(','): + # self.gen.logMsg('diag', type.get('name'), 'extends', parent) + self.validextensionstructs[parent].append(type.get('name')) + # Sort the lists so they don't depend on the XML order + for parent in self.validextensionstructs: + self.validextensionstructs[parent].sort() + def dumpReg(self, maxlen = 40, filehandle = sys.stdout): """Dump all the dictionaries constructed from the Registry object""" write('***************************************', file=filehandle) diff --git a/src/spec/registry.rnc b/src/spec/registry.rnc index 7222a28881..41fe23bc8f 100644 --- a/src/spec/registry.rnc +++ b/src/spec/registry.rnc @@ -37,6 +37,7 @@ start = element registry { # defines a group of vendor IDs Vendorids = element vendorids { + Comment ? , Vendorid * } @@ -52,6 +53,7 @@ Vendorid = element vendorid { # defines a group of author tags Tags = element tags { + Comment ? , Tag * } @@ -67,7 +69,11 @@ Tag = element tag { # defines a group of types Types = element types { - Type * + Comment ? , + ( + Type | + element comment { text } + ) * } # defines a single type. It is usually a C typedef but @@ -88,6 +94,9 @@ Types = element types { # returnedonly - only applicable if category is 'struct'. Notes that this # struct is going to be filled in by the API, rather than an application # filling it out and passing it to the API. +# structextends - only applicable if category is 'struct'. Lists parent +# structures which this structure may extend via the pNext chain +# of the parent. # For types without a category, contents include # - substitutes for an APIENTRY-style macro on output # - contains name of the type being defined @@ -108,6 +117,7 @@ Types = element types { # noautovalidity - tag stating that no automatic validity language should be generated # validextensionstructs - comma-separate list of legal structure types in pNext chain # values - comma-separated list of legal values, usually used only for sType enums +# - containing arbitrary text (unused) # # *** There's a problem here: I'm not sure how to represent the # syntax where it may contain arbitrarily interleaved text, , and @@ -122,6 +132,7 @@ Type = element type { attribute category { text } ? , attribute parent { TypeName } ? , attribute returnedonly { text } ? , + attribute structextends { text } ? , Comment ? , ( ( @@ -147,11 +158,13 @@ Type = element type { attribute values { text } ? , mixed { element type { TypeName } ? , - element name { text }, - element enum { EnumName } ? + element name { text } , + element enum { EnumName } ? , + element comment { text } ? } - } * - ) + } | + element comment { text } + ) * ) } @@ -169,7 +182,11 @@ Enums = element enums { attribute end { Integer } ? , Vendor ? , Comment ? , - (Enum | Unused) * + ( + Enum | + Unused | + element comment { text} + ) * } # defines or references a single enumerant. There are two places it @@ -232,6 +249,7 @@ Unused = element unused { } # defines a group of commands Commands = element commands { + Comment ? , Command * } @@ -313,22 +331,30 @@ Feature = element feature { attribute api { text } , Name , attribute number { xsd:float } , - attribute protect { text } ?, + attribute protect { text } ? , Comment ? , ( element require { ProfileName ? , Comment ? , - InterfaceElement * + ( + InterfaceElement | + element comment { text } + ) * } | element remove { ProfileName ? , Comment ? , - InterfaceElement * + ( + InterfaceElement | + element comment { text } + ) * } ) * } + Extensions = element extensions { + Comment ? , Extension * } @@ -353,12 +379,12 @@ Extensions = element extensions { # Not a regular expression. Extension = element extension { Name , - attribute number { Integer } ?, - attribute protect { text } ?, + attribute number { Integer } ? , + attribute protect { text } ? , attribute author { text } ? , attribute contact { text } ? , - attribute type { text } ?, - attribute requires { text } ?, + attribute type { text } ? , + attribute requires { text } ? , attribute supported { StringGroup } ? , Comment ? , ( diff --git a/src/spec/validitygenerator.py b/src/spec/validitygenerator.py index dc7d39dcf0..5a02984e0a 100644 --- a/src/spec/validitygenerator.py +++ b/src/spec/validitygenerator.py @@ -679,15 +679,27 @@ def makeStructureExtensionPointer(self, blockname, param): paramtype = param.find('type') asciidoc = self.makeAnchor(blockname, paramname.text, 'pNext') - validextensionstructs = param.attrib.get('validextensionstructs') + validextensionstructs = self.registry.validextensionstructs.get(blockname) extensionstructs = [] + # Validate that the XML's "validextensionstructs" tag matches the + # list built from the "structextends" tag. + # Once everything is ported to structextends, delete this block. + validextensionstructsOld = param.attrib.get('validextensionstructs') + if validextensionstructsOld is not None: + validextensionstructsasstring = ''; + if (validextensionstructs is not None): + validextensionstructsasstring = ','.join(elem for elem in validextensionstructs) + if (','.join(sorted(validextensionstructsasstring.split(','))) != + ','.join(sorted(validextensionstructsOld.split(',')))): + self.logMsg('warn', blockname, 'validextensionstructs mismatches structextends\nvalidextensionstructs=', validextensionstructsOld, '\nstructextends=', validextensionstructsasstring, '\n') + if validextensionstructs is not None: # Check each structure name and skip it if not required by the # generator. This allows tagging extension structs in the XML # that are only included in validity when needed for the spec # being targeted. - for struct in validextensionstructs.split(','): + for struct in validextensionstructs: # Unpleasantly breaks encapsulation. Should be a method in the registry class type = self.registry.lookupElementInfo(struct, self.registry.typedict) if (type == None): diff --git a/src/spec/vk.xml b/src/spec/vk.xml index a3e142f7ba..804d0c584d 100644 --- a/src/spec/vk.xml +++ b/src/spec/vk.xml @@ -27,17 +27,16 @@ the master branch of the Khronos Vulkan GitHub project. The authoritative private version is maintained in the 1.0 branch of the member gitlab server. - - + - - + + @@ -63,10 +62,10 @@ private version is maintained in the 1.0 branch of the member gitlab server. - - + #include "vk_platform.h" - + + WSI extensions #include "vulkan.h" #include <X11/Xlib.h> #include <X11/extensions/Xrandr.h> @@ -102,11 +101,11 @@ private version is maintained in the 1.0 branch of the member gitlab server. #define VK_VERSION_PATCH(version) ((uint32_t)(version) & 0xfff) // DEPRECATED: This define has been removed. Specific version defines (e.g. VK_API_VERSION_1_0), or the VK_MAKE_VERSION macro, should be used instead. -//#define VK_API_VERSION VK_MAKE_VERSION(1, 0, 0) +//#define VK_API_VERSION VK_MAKE_VERSION(1, 0, 0) // Patch version should always be set to 0 // Vulkan 1.0 version number -#define VK_API_VERSION_1_0 VK_MAKE_VERSION(1, 0, 0) +#define VK_API_VERSION_1_0 VK_MAKE_VERSION(1, 0, 0)// Patch version should always be set to 0 // Version of this file -#define VK_HEADER_VERSION 54 +#define VK_HEADER_VERSION 55 #define VK_DEFINE_HANDLE(object) typedef struct object##_T* object; @@ -130,7 +129,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. typedef uint32_t VkFlags; typedef uint64_t VkDeviceSize; - + Basic C types, pulled in via vk_platform.h @@ -140,89 +139,91 @@ private version is maintained in the 1.0 branch of the member gitlab server. - - typedef VkFlags VkFramebufferCreateFlags; - typedef VkFlags VkQueryPoolCreateFlags; - typedef VkFlags VkRenderPassCreateFlags; - typedef VkFlags VkSamplerCreateFlags; - typedef VkFlags VkPipelineLayoutCreateFlags; - typedef VkFlags VkPipelineCacheCreateFlags; - typedef VkFlags VkPipelineDepthStencilStateCreateFlags; - typedef VkFlags VkPipelineDynamicStateCreateFlags; - typedef VkFlags VkPipelineColorBlendStateCreateFlags; - typedef VkFlags VkPipelineMultisampleStateCreateFlags; - typedef VkFlags VkPipelineRasterizationStateCreateFlags; - typedef VkFlags VkPipelineViewportStateCreateFlags; - typedef VkFlags VkPipelineTessellationStateCreateFlags; - typedef VkFlags VkPipelineInputAssemblyStateCreateFlags; - typedef VkFlags VkPipelineVertexInputStateCreateFlags; - typedef VkFlags VkPipelineShaderStageCreateFlags; - typedef VkFlags VkDescriptorSetLayoutCreateFlags; - typedef VkFlags VkBufferViewCreateFlags; - typedef VkFlags VkInstanceCreateFlags; - typedef VkFlags VkDeviceCreateFlags; - typedef VkFlags VkDeviceQueueCreateFlags; - typedef VkFlags VkQueueFlags; - typedef VkFlags VkMemoryPropertyFlags; - typedef VkFlags VkMemoryHeapFlags; - typedef VkFlags VkAccessFlags; - typedef VkFlags VkBufferUsageFlags; - typedef VkFlags VkBufferCreateFlags; - typedef VkFlags VkShaderStageFlags; - typedef VkFlags VkImageUsageFlags; - typedef VkFlags VkImageCreateFlags; - typedef VkFlags VkImageViewCreateFlags; - typedef VkFlags VkPipelineCreateFlags; - typedef VkFlags VkColorComponentFlags; - typedef VkFlags VkFenceCreateFlags; - typedef VkFlags VkSemaphoreCreateFlags; - typedef VkFlags VkFormatFeatureFlags; - typedef VkFlags VkQueryControlFlags; - typedef VkFlags VkQueryResultFlags; - typedef VkFlags VkShaderModuleCreateFlags; - typedef VkFlags VkEventCreateFlags; - typedef VkFlags VkCommandPoolCreateFlags; - typedef VkFlags VkCommandPoolResetFlags; - typedef VkFlags VkCommandBufferResetFlags; - typedef VkFlags VkCommandBufferUsageFlags; - typedef VkFlags VkQueryPipelineStatisticFlags; - typedef VkFlags VkMemoryMapFlags; - typedef VkFlags VkImageAspectFlags; - typedef VkFlags VkSparseMemoryBindFlags; - typedef VkFlags VkSparseImageFormatFlags; - typedef VkFlags VkSubpassDescriptionFlags; - typedef VkFlags VkPipelineStageFlags; - typedef VkFlags VkSampleCountFlags; - typedef VkFlags VkAttachmentDescriptionFlags; - typedef VkFlags VkStencilFaceFlags; - typedef VkFlags VkCullModeFlags; - typedef VkFlags VkDescriptorPoolCreateFlags; - typedef VkFlags VkDescriptorPoolResetFlags; - typedef VkFlags VkDependencyFlags; - typedef VkFlags VkIndirectCommandsLayoutUsageFlagsNVX; - typedef VkFlags VkObjectEntryUsageFlagsNVX; + Bitmask types + typedef VkFlags VkFramebufferCreateFlags; + typedef VkFlags VkQueryPoolCreateFlags; + typedef VkFlags VkRenderPassCreateFlags; + typedef VkFlags VkSamplerCreateFlags; + typedef VkFlags VkPipelineLayoutCreateFlags; + typedef VkFlags VkPipelineCacheCreateFlags; + typedef VkFlags VkPipelineDepthStencilStateCreateFlags; + typedef VkFlags VkPipelineDynamicStateCreateFlags; + typedef VkFlags VkPipelineColorBlendStateCreateFlags; + typedef VkFlags VkPipelineMultisampleStateCreateFlags; + typedef VkFlags VkPipelineRasterizationStateCreateFlags; + typedef VkFlags VkPipelineViewportStateCreateFlags; + typedef VkFlags VkPipelineTessellationStateCreateFlags; + typedef VkFlags VkPipelineInputAssemblyStateCreateFlags; + typedef VkFlags VkPipelineVertexInputStateCreateFlags; + typedef VkFlags VkPipelineShaderStageCreateFlags; + typedef VkFlags VkDescriptorSetLayoutCreateFlags; + typedef VkFlags VkBufferViewCreateFlags; + typedef VkFlags VkInstanceCreateFlags; + typedef VkFlags VkDeviceCreateFlags; + typedef VkFlags VkDeviceQueueCreateFlags; + typedef VkFlags VkQueueFlags; + typedef VkFlags VkMemoryPropertyFlags; + typedef VkFlags VkMemoryHeapFlags; + typedef VkFlags VkAccessFlags; + typedef VkFlags VkBufferUsageFlags; + typedef VkFlags VkBufferCreateFlags; + typedef VkFlags VkShaderStageFlags; + typedef VkFlags VkImageUsageFlags; + typedef VkFlags VkImageCreateFlags; + typedef VkFlags VkImageViewCreateFlags; + typedef VkFlags VkPipelineCreateFlags; + typedef VkFlags VkColorComponentFlags; + typedef VkFlags VkFenceCreateFlags; + typedef VkFlags VkSemaphoreCreateFlags; + typedef VkFlags VkFormatFeatureFlags; + typedef VkFlags VkQueryControlFlags; + typedef VkFlags VkQueryResultFlags; + typedef VkFlags VkShaderModuleCreateFlags; + typedef VkFlags VkEventCreateFlags; + typedef VkFlags VkCommandPoolCreateFlags; + typedef VkFlags VkCommandPoolResetFlags; + typedef VkFlags VkCommandBufferResetFlags; + typedef VkFlags VkCommandBufferUsageFlags; + typedef VkFlags VkQueryPipelineStatisticFlags; + typedef VkFlags VkMemoryMapFlags; + typedef VkFlags VkImageAspectFlags; + typedef VkFlags VkSparseMemoryBindFlags; + typedef VkFlags VkSparseImageFormatFlags; + typedef VkFlags VkSubpassDescriptionFlags; + typedef VkFlags VkPipelineStageFlags; + typedef VkFlags VkSampleCountFlags; + typedef VkFlags VkAttachmentDescriptionFlags; + typedef VkFlags VkStencilFaceFlags; + typedef VkFlags VkCullModeFlags; + typedef VkFlags VkDescriptorPoolCreateFlags; + typedef VkFlags VkDescriptorPoolResetFlags; + typedef VkFlags VkDependencyFlags; + + typedef VkFlags VkIndirectCommandsLayoutUsageFlagsNVX; + typedef VkFlags VkObjectEntryUsageFlagsNVX; + + typedef VkFlags VkDescriptorUpdateTemplateCreateFlagsKHR; - typedef VkFlags VkDescriptorUpdateTemplateCreateFlagsKHR; - + WSI extensions typedef VkFlags VkCompositeAlphaFlagsKHR; typedef VkFlags VkDisplayPlaneAlphaFlagsKHR; typedef VkFlags VkSurfaceTransformFlagsKHR; - typedef VkFlags VkSwapchainCreateFlagsKHR; - typedef VkFlags VkDisplayModeCreateFlagsKHR; - typedef VkFlags VkDisplaySurfaceCreateFlagsKHR; - typedef VkFlags VkAndroidSurfaceCreateFlagsKHR; - typedef VkFlags VkMirSurfaceCreateFlagsKHR; - typedef VkFlags VkViSurfaceCreateFlagsNN; - typedef VkFlags VkWaylandSurfaceCreateFlagsKHR; - typedef VkFlags VkWin32SurfaceCreateFlagsKHR; - typedef VkFlags VkXlibSurfaceCreateFlagsKHR; - typedef VkFlags VkXcbSurfaceCreateFlagsKHR; - typedef VkFlags VkIOSSurfaceCreateFlagsMVK; - typedef VkFlags VkMacOSSurfaceCreateFlagsMVK; - typedef VkFlags VkPeerMemoryFeatureFlagsKHX; - typedef VkFlags VkMemoryAllocateFlagsKHX; - typedef VkFlags VkDeviceGroupPresentModeFlagsKHX; + typedef VkFlags VkSwapchainCreateFlagsKHR; + typedef VkFlags VkDisplayModeCreateFlagsKHR; + typedef VkFlags VkDisplaySurfaceCreateFlagsKHR; + typedef VkFlags VkAndroidSurfaceCreateFlagsKHR; + typedef VkFlags VkMirSurfaceCreateFlagsKHR; + typedef VkFlags VkViSurfaceCreateFlagsNN; + typedef VkFlags VkWaylandSurfaceCreateFlagsKHR; + typedef VkFlags VkWin32SurfaceCreateFlagsKHR; + typedef VkFlags VkXlibSurfaceCreateFlagsKHR; + typedef VkFlags VkXcbSurfaceCreateFlagsKHR; + typedef VkFlags VkIOSSurfaceCreateFlagsMVK; + typedef VkFlags VkMacOSSurfaceCreateFlagsMVK; + typedef VkFlags VkPeerMemoryFeatureFlagsKHX; + typedef VkFlags VkMemoryAllocateFlagsKHX; + typedef VkFlags VkDeviceGroupPresentModeFlagsKHX; typedef VkFlags VkDebugReportFlagsEXT; typedef VkFlags VkCommandPoolTrimFlagsKHR; @@ -237,12 +238,12 @@ private version is maintained in the 1.0 branch of the member gitlab server. typedef VkFlags VkExternalFenceFeatureFlagsKHR; typedef VkFlags VkFenceImportFlagsKHR; typedef VkFlags VkSurfaceCounterFlagsEXT; - typedef VkFlags VkPipelineViewportSwizzleStateCreateFlagsNV; - typedef VkFlags VkPipelineDiscardRectangleStateCreateFlagsEXT; - typedef VkFlags VkPipelineCoverageToColorStateCreateFlagsNV; + typedef VkFlags VkPipelineViewportSwizzleStateCreateFlagsNV; + typedef VkFlags VkPipelineDiscardRectangleStateCreateFlagsEXT; + typedef VkFlags VkPipelineCoverageToColorStateCreateFlagsNV; typedef VkFlags VkPipelineCoverageModulationStateCreateFlagsNV; - + Types which can be void pointers or class pointers, selected at compile time VK_DEFINE_HANDLE(VkInstance) VK_DEFINE_HANDLE(VkPhysicalDevice) VK_DEFINE_HANDLE(VkDevice) @@ -272,14 +273,14 @@ private version is maintained in the 1.0 branch of the member gitlab server. VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkIndirectCommandsLayoutNVX) VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkDescriptorUpdateTemplateKHR) - + WSI extensions VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkDisplayKHR) VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkDisplayModeKHR) VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkSurfaceKHR) VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkSwapchainKHR) VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkDebugReportCallbackEXT) - + Types generated from corresponding enums tags below @@ -367,7 +368,8 @@ private version is maintained in the 1.0 branch of the member gitlab server. - + + Extensions @@ -377,7 +379,8 @@ private version is maintained in the 1.0 branch of the member gitlab server. - + + WSI extensions @@ -408,7 +411,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. - + The PFN_vk*Function types are used by VkAllocationCallbacks below typedef void (VKAPI_PTR *PFN_vkInternalAllocationNotification)( void* pUserData, size_t size, @@ -434,10 +437,10 @@ private version is maintained in the 1.0 branch of the member gitlab server. void* pUserData, void* pMemory); - + The PFN_vkVoidFunction type are used by VkGet*ProcAddr below typedef void (VKAPI_PTR *PFN_vkVoidFunction)(void); - + The PFN_vkDebugReportCallbackEXT type are used by the DEBUG_REPORT extension typedef VkBool32 (VKAPI_PTR *PFN_vkDebugReportCallbackEXT)( VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objectType, @@ -448,7 +451,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. const char* pMessage, void* pUserData); - + Struct types int32_t x int32_t y @@ -506,18 +509,18 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkPhysicalDeviceSparseProperties sparseProperties - char extensionName[VK_MAX_EXTENSION_NAME_SIZE] - uint32_t specVersion + char extensionName[VK_MAX_EXTENSION_NAME_SIZE]extension name + uint32_t specVersionversion of the extension specification implemented - char layerName[VK_MAX_EXTENSION_NAME_SIZE] - uint32_t specVersion - uint32_t implementationVersion - char description[VK_MAX_DESCRIPTION_SIZE] + char layerName[VK_MAX_EXTENSION_NAME_SIZE]layer name + uint32_t specVersionversion of the layer specification implemented + uint32_t implementationVersionbuild or release version of the layer's library + char description[VK_MAX_DESCRIPTION_SIZE]Free-form description of the layer VkStructureType sType - const void* pNext + const void* pNext const char* pApplicationName uint32_t applicationVersion const char* pEngineName @@ -534,39 +537,39 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkDeviceQueueCreateFlags flags + const void* pNext + VkDeviceQueueCreateFlags flags uint32_t queueFamilyIndex uint32_t queueCount const float* pQueuePriorities VkStructureType sType - const void* pNext - VkDeviceCreateFlags flags + const void* pNext + VkDeviceCreateFlags flags uint32_t queueCreateInfoCount const VkDeviceQueueCreateInfo* pQueueCreateInfos uint32_t enabledLayerCount - const char* const* ppEnabledLayerNames + const char* const* ppEnabledLayerNamesOrdered list of layer names to be enabled uint32_t enabledExtensionCount const char* const* ppEnabledExtensionNames const VkPhysicalDeviceFeatures* pEnabledFeatures VkStructureType sType - const void* pNext - VkInstanceCreateFlags flags + const void* pNext + VkInstanceCreateFlags flags const VkApplicationInfo* pApplicationInfo uint32_t enabledLayerCount - const char* const* ppEnabledLayerNames + const char* const* ppEnabledLayerNamesOrdered list of layer names to be enabled uint32_t enabledExtensionCount - const char* const* ppEnabledExtensionNames + const char* const* ppEnabledExtensionNamesExtension names to be enabled - VkQueueFlags queueFlags + VkQueueFlags queueFlagsQueue flags uint32_t queueCount uint32_t timestampValidBits - VkExtent3D minImageTransferGranularity + VkExtent3D minImageTransferGranularityMinimum alignment requirement for image transfers uint32_t memoryTypeCount @@ -576,14 +579,14 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkDeviceSize allocationSize - uint32_t memoryTypeIndex + const void* pNext + VkDeviceSize allocationSizeSize of memory allocation + uint32_t memoryTypeIndexIndex of the of the memory type to allocate from - VkDeviceSize size - VkDeviceSize alignment - uint32_t memoryTypeBits + VkDeviceSize sizeSpecified in bytes + VkDeviceSize alignmentSpecified in bytes + uint32_t memoryTypeBitsBitmask of the allowed memory type indices into memoryTypes[] for this object VkImageAspectFlags aspectMask @@ -593,88 +596,88 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkSparseImageFormatProperties formatProperties uint32_t imageMipTailFirstLod - VkDeviceSize imageMipTailSize - VkDeviceSize imageMipTailOffset - VkDeviceSize imageMipTailStride + VkDeviceSize imageMipTailSizeSpecified in bytes, must be a multiple of sparse block size in bytes / alignment + VkDeviceSize imageMipTailOffsetSpecified in bytes, must be a multiple of sparse block size in bytes / alignment + VkDeviceSize imageMipTailStrideSpecified in bytes, must be a multiple of sparse block size in bytes / alignment - VkMemoryPropertyFlags propertyFlags - uint32_t heapIndex + VkMemoryPropertyFlags propertyFlagsMemory properties of this memory type + uint32_t heapIndexIndex of the memory heap allocations of this memory type are taken from - VkDeviceSize size - VkMemoryHeapFlags flags + VkDeviceSize sizeAvailable memory in the heap + VkMemoryHeapFlags flagsFlags for the heap VkStructureType sType - const void* pNext - VkDeviceMemory memory - VkDeviceSize offset - VkDeviceSize size + const void* pNext + VkDeviceMemory memoryMapped memory object + VkDeviceSize offsetOffset within the memory object where the range starts + VkDeviceSize sizeSize of the range within the memory object - VkFormatFeatureFlags linearTilingFeatures - VkFormatFeatureFlags optimalTilingFeatures - VkFormatFeatureFlags bufferFeatures + VkFormatFeatureFlags linearTilingFeaturesFormat features in case of linear tiling + VkFormatFeatureFlags optimalTilingFeaturesFormat features in case of optimal tiling + VkFormatFeatureFlags bufferFeaturesFormat features supported by buffers - VkExtent3D maxExtent - uint32_t maxMipLevels - uint32_t maxArrayLayers - VkSampleCountFlags sampleCounts - VkDeviceSize maxResourceSize + VkExtent3D maxExtentmax image dimensions for this resource type + uint32_t maxMipLevelsmax number of mipmap levels for this resource type + uint32_t maxArrayLayersmax array size for this resource type + VkSampleCountFlags sampleCountssupported sample counts for this resource type + VkDeviceSize maxResourceSizemax size (in bytes) of this resource type - VkBuffer buffer - VkDeviceSize offset - VkDeviceSize range + VkBuffer bufferBuffer used for this descriptor slot when the descriptor is UNIFORM_BUFFER[_DYNAMIC] or STORAGE_BUFFER[_DYNAMIC]. VK_NULL_HANDLE otherwise. + VkDeviceSize offsetBase offset from buffer start in bytes to update in the descriptor set. + VkDeviceSize rangeSize in bytes of the buffer resource for this descriptor update. - VkSampler sampler - VkImageView imageView - VkImageLayout imageLayout + VkSampler samplerSampler to write to the descriptor in case it is a SAMPLER or COMBINED_IMAGE_SAMPLER descriptor. Ignored otherwise. + VkImageView imageViewImage view to write to the descriptor in case it is a SAMPLED_IMAGE, STORAGE_IMAGE, COMBINED_IMAGE_SAMPLER, or INPUT_ATTACHMENT descriptor. Ignored otherwise. + VkImageLayout imageLayoutLayout the image is expected to be in when accessed using this descriptor (only used if imageView is not VK_NULL_HANDLE). VkStructureType sType - const void* pNext - VkDescriptorSet dstSet - uint32_t dstBinding - uint32_t dstArrayElement - uint32_t descriptorCount - VkDescriptorType descriptorType - const VkDescriptorImageInfo* pImageInfo - const VkDescriptorBufferInfo* pBufferInfo - const VkBufferView* pTexelBufferView + const void* pNext + VkDescriptorSet dstSetDestination descriptor set + uint32_t dstBindingBinding within the destination descriptor set to write + uint32_t dstArrayElementArray element within the destination binding to write + uint32_t descriptorCountNumber of descriptors to write (determines the size of the array pointed by pDescriptors) + VkDescriptorType descriptorTypeDescriptor type to write (determines which members of the array pointed by pDescriptors are going to be used) + const VkDescriptorImageInfo* pImageInfoSampler, image view, and layout for SAMPLER, COMBINED_IMAGE_SAMPLER, {SAMPLED,STORAGE}_IMAGE, and INPUT_ATTACHMENT descriptor types. + const VkDescriptorBufferInfo* pBufferInfoRaw buffer, size, and offset for {UNIFORM,STORAGE}_BUFFER[_DYNAMIC] descriptor types. + const VkBufferView* pTexelBufferViewBuffer view to write to the descriptor for {UNIFORM,STORAGE}_TEXEL_BUFFER descriptor types. VkStructureType sType - const void* pNext - VkDescriptorSet srcSet - uint32_t srcBinding - uint32_t srcArrayElement - VkDescriptorSet dstSet - uint32_t dstBinding - uint32_t dstArrayElement - uint32_t descriptorCount + const void* pNext + VkDescriptorSet srcSetSource descriptor set + uint32_t srcBindingBinding within the source descriptor set to copy from + uint32_t srcArrayElementArray element within the source binding to copy from + VkDescriptorSet dstSetDestination descriptor set + uint32_t dstBindingBinding within the destination descriptor set to copy to + uint32_t dstArrayElementArray element within the destination binding to copy to + uint32_t descriptorCountNumber of descriptors to write (determines the size of the array pointed by pDescriptors) VkStructureType sType - const void* pNext - VkBufferCreateFlags flags - VkDeviceSize size - VkBufferUsageFlags usage + const void* pNext + VkBufferCreateFlags flagsBuffer creation flags + VkDeviceSize sizeSpecified in bytes + VkBufferUsageFlags usageBuffer usage flags VkSharingMode sharingMode uint32_t queueFamilyIndexCount const uint32_t* pQueueFamilyIndices VkStructureType sType - const void* pNext - VkBufferViewCreateFlagsflags + const void* pNext + VkBufferViewCreateFlagsflags VkBuffer buffer - VkFormat format - VkDeviceSize offset - VkDeviceSize range + VkFormat formatOptionally specifies format of elements + VkDeviceSize offsetSpecified in bytes + VkDeviceSize rangeView size specified in bytes VkImageAspectFlags aspectMask @@ -696,37 +699,37 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkAccessFlags srcAccessMask - VkAccessFlags dstAccessMask + const void* pNext + VkAccessFlags srcAccessMaskMemory accesses from the source of the dependency to synchronize + VkAccessFlags dstAccessMaskMemory accesses from the destination of the dependency to synchronize VkStructureType sType - const void* pNext - VkAccessFlags srcAccessMask - VkAccessFlags dstAccessMask - uint32_t srcQueueFamilyIndex - uint32_t dstQueueFamilyIndex - VkBuffer buffer - VkDeviceSize offset - VkDeviceSize size + const void* pNext + VkAccessFlags srcAccessMaskMemory accesses from the source of the dependency to synchronize + VkAccessFlags dstAccessMaskMemory accesses from the destination of the dependency to synchronize + uint32_t srcQueueFamilyIndexQueue family to transition ownership from + uint32_t dstQueueFamilyIndexQueue family to transition ownership to + VkBuffer bufferBuffer to sync + VkDeviceSize offsetOffset within the buffer to sync + VkDeviceSize sizeAmount of bytes to sync VkStructureType sType - const void* pNext - VkAccessFlags srcAccessMask - VkAccessFlags dstAccessMask - VkImageLayout oldLayout - VkImageLayout newLayout - uint32_t srcQueueFamilyIndex - uint32_t dstQueueFamilyIndex - VkImage image - VkImageSubresourceRange subresourceRange + const void* pNext + VkAccessFlags srcAccessMaskMemory accesses from the source of the dependency to synchronize + VkAccessFlags dstAccessMaskMemory accesses from the destination of the dependency to synchronize + VkImageLayout oldLayoutCurrent layout of the image + VkImageLayout newLayoutNew layout to transition the image to + uint32_t srcQueueFamilyIndexQueue family to transition ownership from + uint32_t dstQueueFamilyIndexQueue family to transition ownership to + VkImage imageImage to sync + VkImageSubresourceRange subresourceRangeSubresource range to sync VkStructureType sType - const void* pNext - VkImageCreateFlags flags + const void* pNext + VkImageCreateFlags flagsImage creation flags VkImageType imageType VkFormat format VkExtent3D extent @@ -734,23 +737,23 @@ private version is maintained in the 1.0 branch of the member gitlab server. uint32_t arrayLayers VkSampleCountFlagBits samples VkImageTiling tiling - VkImageUsageFlags usage - VkSharingMode sharingMode - uint32_t queueFamilyIndexCount - const uint32_t* pQueueFamilyIndices - VkImageLayout initialLayout + VkImageUsageFlags usageImage usage flags + VkSharingMode sharingModeCross-queue-family sharing mode + uint32_t queueFamilyIndexCountNumber of queue families to share across + const uint32_t* pQueueFamilyIndicesArray of queue family indices to share across + VkImageLayout initialLayoutInitial image layout for all subresources - VkDeviceSize offset - VkDeviceSize size - VkDeviceSize rowPitch - VkDeviceSize arrayPitch - VkDeviceSize depthPitch + VkDeviceSize offsetSpecified in bytes + VkDeviceSize sizeSpecified in bytes + VkDeviceSize rowPitchSpecified in bytes + VkDeviceSize arrayPitchSpecified in bytes + VkDeviceSize depthPitchSpecified in bytes VkStructureType sType - const void* pNext - VkImageViewCreateFlags flags + const void* pNext + VkImageViewCreateFlags flags VkImage image VkImageViewType viewType VkFormat format @@ -758,24 +761,24 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkImageSubresourceRange subresourceRange - VkDeviceSize srcOffset - VkDeviceSize dstOffset - VkDeviceSize size + VkDeviceSize srcOffsetSpecified in bytes + VkDeviceSize dstOffsetSpecified in bytes + VkDeviceSize sizeSpecified in bytes - VkDeviceSize resourceOffset - VkDeviceSize size + VkDeviceSize resourceOffsetSpecified in bytes + VkDeviceSize sizeSpecified in bytes VkDeviceMemory memory - VkDeviceSize memoryOffset - VkSparseMemoryBindFlagsflags + VkDeviceSize memoryOffsetSpecified in bytes + VkSparseMemoryBindFlagsflags VkImageSubresource subresource VkOffset3D offset VkExtent3D extent VkDeviceMemory memory - VkDeviceSize memoryOffset - VkSparseMemoryBindFlagsflags + VkDeviceSize memoryOffsetSpecified in bytes + VkSparseMemoryBindFlagsflags VkBuffer buffer @@ -794,7 +797,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext + const void* pNext uint32_t waitSemaphoreCount const VkSemaphore* pWaitSemaphores uint32_t bufferBindCount @@ -808,24 +811,24 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkImageSubresourceLayers srcSubresource - VkOffset3D srcOffset + VkOffset3D srcOffsetSpecified in pixels for both compressed and uncompressed images VkImageSubresourceLayers dstSubresource - VkOffset3D dstOffset - VkExtent3D extent + VkOffset3D dstOffsetSpecified in pixels for both compressed and uncompressed images + VkExtent3D extentSpecified in pixels for both compressed and uncompressed images VkImageSubresourceLayers srcSubresource - VkOffset3D srcOffsets[2] + VkOffset3D srcOffsets[2]Specified in pixels for both compressed and uncompressed images VkImageSubresourceLayers dstSubresource - VkOffset3D dstOffsets[2] + VkOffset3D dstOffsets[2]Specified in pixels for both compressed and uncompressed images - VkDeviceSize bufferOffset - uint32_t bufferRowLength + VkDeviceSize bufferOffsetSpecified in bytes + uint32_t bufferRowLengthSpecified in texels uint32_t bufferImageHeight VkImageSubresourceLayers imageSubresource - VkOffset3D imageOffset - VkExtent3D imageExtent + VkOffset3D imageOffsetSpecified in pixels for both compressed and uncompressed images + VkExtent3D imageExtentSpecified in pixels for both compressed and uncompressed images VkImageSubresourceLayers srcSubresource @@ -836,24 +839,24 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkShaderModuleCreateFlags flags - size_t codeSize - const uint32_t* pCode + const void* pNext + VkShaderModuleCreateFlags flags + size_t codeSizeSpecified in bytes + const uint32_t* pCodeBinary code of size codeSize - uint32_t binding - VkDescriptorType descriptorType - uint32_t descriptorCount - VkShaderStageFlags stageFlags - const VkSampler* pImmutableSamplers + uint32_t bindingBinding number for this entry + VkDescriptorType descriptorTypeType of the descriptors in this binding + uint32_t descriptorCountNumber of descriptors in this binding + VkShaderStageFlags stageFlagsShader stages this binding is visible to + const VkSampler* pImmutableSamplersImmutable samplers (used if descriptor type is SAMPLER or COMBINED_IMAGE_SAMPLER, is either NULL or contains count number of elements) VkStructureType sType - const void* pNext - VkDescriptorSetLayoutCreateFlags flags - uint32_t bindingCount - const VkDescriptorSetLayoutBinding* pBindings + const void* pNext + VkDescriptorSetLayoutCreateFlags flags + uint32_t bindingCountNumber of bindings in the descriptor set layout + const VkDescriptorSetLayoutBinding* pBindingsArray of descriptor set layout bindings VkDescriptorType type @@ -861,7 +864,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext + const void* pNext VkDescriptorPoolCreateFlags flags uint32_t maxSets uint32_t poolSizeCount @@ -869,77 +872,77 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext + const void* pNext VkDescriptorPool descriptorPool uint32_t descriptorSetCount const VkDescriptorSetLayout* pSetLayouts - uint32_t constantID - uint32_t offset - size_t size + uint32_t constantIDThe SpecConstant ID specified in the BIL + uint32_t offsetOffset of the value in the data block + size_t sizeSize in bytes of the SpecConstant - uint32_t mapEntryCount - const VkSpecializationMapEntry* pMapEntries - size_t dataSize - const void* pData + uint32_t mapEntryCountNumber of entries in the map + const VkSpecializationMapEntry* pMapEntriesArray of map entries + size_t dataSizeSize in bytes of pData + const void* pDataPointer to SpecConstant data VkStructureType sType - const void* pNext - VkPipelineShaderStageCreateFlags flags - VkShaderStageFlagBits stage - VkShaderModule module - const char* pName + const void* pNext + VkPipelineShaderStageCreateFlags flags + VkShaderStageFlagBits stageShader stage + VkShaderModule moduleModule containing entry point + const char* pNameNull-terminated entry point name const VkSpecializationInfo* pSpecializationInfo VkStructureType sType - const void* pNext - VkPipelineCreateFlags flags + const void* pNext + VkPipelineCreateFlags flagsPipeline creation flags VkPipelineShaderStageCreateInfo stage - VkPipelineLayout layout - VkPipeline basePipelineHandle - int32_t basePipelineIndex + VkPipelineLayout layoutInterface layout of the pipeline + VkPipeline basePipelineHandleIf VK_PIPELINE_CREATE_DERIVATIVE_BIT is set and this value is nonzero, it specifies the handle of the base pipeline this is a derivative of + int32_t basePipelineIndexIf VK_PIPELINE_CREATE_DERIVATIVE_BIT is set and this value is not -1, it specifies an index into pCreateInfos of the base pipeline this is a derivative of - uint32_t binding - uint32_t stride - VkVertexInputRate inputRate + uint32_t bindingVertex buffer binding id + uint32_t strideDistance between vertices in bytes (0 = no advancement) + VkVertexInputRate inputRateThe rate at which the vertex data is consumed - uint32_t location - uint32_t binding - VkFormat format - uint32_t offset + uint32_t locationlocation of the shader vertex attrib + uint32_t bindingVertex buffer binding id + VkFormat formatformat of source data + uint32_t offsetOffset of first element in bytes from base of vertex VkStructureType sType - const void* pNext - VkPipelineVertexInputStateCreateFlags flags - uint32_t vertexBindingDescriptionCount + const void* pNext + VkPipelineVertexInputStateCreateFlags flags + uint32_t vertexBindingDescriptionCountnumber of bindings const VkVertexInputBindingDescription* pVertexBindingDescriptions - uint32_t vertexAttributeDescriptionCount + uint32_t vertexAttributeDescriptionCountnumber of attributes const VkVertexInputAttributeDescription* pVertexAttributeDescriptions VkStructureType sType - const void* pNext - VkPipelineInputAssemblyStateCreateFlags flags + const void* pNext + VkPipelineInputAssemblyStateCreateFlags flags VkPrimitiveTopology topology VkBool32 primitiveRestartEnable VkStructureType sType - const void* pNext - VkPipelineTessellationStateCreateFlags flags + const void* pNext + VkPipelineTessellationStateCreateFlags flags uint32_t patchControlPoints VkStructureType sType - const void* pNext - VkPipelineViewportStateCreateFlags flags + const void* pNext + VkPipelineViewportStateCreateFlags flags uint32_t viewportCount const VkViewport* pViewports uint32_t scissorCount @@ -947,11 +950,11 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkPipelineRasterizationStateCreateFlags flags + const void* pNext + VkPipelineRasterizationStateCreateFlags flags VkBool32 depthClampEnable VkBool32 rasterizerDiscardEnable - VkPolygonMode polygonMode + VkPolygonMode polygonModeoptional (GL45) VkCullModeFlags cullMode VkFrontFace frontFace VkBool32 depthBiasEnable @@ -962,12 +965,12 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkPipelineMultisampleStateCreateFlags flags - VkSampleCountFlagBits rasterizationSamples - VkBool32 sampleShadingEnable - float minSampleShading - const VkSampleMask* pSampleMask + const void* pNext + VkPipelineMultisampleStateCreateFlags flags + VkSampleCountFlagBits rasterizationSamplesNumber of samples used for rasterization + VkBool32 sampleShadingEnableoptional (GL45) + float minSampleShadingoptional (GL45) + const VkSampleMask* pSampleMaskArray of sampleMask words VkBool32 alphaToCoverageEnable VkBool32 alphaToOneEnable @@ -983,18 +986,18 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkPipelineColorBlendStateCreateFlags flags + const void* pNext + VkPipelineColorBlendStateCreateFlags flags VkBool32 logicOpEnable VkLogicOp logicOp - uint32_t attachmentCount + uint32_t attachmentCount# of pAttachments const VkPipelineColorBlendAttachmentState* pAttachments float blendConstants[4] VkStructureType sType - const void* pNext - VkPipelineDynamicStateCreateFlags flags + const void* pNext + VkPipelineDynamicStateCreateFlags flags uint32_t dynamicStateCount const VkDynamicState* pDynamicStates @@ -1009,12 +1012,12 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkPipelineDepthStencilStateCreateFlags flags + const void* pNext + VkPipelineDepthStencilStateCreateFlags flags VkBool32 depthTestEnable VkBool32 depthWriteEnable VkCompareOp depthCompareOp - VkBool32 depthBoundsTestEnable + VkBool32 depthBoundsTestEnableoptional (depth_bounds_test) VkBool32 stencilTestEnable VkStencilOpState front VkStencilOpState back @@ -1023,10 +1026,10 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkPipelineCreateFlags flags + const void* pNext + VkPipelineCreateFlags flagsPipeline creation flags uint32_t stageCount - const VkPipelineShaderStageCreateInfo* pStages + const VkPipelineShaderStageCreateInfo* pStagesOne entry for each active shader stage const VkPipelineVertexInputStateCreateInfo* pVertexInputState const VkPipelineInputAssemblyStateCreateInfo* pInputAssemblyState const VkPipelineTessellationStateCreateInfo* pTessellationState @@ -1036,40 +1039,40 @@ private version is maintained in the 1.0 branch of the member gitlab server. const VkPipelineDepthStencilStateCreateInfo* pDepthStencilState const VkPipelineColorBlendStateCreateInfo* pColorBlendState const VkPipelineDynamicStateCreateInfo* pDynamicState - VkPipelineLayout layout + VkPipelineLayout layoutInterface layout of the pipeline VkRenderPass renderPass uint32_t subpass - VkPipeline basePipelineHandle - int32_t basePipelineIndex + VkPipeline basePipelineHandleIf VK_PIPELINE_CREATE_DERIVATIVE_BIT is set and this value is nonzero, it specifies the handle of the base pipeline this is a derivative of + int32_t basePipelineIndexIf VK_PIPELINE_CREATE_DERIVATIVE_BIT is set and this value is not -1, it specifies an index into pCreateInfos of the base pipeline this is a derivative of VkStructureType sType - const void* pNext - VkPipelineCacheCreateFlags flags - size_t initialDataSize - const void* pInitialData + const void* pNext + VkPipelineCacheCreateFlags flags + size_t initialDataSizeSize of initial data to populate cache, in bytes + const void* pInitialDataInitial data to populate cache - VkShaderStageFlags stageFlags - uint32_t offset - uint32_t size + VkShaderStageFlags stageFlagsWhich stages use the range + uint32_t offsetStart of the range, in bytes + uint32_t sizeSize of the range, in bytes VkStructureType sType - const void* pNext - VkPipelineLayoutCreateFlags flags - uint32_t setLayoutCount - const VkDescriptorSetLayout* pSetLayouts - uint32_t pushConstantRangeCount - const VkPushConstantRange* pPushConstantRanges + const void* pNext + VkPipelineLayoutCreateFlags flags + uint32_t setLayoutCountNumber of descriptor sets interfaced by the pipeline + const VkDescriptorSetLayout* pSetLayoutsArray of setCount number of descriptor set layout objects defining the layout of the + uint32_t pushConstantRangeCountNumber of push-constant ranges used by the pipeline + const VkPushConstantRange* pPushConstantRangesArray of pushConstantRangeCount number of ranges used by various shader stages VkStructureType sType - const void* pNext - VkSamplerCreateFlags flags - VkFilter magFilter - VkFilter minFilter - VkSamplerMipmapMode mipmapMode + const void* pNext + VkSamplerCreateFlags flags + VkFilter magFilterFilter mode for magnification + VkFilter minFilterFilter mode for minifiation + VkSamplerMipmapMode mipmapModeMipmap selection mode VkSamplerAddressMode addressModeU VkSamplerAddressMode addressModeV VkSamplerAddressMode addressModeW @@ -1085,36 +1088,36 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkCommandPoolCreateFlags flags + const void* pNext + VkCommandPoolCreateFlags flagsCommand pool creation flags uint32_t queueFamilyIndex VkStructureType sType - const void* pNext + const void* pNext VkCommandPool commandPool VkCommandBufferLevel level uint32_t commandBufferCount VkStructureType sType - const void* pNext - VkRenderPass renderPass + const void* pNext + VkRenderPass renderPassRender pass for secondary command buffers uint32_t subpass - VkFramebuffer framebuffer - VkBool32 occlusionQueryEnable - VkQueryControlFlags queryFlags - VkQueryPipelineStatisticFlags pipelineStatistics + VkFramebuffer framebufferFramebuffer for secondary command buffers + VkBool32 occlusionQueryEnableWhether this secondary command buffer may be executed during an occlusion query + VkQueryControlFlags queryFlagsQuery flags used by this secondary command buffer, if executed during an occlusion query + VkQueryPipelineStatisticFlags pipelineStatisticsPipeline statistics that may be counted for this secondary command buffer VkStructureType sType - const void* pNext - VkCommandBufferUsageFlags flags - const VkCommandBufferInheritanceInfo* pInheritanceInfo + const void* pNext + VkCommandBufferUsageFlags flagsCommand buffer usage flags + const VkCommandBufferInheritanceInfo* pInheritanceInfoPointer to inheritance info for secondary command buffers VkStructureType sType - const void* pNext + const void* pNext VkRenderPass renderPass VkFramebuffer framebuffer VkRect2D renderArea @@ -1143,10 +1146,10 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkAttachmentDescriptionFlags flags VkFormat format VkSampleCountFlagBits samples - VkAttachmentLoadOp loadOp - VkAttachmentStoreOp storeOp - VkAttachmentLoadOp stencilLoadOp - VkAttachmentStoreOp stencilStoreOp + VkAttachmentLoadOp loadOpLoad operation for color or depth data + VkAttachmentStoreOp storeOpStore operation for color or depth data + VkAttachmentLoadOp stencilLoadOpLoad operation for stencil data + VkAttachmentStoreOp stencilStoreOpStore operation for stencil data VkImageLayout initialLayout VkImageLayout finalLayout @@ -1156,7 +1159,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkSubpassDescriptionFlags flags - VkPipelineBindPoint pipelineBindPoint + VkPipelineBindPoint pipelineBindPointMust be VK_PIPELINE_BIND_POINT_GRAPHICS for now uint32_t inputAttachmentCount const VkAttachmentReference* pInputAttachments uint32_t colorAttachmentCount @@ -1171,14 +1174,14 @@ private version is maintained in the 1.0 branch of the member gitlab server. uint32_t dstSubpass VkPipelineStageFlags srcStageMask VkPipelineStageFlags dstStageMask - VkAccessFlags srcAccessMask - VkAccessFlags dstAccessMask + VkAccessFlags srcAccessMaskMemory accesses from the source of the dependency to synchronize + VkAccessFlags dstAccessMaskMemory accesses from the destination of the dependency to synchronize VkDependencyFlags dependencyFlags VkStructureType sType - const void* pNext - VkRenderPassCreateFlags flags + const void* pNext + VkRenderPassCreateFlags flags uint32_t attachmentCount const VkAttachmentDescription* pAttachments uint32_t subpassCount @@ -1188,212 +1191,212 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkEventCreateFlags flags + const void* pNext + VkEventCreateFlags flagsEvent creation flags VkStructureType sType - const void* pNext - VkFenceCreateFlags flags + const void* pNext + VkFenceCreateFlags flagsFence creation flags - VkBool32 robustBufferAccess - VkBool32 fullDrawIndexUint32 - VkBool32 imageCubeArray - VkBool32 independentBlend - VkBool32 geometryShader - VkBool32 tessellationShader - VkBool32 sampleRateShading - VkBool32 dualSrcBlend - VkBool32 logicOp - VkBool32 multiDrawIndirect - VkBool32 drawIndirectFirstInstance - VkBool32 depthClamp - VkBool32 depthBiasClamp - VkBool32 fillModeNonSolid - VkBool32 depthBounds - VkBool32 wideLines - VkBool32 largePoints - VkBool32 alphaToOne - VkBool32 multiViewport - VkBool32 samplerAnisotropy - VkBool32 textureCompressionETC2 - VkBool32 textureCompressionASTC_LDR - VkBool32 textureCompressionBC - VkBool32 occlusionQueryPrecise - VkBool32 pipelineStatisticsQuery - VkBool32 vertexPipelineStoresAndAtomics - VkBool32 fragmentStoresAndAtomics - VkBool32 shaderTessellationAndGeometryPointSize - VkBool32 shaderImageGatherExtended - VkBool32 shaderStorageImageExtendedFormats - VkBool32 shaderStorageImageMultisample - VkBool32 shaderStorageImageReadWithoutFormat - VkBool32 shaderStorageImageWriteWithoutFormat - VkBool32 shaderUniformBufferArrayDynamicIndexing - VkBool32 shaderSampledImageArrayDynamicIndexing - VkBool32 shaderStorageBufferArrayDynamicIndexing - VkBool32 shaderStorageImageArrayDynamicIndexing - VkBool32 shaderClipDistance - VkBool32 shaderCullDistance - VkBool32 shaderFloat64 - VkBool32 shaderInt64 - VkBool32 shaderInt16 - VkBool32 shaderResourceResidency - VkBool32 shaderResourceMinLod - VkBool32 sparseBinding - VkBool32 sparseResidencyBuffer - VkBool32 sparseResidencyImage2D - VkBool32 sparseResidencyImage3D - VkBool32 sparseResidency2Samples - VkBool32 sparseResidency4Samples - VkBool32 sparseResidency8Samples - VkBool32 sparseResidency16Samples - VkBool32 sparseResidencyAliased - VkBool32 variableMultisampleRate - VkBool32 inheritedQueries + VkBool32 robustBufferAccessout of bounds buffer accesses are well defined + VkBool32 fullDrawIndexUint32full 32-bit range of indices for indexed draw calls + VkBool32 imageCubeArrayimage views which are arrays of cube maps + VkBool32 independentBlendblending operations are controlled per-attachment + VkBool32 geometryShadergeometry stage + VkBool32 tessellationShadertessellation control and evaluation stage + VkBool32 sampleRateShadingper-sample shading and interpolation + VkBool32 dualSrcBlendblend operations which take two sources + VkBool32 logicOplogic operations + VkBool32 multiDrawIndirectmulti draw indirect + VkBool32 drawIndirectFirstInstanceindirect draws can use non-zero firstInstance + VkBool32 depthClampdepth clamping + VkBool32 depthBiasClampdepth bias clamping + VkBool32 fillModeNonSolidpoint and wireframe fill modes + VkBool32 depthBoundsdepth bounds test + VkBool32 wideLineslines with width greater than 1 + VkBool32 largePointspoints with size greater than 1 + VkBool32 alphaToOnethe fragment alpha component can be forced to maximum representable alpha value + VkBool32 multiViewportviewport arrays + VkBool32 samplerAnisotropyanisotropic sampler filtering + VkBool32 textureCompressionETC2ETC texture compression formats + VkBool32 textureCompressionASTC_LDRASTC LDR texture compression formats + VkBool32 textureCompressionBCBC1-7 texture compressed formats + VkBool32 occlusionQueryPreciseprecise occlusion queries returning actual sample counts + VkBool32 pipelineStatisticsQuerypipeline statistics query + VkBool32 vertexPipelineStoresAndAtomicsstores and atomic ops on storage buffers and images are supported in vertex, tessellation, and geometry stages + VkBool32 fragmentStoresAndAtomicsstores and atomic ops on storage buffers and images are supported in the fragment stage + VkBool32 shaderTessellationAndGeometryPointSizetessellation and geometry stages can export point size + VkBool32 shaderImageGatherExtendedimage gather with run-time values and independent offsets + VkBool32 shaderStorageImageExtendedFormatsthe extended set of formats can be used for storage images + VkBool32 shaderStorageImageMultisamplemultisample images can be used for storage images + VkBool32 shaderStorageImageReadWithoutFormatread from storage image does not require format qualifier + VkBool32 shaderStorageImageWriteWithoutFormatwrite to storage image does not require format qualifier + VkBool32 shaderUniformBufferArrayDynamicIndexingarrays of uniform buffers can be accessed with dynamically uniform indices + VkBool32 shaderSampledImageArrayDynamicIndexingarrays of sampled images can be accessed with dynamically uniform indices + VkBool32 shaderStorageBufferArrayDynamicIndexingarrays of storage buffers can be accessed with dynamically uniform indices + VkBool32 shaderStorageImageArrayDynamicIndexingarrays of storage images can be accessed with dynamically uniform indices + VkBool32 shaderClipDistanceclip distance in shaders + VkBool32 shaderCullDistancecull distance in shaders + VkBool32 shaderFloat6464-bit floats (doubles) in shaders + VkBool32 shaderInt6464-bit integers in shaders + VkBool32 shaderInt1616-bit integers in shaders + VkBool32 shaderResourceResidencyshader can use texture operations that return resource residency information (requires sparseNonResident support) + VkBool32 shaderResourceMinLodshader can use texture operations that specify minimum resource level of detail + VkBool32 sparseBindingSparse resources support: Resource memory can be managed at opaque page level rather than object level + VkBool32 sparseResidencyBufferSparse resources support: GPU can access partially resident buffers + VkBool32 sparseResidencyImage2DSparse resources support: GPU can access partially resident 2D (non-MSAA non-depth/stencil) images + VkBool32 sparseResidencyImage3DSparse resources support: GPU can access partially resident 3D images + VkBool32 sparseResidency2SamplesSparse resources support: GPU can access partially resident MSAA 2D images with 2 samples + VkBool32 sparseResidency4SamplesSparse resources support: GPU can access partially resident MSAA 2D images with 4 samples + VkBool32 sparseResidency8SamplesSparse resources support: GPU can access partially resident MSAA 2D images with 8 samples + VkBool32 sparseResidency16SamplesSparse resources support: GPU can access partially resident MSAA 2D images with 16 samples + VkBool32 sparseResidencyAliasedSparse resources support: GPU can correctly access data aliased into multiple locations (opt-in) + VkBool32 variableMultisampleRatemultisample rate must be the same for all pipelines in a subpass + VkBool32 inheritedQueriesQueries may be inherited from primary to secondary command buffers - VkBool32 residencyStandard2DBlockShape - VkBool32 residencyStandard2DMultisampleBlockShape - VkBool32 residencyStandard3DBlockShape - VkBool32 residencyAlignedMipSize - VkBool32 residencyNonResidentStrict + VkBool32 residencyStandard2DBlockShapeSparse resources support: GPU will access all 2D (single sample) sparse resources using the standard sparse image block shapes (based on pixel format) + VkBool32 residencyStandard2DMultisampleBlockShapeSparse resources support: GPU will access all 2D (multisample) sparse resources using the standard sparse image block shapes (based on pixel format) + VkBool32 residencyStandard3DBlockShapeSparse resources support: GPU will access all 3D sparse resources using the standard sparse image block shapes (based on pixel format) + VkBool32 residencyAlignedMipSizeSparse resources support: Images with mip level dimensions that are NOT a multiple of the sparse image block dimensions will be placed in the mip tail + VkBool32 residencyNonResidentStrictSparse resources support: GPU can consistently access non-resident regions of a resource, all reads return as if data is 0, writes are discarded - - uint32_t maxImageDimension1D - uint32_t maxImageDimension2D - uint32_t maxImageDimension3D - uint32_t maxImageDimensionCube - uint32_t maxImageArrayLayers - uint32_t maxTexelBufferElements - uint32_t maxUniformBufferRange - uint32_t maxStorageBufferRange - uint32_t maxPushConstantsSize - - uint32_t maxMemoryAllocationCount - uint32_t maxSamplerAllocationCount - VkDeviceSize bufferImageGranularity - VkDeviceSize sparseAddressSpaceSize - - uint32_t maxBoundDescriptorSets - uint32_t maxPerStageDescriptorSamplers - uint32_t maxPerStageDescriptorUniformBuffers - uint32_t maxPerStageDescriptorStorageBuffers - uint32_t maxPerStageDescriptorSampledImages - uint32_t maxPerStageDescriptorStorageImages - uint32_t maxPerStageDescriptorInputAttachments - uint32_t maxPerStageResources - uint32_t maxDescriptorSetSamplers - uint32_t maxDescriptorSetUniformBuffers - uint32_t maxDescriptorSetUniformBuffersDynamic - uint32_t maxDescriptorSetStorageBuffers - uint32_t maxDescriptorSetStorageBuffersDynamic - uint32_t maxDescriptorSetSampledImages - uint32_t maxDescriptorSetStorageImages - uint32_t maxDescriptorSetInputAttachments - - uint32_t maxVertexInputAttributes - uint32_t maxVertexInputBindings - uint32_t maxVertexInputAttributeOffset - uint32_t maxVertexInputBindingStride - uint32_t maxVertexOutputComponents - - uint32_t maxTessellationGenerationLevel - uint32_t maxTessellationPatchSize - uint32_t maxTessellationControlPerVertexInputComponents - uint32_t maxTessellationControlPerVertexOutputComponents - uint32_t maxTessellationControlPerPatchOutputComponents - uint32_t maxTessellationControlTotalOutputComponents - - uint32_t maxTessellationEvaluationInputComponents - uint32_t maxTessellationEvaluationOutputComponents - - uint32_t maxGeometryShaderInvocations - uint32_t maxGeometryInputComponents - uint32_t maxGeometryOutputComponents - uint32_t maxGeometryOutputVertices - uint32_t maxGeometryTotalOutputComponents - - uint32_t maxFragmentInputComponents - uint32_t maxFragmentOutputAttachments - uint32_t maxFragmentDualSrcAttachments - uint32_t maxFragmentCombinedOutputResources - - uint32_t maxComputeSharedMemorySize - uint32_t maxComputeWorkGroupCount[3] - uint32_t maxComputeWorkGroupInvocations - uint32_t maxComputeWorkGroupSize[3] - uint32_t subPixelPrecisionBits - uint32_t subTexelPrecisionBits - uint32_t mipmapPrecisionBits - uint32_t maxDrawIndexedIndexValue - uint32_t maxDrawIndirectCount - float maxSamplerLodBias - float maxSamplerAnisotropy - uint32_t maxViewports - uint32_t maxViewportDimensions[2] - float viewportBoundsRange[2] - uint32_t viewportSubPixelBits - size_t minMemoryMapAlignment - VkDeviceSize minTexelBufferOffsetAlignment - VkDeviceSize minUniformBufferOffsetAlignment - VkDeviceSize minStorageBufferOffsetAlignment - int32_t minTexelOffset - uint32_t maxTexelOffset - int32_t minTexelGatherOffset - uint32_t maxTexelGatherOffset - float minInterpolationOffset - float maxInterpolationOffset - uint32_t subPixelInterpolationOffsetBits - uint32_t maxFramebufferWidth - uint32_t maxFramebufferHeight - uint32_t maxFramebufferLayers - VkSampleCountFlags framebufferColorSampleCounts - VkSampleCountFlags framebufferDepthSampleCounts - VkSampleCountFlags framebufferStencilSampleCounts - VkSampleCountFlags framebufferNoAttachmentsSampleCounts - uint32_t maxColorAttachments - VkSampleCountFlags sampledImageColorSampleCounts - VkSampleCountFlags sampledImageIntegerSampleCounts - VkSampleCountFlags sampledImageDepthSampleCounts - VkSampleCountFlags sampledImageStencilSampleCounts - VkSampleCountFlags storageImageSampleCounts - uint32_t maxSampleMaskWords - VkBool32 timestampComputeAndGraphics - float timestampPeriod - uint32_t maxClipDistances - uint32_t maxCullDistances - uint32_t maxCombinedClipAndCullDistances - uint32_t discreteQueuePriorities - float pointSizeRange[2] - float lineWidthRange[2] - float pointSizeGranularity - float lineWidthGranularity - VkBool32 strictLines - VkBool32 standardSampleLocations - VkDeviceSize optimalBufferCopyOffsetAlignment - VkDeviceSize optimalBufferCopyRowPitchAlignment - VkDeviceSize nonCoherentAtomSize + resource maximum sizes + uint32_t maxImageDimension1Dmax 1D image dimension + uint32_t maxImageDimension2Dmax 2D image dimension + uint32_t maxImageDimension3Dmax 3D image dimension + uint32_t maxImageDimensionCubemax cubemap image dimension + uint32_t maxImageArrayLayersmax layers for image arrays + uint32_t maxTexelBufferElementsmax texel buffer size (fstexels) + uint32_t maxUniformBufferRangemax uniform buffer range (bytes) + uint32_t maxStorageBufferRangemax storage buffer range (bytes) + uint32_t maxPushConstantsSizemax size of the push constants pool (bytes) + memory limits + uint32_t maxMemoryAllocationCountmax number of device memory allocations supported + uint32_t maxSamplerAllocationCountmax number of samplers that can be allocated on a device + VkDeviceSize bufferImageGranularityGranularity (in bytes) at which buffers and images can be bound to adjacent memory for simultaneous usage + VkDeviceSize sparseAddressSpaceSizeTotal address space available for sparse allocations (bytes) + descriptor set limits + uint32_t maxBoundDescriptorSetsmax number of descriptors sets that can be bound to a pipeline + uint32_t maxPerStageDescriptorSamplersmax number of samplers allowed per-stage in a descriptor set + uint32_t maxPerStageDescriptorUniformBuffersmax number of uniform buffers allowed per-stage in a descriptor set + uint32_t maxPerStageDescriptorStorageBuffersmax number of storage buffers allowed per-stage in a descriptor set + uint32_t maxPerStageDescriptorSampledImagesmax number of sampled images allowed per-stage in a descriptor set + uint32_t maxPerStageDescriptorStorageImagesmax number of storage images allowed per-stage in a descriptor set + uint32_t maxPerStageDescriptorInputAttachmentsmax number of input attachments allowed per-stage in a descriptor set + uint32_t maxPerStageResourcesmax number of resources allowed by a single stage + uint32_t maxDescriptorSetSamplersmax number of samplers allowed in all stages in a descriptor set + uint32_t maxDescriptorSetUniformBuffersmax number of uniform buffers allowed in all stages in a descriptor set + uint32_t maxDescriptorSetUniformBuffersDynamicmax number of dynamic uniform buffers allowed in all stages in a descriptor set + uint32_t maxDescriptorSetStorageBuffersmax number of storage buffers allowed in all stages in a descriptor set + uint32_t maxDescriptorSetStorageBuffersDynamicmax number of dynamic storage buffers allowed in all stages in a descriptor set + uint32_t maxDescriptorSetSampledImagesmax number of sampled images allowed in all stages in a descriptor set + uint32_t maxDescriptorSetStorageImagesmax number of storage images allowed in all stages in a descriptor set + uint32_t maxDescriptorSetInputAttachmentsmax number of input attachments allowed in all stages in a descriptor set + vertex stage limits + uint32_t maxVertexInputAttributesmax number of vertex input attribute slots + uint32_t maxVertexInputBindingsmax number of vertex input binding slots + uint32_t maxVertexInputAttributeOffsetmax vertex input attribute offset added to vertex buffer offset + uint32_t maxVertexInputBindingStridemax vertex input binding stride + uint32_t maxVertexOutputComponentsmax number of output components written by vertex shader + tessellation control stage limits + uint32_t maxTessellationGenerationLevelmax level supported by tessellation primitive generator + uint32_t maxTessellationPatchSizemax patch size (vertices) + uint32_t maxTessellationControlPerVertexInputComponentsmax number of input components per-vertex in TCS + uint32_t maxTessellationControlPerVertexOutputComponentsmax number of output components per-vertex in TCS + uint32_t maxTessellationControlPerPatchOutputComponentsmax number of output components per-patch in TCS + uint32_t maxTessellationControlTotalOutputComponentsmax total number of per-vertex and per-patch output components in TCS + tessellation evaluation stage limits + uint32_t maxTessellationEvaluationInputComponentsmax number of input components per vertex in TES + uint32_t maxTessellationEvaluationOutputComponentsmax number of output components per vertex in TES + geometry stage limits + uint32_t maxGeometryShaderInvocationsmax invocation count supported in geometry shader + uint32_t maxGeometryInputComponentsmax number of input components read in geometry stage + uint32_t maxGeometryOutputComponentsmax number of output components written in geometry stage + uint32_t maxGeometryOutputVerticesmax number of vertices that can be emitted in geometry stage + uint32_t maxGeometryTotalOutputComponentsmax total number of components (all vertices) written in geometry stage + fragment stage limits + uint32_t maxFragmentInputComponentsmax number of input compontents read in fragment stage + uint32_t maxFragmentOutputAttachmentsmax number of output attachments written in fragment stage + uint32_t maxFragmentDualSrcAttachmentsmax number of output attachments written when using dual source blending + uint32_t maxFragmentCombinedOutputResourcesmax total number of storage buffers, storage images and output buffers + compute stage limits + uint32_t maxComputeSharedMemorySizemax total storage size of work group local storage (bytes) + uint32_t maxComputeWorkGroupCount[3]max num of compute work groups that may be dispatched by a single command (x,y,z) + uint32_t maxComputeWorkGroupInvocationsmax total compute invocations in a single local work group + uint32_t maxComputeWorkGroupSize[3]max local size of a compute work group (x,y,z) + uint32_t subPixelPrecisionBitsnumber bits of subpixel precision in screen x and y + uint32_t subTexelPrecisionBitsnumber bits of precision for selecting texel weights + uint32_t mipmapPrecisionBitsnumber bits of precision for selecting mipmap weights + uint32_t maxDrawIndexedIndexValuemax index value for indexed draw calls (for 32-bit indices) + uint32_t maxDrawIndirectCountmax draw count for indirect draw calls + float maxSamplerLodBiasmax absolute sampler level of detail bias + float maxSamplerAnisotropymax degree of sampler anisotropy + uint32_t maxViewportsmax number of active viewports + uint32_t maxViewportDimensions[2]max viewport dimensions (x,y) + float viewportBoundsRange[2]viewport bounds range (min,max) + uint32_t viewportSubPixelBitsnumber bits of subpixel precision for viewport + size_t minMemoryMapAlignmentmin required alignment of pointers returned by MapMemory (bytes) + VkDeviceSize minTexelBufferOffsetAlignmentmin required alignment for texel buffer offsets (bytes) + VkDeviceSize minUniformBufferOffsetAlignmentmin required alignment for uniform buffer sizes and offsets (bytes) + VkDeviceSize minStorageBufferOffsetAlignmentmin required alignment for storage buffer offsets (bytes) + int32_t minTexelOffsetmin texel offset for OpTextureSampleOffset + uint32_t maxTexelOffsetmax texel offset for OpTextureSampleOffset + int32_t minTexelGatherOffsetmin texel offset for OpTextureGatherOffset + uint32_t maxTexelGatherOffsetmax texel offset for OpTextureGatherOffset + float minInterpolationOffsetfurthest negative offset for interpolateAtOffset + float maxInterpolationOffsetfurthest positive offset for interpolateAtOffset + uint32_t subPixelInterpolationOffsetBitsnumber of subpixel bits for interpolateAtOffset + uint32_t maxFramebufferWidthmax width for a framebuffer + uint32_t maxFramebufferHeightmax height for a framebuffer + uint32_t maxFramebufferLayersmax layer count for a layered framebuffer + VkSampleCountFlags framebufferColorSampleCountssupported color sample counts for a framebuffer + VkSampleCountFlags framebufferDepthSampleCountssupported depth sample counts for a framebuffer + VkSampleCountFlags framebufferStencilSampleCountssupported stencil sample counts for a framebuffer + VkSampleCountFlags framebufferNoAttachmentsSampleCountssupported sample counts for a framebuffer with no attachments + uint32_t maxColorAttachmentsmax number of color attachments per subpass + VkSampleCountFlags sampledImageColorSampleCountssupported color sample counts for a non-integer sampled image + VkSampleCountFlags sampledImageIntegerSampleCountssupported sample counts for an integer image + VkSampleCountFlags sampledImageDepthSampleCountssupported depth sample counts for a sampled image + VkSampleCountFlags sampledImageStencilSampleCountssupported stencil sample counts for a sampled image + VkSampleCountFlags storageImageSampleCountssupported sample counts for a storage image + uint32_t maxSampleMaskWordsmax number of sample mask words + VkBool32 timestampComputeAndGraphicstimestamps on graphics and compute queues + float timestampPeriodnumber of nanoseconds it takes for timestamp query value to increment by 1 + uint32_t maxClipDistancesmax number of clip distances + uint32_t maxCullDistancesmax number of cull distances + uint32_t maxCombinedClipAndCullDistancesmax combined number of user clipping + uint32_t discreteQueuePrioritiesdistinct queue priorities available + float pointSizeRange[2]range (min,max) of supported point sizes + float lineWidthRange[2]range (min,max) of supported line widths + float pointSizeGranularitygranularity of supported point sizes + float lineWidthGranularitygranularity of supported line widths + VkBool32 strictLinesline rasterization follows preferred rules + VkBool32 standardSampleLocationssupports standard sample locations for all supported sample counts + VkDeviceSize optimalBufferCopyOffsetAlignmentoptimal offset of buffer copies + VkDeviceSize optimalBufferCopyRowPitchAlignmentoptimal pitch of buffer copies + VkDeviceSize nonCoherentAtomSizeminimum size and alignment for non-coherent host-mapped device memory access VkStructureType sType - const void* pNext - VkSemaphoreCreateFlags flags + const void* pNext + VkSemaphoreCreateFlags flagsSemaphore creation flags VkStructureType sType - const void* pNext - VkQueryPoolCreateFlags flags + const void* pNext + VkQueryPoolCreateFlags flags VkQueryType queryType uint32_t queryCount - VkQueryPipelineStatisticFlags pipelineStatistics + VkQueryPipelineStatisticFlags pipelineStatisticsOptional VkStructureType sType - const void* pNext - VkFramebufferCreateFlags flags + const void* pNext + VkFramebufferCreateFlags flags VkRenderPass renderPass uint32_t attachmentCount const VkImageView* pAttachments @@ -1421,7 +1424,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext + const void* pNext uint32_t waitSemaphoreCount const VkSemaphore* pWaitSemaphores const VkPipelineStageFlags* pWaitDstStageMask @@ -1430,37 +1433,37 @@ private version is maintained in the 1.0 branch of the member gitlab server. uint32_t signalSemaphoreCount const VkSemaphore* pSignalSemaphores - + WSI extensions - VkDisplayKHR display - const char* displayName - VkExtent2D physicalDimensions - VkExtent2D physicalResolution - VkSurfaceTransformFlagsKHR supportedTransforms - VkBool32 planeReorderPossible - VkBool32 persistentContent + VkDisplayKHR displayHandle of the display object + const char* displayNameName of the display + VkExtent2D physicalDimensionsIn millimeters? + VkExtent2D physicalResolutionMax resolution for CRT? + VkSurfaceTransformFlagsKHR supportedTransformsone or more bits from VkSurfaceTransformFlagsKHR + VkBool32 planeReorderPossibleVK_TRUE if the overlay plane's z-order can be changed on this display. + VkBool32 persistentContentVK_TRUE if this is a "smart" display that supports self-refresh/internal buffering. - VkDisplayKHR currentDisplay - uint32_t currentStackIndex + VkDisplayKHR currentDisplayDisplay the plane is currently associated with. Will be VK_NULL_HANDLE if the plane is not in use. + uint32_t currentStackIndexCurrent z-order of the plane. - VkExtent2D visibleRegion - uint32_t refreshRate + VkExtent2D visibleRegionVisible scanout region. + uint32_t refreshRateNumber of times per second the display is updated. - VkDisplayModeKHR displayMode - VkDisplayModeParametersKHR parameters + VkDisplayModeKHR displayModeHandle of this display mode. + VkDisplayModeParametersKHR parametersThe parameters this mode uses. VkStructureType sType - const void* pNext - VkDisplayModeCreateFlagsKHR flags - VkDisplayModeParametersKHR parameters + const void* pNext + VkDisplayModeCreateFlagsKHR flags + VkDisplayModeParametersKHR parametersThe parameters this mode uses. - VkDisplayPlaneAlphaFlagsKHR supportedAlpha - VkOffset2D minSrcPosition + VkDisplayPlaneAlphaFlagsKHR supportedAlphaTypes of alpha blending supported, if any. + VkOffset2D minSrcPositionDoes the plane have any position and extent restrictions? VkOffset2D maxSrcPosition VkExtent2D minSrcExtent VkExtent2D maxSrcExtent @@ -1471,171 +1474,171 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkDisplaySurfaceCreateFlagsKHR flags - VkDisplayModeKHR displayMode - uint32_t planeIndex - uint32_t planeStackIndex - VkSurfaceTransformFlagBitsKHR transform - float globalAlpha - VkDisplayPlaneAlphaFlagBitsKHR alphaMode - VkExtent2D imageExtent - - + const void* pNext + VkDisplaySurfaceCreateFlagsKHR flags + VkDisplayModeKHR displayModeThe mode to use when displaying this surface + uint32_t planeIndexThe plane on which this surface appears. Must be between 0 and the value returned by vkGetPhysicalDeviceDisplayPlanePropertiesKHR() in pPropertyCount. + uint32_t planeStackIndexThe z-order of the plane. + VkSurfaceTransformFlagBitsKHR transformTransform to apply to the images as part of the scanout operation + float globalAlphaGlobal alpha value. Must be between 0 and 1, inclusive. Ignored if alphaMode is not VK_DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR + VkDisplayPlaneAlphaFlagBitsKHR alphaModeWhat type of alpha blending to use. Must be a bit from vkGetDisplayPlanePropertiesKHR::supportedAlpha. + VkExtent2D imageExtentsize of the images to use with this surface + + VkStructureType sType - const void* pNext - VkRect2D srcRect - VkRect2D dstRect - VkBool32 persistent + const void* pNext + VkRect2D srcRectRectangle within the presentable image to read pixel data from when presenting to the display. + VkRect2D dstRectRectangle within the current display mode's visible region to display srcRectangle in. + VkBool32 persistentFor smart displays, use buffered mode. If the display properties member "persistentMode" is VK_FALSE, this member must always be VK_FALSE. - uint32_t minImageCount - uint32_t maxImageCount - VkExtent2D currentExtent - VkExtent2D minImageExtent - VkExtent2D maxImageExtent - uint32_t maxImageArrayLayers - VkSurfaceTransformFlagsKHR supportedTransforms - VkSurfaceTransformFlagBitsKHR currentTransform - VkCompositeAlphaFlagsKHR supportedCompositeAlpha - VkImageUsageFlags supportedUsageFlags + uint32_t minImageCountSupported minimum number of images for the surface + uint32_t maxImageCountSupported maximum number of images for the surface, 0 for unlimited + VkExtent2D currentExtentCurrent image width and height for the surface, (0, 0) if undefined + VkExtent2D minImageExtentSupported minimum image width and height for the surface + VkExtent2D maxImageExtentSupported maximum image width and height for the surface + uint32_t maxImageArrayLayersSupported maximum number of image layers for the surface + VkSurfaceTransformFlagsKHR supportedTransforms1 or more bits representing the transforms supported + VkSurfaceTransformFlagBitsKHR currentTransformThe surface's current transform relative to the device's natural orientation + VkCompositeAlphaFlagsKHR supportedCompositeAlpha1 or more bits representing the alpha compositing modes supported + VkImageUsageFlags supportedUsageFlagsSupported image usage flags for the surface VkStructureType sType - const void* pNext - VkAndroidSurfaceCreateFlagsKHR flags + const void* pNext + VkAndroidSurfaceCreateFlagsKHR flags ANativeWindow* window VkStructureType sType - const void* pNext - VkMirSurfaceCreateFlagsKHR flags + const void* pNext + VkMirSurfaceCreateFlagsKHR flags MirConnection* connection MirSurface* mirSurface VkStructureType sType - const void* pNext - VkViSurfaceCreateFlagsNN flags + const void* pNext + VkViSurfaceCreateFlagsNN flags void* window VkStructureType sType - const void* pNext - VkWaylandSurfaceCreateFlagsKHR flags + const void* pNext + VkWaylandSurfaceCreateFlagsKHR flags struct wl_display* display struct wl_surface* surface VkStructureType sType - const void* pNext - VkWin32SurfaceCreateFlagsKHR flags + const void* pNext + VkWin32SurfaceCreateFlagsKHR flags HINSTANCE hinstance HWND hwnd VkStructureType sType - const void* pNext - VkXlibSurfaceCreateFlagsKHR flags + const void* pNext + VkXlibSurfaceCreateFlagsKHR flags Display* dpy Window window VkStructureType sType - const void* pNext - VkXcbSurfaceCreateFlagsKHR flags + const void* pNext + VkXcbSurfaceCreateFlagsKHR flags xcb_connection_t* connection xcb_window_t window - VkFormat format - VkColorSpaceKHR colorSpace + VkFormat formatSupported pair of rendering format + VkColorSpaceKHR colorSpaceand color space for the surface VkStructureType sType - const void* pNext - VkSwapchainCreateFlagsKHR flags - VkSurfaceKHR surface - uint32_t minImageCount - VkFormat imageFormat - VkColorSpaceKHR imageColorSpace - VkExtent2D imageExtent - uint32_t imageArrayLayers - VkImageUsageFlags imageUsage - VkSharingMode imageSharingMode - uint32_t queueFamilyIndexCount - const uint32_t* pQueueFamilyIndices - VkSurfaceTransformFlagBitsKHR preTransform - VkCompositeAlphaFlagBitsKHR compositeAlpha - VkPresentModeKHR presentMode - VkBool32 clipped - VkSwapchainKHR oldSwapchain + const void* pNext + VkSwapchainCreateFlagsKHR flags + VkSurfaceKHR surfaceThe swapchain's target surface + uint32_t minImageCountMinimum number of presentation images the application needs + VkFormat imageFormatFormat of the presentation images + VkColorSpaceKHR imageColorSpaceColorspace of the presentation images + VkExtent2D imageExtentDimensions of the presentation images + uint32_t imageArrayLayersDetermines the number of views for multiview/stereo presentation + VkImageUsageFlags imageUsageBits indicating how the presentation images will be used + VkSharingMode imageSharingModeSharing mode used for the presentation images + uint32_t queueFamilyIndexCountNumber of queue families having access to the images in case of concurrent sharing mode + const uint32_t* pQueueFamilyIndicesArray of queue family indices having access to the images in case of concurrent sharing mode + VkSurfaceTransformFlagBitsKHR preTransformThe transform, relative to the device's natural orientation, applied to the image content prior to presentation + VkCompositeAlphaFlagBitsKHR compositeAlphaThe alpha blending mode used when compositing this surface with other surfaces in the window system + VkPresentModeKHR presentModeWhich presentation mode to use for presents on this swap chain + VkBool32 clippedSpecifies whether presentable images may be affected by window clip regions + VkSwapchainKHR oldSwapchainExisting swap chain to replace, if any VkStructureType sType - const void* pNext - uint32_t waitSemaphoreCount - const VkSemaphore* pWaitSemaphores - uint32_t swapchainCount - const VkSwapchainKHR* pSwapchains - const uint32_t* pImageIndices - VkResult* pResults - - + const void* pNext + uint32_t waitSemaphoreCountNumber of semaphores to wait for before presenting + const VkSemaphore* pWaitSemaphoresSemaphores to wait for before presenting + uint32_t swapchainCountNumber of swapchains to present in this call + const VkSwapchainKHR* pSwapchainsSwapchains to present an image from + const uint32_t* pImageIndicesIndices of which presentable images to present + VkResult* pResultsOptional (i.e. if non-NULL) VkResult for each swapchain + + VkStructureType sType - const void* pNext - VkDebugReportFlagsEXT flags - PFN_vkDebugReportCallbackEXT pfnCallback - void* pUserData + const void* pNext + VkDebugReportFlagsEXT flagsIndicates which events call this callback + PFN_vkDebugReportCallbackEXT pfnCallbackFunction pointer of a callback function + void* pUserDataUser data provided to callback function - VkStructureType sType - const void* pNext - uint32_t disabledValidationCheckCount - VkValidationCheckEXT* pDisabledValidationChecks + VkStructureType sTypeMust be VK_STRUCTURE_TYPE_VALIDATION_FLAGS_EXT + const void* pNext + uint32_t disabledValidationCheckCountNumber of validation checks to disable + VkValidationCheckEXT* pDisabledValidationChecksValidation checks to disable - + VkStructureType sType - const void* pNext - VkRasterizationOrderAMD rasterizationOrder + const void* pNext + VkRasterizationOrderAMD rasterizationOrderRasterization order to use for the pipeline VkStructureType sType - const void* pNext - VkDebugReportObjectTypeEXT objectType - uint64_t object - const char* pObjectName + const void* pNext + VkDebugReportObjectTypeEXT objectTypeThe type of the object + uint64_t objectThe handle of the object, cast to uint64_t + const char* pObjectNameName to apply to the object VkStructureType sType - const void* pNext - VkDebugReportObjectTypeEXT objectType - uint64_t object - uint64_t tagName - size_t tagSize - const void* pTag + const void* pNext + VkDebugReportObjectTypeEXT objectTypeThe type of the object + uint64_t objectThe handle of the object, cast to uint64_t + uint64_t tagNameThe name of the tag to set on the object + size_t tagSizeThe length in bytes of the tag data + const void* pTagTag data to attach to the object VkStructureType sType - const void* pNext - const char* pMarkerName - float color[4] + const void* pNext + const char* pMarkerNameName of the debug marker + float color[4]Optional color for debug marker - + VkStructureType sType - const void* pNext - VkBool32 dedicatedAllocation + const void* pNext + VkBool32 dedicatedAllocationWhether this image uses a dedicated allocation - + VkStructureType sType - const void* pNext - VkBool32 dedicatedAllocation + const void* pNext + VkBool32 dedicatedAllocationWhether this buffer uses a dedicated allocation - + VkStructureType sType - const void* pNext - VkImage image - VkBuffer buffer + const void* pNext + VkImage imageImage that this allocation will be bound to + VkBuffer bufferBuffer that this allocation will be bound to VkImageFormatProperties imageFormatProperties @@ -1665,7 +1668,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. const SECURITY_ATTRIBUTES* pAttributes DWORD dwAccess - + VkStructureType sType const void* pNext uint32_t acquireCount @@ -1692,14 +1695,14 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkIndirectCommandsTokenTypeNVX tokenType - VkBuffer buffer - VkDeviceSize offset + VkBuffer bufferbuffer containing tableEntries and additional data for indirectCommands + VkDeviceSize offsetoffset from the base address of the buffer VkIndirectCommandsTokenTypeNVX tokenType - uint32_t bindingUnit - uint32_t dynamicCount - uint32_t divisor + uint32_t bindingUnitBinding unit for vertex attribute / descriptor set, offset for pushconstants + uint32_t dynamicCountNumber of variable dynamic values for descriptor set / push constants + uint32_t divisorRate the which the array is advanced per element (must be power of 2, minimum 1) VkStructureType sType @@ -1776,29 +1779,29 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkPipelineLayout pipelineLayout VkShaderStageFlags stageFlags - + VkStructureType sType - void* pNext + void* pNext VkPhysicalDeviceFeatures features VkStructureType sType - void* pNext + void* pNext VkPhysicalDeviceProperties properties VkStructureType sType - void* pNext + void* pNext VkFormatProperties formatProperties VkStructureType sType - void* pNext + void* pNext VkImageFormatProperties imageFormatProperties VkStructureType sType - const void* pNext + const void* pNext VkFormat format VkImageType type VkImageTiling tiling @@ -1807,51 +1810,51 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - void* pNext + void* pNext VkQueueFamilyProperties queueFamilyProperties VkStructureType sType - void* pNext + void* pNext VkPhysicalDeviceMemoryProperties memoryProperties VkStructureType sType - void* pNext + void* pNext VkSparseImageFormatProperties properties VkStructureType sType - const void* pNext + const void* pNext VkFormat format VkImageType type VkSampleCountFlagBits samples VkImageUsageFlags usage VkImageTiling tiling - + VkStructureType sType - void* pNext + void* pNext uint32_t maxPushDescriptors - + VkStructureType sType - const void* pNext - uint32_t swapchainCount - const VkPresentRegionKHR* pRegions + const void* pNext + uint32_t swapchainCountCopy of VkPresentInfoKHR::swapchainCount + const VkPresentRegionKHR* pRegionsThe regions that have changed - uint32_t rectangleCount - const VkRectLayerKHR* pRectangles + uint32_t rectangleCountNumber of rectangles in pRectangles + const VkRectLayerKHR* pRectanglesArray of rectangles that have changed in a swapchain's image(s) - VkOffset2D offset - VkExtent2D extent - uint32_t layer + VkOffset2D offsetupper-left corner of a rectangle that has not changed, in pixels of a presentation images + VkExtent2D extentDimensions of a rectangle that has not changed, in pixels of a presentation images + uint32_t layerLayer of a swapchain's image(s), for stereoscopic-3D images - + VkStructureType sType - void* pNext + void* pNext VkBool32 variablePointersStorageBuffer VkBool32 variablePointers @@ -1860,31 +1863,31 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkExternalMemoryHandleTypeFlagsKHR exportFromImportedHandleTypes VkExternalMemoryHandleTypeFlagsKHR compatibleHandleTypes - + VkStructureType sType - const void* pNext + const void* pNext VkExternalMemoryHandleTypeFlagBitsKHR handleType - + VkStructureType sType - void* pNext + void* pNext VkExternalMemoryPropertiesKHR externalMemoryProperties VkStructureType sType - const void* pNext + const void* pNext VkBufferCreateFlags flags VkBufferUsageFlags usage VkExternalMemoryHandleTypeFlagBitsKHR handleType VkStructureType sType - void* pNext + void* pNext VkExternalMemoryPropertiesKHR externalMemoryProperties - + VkStructureType sType - void* pNext + void* pNext uint8_t deviceUUID[VK_UUID_SIZE] uint8_t driverUUID[VK_UUID_SIZE] uint8_t deviceLUID[VK_LUID_SIZE_KHR] @@ -1893,64 +1896,64 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext + const void* pNext VkExternalMemoryHandleTypeFlagsKHR handleTypes VkStructureType sType - const void* pNext + const void* pNext VkExternalMemoryHandleTypeFlagsKHR handleTypes VkStructureType sType - const void* pNext + const void* pNext VkExternalMemoryHandleTypeFlagsKHR handleTypes VkStructureType sType - const void* pNext + const void* pNext VkExternalMemoryHandleTypeFlagBitsKHR handleType HANDLE handle LPCWSTR name VkStructureType sType - const void* pNext + const void* pNext const SECURITY_ATTRIBUTES* pAttributes DWORD dwAccess LPCWSTR name VkStructureType sType - void* pNext + void* pNext uint32_t memoryTypeBits VkStructureType sType - const void* pNext + const void* pNext VkDeviceMemory memory VkExternalMemoryHandleTypeFlagBitsKHR handleType VkStructureType sType - const void* pNext + const void* pNext VkExternalMemoryHandleTypeFlagBitsKHR handleType int fd VkStructureType sType - void* pNext + void* pNext uint32_t memoryTypeBits VkStructureType sType - const void* pNext + const void* pNext VkDeviceMemory memory VkExternalMemoryHandleTypeFlagBitsKHR handleType - + VkStructureType sType - const void* pNext + const void* pNext uint32_t acquireCount const VkDeviceMemory* pAcquireSyncs const uint64_t* pAcquireKeys @@ -1961,40 +1964,40 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext + const void* pNext VkExternalSemaphoreHandleTypeFlagBitsKHR handleType VkStructureType sType - void* pNext + void* pNext VkExternalSemaphoreHandleTypeFlagsKHR exportFromImportedHandleTypes VkExternalSemaphoreHandleTypeFlagsKHR compatibleHandleTypes VkExternalSemaphoreFeatureFlagsKHR externalSemaphoreFeatures - + VkStructureType sType - const void* pNext + const void* pNext VkExternalSemaphoreHandleTypeFlagsKHR handleTypes VkStructureType sType - const void* pNext + const void* pNext VkSemaphore semaphore VkSemaphoreImportFlagsKHR flags VkExternalSemaphoreHandleTypeFlagBitsKHR handleType HANDLE handle LPCWSTR name - + VkStructureType sType - const void* pNext + const void* pNext const SECURITY_ATTRIBUTES* pAttributes DWORD dwAccess LPCWSTR name - + VkStructureType sType - const void* pNext + const void* pNext uint32_t waitSemaphoreValuesCount const uint64_t* pWaitSemaphoreValues uint32_t signalSemaphoreValuesCount @@ -2002,13 +2005,13 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext + const void* pNext VkSemaphore semaphore VkExternalSemaphoreHandleTypeFlagBitsKHR handleType VkStructureType sType - const void* pNext + const void* pNext VkSemaphore semaphore VkSemaphoreImportFlagsKHR flags VkExternalSemaphoreHandleTypeFlagBitsKHR handleType @@ -2016,52 +2019,52 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext + const void* pNext VkSemaphore semaphore VkExternalSemaphoreHandleTypeFlagBitsKHR handleType VkStructureType sType - const void* pNext + const void* pNext VkExternalFenceHandleTypeFlagBitsKHR handleType VkStructureType sType - void* pNext + void* pNext VkExternalFenceHandleTypeFlagsKHR exportFromImportedHandleTypes VkExternalFenceHandleTypeFlagsKHR compatibleHandleTypes VkExternalFenceFeatureFlagsKHR externalFenceFeatures - + VkStructureType sType - const void* pNext + const void* pNext VkExternalFenceHandleTypeFlagsKHR handleTypes VkStructureType sType - const void* pNext + const void* pNext VkFence fence VkFenceImportFlagsKHR flags VkExternalFenceHandleTypeFlagBitsKHR handleType HANDLE handle LPCWSTR name - + VkStructureType sType - const void* pNext + const void* pNext const SECURITY_ATTRIBUTES* pAttributes DWORD dwAccess LPCWSTR name VkStructureType sType - const void* pNext + const void* pNext VkFence fence VkExternalFenceHandleTypeFlagBitsKHR handleType VkStructureType sType - const void* pNext + const void* pNext VkFence fence VkFenceImportFlagsKHR flags VkExternalFenceHandleTypeFlagBitsKHR handleType @@ -2069,26 +2072,26 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext + const void* pNext VkFence fence VkExternalFenceHandleTypeFlagBitsKHR handleType - + VkStructureType sType - void* pNext - VkBool32 multiview - VkBool32 multiviewGeometryShader - VkBool32 multiviewTessellationShader + void* pNext + VkBool32 multiviewMultiple views in a renderpass + VkBool32 multiviewGeometryShaderMultiple views in a renderpass w/ geometry shader + VkBool32 multiviewTessellationShaderMultiple views in a renderpass w/ tessellation shader - + VkStructureType sType - void* pNext - uint32_t maxMultiviewViewCount - uint32_t maxMultiviewInstanceIndex + void* pNext + uint32_t maxMultiviewViewCountmax number of views in a subpass + uint32_t maxMultiviewInstanceIndexmax instance index for a draw in a multiview subpass VkStructureType sType - const void* pNext + const void* pNext uint32_t subpassCount const uint32_t* pViewMasks uint32_t dependencyCount @@ -2099,16 +2102,16 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType void* pNext - uint32_t minImageCount - uint32_t maxImageCount - VkExtent2D currentExtent - VkExtent2D minImageExtent - VkExtent2D maxImageExtent - uint32_t maxImageArrayLayers - VkSurfaceTransformFlagsKHR supportedTransforms - VkSurfaceTransformFlagBitsKHR currentTransform - VkCompositeAlphaFlagsKHR supportedCompositeAlpha - VkImageUsageFlags supportedUsageFlags + uint32_t minImageCountSupported minimum number of images for the surface + uint32_t maxImageCountSupported maximum number of images for the surface, 0 for unlimited + VkExtent2D currentExtentCurrent image width and height for the surface, (0, 0) if undefined + VkExtent2D minImageExtentSupported minimum image width and height for the surface + VkExtent2D maxImageExtentSupported maximum image width and height for the surface + uint32_t maxImageArrayLayersSupported maximum number of image layers for the surface + VkSurfaceTransformFlagsKHR supportedTransforms1 or more bits representing the transforms supported + VkSurfaceTransformFlagBitsKHR currentTransformThe surface's current transform relative to the device's natural orientation + VkCompositeAlphaFlagsKHR supportedCompositeAlpha1 or more bits representing the alpha compositing modes supported + VkImageUsageFlags supportedUsageFlagsSupported image usage flags for the surface VkSurfaceCounterFlagsEXT supportedSurfaceCounters @@ -2126,27 +2129,27 @@ private version is maintained in the 1.0 branch of the member gitlab server. const void* pNext VkDisplayEventTypeEXT displayEvent - + VkStructureType sType const void* pNext VkSurfaceCounterFlagsEXT surfaceCounters VkStructureType sType - void* pNext + void* pNext uint32_t physicalDeviceCount VkPhysicalDevice physicalDevices[VK_MAX_DEVICE_GROUP_SIZE_KHX] VkBool32 subsetAllocation - + VkStructureType sType - const void* pNext + const void* pNext VkMemoryAllocateFlagsKHX flags uint32_t deviceMask VkStructureType sType - const void* pNext + const void* pNext VkBuffer buffer VkDeviceMemory memory VkDeviceSize memoryOffset @@ -2155,7 +2158,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext + const void* pNext VkImage image VkDeviceMemory memory VkDeviceSize memoryOffset @@ -2164,21 +2167,21 @@ private version is maintained in the 1.0 branch of the member gitlab server. uint32_t SFRRectCount const VkRect2D* pSFRRects - + VkStructureType sType - const void* pNext + const void* pNext uint32_t deviceMask uint32_t deviceRenderAreaCount const VkRect2D* pDeviceRenderAreas - + VkStructureType sType - const void* pNext + const void* pNext uint32_t deviceMask - + VkStructureType sType - const void* pNext + const void* pNext uint32_t waitSemaphoreCount const uint32_t* pWaitSemaphoreDeviceIndices uint32_t commandBufferCount @@ -2186,135 +2189,134 @@ private version is maintained in the 1.0 branch of the member gitlab server. uint32_t signalSemaphoreCount const uint32_t* pSignalSemaphoreDeviceIndices - + VkStructureType sType - const void* pNext + const void* pNext uint32_t resourceDeviceIndex uint32_t memoryDeviceIndex VkStructureType sType - const void* pNext + const void* pNext uint32_t presentMask[VK_MAX_DEVICE_GROUP_SIZE_KHX] VkDeviceGroupPresentModeFlagsKHX modes - + VkStructureType sType - const void* pNext + const void* pNext VkSwapchainKHR swapchain - + VkStructureType sType - const void* pNext + const void* pNext VkSwapchainKHR swapchain uint32_t imageIndex VkStructureType sType - const void* pNext + const void* pNext VkSwapchainKHR swapchain uint64_t timeout VkSemaphore semaphore VkFence fence uint32_t deviceMask - + VkStructureType sType - const void* pNext + const void* pNext uint32_t swapchainCount const uint32_t* pDeviceMasks VkDeviceGroupPresentModeFlagBitsKHX mode - + VkStructureType sType - const void* pNext + const void* pNext uint32_t physicalDeviceCount const VkPhysicalDevice* pPhysicalDevices - + VkStructureType sType - const void* pNext + const void* pNext VkDeviceGroupPresentModeFlagsKHX modes - uint32_t dstBinding - uint32_t dstArrayElement - uint32_t descriptorCount - VkDescriptorType descriptorType - size_t offset - size_t stride + uint32_t dstBindingBinding within the destination descriptor set to write + uint32_t dstArrayElementArray element within the destination binding to write + uint32_t descriptorCountNumber of descriptors to write + VkDescriptorType descriptorTypeDescriptor type to write + size_t offsetOffset into pData where the descriptors to update are stored + size_t strideStride between two descriptors in pData when writing more than one descriptor VkStructureType sType - void* pNext - VkDescriptorUpdateTemplateCreateFlagsKHR flags - uint32_t descriptorUpdateEntryCount - const VkDescriptorUpdateTemplateEntryKHR* pDescriptorUpdateEntries + void* pNext + VkDescriptorUpdateTemplateCreateFlagsKHR flags + uint32_t descriptorUpdateEntryCountNumber of descriptor update entries to use for the update template + const VkDescriptorUpdateTemplateEntryKHR* pDescriptorUpdateEntriesDescriptor update entries for the template VkDescriptorUpdateTemplateTypeKHR templateType VkDescriptorSetLayout descriptorSetLayout VkPipelineBindPoint pipelineBindPoint - VkPipelineLayoutpipelineLayout + VkPipelineLayoutpipelineLayoutIf used for push descriptors, this is the only allowed layout uint32_t set - - + float x float y - + Display primary in chromaticity coordinates VkStructureType sType const void* pNext - - VkXYColorEXT displayPrimaryRed - VkXYColorEXT displayPrimaryGreen - VkXYColorEXT displayPrimaryBlue - VkXYColorEXT whitePoint - float maxLuminance - float minLuminance - - float maxContentLightLevel + From SMPTE 2086 + VkXYColorEXT displayPrimaryRedDisplay primary's Red + VkXYColorEXT displayPrimaryGreenDisplay primary's Green + VkXYColorEXT displayPrimaryBlueDisplay primary's Blue + VkXYColorEXT whitePointDisplay primary's Blue + float maxLuminanceDisplay maximum luminance + float minLuminanceDisplay minimum luminance + From CTA 861.3 + float maxContentLightLevelContent maximum luminance float maxFrameAverageLightLevel - uint64_t refreshDuration + uint64_t refreshDurationNumber of nanoseconds from the start of one refresh cycle to the next - uint32_t presentID - uint64_t desiredPresentTime - uint64_t actualPresentTime - uint64_t earliestPresentTime - uint64_t presentMargin + uint32_t presentIDApplication-provided identifier, previously given to vkQueuePresentKHR + uint64_t desiredPresentTimeEarliest time an image should have been presented, previously given to vkQueuePresentKHR + uint64_t actualPresentTimeTime the image was actually displayed + uint64_t earliestPresentTimeEarliest time the image could have been displayed + uint64_t presentMarginHow early vkQueuePresentKHR was processed vs. how soon it needed to be and make earliestPresentTime - + VkStructureType sType - const void* pNext - uint32_t swapchainCount - const VkPresentTimeGOOGLE* pTimes + const void* pNext + uint32_t swapchainCountCopy of VkPresentInfoKHR::swapchainCount + const VkPresentTimeGOOGLE* pTimesThe earliest times to present images - uint32_t presentID - uint64_t desiredPresentTime + uint32_t presentIDApplication-provided identifier + uint64_t desiredPresentTimeEarliest time an image should be presented VkStructureType sType - const void* pNext - VkIOSSurfaceCreateFlagsMVK flags + const void* pNext + VkIOSSurfaceCreateFlagsMVK flags const void* pView VkStructureType sType - const void* pNext - VkMacOSSurfaceCreateFlagsMVK flags + const void* pNext + VkMacOSSurfaceCreateFlagsMVK flags const void* pView float xcoeff float ycoeff - + VkStructureType sType - const void* pNext + const void* pNext VkBool32 viewportWScalingEnable uint32_t viewportCount const VkViewportWScalingNV* pViewportWScalings @@ -2327,27 +2329,27 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - const void* pNext - VkPipelineViewportSwizzleStateCreateFlagsNV flags + const void* pNext + VkPipelineViewportSwizzleStateCreateFlagsNV flags uint32_t viewportCount const VkViewportSwizzleNV* pViewportSwizzles - + VkStructureType sType - void* pNext - uint32_t maxDiscardRectangles + void* pNext + uint32_t maxDiscardRectanglesmax number of active discard rectangles VkStructureType sType - const void* pNext - VkPipelineDiscardRectangleStateCreateFlagsEXT flags + const void* pNext + VkPipelineDiscardRectangleStateCreateFlagsEXT flags VkDiscardRectangleModeEXT discardRectangleMode uint32_t discardRectangleCount const VkRect2D* pDiscardRectangles - + VkStructureType sType - void* pNext + void* pNext VkBool32 perViewPositionAllComponents @@ -2357,7 +2359,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkStructureType sType - void* pNext + void* pNext VkSurfaceCapabilitiesKHR surfaceCapabilities @@ -2365,87 +2367,87 @@ private version is maintained in the 1.0 branch of the member gitlab server. void* pNext VkSurfaceFormatKHR surfaceFormat - + VkStructureType sType - void* pNext - VkImageUsageFlags sharedPresentSupportedUsageFlags + void* pNext + VkImageUsageFlags sharedPresentSupportedUsageFlagsSupported image usage flags if swapchain created using a shared present mode - + VkStructureType sType - void* pNext - VkBool32 storageBuffer16BitAccess - VkBool32 uniformAndStorageBuffer16BitAccess - VkBool32 storagePushConstant16 - VkBool32 storageInputOutput16 + void* pNext + VkBool32 storageBuffer16BitAccess16-bit integer/floating-point variables supported in BufferBlock + VkBool32 uniformAndStorageBuffer16BitAccess16-bit integer/floating-point variables supported in BufferBlock and Block + VkBool32 storagePushConstant1616-bit integer/floating-point variables supported in PushConstant + VkBool32 storageInputOutput1616-bit integer/floating-point variables supported in shader inputs and outputs VkStructureType sType - const void* pNext + const void* pNext VkBuffer buffer VkStructureType sType - const void* pNext + const void* pNext VkImage image VkStructureType sType - const void* pNext + const void* pNext VkImage image VkStructureType sType - void* pNext + void* pNext VkMemoryRequirements memoryRequirements VkStructureType sType - void* pNext + void* pNext VkSparseImageMemoryRequirements memoryRequirements - + VkStructureType sType - void* pNext + void* pNext VkBool32 prefersDedicatedAllocation VkBool32 requiresDedicatedAllocation - + VkStructureType sType - const void* pNext - VkImage image - VkBuffer buffer + const void* pNext + VkImage imageImage that this allocation will be bound to + VkBuffer bufferBuffer that this allocation will be bound to - + VkStructureType sType - void* pNext + void* pNext VkBool32 supportsTextureGatherLODBiasAMD - + VkStructureType sType - const void* pNext - VkPipelineCoverageToColorStateCreateFlagsNV flags + const void* pNext + VkPipelineCoverageToColorStateCreateFlagsNV flags VkBool32 coverageToColorEnable uint32_t coverageToColorLocation - + VkStructureType sType - void* pNext + void* pNext VkBool32 filterMinmaxSingleComponentFormats VkBool32 filterMinmaxImageComponentMapping - + VkStructureType sType - const void* pNext + const void* pNext VkSamplerReductionModeEXT reductionMode - + VkStructureType sType - void* pNext + void* pNext VkBool32 advancedBlendCoherentOperations - + VkStructureType sType - void* pNext + void* pNext uint32_t advancedBlendMaxColorAttachments VkBool32 advancedBlendIndependentBlend VkBool32 advancedBlendNonPremultipliedSrcColor @@ -2453,17 +2455,17 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkBool32 advancedBlendCorrelatedOverlap VkBool32 advancedBlendAllOperations - + VkStructureType sType - const void* pNext + const void* pNext VkBool32 srcPremultiplied VkBool32 dstPremultiplied VkBlendOverlapEXT blendOverlap - + VkStructureType sType - const void* pNext - VkPipelineCoverageModulationStateCreateFlagsNV flags + const void* pNext + VkPipelineCoverageModulationStateCreateFlagsNV flags VkCoverageModulationModeNV coverageModulationMode VkBool32 coverageModulationTableEnable uint32_t coverageModulationTableCount @@ -2471,17 +2473,16 @@ private version is maintained in the 1.0 branch of the member gitlab server. - + Vulkan enumerant (token) definitions - - + - + @@ -2495,12 +2496,14 @@ private version is maintained in the 1.0 branch of the member gitlab server. - + + Unlike OpenGL, most tokens in Vulkan are actual typed enumerants in + their own numeric namespaces. The "name" attribute is the C enum + type name, and is pulled in from a type tag definition above + (slightly clunky, but retains the type / enum distinction). "type" + attributes of "enum" or "bitmask" indicate that these values should + be generated inside an appropriate definition. + @@ -2620,7 +2623,11 @@ private version is maintained in the 1.0 branch of the member gitlab server. - + + value="4" reserved for VK_KHR_sampler_mirror_clamp_to_edge + enum VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE; do not + alias! + @@ -2959,22 +2966,22 @@ private version is maintained in the 1.0 branch of the member gitlab server. - - + + - - + + Return codes (positive values) - + Error codes (negative values) @@ -3033,7 +3040,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. - + Flags @@ -3234,7 +3241,8 @@ private version is maintained in the 1.0 branch of the member gitlab server. - + + WSI Extensions @@ -3310,8 +3318,8 @@ private version is maintained in the 1.0 branch of the member gitlab server. - - + + @@ -3327,27 +3335,27 @@ private version is maintained in the 1.0 branch of the member gitlab server. - + Placeholder for validation enums to be defined for VK_EXT_Validation_flags extension - - - - + + + + - - - - - - - - + + + + + + + + @@ -3463,8 +3471,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. - - + VkResult vkCreateInstance const VkInstanceCreateInfo* pCreateInfo @@ -4641,17 +4648,17 @@ private version is maintained in the 1.0 branch of the member gitlab server. VkResult vkDebugMarkerSetObjectNameEXT VkDevice device - VkDebugMarkerObjectNameInfoEXT* pNameInfo + const VkDebugMarkerObjectNameInfoEXT* pNameInfo VkResult vkDebugMarkerSetObjectTagEXT VkDevice device - VkDebugMarkerObjectTagInfoEXT* pTagInfo + const VkDebugMarkerObjectTagInfoEXT* pTagInfo void vkCmdDebugMarkerBeginEXT VkCommandBuffer commandBuffer - VkDebugMarkerMarkerInfoEXT* pMarkerInfo + const VkDebugMarkerMarkerInfoEXT* pMarkerInfo void vkCmdDebugMarkerEndEXT @@ -4660,7 +4667,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. void vkCmdDebugMarkerInsertEXT VkCommandBuffer commandBuffer - VkDebugMarkerMarkerInfoEXT* pMarkerInfo + const VkDebugMarkerMarkerInfoEXT* pMarkerInfo VkResult vkGetPhysicalDeviceExternalImageFormatPropertiesNV @@ -5049,8 +5056,8 @@ private version is maintained in the 1.0 branch of the member gitlab server. void vkSetHdrMetadataEXT VkDevice device - uint32_t swapchainCount - const VkSwapchainKHR* pSwapchains + uint32_t swapchainCount + const VkSwapchainKHR* pSwapchains const VkHdrMetadataEXT* pMetadata @@ -5133,8 +5140,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. - - + @@ -5348,11 +5354,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. - - + @@ -5363,9 +5365,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. - - - + @@ -6419,7 +6419,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. - + @@ -6434,6 +6434,7 @@ private version is maintained in the 1.0 branch of the member gitlab server. + @@ -6739,8 +6740,8 @@ private version is maintained in the 1.0 branch of the member gitlab server. - - + + @@ -6908,5 +6909,11 @@ private version is maintained in the 1.0 branch of the member gitlab server. + + + + + + diff --git a/src/vulkan/vulkan.h b/src/vulkan/vulkan.h index 16434fefbe..f20af411c6 100644 --- a/src/vulkan/vulkan.h +++ b/src/vulkan/vulkan.h @@ -34,16 +34,16 @@ extern "C" { (((major) << 22) | ((minor) << 12) | (patch)) // DEPRECATED: This define has been removed. Specific version defines (e.g. VK_API_VERSION_1_0), or the VK_MAKE_VERSION macro, should be used instead. -//#define VK_API_VERSION VK_MAKE_VERSION(1, 0, 0) +//#define VK_API_VERSION VK_MAKE_VERSION(1, 0, 0) // Patch version should always be set to 0 // Vulkan 1.0 version number -#define VK_API_VERSION_1_0 VK_MAKE_VERSION(1, 0, 0) +#define VK_API_VERSION_1_0 VK_MAKE_VERSION(1, 0, 0)// Patch version should always be set to 0 #define VK_VERSION_MAJOR(version) ((uint32_t)(version) >> 22) #define VK_VERSION_MINOR(version) (((uint32_t)(version) >> 12) & 0x3ff) #define VK_VERSION_PATCH(version) ((uint32_t)(version) & 0xfff) // Version of this file -#define VK_HEADER_VERSION 54 +#define VK_HEADER_VERSION 55 #define VK_NULL_HANDLE 0 @@ -3433,6 +3433,7 @@ typedef enum VkColorSpaceKHR { VK_COLOR_SPACE_ADOBERGB_LINEAR_EXT = 1000104011, VK_COLOR_SPACE_ADOBERGB_NONLINEAR_EXT = 1000104012, VK_COLOR_SPACE_PASS_THROUGH_EXT = 1000104013, + VK_COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT = 1000104014, VK_COLOR_SPACE_BEGIN_RANGE_KHR = VK_COLOR_SPACE_SRGB_NONLINEAR_KHR, VK_COLOR_SPACE_END_RANGE_KHR = VK_COLOR_SPACE_SRGB_NONLINEAR_KHR, VK_COLOR_SPACE_RANGE_SIZE_KHR = (VK_COLOR_SPACE_SRGB_NONLINEAR_KHR - VK_COLOR_SPACE_SRGB_NONLINEAR_KHR + 1), @@ -5088,31 +5089,31 @@ typedef struct VkDebugMarkerMarkerInfoEXT { } VkDebugMarkerMarkerInfoEXT; -typedef VkResult (VKAPI_PTR *PFN_vkDebugMarkerSetObjectTagEXT)(VkDevice device, VkDebugMarkerObjectTagInfoEXT* pTagInfo); -typedef VkResult (VKAPI_PTR *PFN_vkDebugMarkerSetObjectNameEXT)(VkDevice device, VkDebugMarkerObjectNameInfoEXT* pNameInfo); -typedef void (VKAPI_PTR *PFN_vkCmdDebugMarkerBeginEXT)(VkCommandBuffer commandBuffer, VkDebugMarkerMarkerInfoEXT* pMarkerInfo); +typedef VkResult (VKAPI_PTR *PFN_vkDebugMarkerSetObjectTagEXT)(VkDevice device, const VkDebugMarkerObjectTagInfoEXT* pTagInfo); +typedef VkResult (VKAPI_PTR *PFN_vkDebugMarkerSetObjectNameEXT)(VkDevice device, const VkDebugMarkerObjectNameInfoEXT* pNameInfo); +typedef void (VKAPI_PTR *PFN_vkCmdDebugMarkerBeginEXT)(VkCommandBuffer commandBuffer, const VkDebugMarkerMarkerInfoEXT* pMarkerInfo); typedef void (VKAPI_PTR *PFN_vkCmdDebugMarkerEndEXT)(VkCommandBuffer commandBuffer); -typedef void (VKAPI_PTR *PFN_vkCmdDebugMarkerInsertEXT)(VkCommandBuffer commandBuffer, VkDebugMarkerMarkerInfoEXT* pMarkerInfo); +typedef void (VKAPI_PTR *PFN_vkCmdDebugMarkerInsertEXT)(VkCommandBuffer commandBuffer, const VkDebugMarkerMarkerInfoEXT* pMarkerInfo); #ifndef VK_NO_PROTOTYPES VKAPI_ATTR VkResult VKAPI_CALL vkDebugMarkerSetObjectTagEXT( VkDevice device, - VkDebugMarkerObjectTagInfoEXT* pTagInfo); + const VkDebugMarkerObjectTagInfoEXT* pTagInfo); VKAPI_ATTR VkResult VKAPI_CALL vkDebugMarkerSetObjectNameEXT( VkDevice device, - VkDebugMarkerObjectNameInfoEXT* pNameInfo); + const VkDebugMarkerObjectNameInfoEXT* pNameInfo); VKAPI_ATTR void VKAPI_CALL vkCmdDebugMarkerBeginEXT( VkCommandBuffer commandBuffer, - VkDebugMarkerMarkerInfoEXT* pMarkerInfo); + const VkDebugMarkerMarkerInfoEXT* pMarkerInfo); VKAPI_ATTR void VKAPI_CALL vkCmdDebugMarkerEndEXT( VkCommandBuffer commandBuffer); VKAPI_ATTR void VKAPI_CALL vkCmdDebugMarkerInsertEXT( VkCommandBuffer commandBuffer, - VkDebugMarkerMarkerInfoEXT* pMarkerInfo); + const VkDebugMarkerMarkerInfoEXT* pMarkerInfo); #endif #define VK_AMD_gcn_shader 1 @@ -6204,7 +6205,7 @@ VKAPI_ATTR void VKAPI_CALL vkCmdSetDiscardRectangleEXT( #endif #define VK_EXT_swapchain_colorspace 1 -#define VK_EXT_SWAPCHAIN_COLOR_SPACE_SPEC_VERSION 2 +#define VK_EXT_SWAPCHAIN_COLOR_SPACE_SPEC_VERSION 3 #define VK_EXT_SWAPCHAIN_COLOR_SPACE_EXTENSION_NAME "VK_EXT_swapchain_colorspace"