Skip to content

Commit 9dc6dfb

Browse files
oddhackoddhack
committed
Change log for October 5, 2021 Vulkan 1.2.195 spec update:
 * Update release number to 195 for this update. Github Issues: * Add a NOTE to flink:vkDestroyQueryPool clarifying when a query pool can be destroyed (public issue 1647). Internal Issues: * Begin cleanup of internal broken links in various builds of the specs, including generating a Ruby API map to be used by the asciidoctor macros to validate their API name arguments; using "nofollow" on github issue opening links to avoid link-checkers being interpreted as DOS attacks; improved checker scripts; minor markup fixes; and using the `apiext:` macro to replace `<<VK_KHR_extension_name>>`-style extension links everywhere (internal issue 2831). * Minor editorial cleanups to descriptions of apiext:VK_FUCHSIA_buffer_collection APIs (internal issue 2836). * Match `Cull Mask` SPIR-V name to pname:mask parameter name in the <<acceleration-structure, Acceleration Structures>> chapter (internal merge request 4844). * Add pname:minTexelOffset and pname:maxTexelOffset limit valid usage statements for code:OpImageSample* and code:OpImageFetch* in the <<spirvenv-module-validation-runtime, Runtime SPIR-V Validation>> section (internal merge request 4845). * Add pname:maxFragmentDualSrcAttachments and pname:maxFragmentCombinedOutputResources limit valid usage statements for output and color attachments in the <<spirvenv-module-validation-runtime, Runtime SPIR-V Validation>> section (internal merge request 4847). New Extensions * `<<VK_KHR_format_feature_flags2>>` * `<<VK_KHR_maintenance4>>` * `<<VK_EXT_rgba10x6_formats>>`
1 parent a096096 commit 9dc6dfb

File tree

152 files changed

+2817
-1093
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

152 files changed

+2817
-1093
lines changed

‎ChangeLog.txt‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,47 @@ public pull requests that have been accepted.
1111

1212
-----------------------------------------------------
1313

14+
Change log for October 5, 2021 Vulkan 1.2.195 spec update:
15+
16+
* Update release number to 195 for this update.
17+
18+
Github Issues:
19+
20+
* Add a NOTE to flink:vkDestroyQueryPool clarifying when a query pool can
21+
be destroyed (public issue 1647).
22+
23+
Internal Issues:
24+
25+
* Begin cleanup of internal broken links in various builds of the specs,
26+
including generating a Ruby API map to be used by the asciidoctor macros
27+
to validate their API name arguments; using "nofollow" on github issue
28+
opening links to avoid link-checkers being interpreted as DOS attacks;
29+
improved checker scripts; minor markup fixes; and using the `apiext:`
30+
macro to replace `<<VK_KHR_extension_name>>`-style extension links
31+
everywhere (internal issue 2831).
32+
* Minor editorial cleanups to descriptions of
33+
apiext:VK_FUCHSIA_buffer_collection APIs (internal issue 2836).
34+
* Match `Cull Mask` SPIR-V name to pname:mask parameter name in the
35+
<<acceleration-structure, Acceleration Structures>> chapter (internal
36+
merge request 4844).
37+
* Add pname:minTexelOffset and pname:maxTexelOffset limit valid usage
38+
statements for code:OpImageSample* and code:OpImageFetch* in the
39+
<<spirvenv-module-validation-runtime, Runtime SPIR-V Validation>>
40+
section (internal merge request 4845).
41+
* Add pname:maxFragmentDualSrcAttachments and
42+
pname:maxFragmentCombinedOutputResources limit valid usage statements
43+
for output and color attachments in the
44+
<<spirvenv-module-validation-runtime, Runtime SPIR-V Validation>>
45+
section (internal merge request 4847).
46+
47+
New Extensions
48+
49+
* `<<VK_KHR_format_feature_flags2>>`
50+
* `<<VK_KHR_maintenance4>>`
51+
* `<<VK_EXT_rgba10x6_formats>>`
52+
53+
-----------------------------------------------------
54+
1455
Change log for September 28, 2021 Vulkan 1.2.194 spec update:
1556

1657
* Update release number to 194 for this update.
@@ -26,7 +67,7 @@ Github Issues:
2667
Internal Issues:
2768

2869
* Fix incorrect member name in slink:VkRenderPassCreateInfo valid usage
29-
statement 02515 (internal issue 2484).
70+
statement 02515 (internal issue 2824).
3071
* Fix XML dependency for `<<VK_NV_device_generated_commands>>` (internal
3172
issue 2818).
3273
* Add packed formats from `<<VK_KHR_sampler_ycbcr_conversion>>`` to the

‎Makefile‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ VERBOSE =
120120
# ADOCOPTS options for asciidoc->HTML5 output
121121

122122
NOTEOPTS = -a editing-notes -a implementation-guide
123-
PATCHVERSION = 194
123+
PATCHVERSION = 195
124124

125125
ifneq (,$(findstring VK_VERSION_1_2,$(VERSIONS)))
126126
SPECMINOR = 2
@@ -176,7 +176,9 @@ ATTRIBOPTS = -a revnumber="$(SPECREVISION)" \
176176
$(EXTRAATTRIBS)
177177
ADOCMISCOPTS = --failure-level ERROR
178178
# Non target-specific Asciidoctor extensions and options
179-
ADOCEXTS = -r $(CURDIR)/config/spec-macros.rb -r $(CURDIR)/config/tilde_open_block.rb
179+
# Look in $(GENERATED) for explicitly required non-extension Ruby, such
180+
# as api.rb
181+
ADOCEXTS = -I$(GENERATED) -r $(CURDIR)/config/spec-macros.rb -r $(CURDIR)/config/tilde_open_block.rb
180182
ADOCOPTS = -d book $(ADOCMISCOPTS) $(ATTRIBOPTS) $(NOTEOPTS) $(VERBOSE) $(ADOCEXTS)
181183

182184
# HTML target-specific Asciidoctor extensions and options
@@ -232,15 +234,17 @@ METAPATH = $(GENERATED)/meta
232234
INTERFACEPATH = $(GENERATED)/interfaces
233235
SPIRVCAPPATH = $(GENERATED)/spirvcap
234236
PROPOSALPATH = $(CURDIR)/proposals
235-
# Dynamically generated markers when many generated files are made at once
237+
# timeMarker is a proxy target created when many generated files are
238+
# made at once
236239
APIDEPEND = $(APIPATH)/timeMarker
237240
VALIDITYDEPEND = $(VALIDITYPATH)/timeMarker
238241
HOSTSYNCDEPEND = $(HOSTSYNCPATH)/timeMarker
239242
METADEPEND = $(METAPATH)/timeMarker
240243
INTERFACEDEPEND = $(INTERFACEPATH)/timeMarker
241244
SPIRVCAPDEPEND = $(SPIRVCAPPATH)/timeMarker
245+
RUBYDEPEND = $(GENERATED)/api.rb
242246
# All generated dependencies
243-
GENDEPENDS = $(APIDEPEND) $(VALIDITYDEPEND) $(HOSTSYNCDEPEND) $(METADEPEND) $(INTERFACEDEPEND) $(SPIRVCAPDEPEND)
247+
GENDEPENDS = $(APIDEPEND) $(VALIDITYDEPEND) $(HOSTSYNCDEPEND) $(METADEPEND) $(INTERFACEDEPEND) $(SPIRVCAPDEPEND) $(RUBYDEPEND)
244248
# All non-format-specific dependencies
245249
COMMONDOCS = $(SPECFILES) $(GENDEPENDS)
246250

@@ -350,7 +354,7 @@ REGSRC = registry.txt
350354

351355
registry: $(OUTDIR)/registry.html
352356

353-
$(OUTDIR)/registry.html: $(REGSRC)
357+
$(OUTDIR)/registry.html: $(REGSRC) $(GENDEPENDS)
354358
$(QUIET)$(MKDIR) $(OUTDIR)
355359
$(QUIET)$(ASCIIDOC) -b html5 $(ADOCOPTS) $(ADOCHTMLOPTS) -o $@ $(REGSRC)
356360
$(QUIET)$(TRANSLATEMATH) $@
@@ -406,6 +410,7 @@ CLEAN_GEN_PATHS = \
406410
$(GENERATED)/__pycache__ \
407411
$(PDFMATHDIR) \
408412
$(GENERATED)/api.py \
413+
$(GENERATED)/api.rb \
409414
$(GENERATED)/extDependency.*
410415

411416
clean_generated:
@@ -541,9 +546,14 @@ GENVK = $(SCRIPTS)/genvk.py
541546
GENVKOPTS = $(VERSIONOPTIONS) $(EXTOPTIONS) $(GENVKEXTRA) -registry $(VKXML)
542547
GENVKEXTRA =
543548

544-
$(GENERATED)/api.py: $(VKXML) $(GENVK)
549+
scriptapi: pyapi rubyapi
550+
551+
pyapi $(GENERATED)/api.py: $(VKXML) $(GENVK)
545552
$(PYTHON) $(GENVK) $(GENVKOPTS) -o $(GENERATED) api.py
546553

554+
rubyapi $(GENERATED)/api.rb: $(VKXML) $(GENVK)
555+
$(PYTHON) $(GENVK) $(GENVKOPTS) -o $(GENERATED) api.rb
556+
547557
apiinc: $(APIDEPEND)
548558

549559
$(APIDEPEND): $(VKXML) $(GENVK) $(GENERATED)/api.py

‎appendices/VK_AMD_draw_indirect_count.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ include::{generated}/meta/{refprefix}VK_AMD_draw_indirect_count.txt[]
99
*Last Modified Date*::
1010
2016-08-23
1111
*Interactions and External Dependencies*::
12-
- Promoted to <<VK_KHR_draw_indirect_count>>
12+
- Promoted to apiext:VK_KHR_draw_indirect_count
1313
*IP Status*::
1414
No known IP claims.
1515
*Contributors*::
@@ -29,7 +29,7 @@ commands and execute them without host intervention.
2929
=== Promotion to `VK_KHR_draw_indirect_count`
3030

3131
All functionality in this extension is included in
32-
`<<VK_KHR_draw_indirect_count>>`, with the suffix changed to KHR.
32+
`apiext:VK_KHR_draw_indirect_count`, with the suffix changed to KHR.
3333
The original type, enum and command names are still available as aliases of
3434
the core functionality.
3535

‎appendices/VK_AMD_gpu_shader_half_float.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This extension adds support for using half float variables in shaders.
2828
=== Deprecation by `VK_KHR_shader_float16_int8`
2929

3030
Functionality in this extension was included in
31-
`<<VK_KHR_shader_float16_int8>>` extension, when
31+
`apiext:VK_KHR_shader_float16_int8` extension, when
3232
slink:VkPhysicalDeviceShaderFloat16Int8FeaturesKHR::pname:shaderFloat16 is
3333
enabled.
3434

‎appendices/VK_AMD_gpu_shader_int16.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This extension adds support for using 16-bit integer variables in shaders.
3030
=== Deprecation by `VK_KHR_shader_float16_int8`
3131

3232
Functionality in this extension was included in
33-
`<<VK_KHR_shader_float16_int8>>` extension, when
33+
`apiext:VK_KHR_shader_float16_int8` extension, when
3434
slink:VkPhysicalDeviceFeatures::pname:shaderInt16 and
3535
slink:VkPhysicalDeviceShaderFloat16Int8FeaturesKHR::pname:shaderFloat16 are
3636
enabled.

‎appendices/VK_AMD_shader_core_properties.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ include::{generated}/meta/{refprefix}VK_AMD_shader_core_properties.txt[]
1717
=== Description
1818

1919
This extension exposes shader core properties for a target physical device
20-
through the `<<VK_KHR_get_physical_device_properties2>>` extension.
20+
through the `apiext:VK_KHR_get_physical_device_properties2` extension.
2121
Please refer to the example below for proper usage.
2222

2323
include::{generated}/interfaces/VK_AMD_shader_core_properties.txt[]

‎appendices/VK_AMD_shader_core_properties2.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ include::{generated}/meta/{refprefix}VK_AMD_shader_core_properties2.txt[]
1717
=== Description
1818

1919
This extension exposes additional shader core properties for a target
20-
physical device through the `<<VK_KHR_get_physical_device_properties2>>`
20+
physical device through the `apiext:VK_KHR_get_physical_device_properties2`
2121
extension.
2222

2323
include::{generated}/interfaces/VK_AMD_shader_core_properties2.txt[]

‎appendices/VK_ANDROID_external_memory_android_hardware_buffer.txt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::{generated}/meta/{refprefix}VK_ANDROID_external_memory_android_hardware
77
=== Other Extension Metadata
88

99
*Last Modified Date*::
10-
2019-08-27
10+
2021-09-30
1111
*IP Status*::
1212
No known IP claims.
1313
*Contributors*::
@@ -135,6 +135,8 @@ new Android feature.
135135

136136
=== Version History
137137

138+
* Revision 4, 2021-09-30 (Jon Leech)
139+
- Add interaction with `apiext:VK_KHR_format_feature_flags2` to `vk.xml`
138140
* Revision 3, 2019-08-27 (Jon Leech)
139141
- Update revision history to correspond to XML version number
140142
* Revision 2, 2018-04-09 (Petr Kraus)

‎appendices/VK_EXT_debug_utils.txt‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ This extension provides the following capabilities:
5050
sname:VkCommandBuffer using labels to aid organization and offline
5151
analysis in external tools.
5252

53-
The main difference between this extension and `<<VK_EXT_debug_report>>` and
54-
`<<VK_EXT_debug_marker>>` is that those extensions use
53+
The main difference between this extension and `apiext:VK_EXT_debug_report`
54+
and `apiext:VK_EXT_debug_marker` is that those extensions use
5555
elink:VkDebugReportObjectTypeEXT to identify objects.
5656
This extension uses the core elink:VkObjectType in place of
5757
elink:VkDebugReportObjectTypeEXT.
@@ -60,8 +60,8 @@ enumeration values will be added to elink:VkDebugReportObjectTypeEXT since
6060
the creation of elink:VkObjectType.
6161

6262
In addition, this extension combines the functionality of both
63-
`<<VK_EXT_debug_report>>` and `<<VK_EXT_debug_marker>>` by allowing object
64-
name and debug markers (now called labels) to be returned to the
63+
`apiext:VK_EXT_debug_report` and `apiext:VK_EXT_debug_marker` by allowing
64+
object name and debug markers (now called labels) to be returned to the
6565
application's callback function.
6666
This should assist in clarifying the details of a debug message including:
6767
what objects are involved and potentially which location within a
@@ -297,7 +297,7 @@ previous extension.
297297
*RESOLVED*: Not immediately.
298298
As one can imagine, there is a lot of work involved with converting the
299299
validation layer logging over to the new functionality.
300-
Basic logging, as seen in the origin `<<VK_EXT_debug_report>>` extension
300+
Basic logging, as seen in the origin `apiext:VK_EXT_debug_report` extension
301301
will be made available immediately.
302302
However, adding the labels and object names will take time.
303303
Since the priority for Khronos at this time is to continue focusing on Valid
@@ -307,7 +307,7 @@ exposed.
307307
3) If the validation layers will not expose the new functionality
308308
immediately, then what is the point of this extension?
309309

310-
*RESOLVED*: We needed a replacement for `<<VK_EXT_debug_report>>` because
310+
*RESOLVED*: We needed a replacement for `apiext:VK_EXT_debug_report` because
311311
the elink:VkDebugReportObjectTypeEXT enumeration will no longer be updated
312312
and any new objects will need to be debugged using the new functionality
313313
provided by this extension.
@@ -329,9 +329,9 @@ enable string during flink:vkCreateInstance.
329329
=== Version History
330330

331331
* Revision 1, 2017-09-14 (Mark Young and all listed Contributors)
332-
** Initial draft, based on `<<VK_EXT_debug_report>>` and
333-
`<<VK_EXT_debug_marker>>` in addition to previous feedback supplied from
334-
various companies including Valve, Epic, and Oxide games.
332+
** Initial draft, based on `apiext:VK_EXT_debug_report` and
333+
`apiext:VK_EXT_debug_marker` in addition to previous feedback supplied
334+
from various companies including Valve, Epic, and Oxide games.
335335
* Revision 2, 2020-04-03 (Mark Young and Piers Daniell)
336336
** Updated to allow either `NULL` or an empty string to be passed in for
337337
pname:pObjectName in sname:VkDebugUtilsObjectNameInfoEXT, because the

‎appendices/VK_EXT_device_memory_report.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ We want to make this extension tied to the device's lifecycle.
3939
Each ICD just handles its own implementation of this extension, and this
4040
extension will only be directly exposed from the ICD.
4141
So we can avoid the extra implementation complexity used to accommodate the
42-
flexibility of `<<VK_EXT_debug_utils>>` extension.
42+
flexibility of `apiext:VK_EXT_debug_utils` extension.
4343

4444
2) Can we extend and use the existing internal allocation callbacks instead
4545
of adding the new callback structure in this extension?

0 commit comments

Comments
 (0)