Skip to content

Commit 2dd2b35

Browse files
oddhackoddhack
committed
Change log for August 12, 2016 Vulkan 1.0.24 spec update:
 * Bump API patch number and header version number to 24 for this update. Github Issues: * Fix type mismatch in swapchain image equivalency table (public issue 289). * Fix a copy-and-paste error in the description of flink:vkGetSwapchainImagesKHR::pname:pSwapchainImages, that said it was an array of ``sname:VkSwapchainImageKHR structures'' instead of an array of ``sname:VkImage handles'' (public issue 292). * Specify that ename:VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT is only valid for ename:VK_IMAGE_TYPE_2D images (public issue 293). * Add a valid usage statement to flink:vkCmdExecuteCommands saying that when called outside a render pass instance, the secondary command buffers must not have been created with the ename:VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT (public issue 297). * Fix description of +VK_NO_STDINT_H+ in the <<boilerplate-platform-macros,platform macros>> section (public issue 314). Internal Issues: * Normalize the language for the remaining built-in variables in the <<interfaces-builtin-variables,Built-In Variables>> section. Fix code:FrontFacing and code:HelperInvocation, as they should be of code:boolean type rather than code:integer (internal issue 323). * Clarify that when ename:VK_WHOLE_SIZE is used for a buffer descriptor range, the effective range must still be within the max buffer range (internal issue 426). * Clarify that command buffers and descriptor sets are allocated rather than created. Also clarify when the recording state of a command buffer is relevant (internal issue 434).
1 parent 2b7c8f3 commit 2dd2b35

21 files changed

Lines changed: 609 additions & 365 deletions

‎ChangeLog.txt‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1139,3 +1139,40 @@ Other Commits:
11391139
sname:VkPipelineInputAssemblyStateCreateInfo are described to match
11401140
their order in the structures.
11411141

1142+
-----------------------------------------------------
1143+
1144+
Change log for August 12, 2016 Vulkan 1.0.24 spec update:
1145+
1146+
* Bump API patch number and header version number to 24 for this update.
1147+
1148+
Github Issues:
1149+
1150+
* Fix type mismatch in swapchain image equivalency table (public issue
1151+
289).
1152+
* Fix a copy-and-paste error in the description of
1153+
flink:vkGetSwapchainImagesKHR::pname:pSwapchainImages, that said it
1154+
was an array of ``sname:VkSwapchainImageKHR structures'' instead of
1155+
an array of ``sname:VkImage handles'' (public issue 292).
1156+
* Specify that ename:VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT is only valid
1157+
for ename:VK_IMAGE_TYPE_2D images (public issue 293).
1158+
* Add a valid usage statement to flink:vkCmdExecuteCommands saying
1159+
that when called outside a render pass instance, the secondary
1160+
command buffers must not have been created with the
1161+
ename:VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT (public issue
1162+
297).
1163+
* Fix description of +VK_NO_STDINT_H+ in the
1164+
<<boilerplate-platform-macros,platform macros>> section (public
1165+
issue 314).
1166+
1167+
Internal Issues:
1168+
1169+
* Normalize the language for the remaining built-in variables in the
1170+
<<interfaces-builtin-variables,Built-In Variables>> section. Fix
1171+
code:FrontFacing and code:HelperInvocation, as they should be of
1172+
code:boolean type rather than code:integer (internal issue 323).
1173+
* Clarify that when ename:VK_WHOLE_SIZE is used for a buffer
1174+
descriptor range, the effective range must still be within the max
1175+
buffer range (internal issue 426).
1176+
* Clarify that command buffers and descriptor sets are allocated
1177+
rather than created. Also clarify when the recording state of a
1178+
command buffer is relevant (internal issue 434).

‎doc/specs/vulkan/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ GENDEPENDS = api/timeMarker validity/timeMarker hostsynctable/timeMarker
134134
COMMONDOCS = $(CHAPTERS) $(GENINCLUDE) $(GENDEPENDS)
135135
# A generated included file with the spec version, date, and git commit
136136
SPECVERSION = specversion.txt
137-
SPECREVISION = 1.0.23
137+
SPECREVISION = 1.0.24
138138
SPECREMARK =
139139

140140
# Spec targets

‎doc/specs/vulkan/api/defines/VK_HEADER_VERSION.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ ifdef::doctype-manpage[]
88
endif::doctype-manpage[]
99
------------------------------------------------------------------------------
1010
// Version of this file
11-
#define VK_HEADER_VERSION 23
11+
#define VK_HEADER_VERSION 24
1212

1313
------------------------------------------------------------------------------

‎doc/specs/vulkan/appendices/boilerplate.txt‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -272,11 +272,12 @@ dname:VKAPI_ATTR or dname:VKAPI_CALL, depending on the compiler.
272272

273273
// @refBegin VK_NO_STDINT_H - control definition of +<stdint.h>+ types
274274

275-
If the +VK_NO_STDINT_H+ macro is defined at compile time, it indicates that
276-
the system +<stdint.h>+ does not define some required integer types, and
277-
+vk_platform.h+ will declare fallback definitions of those types. This is
278-
included for backwards compatibility with very old compilers, such as
279-
Microsoft Visual Studio version 2008 or before.
275+
If the +VK_NO_STDINT_H+ macro is defined by the application at compile time,
276+
extended integer types required by +vulkan.h+, such as +uint8_t+, must: also
277+
be defined by the application. Otherwise, +vulkan.h+ will not compile. If
278+
+VK_NO_STDINT_H+ is not defined, the system +<stdint.h>+ is used to define
279+
these types, or there is a fallback path when Microsoft Visual Studio
280+
version 2008 and earlier versions are detected at compile time.
280281

281282
// @refEnd VK_NO_STDINT_H
282283

‎doc/specs/vulkan/appendices/glossary.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ Image View::
394394

395395
Immutable Sampler::
396396
A sampler descriptor provided at descriptor set layout creation time,
397-
and that is used for that binding in all descriptor sets created from
397+
and that is used for that binding in all descriptor sets allocated from
398398
the layout, and cannot be changed.
399399

400400
Implicitly-Enabled Layer::

‎doc/specs/vulkan/chapters/cmdbuffers.txt‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ include::../api/enums/VkCommandPoolCreateFlagBits.txt[]
136136
only be reset in bulk by calling fname:vkResetCommandPool.
137137
* pname:queueFamilyIndex designates a queue family as described in section
138138
<<devsandqueues-queueprops,Queue Family Properties>>. All command
139-
buffers created from this command pool must: be submitted on queues
139+
buffers allocated from this command pool must: be submitted on queues
140140
from the same queue family.
141141

142142
include::../validity/structs/VkCommandPoolCreateInfo.txt[]
@@ -327,18 +327,21 @@ be inherited from the primary command buffer:
327327

328328
include::../api/structs/VkCommandBufferInheritanceInfo.txt[]
329329

330-
* pname:renderPass is a sname:VkRenderPass object that must: be
331-
<<renderpass-compatibility, compatible>> with the one that is bound when
332-
the sname:VkCommandBuffer is executed if the command buffer was
333-
allocated with the
334-
ename:VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT set.
330+
* pname:renderPass is a sname:VkRenderPass object defining which
331+
render passes the sname:VkCommandBuffer will be
332+
<<renderpass-compatibility, compatible>> with and can: be executed
333+
within. If the sname:VkCommandBuffer will not be executed within a
334+
render pass instance, pname:renderPass is ignored.
335335
* pname:subpass is the index of the subpass within pname:renderPass that
336-
the sname:VkCommandBuffer will be rendering against if it was allocated
337-
with the ename:VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT set.
338-
* pname:framebuffer refers to the sname:VkFramebuffer object that the
339-
sname:VkCommandBuffer will be rendering to if it was allocated with
340-
the ename:VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT set. It can:
341-
be dlink:VK_NULL_HANDLE if the framebuffer is not known.
336+
the sname:VkCommandBuffer will be executed within. If the
337+
sname:VkCommandBuffer will not be executed within a render pass
338+
instance, pname:subpass is ignored.
339+
* pname:framebuffer optionally refers to the sname:VkFramebuffer
340+
object that the sname:VkCommandBuffer will be rendering to if it is
341+
executed within a render pass instance. It can:
342+
be dlink:VK_NULL_HANDLE if the framebuffer is not known, or if the
343+
sname:VkCommandBuffer will not be executed within a render pass
344+
instance.
342345
+
343346
[NOTE]
344347
.Note
@@ -543,8 +546,7 @@ primary command buffer with the command:
543546
include::../api/protos/vkCmdExecuteCommands.txt[]
544547

545548
* pname:commandBuffer is a handle to a primary command buffer that the
546-
secondary command buffers are submitted to, and must: be in the
547-
recording state.
549+
secondary command buffers are executed in.
548550
* pname:commandBufferCount is the length of the pname:pCommandBuffers
549551
array.
550552
* pname:pCommandBuffers is an array of secondary command buffer handles,

‎doc/specs/vulkan/chapters/descriptorsets.txt‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1433,7 +1433,21 @@ include::../api/structs/VkDescriptorBufferInfo.txt[]
14331433
* pname:range is the size in bytes that is used for this descriptor
14341434
update, or ename:VK_WHOLE_SIZE to use the range from pname:offset to the
14351435
end of the buffer.
1436-
1436+
+
1437+
--
1438+
[NOTE]
1439+
.Note
1440+
====
1441+
When using ename:VK_WHOLE_SIZE, the effective range mustnot: be larger
1442+
than the maximum range for the descriptor type
1443+
(<<features-limits-maxUniformBufferRange, maxUniformBufferRange>> or
1444+
<<features-limits-maxStorageBufferRange, maxStorageBufferRange>>). This
1445+
means that ename:VK_WHOLE_SIZE is not typically useful in the common
1446+
case where uniform buffer descriptors are suballocated from a buffer
1447+
that is much larger than pname:maxUniformBufferRange.
1448+
====
1449+
--
1450+
+
14371451
For ename:VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC and
14381452
ename:VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC descriptor types,
14391453
pname:offset is the base offset from which the dynamic offset is applied and

0 commit comments

Comments
 (0)