Skip to content

Commit

Permalink
Change log for September 7, 2020 Vulkan 1.2.153 spec update:
Browse files Browse the repository at this point in the history
  * Update release number to 153 for this update.

Github Issues:

  * Specification default branch for updates and PRs is now `main` instead
    of `master`. `master` branch still exists, but is frozen at the 1.2.152
    level. If you are pulling content from this repository, please switch
    from `master` to `main` branch (internal issue 1351).
  * Fix slink:VkSubpassDependency2 link from slink:VkRenderPassCreateInfo2
    (public issue 1358).

Internal Issues:

  * Add developer documentation to the appendices for
    `<<VK_EXT_memory_budget>>`, `<<VK_KHR_buffer_device_address>>`,
    `<<VK_KHR_depth_stencil_resolve>>`, `<<VK_KHR_draw_indirect_count>>`,
    `<<VK_KHR_multiview>>`, `<<VK_KHR_sampler_ycbcr_conversion>>` (internal
    issue 2109).
  * Implement VUID expander treeprocessor plugin to make VUID text visible
    and searchable in generated outputs (internal issue 2253, 2258).
  * Clarify when acceleration structures can be indexed dynamically in the
    <<interfaces-resources-descset, Descriptor Set Interface>> section
    (internal issue 2316).
  * Add missing valid usage statement for flink:vkImportFenceWin32HandleKHR
    (internal merge request 4087).
  * Replace badly formatted VUID for `<<VK_AMD_display_native_hdr>>`
    (internal merge request 4096).
  * Add ray tracing acceleration structures to the lists of objects where
    appropriate in the <<fundamentals-objectmodel-lifetime, Object
    Lifetime>> section (internal merge request 4100).
  * Move GLSL and SPIR-V extension references in the extension appendices
    into the "`Interactions and External Dependencies`" sections (internal
    merge request 3969).
  • Loading branch information
oddhack committed Sep 7, 2020
1 parent 95ef004 commit 7225407
Show file tree
Hide file tree
Showing 66 changed files with 386 additions and 167 deletions.
41 changes: 39 additions & 2 deletions ChangeLog.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Copyright (c) 2016-2020 The Khronos Group Inc.

Copyright 2016-2020 The Khronos Group Inc.
SPDX-License-Identifier: CC-BY-4.0

Update Log for the Vulkan-Docs repository on Github. Updates are in reverse
Expand All @@ -12,6 +11,44 @@ public pull requests that have been accepted.

-----------------------------------------------------

Change log for September 7, 2020 Vulkan 1.2.153 spec update:

* Update release number to 153 for this update.

Github Issues:

* Specification default branch for updates and PRs is now `main` instead
of `master`. `master` branch still exists, but is frozen at the 1.2.152
level. If you are pulling content from this repository, please switch
from `master` to `main` branch (internal issue 1351).
* Fix slink:VkSubpassDependency2 link from slink:VkRenderPassCreateInfo2
(public issue 1358).

Internal Issues:

* Add developer documentation to the appendices for
`<<VK_EXT_memory_budget>>`, `<<VK_KHR_buffer_device_address>>`,
`<<VK_KHR_depth_stencil_resolve>>`, `<<VK_KHR_draw_indirect_count>>`,
`<<VK_KHR_multiview>>`, `<<VK_KHR_sampler_ycbcr_conversion>>` (internal
issue 2109).
* Implement VUID expander treeprocessor plugin to make VUID text visible
and searchable in generated outputs (internal issue 2253, 2258).
* Clarify when acceleration structures can be indexed dynamically in the
<<interfaces-resources-descset, Descriptor Set Interface>> section
(internal issue 2316).
* Add missing valid usage statement for flink:vkImportFenceWin32HandleKHR
(internal merge request 4087).
* Replace badly formatted VUID for `<<VK_AMD_display_native_hdr>>`
(internal merge request 4096).
* Add ray tracing acceleration structures to the lists of objects where
appropriate in the <<fundamentals-objectmodel-lifetime, Object
Lifetime>> section (internal merge request 4100).
* Move GLSL and SPIR-V extension references in the extension appendices
into the "`Interactions and External Dependencies`" sections (internal
merge request 3969).

-----------------------------------------------------

Change log for August 26, 2020 Vulkan 1.2.152 spec update:

* Update release number to 152 for this update.
Expand Down
9 changes: 5 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ VERBOSE =
# ADOCOPTS options for asciidoc->HTML5 output

NOTEOPTS = -a editing-notes -a implementation-guide
PATCHVERSION = 152
PATCHVERSION = 153
ifneq (,$(findstring VK_VERSION_1_2,$(VERSIONS)))
SPECREVISION = 1.2.$(PATCHVERSION)
else
Expand Down Expand Up @@ -164,7 +164,7 @@ ADOCMISCOPTS = --failure-level ERROR
ADOCEXTS = -r $(CURDIR)/config/spec-macros.rb -r $(CURDIR)/config/tilde_open_block.rb
ADOCOPTS = -d book $(ADOCMISCOPTS) $(ATTRIBOPTS) $(NOTEOPTS) $(VERBOSE) $(ADOCEXTS)

ADOCHTMLEXTS = -r $(CURDIR)/config/katex_replace.rb -r $(CURDIR)/config/loadable_html.rb
ADOCHTMLEXTS = -r $(CURDIR)/config/katex_replace.rb -r $(CURDIR)/config/loadable_html.rb -r $(CURDIR)/config/vuid-expander.rb

# ADOCHTMLOPTS relies on the relative runtime path from the output HTML
# file to the katex scripts being set with KATEXDIR. This is overridden
Expand All @@ -178,7 +178,8 @@ ADOCHTMLOPTS = $(ADOCHTMLEXTS) -a katexpath=$(KATEXDIR) \
-a sectanchors

ADOCPDFEXTS = -r asciidoctor-pdf -r asciidoctor-mathematical \
-r $(CURDIR)/config/asciidoctor-mathematical-ext.rb
-r $(CURDIR)/config/asciidoctor-mathematical-ext.rb \
-r $(CURDIR)/config/vuid-expander.rb
ADOCPDFOPTS = $(ADOCPDFEXTS) -a mathematical-format=svg \
-a imagesoutdir=$(PDFMATHDIR) \
-a pdf-stylesdir=config/themes -a pdf-style=pdf
Expand Down Expand Up @@ -235,7 +236,7 @@ $(OUTDIR)/$(KATEXDIR): $(KATEXSRCDIR)
# There is some complexity to try and avoid short virtual targets like 'html'
# causing specs to *always* be regenerated.
ROSWELL = ros
ROSWELLOPTS ?= dynamic-space-size=4000
ROSWELLOPTS ?= dynamic-space-size=5000
CHUNKER = $(HOME)/common-lisp/asciidoctor-chunker/roswell/asciidoctor-chunker.ros
CHUNKINDEX = $(CURDIR)/config/chunkindex
# Only the $(ROSWELL) step is required unless the search index is to be
Expand Down
3 changes: 3 additions & 0 deletions appendices/VK_AMD_gcn_shader.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ include::{generated}/meta/{refprefix}VK_AMD_gcn_shader.txt[]
2016-05-30
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- This extension requires
{spirv}/AMD/SPV_AMD_gcn_shader.html[`SPV_AMD_gcn_shader`]
*Contributors*::
- Dominik Witczak, AMD
- Daniel Rakos, AMD
Expand Down
5 changes: 3 additions & 2 deletions appendices/VK_AMD_gpu_shader_half_float.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@ include::{generated}/meta/{refprefix}VK_AMD_gpu_shader_half_float.txt[]
2019-04-11
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- This extension requires
{spirv}/AMD/SPV_AMD_gpu_shader_half_float.html[`SPV_AMD_gpu_shader_half_float`]
*Contributors*::
- Daniel Rakos, AMD
- Dominik Witczak, AMD
- Donglin Wei, AMD
- Graham Sellers, AMD
- Qun Lin, AMD
- Rex Xu, AMD
*External Dependencies*::
- {spirv}/AMD/SPV_AMD_gpu_shader_half_float.html[`SPV_AMD_gpu_shader_half_float`]

=== Description

Expand Down
3 changes: 1 addition & 2 deletions appendices/VK_AMD_gpu_shader_int16.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,8 @@ include::{generated}/meta/{refprefix}VK_AMD_gpu_shader_int16.txt[]
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- Requires the
- This extension requires
{spirv}/AMD/SPV_AMD_gpu_shader_int16.html[`SPV_AMD_gpu_shader_int16`]
SPIR-V extension.
*Contributors*::
- Daniel Rakos, AMD
- Dominik Witczak, AMD
Expand Down
3 changes: 3 additions & 0 deletions appendices/VK_AMD_shader_ballot.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ include::{generated}/meta/{refprefix}VK_AMD_shader_ballot.txt[]
2016-09-19
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- This extension requires
{spirv}/AMD/SPV_AMD_shader_ballot.html[`SPV_AMD_shader_ballot`]
*Contributors*::
- Qun Lin, AMD
- Graham Sellers, AMD
Expand Down
3 changes: 3 additions & 0 deletions appendices/VK_AMD_shader_explicit_vertex_parameter.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ include::{generated}/meta/{refprefix}VK_AMD_shader_explicit_vertex_parameter.txt
2016-05-10
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- This extension requires
{spirv}/AMD/SPV_AMD_shader_explicit_vertex_parameter.html[`SPV_AMD_shader_explicit_vertex_parameter`]
*Contributors*::
- Matthaeus G. Chajdas, AMD
- Qun Lin, AMD
Expand Down
5 changes: 2 additions & 3 deletions appendices/VK_AMD_shader_fragment_mask.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@ include::{generated}/meta/{refprefix}VK_AMD_shader_fragment_mask.txt[]
2017-08-16
*IP Status*::
No known IP claims.
*Dependencies*::
- Requires the
*Interactions and External Dependencies*::
- This extension requires
{spirv}/AMD/SPV_AMD_shader_fragment_mask.html[`SPV_AMD_shader_fragment_mask`]
SPIR-V extension.
*Contributors*::
- Aaron Hagan, AMD
- Daniel Rakos, AMD
Expand Down
6 changes: 2 additions & 4 deletions appendices/VK_AMD_shader_image_load_store_lod.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@ include::{generated}/meta/{refprefix}VK_AMD_shader_image_load_store_lod.txt[]
*Last Modified Date*::
2017-08-21
*Interactions and External Dependencies*::
- This extension requires the
{spirv}/AMD/SPV_AMD_shader_image_load_store_lod.html[`SPV_AMD_shader_image_load_store_lod`]
SPIR-V extension.
- This extension requires
{spirv}/AMD/SPV_AMD_shader_image_load_store_lod.html[`SPV_AMD_shader_image_load_store_lod`]
- This extension provides API support for
https://www.khronos.org/registry/OpenGL/extensions/AMD/AMD_shader_image_load_store_lod.txt[`GL_AMD_shader_image_load_store_lod`]
for GLSL-based source languages.
*IP Status*::
No known IP claims.
*Contributors*::
Expand Down
3 changes: 3 additions & 0 deletions appendices/VK_AMD_shader_trinary_minmax.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ include::{generated}/meta/{refprefix}VK_AMD_shader_trinary_minmax.txt[]
2016-05-10
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- This extension requires
{spirv}/AMD/SPV_AMD_shader_trinary_minmax.html[`SPV_AMD_shader_trinary_minmax`]
*Contributors*::
- Matthaeus G. Chajdas, AMD
- Qun Lin, AMD
Expand Down
3 changes: 1 addition & 2 deletions appendices/VK_AMD_texture_gather_bias_lod.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,8 @@ include::{generated}/meta/{refprefix}VK_AMD_texture_gather_bias_lod.txt[]
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- Requires the
- This extension requires
{spirv}/AMD/SPV_AMD_texture_gather_bias_lod.html[`SPV_AMD_texture_gather_bias_lod`]
SPIR-V extension.
*Contributors*::
- Dominik Witczak, AMD
- Daniel Rakos, AMD
Expand Down
3 changes: 3 additions & 0 deletions appendices/VK_EXT_buffer_device_address.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ include::{generated}/meta/{refprefix}VK_EXT_buffer_device_address.txt[]
2019-01-06
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- This extension requires
{spirv}/EXT/SPV_EXT_physical_storage_buffer.html[`SPV_EXT_physical_storage_buffer`]
*Contributors*::
- Jeff Bolz, NVIDIA
- Neil Henning, AMD
Expand Down
14 changes: 7 additions & 7 deletions appendices/VK_EXT_conservative_rasterization.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ include::{generated}/meta/{refprefix}VK_EXT_conservative_rasterization.txt[]
*Last Modified Date*::
2020-06-09
*Interactions and External Dependencies*::
- This extension requires the
- This extension requires
{spirv}/EXT/SPV_EXT_fragment_fully_covered.html[`SPV_EXT_fragment_fully_covered`]
SPIR-V extension if the
if the
sname:VkPhysicalDeviceConservativeRasterizationPropertiesEXT::pname:fullyCoveredFragmentShaderInputVariable
feature is used.
- This extension requires the
{spirv}/KHR/SPV_KHR_post_depth_coverage.html[`SPV_KHR_post_depth_coverage`]
SPIR-V extension if the
- This extension requires
{spirv}/KHR/SPV_KHR_post_depth_coverage.html[`SPV_KHR_post_depth_coverage`]if
the
sname:VkPhysicalDeviceConservativeRasterizationPropertiesEXT::pname:conservativeRasterizationPostDepthCoverage
feature is used.
- This extension requires
- This extension provides API support for
https://www.khronos.org/registry/OpenGL/extensions/NV/NV_conservative_raster_underestimation.txt[`GL_NV_conservative_raster_underestimation`]
for GLSL-based source languages if the
if the
sname:VkPhysicalDeviceConservativeRasterizationPropertiesEXT::pname:fullyCoveredFragmentShaderInputVariable
feature is used.
*Contributors*::
Expand Down
3 changes: 1 addition & 2 deletions appendices/VK_EXT_fragment_density_map.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ include::{generated}/meta/{refprefix}VK_EXT_fragment_density_map.txt[]
*Last Modified Date*::
2018-09-25
*Interactions and External Dependencies*::
- This extension requires the
- This extension requires
{spirv}/EXT/SPV_EXT_fragment_invocation_density.html[`SPV_EXT_fragment_invocation_density`]
SPIR-V extension.
*Contributors*::
- Matthew Netsch, Qualcomm Technologies, Inc.
- Robert VanReenen, Qualcomm Technologies, Inc.
Expand Down
8 changes: 3 additions & 5 deletions appendices/VK_EXT_fragment_shader_interlock.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@ include::{generated}/meta/{refprefix}VK_EXT_fragment_shader_interlock.txt[]
*Last Modified Date*::
2019-05-02
*Interactions and External Dependencies*::
- This extension requires the
- This extension requires
{spirv}/EXT/SPV_EXT_fragment_shader_interlock.html[`SPV_EXT_fragment_shader_interlock`]
SPIR-V extension.
- This extension requires the
https://www.khronos.org/registry/OpenGL/extensions/ARB/ARB_fragment_shader_interlock.txt[`GL_ARB_fragment_shader_interlock`],
extensions for GLSL source languages.
- This extension provides API support for
https://www.khronos.org/registry/OpenGL/extensions/ARB/ARB_fragment_shader_interlock.txt[`GL_ARB_fragment_shader_interlock`]
*Contributors*::
- Daniel Koch, NVIDIA
- Graeme Leese, Broadcom
Expand Down
22 changes: 18 additions & 4 deletions appendices/VK_EXT_memory_budget.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,35 @@ include::{generated}/meta/{refprefix}VK_EXT_memory_budget.txt[]

=== Description

While running a Vulkan application, other processes on the machine might
also be attempting to use the same device memory, which can pose problems.
This extension adds support for querying the amount of memory used and the
total memory budget for a memory heap.
The values returned by this query are implementation-dependent and can
depend on a variety of factors including operating system and system load.

The pname:heapBudget values can be used as a guideline for how much total
memory from each heap the process can use at any given time, before
allocations may start failing or causing performance degradation.
The slink:VkPhysicalDeviceMemoryBudgetPropertiesEXT::pname:heapBudget values
can be used as a guideline for how much total memory from each heap the
**current process** can use at any given time, before allocations may start
failing or causing performance degradation.
The values may change based on other activity in the system that is outside
the scope and control of the Vulkan implementation.

The slink:VkPhysicalDeviceMemoryBudgetPropertiesEXT::pname:heapUsage will
display the **current process** estimated heap usage.

With this information, the idea is for an application at some interval (once
per frame, per few seconds, etc) to query pname:heapBudget and
pname:heapUsage.
From here the application can notice if it is over budget and decide how it
wants to handle the memory situation (free it, move to host memory, changing
mipmap levels, etc).
This extension is designed to be used in concert with
<<VK_EXT_memory_priority>> to help with this part of memory management.

include::{generated}/interfaces/VK_EXT_memory_budget.txt[]

=== Version History

* Revision 1, 2018-10-08 (Jeff Bolz)
- Initial revision

8 changes: 3 additions & 5 deletions appendices/VK_EXT_post_depth_coverage.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,12 @@ include::{generated}/meta/{refprefix}VK_EXT_post_depth_coverage.txt[]
*Last Modified Date*::
2017-07-17
*Interactions and External Dependencies*::
- This extension requires the
{spirv}/KHR/SPV_KHR_post_depth_coverage.html[`SPV_KHR_post_depth_coverage`]
SPIR-V extension.
- This extension requires
{spirv}/KHR/SPV_KHR_post_depth_coverage.html[`SPV_KHR_post_depth_coverage`]
- This extension provides API support for
https://www.khronos.org/registry/OpenGL/extensions/ARB/ARB_post_depth_coverage.txt[`GL_ARB_post_depth_coverage`]
or
and
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_post_depth_coverage.txt[`GL_EXT_post_depth_coverage`]
for GLSL-based source languages.
*Contributors*::
- Jeff Bolz, NVIDIA

Expand Down
6 changes: 2 additions & 4 deletions appendices/VK_EXT_shader_atomic_float.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@ include::{generated}/meta/{refprefix}VK_EXT_shader_atomic_float.txt[]
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- This extension requires the
- This extension requires
{spirv}/EXT/SPV_EXT_shader_atomic_float_add.html[`SPV_EXT_shader_atomic_float_add`]
SPIR-V extension.
- This extension provides API support for the
- This extension provides API support for
https://github.com/KhronosGroup/GLSL/tree/master/extensions/ext/GLSL_EXT_shader_atomic_float.txt[`GL_EXT_shader_atomic_float`]
extension for GLSL-based source languages.
*Contributors*::
- Vikram Kushwaha, NVIDIA
- Jeff Bolz, NVIDIA
Expand Down
3 changes: 3 additions & 0 deletions appendices/VK_EXT_shader_demote_to_helper_invocation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ include::{generated}/meta/{refprefix}VK_EXT_shader_demote_to_helper_invocation.t
2019-06-01
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- This extension requires
{spirv}/EXT/SPV_EXT_demote_to_helper_invocation.html[`SPV_EXT_demote_to_helper_invocation`]
*Contributors*::
- Jeff Bolz, NVIDIA

Expand Down
5 changes: 3 additions & 2 deletions appendices/VK_EXT_shader_stencil_export.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ include::{generated}/meta/{refprefix}VK_EXT_shader_stencil_export.txt[]
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- Requires the
- This extension requires
{spirv}/EXT/SPV_EXT_shader_stencil_export.html[`SPV_EXT_shader_stencil_export`]
SPIR-V extension.
- This extension provides API support for
https://www.khronos.org/registry/OpenGL/extensions/ARB/ARB_shader_stencil_export.txt[`GL_ARB_shader_stencil_export`]
*Contributors*::
- Dominik Witczak, AMD
- Daniel Rakos, AMD
Expand Down
8 changes: 3 additions & 5 deletions appendices/VK_EXT_shader_subgroup_ballot.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@ include::{generated}/meta/{refprefix}VK_EXT_shader_subgroup_ballot.txt[]
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- This extension requires the
{spirv}/KHR/SPV_KHR_shader_ballot.html[`SPV_KHR_shader_ballot`] SPIR-V
extension.
- This extension requires the
- This extension requires
{spirv}/KHR/SPV_KHR_shader_ballot.html[`SPV_KHR_shader_ballot`]
- This extension provides API support for
https://www.khronos.org/registry/OpenGL/extensions/ARB/ARB_shader_ballot.txt[`GL_ARB_shader_ballot`]
extension for GLSL source languages.
*Contributors*::
- Jeff Bolz, NVIDIA
- Neil Henning, Codeplay
Expand Down
8 changes: 3 additions & 5 deletions appendices/VK_EXT_shader_subgroup_vote.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@ include::{generated}/meta/{refprefix}VK_EXT_shader_subgroup_vote.txt[]
*IP Status*::
No known IP claims.
*Interactions and External Dependencies*::
- This extension requires the
{spirv}/KHR/SPV_KHR_subgroup_vote.html[`SPV_KHR_subgroup_vote`] SPIR-V
extension.
- This extension requires the
- This extension requires
{spirv}/KHR/SPV_KHR_subgroup_vote.html[`SPV_KHR_subgroup_vote`]
- This extension provides API support for
https://www.khronos.org/registry/OpenGL/extensions/ARB/ARB_shader_group_vote.txt[`GL_ARB_shader_group_vote`]
extension for GLSL source languages.
*Contributors*::
- Neil Henning, Codeplay
- Daniel Koch, NVIDIA Corporation
Expand Down
Loading

0 comments on commit 7225407

Please sign in to comment.