Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change log for March 10, 2016 Vulkan 1.0.6 spec update:
* Bump API patch number and header version number to 6 for this update. Github Issues: * Define 'invocation group' for compute and graphics shaders. Cleanup definition and use of 'workgroup', and add glossary entries (public issue 1). * Various minor editorial fixes (public issue 33). * Clarify locations for block members in the <<interfaces-iointerfaces-locations,Location Assignment>> section (public issue 45). * Editorial fixes for <<commandbuffer-allocation,Command Buffer Allocation>> section (public issues 54, 59). * Clarify behavior of depth test in the <<fragops-depth,Depth Test>> section (public issues 80, 81). * Remove discussion of return codes from flink:vkGetPhysicalDeviceSparseImageFormatProperties and flink:vkGetImageSparseMemoryRequirements, which don't return values (public issue 82). * Allow flink:vkCmdDrawIndirect and flink:vkCmdDrawIndexedIndirect pname:drawCount of 0, as well as 1, when the multiDrawIndirect feature is not supported (public issue 88). * Remove confusing wording in the <<features-limits,Limits>> section describing the slink:VkPhysicalDeviceLimits pname:minTexelBufferOffsetAlignment, pname:minUniformBufferOffsetAlignment, and pname:minStorageBufferOffsetAlignment members as both minimums and maximums (public issue 91). * Clarified that only the RGB components should be affected in places where sRGB is referred to in the spec, such as ASTC formats. Minor re-wording to avoid "color space" when actively incorrect, now that we refer to the Data Format Spec which actually makes a distinction between color space and transfer function (public issue 94). * Treat pname:pPropertyCount == 0 consistently in flink:vkEnumerateInstanceLayerProperties and flink:vkEnumerateDeviceLayerProperties (public issue 99) * Cleanup minor editorial issues in chapters 14-17 (public issue 100). * Clarify definition of flink:vkEnumerateInstanceExtensionProperties and flink:vkEnumerateDeviceExtensionProperties (public issue 101). * Define the flink:vkEnumerateInstanceExtensionProperties and flink:vkEnumerateDeviceExtensionProperties pname:pLayerName parameter to be a pointer to a null-terminated UTF-8 string (public issue 101). * Rearrange "Missing information" references in mandatory format tables (public issue 101). * Clarify that the enumerated extensions returned by flink:vkEnumerateInstanceExtensionProperties and flink:vkEnumerateDeviceExtensionProperties will only include extensions provided by the platform or extensions implemented in implicitly enabled layers (public issue 101). * Miscellaneous editorial fixes. Include the Vulkan spec patch number in the PDF title. Fix label on <<fig-non-strict-lines,Non strict lines>> diagram. Use more easily distinguished symbols in tables in the <<features-required-format-support,Required Format Support>> section. Don't require FQDNs used as layer names be encoded in lower case if not possible, in the <<extensions-naming-conventions, Extension and Layer Naming Conventions>> section (public issues 101, 119, 121). Internal Issues: * Fixed excessive spacing in tables in XHTML (internal issue 18). * Clarify that ename:VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT applies to secondary command buffers. Previously spec only referred to the members of pname:pCommandBuffers being affected by this bit. Added a separate slink:VkSubmitInfo Valid Usage restriction specifying that ename:VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT also applies to any secondary command buffers that are recorded into the primary command buffers in pname:pCommandBuffers (internal issue 106). * Clarify that slink:VkDeviceCreateInfo::pname:pEnabledFeatures can be NULL (internal issue 117). * Remove "the value of" where it is redundant (e.g. speaking of an API parameter, struct member, or SPIR-V variable, but not when speaking of color components) (internal issue 175). * Forced patch version to always be 0 in the header. Add a "VK_API_VERSION_<major>_<minor>" macro for people to use to do the right thing. Add a VK_HEADER_VERSION which captures the header release number independent of the spec patch number (internal issue 176). * Correct description of slink:VkPipelineShaderStageCreateInfo::pname:pName to "a pointer to a null-terminated UTF-8 string" (internal issue #197). Other Commits: * Updated DataFormat spec reference to the new date for revision 5 of that spec. * Fixed KEEP option (to retain LaTeX intermediate files) in the Makefile to be included when edited there, as well as set on the command line. * Reserve and add "VK_IMG_filter_cubic" to the registry, and implement script functionality to add and remove validity from existing functions. Includes schema and readme changes. * Update GL_KHR_vulkan_glsl so push_constants do not have descriptor sets.
- Loading branch information
Showing
118 changed files
with
1,238 additions
and
760 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,275 @@ | |||
Update Log for the Vulkan-Docs repository on Github. This just | |||
summarizes the periodic public updates, not individual commits to the | |||
tree. For the most part, commits on Github are done as single large | |||
patches at the release point, collecting together the resolution of many | |||
Khronos internal and public issues. | |||
|
|||
----------------------------------------------------- | |||
|
|||
February 16, 2016 - Vulkan 1.0 initial public release | |||
|
|||
----------------------------------------------------- | |||
|
|||
Change log for February 25, 2015 Vulkan 1.0.4 spec update: | |||
* Bump API patch number from 3 to 4 for the first public update to the | |||
spec. Add patch number to the spec title (this will be done | |||
automatically from XML, later). | |||
* Fixes for numerous editorial issues. Regularize descriptions of | |||
variable-length array queries. Properly tag enumerants so they come | |||
out in the right font (many were mislabeled in usage tags in vk.xml, | |||
or not tagged). Spelling and markup corrections (public issue 4). | |||
* Fix typos and clearly separate description of different types of | |||
memory areas (public issue 5). | |||
* Use standards-compliant preprocessor guard symbols on headers | |||
(public issue 7). | |||
* Note that Github users can't currently set labels on issues, and | |||
recommend a fallback approach (public issue 15). | |||
* Use latexmath prefix on len= attributes (public issue 29). | |||
* Make flink:vkCmdUpdateBuffer pname:dataSize limit consistent (public | |||
issue 65). | |||
* Add VK_KHR_mirror_clamp_to_edge extension to core API branch, as an | |||
optional feature not introducing new commands or enums (internal | |||
issue 104). | |||
* Cleanup invariance language inherited from the GL specification to | |||
not refer to nonexistent (GL-specific) state (internal issue 111). | |||
* Modify the flink:vkCmdDrawIndexed pname:vertexOffset definition to | |||
not be the "base offset within the index buffer" but rather the | |||
"value added to the vertex index before indexing into the vertex | |||
buffer" (internal issue 118). | |||
* Fix drawing chapter in the "Programmable Primitive Shading" section | |||
where it described categories of drawing commands. It referenced | |||
flink:vkCmdDrawIndexed twice. Replace the second reference with | |||
flink:vkCmdDrawIndexedIndirect (internal issue 119). | |||
* Typo fixed in <<sparsememory-examples-advanced,Advanced Sparse | |||
Resources>> sparse memory example (internal issue 122). | |||
* Add flink:VkDisplayPlaneAlphaFlagsKHR to <require> section of | |||
VK_KHR_display extension (internal issue 125) | |||
* Add missing optional="false,true" to | |||
flink:vkGetImageSparseMemoryRequirements | |||
pname:pSparseMemoryRequirementCount parameter (internal issue 132) | |||
* Rename ename:VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT to | |||
ename:VK_STRUCTURE_TYPE_DEBUG_REPORT_CALLBACK_CREATE_INFO_EXT | |||
(internal issue 133) | |||
* Fix a handful of broken cross-references in the | |||
<<samplers,Samplers>> chapter (internal issue 134). | |||
* Fix "Input Attachement" GLSL example to use correct syntax (internal | |||
issue 135). | |||
* Update XML schema and documentation to accomodate recently added | |||
attributes for validity. Add some introductory material describing | |||
design choices and pointing to the public repository to file issues. | |||
* Put include of validity in the core spec extensions chapter on its | |||
own line, so that asciidoc is happy. | |||
* Fix vertexOffset language to specify that it's the value added to | |||
the vertex index before indexing into the vertex buffer, not the | |||
base offset within the index buffer. | |||
* Fix error in the description of flink:vkCmdNextSubpass. | |||
|
|||
----------------------------------------------------- | |||
|
|||
Change log for March 4, 2016 Vulkan 1.0.5 spec update: | |||
* Bump API patch number to 5 for this update. | |||
|
|||
Github Issues: | |||
* Correctly describe slink:VkPhysicalDeviceProperties pname:deviceName | |||
member as a string, not a pointer to a string. Also one typo fix for | |||
"hetereogeneous" (public issue 4). | |||
* Replace maynot: macro with may: not, and "may: or maynot:" with | |||
"may:" (public issue 4). | |||
* Clarify that redundantly setting the state of a fence or event has | |||
no effect (public issue 4). | |||
* Minor fixes to ref pages to track descriptions of memory bits that | |||
changed in the core spec. Fix name of a member in the description of | |||
sname:sname:VkPipelineMultisampleStateCreateInfo (public issues 8, | |||
13). | |||
* Remove redundant validity statement for | |||
sname:VkGraphicsPipelineCreateInfo::pname:stageCount (public issue | |||
14). | |||
* Fix typos in chapters 7-9 (public issue 14). | |||
* Clarify the example demonstrating the behavior of | |||
code:OpMemoryBarrier in the | |||
<<shaders-execution-memory-ordering,shader memory acces | |||
ordering>> section (public issue 16). | |||
* Specify that freeing mapped memory implicitly unmaps the memory in | |||
the description of flink:vkFreeMemory (public issue 17). | |||
* Forbid allocation callbacks from calling into the API in the | |||
<<memory-allocation,memory allocation>> section (public issue | |||
20). | |||
* Add missing validity rules about size being greater than 0 and | |||
offset being less than size of object. Fix | |||
flink:VkMappedMemoryRange's misinterpretation of offset (public | |||
issues 27, 31). | |||
* Add validity rule disallowing overlapping source/destination | |||
descriptors in flink:VkCopyDescriptorSet (public issue 32). | |||
* Clarify that array and matrix stride has to be a multiple of the | |||
base alignment of the array or matrix in the | |||
<<interfaces-resources-layout,Offset and Stride Assignment>> | |||
section (public issue 38). | |||
* Correct parenthesis floor nesting error in equation for | |||
<<textures-RGB-sexp,RGB to shared exponent conversion>>. | |||
Clarify case of when exp' is forced to 0, avoiding log2(0) undefined | |||
problem (public issue 40). | |||
* Remove redundant statement from the code:FragDepth description in | |||
the <<interfaces-builtin-variables,Built-In Variables>> | |||
section (public issue 47). | |||
* Define the clamping of the | |||
<<textures-level-of-detail-operation,bias added to the scale | |||
factor>> by linking to the slink:VkPhysicalDevice feature | |||
pname:maxSamplerLodBias (public issue 64). | |||
* Fix typo "optimal linear resources" and clarify the set of resources | |||
<<features-limits-bufferImageGranularity,the | |||
pname:bufferImageGranularity resource>> applies to (public issue | |||
67). | |||
* Replace 'descriptor accessed by a pipeline' language for | |||
sname:VkDescriptorSetAllocateInfo with more precise phrasing about | |||
binding a descriptor set before a command that invokes work using | |||
that set (public issue 69). | |||
* tstripadj.svg contained an Inkscape tag which caused Firefox and IE | |||
11 to fail to render it, and was illegal SVG. Generating Plain SVG | |||
from the Inkscape SVG source fixes this (public issue 70). | |||
* Fix validity for sname:VkVertexInputBindingDescription and | |||
sname:VkVertexInputAttributeDescription numbers (public issue 72). | |||
|
|||
Internal Issues: | |||
* Clarify the meaning of | |||
ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT in | |||
elink:VkFormatFeatureFlagBits with respect to depth compare | |||
(internal issue 107). | |||
* Added a note explaining that ename:VK_QUEUE_TRANSFER_BIT may or may | |||
not be reported for a queue family that already supports | |||
ename:VK_QUEUE_GRAPHICS_BIT or ename:VK_QUEUE_COMPUTE_BIT as the | |||
former is a strict subset of the latter ones (internal issue 116). | |||
* Add validity language for sname:VkDescriptorSetAllocateInfo about | |||
exceeding the descriptor pool capacity (internal issue 140). | |||
* Add ename:VK_INCOMPLETE success code for | |||
flink:vkEnumeratePhysicalDevices query (internal issue 163). | |||
|
|||
Other Commits: | |||
* Add the VK_NV_glsl_shader extension definitions to the API. | |||
* Update GL_KHR_vulkan_glsl with 1) origin_upper_left as default 2) | |||
specialization array constant semantics. | |||
* Corrected/updated Data Format Specification date. | |||
|
|||
----------------------------------------------------- | |||
|
|||
Change log for March 10, 2016 Vulkan 1.0.6 spec update: | |||
|
|||
* Bump API patch number and header version number to 6 for this | |||
update. | |||
|
|||
Github Issues: | |||
|
|||
* Define 'invocation group' for compute and graphics shaders. Cleanup | |||
definition and use of 'workgroup', and add glossary entries (public | |||
issue 1). | |||
|
|||
* Various minor editorial fixes (public issue 33). | |||
|
|||
* Clarify locations for block members in the | |||
<<interfaces-iointerfaces-locations,Location Assignment>> | |||
section (public issue 45). | |||
|
|||
* Editorial fixes for <<commandbuffer-allocation,Command Buffer | |||
Allocation>> section (public issues 54, 59). | |||
|
|||
* Clarify behavior of depth test in the <<fragops-depth,Depth | |||
Test>> section (public issues 80, 81). | |||
|
|||
* Remove discussion of return codes from | |||
flink:vkGetPhysicalDeviceSparseImageFormatProperties and | |||
flink:vkGetImageSparseMemoryRequirements, which don't return values | |||
(public issue 82). | |||
|
|||
* Allow flink:vkCmdDrawIndirect and flink:vkCmdDrawIndexedIndirect | |||
pname:drawCount of 0, as well as 1, when the multiDrawIndirect | |||
feature is not supported (public issue 88). | |||
|
|||
* Remove confusing wording in the <<features-limits,Limits>> | |||
section describing the slink:VkPhysicalDeviceLimits | |||
pname:minTexelBufferOffsetAlignment, | |||
pname:minUniformBufferOffsetAlignment, and | |||
pname:minStorageBufferOffsetAlignment members as both minimums and | |||
maximums (public issue 91). | |||
|
|||
* Clarified that only the RGB components should be affected in places | |||
where sRGB is referred to in the spec, such as ASTC formats. Minor | |||
re-wording to avoid "color space" when actively incorrect, now that | |||
we refer to the Data Format Spec which actually makes a distinction | |||
between color space and transfer function (public issue 94). | |||
|
|||
* Treat pname:pPropertyCount == 0 consistently in | |||
flink:vkEnumerateInstanceLayerProperties and | |||
flink:vkEnumerateDeviceLayerProperties (public issue 99) | |||
|
|||
* Cleanup minor editorial issues in chapters 14-17 (public issue 100). | |||
|
|||
* Clarify definition of flink:vkEnumerateInstanceExtensionProperties | |||
and flink:vkEnumerateDeviceExtensionProperties (public issue 101). | |||
|
|||
* Define the flink:vkEnumerateInstanceExtensionProperties and | |||
flink:vkEnumerateDeviceExtensionProperties pname:pLayerName | |||
parameter to be a pointer to a null-terminated UTF-8 string (public | |||
issue 101). | |||
|
|||
* Rearrange "Missing information" references in mandatory format | |||
tables (public issue 101). | |||
|
|||
* Clarify that the enumerated extensions returned by | |||
flink:vkEnumerateInstanceExtensionProperties and | |||
flink:vkEnumerateDeviceExtensionProperties will only include | |||
extensions provided by the platform or extensions implemented in | |||
implicitly enabled layers (public issue 101). | |||
|
|||
* Miscellaneous editorial fixes. Include the Vulkan spec patch number | |||
in the PDF title. Fix label on <<fig-non-strict-lines,Non | |||
strict lines>> diagram. Use more easily distinguished symbols in | |||
tables in the <<features-required-format-support,Required | |||
Format Support>> section. Don't require FQDNs used as layer names be | |||
encoded in lower case if not possible, in the | |||
<<extensions-naming-conventions, Extension and Layer Naming | |||
Conventions>> section (public issues 101, 119, 121). | |||
|
|||
Internal Issues: | |||
|
|||
* Fixed excessive spacing in tables in XHTML (internal issue 18). | |||
|
|||
* Clarify that ename:VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT | |||
applies to secondary command buffers. Previously spec only referred | |||
to the members of pname:pCommandBuffers being affected by this bit. | |||
Added a separate slink:VkSubmitInfo Valid Usage restriction | |||
specifying that ename:VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT | |||
also applies to any secondary command buffers that are recorded into | |||
the primary command buffers in pname:pCommandBuffers (internal issue | |||
106). | |||
|
|||
* Clarify that slink:VkDeviceCreateInfo::pname:pEnabledFeatures can be | |||
NULL (internal issue 117). | |||
|
|||
* Remove "the value of" where it is redundant (e.g. speaking of an API | |||
parameter, struct member, or SPIR-V variable, but not when speaking | |||
of color components) (internal issue 175). | |||
|
|||
* Forced patch version to always be 0 in the header. Add a | |||
"VK_API_VERSION_<major>_<minor>" macro for people to use to do the | |||
right thing. Add a VK_HEADER_VERSION which captures the header | |||
release number independent of the spec patch number (internal issue | |||
176). | |||
|
|||
* Correct description of | |||
slink:VkPipelineShaderStageCreateInfo::pname:pName to "a pointer to | |||
a null-terminated UTF-8 string" (internal issue #197). | |||
|
|||
Other Commits: | |||
|
|||
* Updated DataFormat spec reference to the new date for revision 5 of | |||
that spec. | |||
|
|||
* Fixed KEEP option (to retain LaTeX intermediate files) in the | |||
Makefile to be included when edited there, as well as set on the | |||
command line. | |||
|
|||
* Reserve and add "VK_IMG_filter_cubic" to the registry, and implement | |||
script functionality to add and remove validity from existing | |||
functions. Includes schema and readme changes. | |||
|
|||
* Update GL_KHR_vulkan_glsl so push_constants do not have descriptor | |||
sets. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.