mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-16 01:14:28 +00:00
2656f45933
* Bump API patch number and header version number to 13 for this
update.
Github Issues:
* Improve the description of ename:VK_PRESENT_MODE_FIFO_RELAXED_KHR in the
VK_KHR_surface extension (public issue 174).
* Clarify use of etext:*_SIMULTANEOUS_USE_BIT for secondary command
buffers (public issue 182).
* Fix typos in VK_KHR_wayland_surface extension where code:wl_device was
used instead of code:wl_display (public issue 193).
* Replaced {apiname} with ``Vulkan'' in XML validity statements (public
issue 199).
* Fix dead links for WSI handle types (public issue 200).
*** N.b. this needs to be done in WSI branches as well ***
* Use "signaled" instead of "signalled" spelling everywhere (public issue
201).
*** N.b. this needs to be done in WSI branches as well ***
* Move readme.pdf target directory for XML schema documentation into the
target generation directory, instead of leaving it checked into the spec
source tree (public issue 203).
*** N.b. need to add generated PDF to registry index/1.0 page
* Fix duplicate 'which which' typo in description of
elink:VkCommandPoolResetFlagBits (public issue 204).
* Move the <<Programmable Primitive Shading>> section up one level, out of
the <<drawing-primitive-topologies,Primitive Topologies>> section
(public issue 209).
Internal Issues:
* Clarify in the <<pipelines-cache,Pipeline Cache>> section that
implementations should not manage the size of pipeline cache (internal
issue 192).
* Deprecate the concept of device layers and associated commands (internal
issue 255).
* Remove ename:VK_INCOMPLETE from the list of possible result codes of
flink:vkGetPhysicalDeviceSurfaceCapabilitiesKHR (internal issue 314).
* Add missing std140/std430 rule: the base alignment of a member following
a structure is a multiple of the structure's base alignment (internal
issue 321).
* Fixes naming of the single elink:VkColorSpaceKHR enum from
ename:VK_COLORSPACE_SRGB_NONLINEAR_KHR to
ename:VK_COLOR_SPACE_SRGB_NONLINEAR_KHR in XML/header and the
VK_KHR_swapchain and VK_KHR_surface extensions to match the style of the
typename (space and color are two words, not one) (internal issue 322).
* Make it clear that code:LocalInvocationID should only be applied to an
input variable and normalize the language describing
code:LocalInvocationID to the language for other compute shader
variables in the <<interfaces-builtin-variables,Built-in Variables>>
section, and add normative language (internal issue 323).
* Clarify in the <<fundamentals-returncodes,Return Codes>> section that
the result pointer may be modified for specific commands, even if a
runtime error is returned (internal issue 324).
65 lines
2.7 KiB
HTML
65 lines
2.7 KiB
HTML
<html>
|
|
<head>
|
|
<title>Vulkan Spec Sandbox</title>
|
|
</head>
|
|
<body>
|
|
<h1>Vulkan Spec Sandbox</h1>
|
|
|
|
<p> This is the vulkan spec sandbox, used to view generated Vulkan API and
|
|
related documents. It is updated by hand periodically by Jon Leech. </p>
|
|
|
|
<ul>
|
|
<li> The <a href="1.0/styleguide.html">Vulkan Style Guide</a> is a work in
|
|
progress (but significantly complete) document, useful when writing
|
|
and modifying Specification and reference page language. </li>
|
|
<li> The <a href="1.0/readme.pdf">XML Registry README</a> describes the
|
|
schema and some use cases for <tt>vk.xml</tt>. </li>
|
|
<li> <b> Core API Specifications </b>
|
|
<ul>
|
|
<li> <a href="1.0/xhtml/vkspec.html">Single document</a> (XHTML from 'a2x') </li>
|
|
<li> <a href="1.0/pdf/vkspec.pdf"> Vulkan API spec (PDF)</a> </li>
|
|
<!-- <li> <a href="1.0/vkspec.chunked/index.html">Chunked HTML</a> (may be out of date or not present) </li> -->
|
|
</ul>
|
|
</li>
|
|
<li> <b> Core+WSI API Specifications </b>
|
|
<ul>
|
|
<li> <a href="1.0-wsi_extensions/xhtml/vkspec.html">Single document</a> (XHTML from 'a2x') </li>
|
|
<li> <a href="1.0-wsi_extensions/pdf/vkspec.pdf"> Vulkan API spec (PDF)</a> </li>
|
|
<!-- <li> <a href="1.0-wsi_extensions/vkspec.chunked/index.html">Chunked HTML</a> (may be out of date or not present) </li> -->
|
|
</ul>
|
|
</li>
|
|
<li> <b> Khronos Data Format 1.1 Specification </b>
|
|
<ul>
|
|
<li> <a href="df/df_inline.html">(HTML)</a> </li>
|
|
<li> <a href="df/df.pdf">(PDF)</a> </li>
|
|
</ul>
|
|
</li>
|
|
<li> <b> Validator script output (Core API only)</b>
|
|
<ul>
|
|
<li> <a href="1.0/checks/notInSpec.txt">List of commands, structs, etc. not included in API spec</a></li>
|
|
<li> <a href="1.0/checks/specErrs.txt">Validator script output for API specification</a>
|
|
<li> <a href="1.0/checks/manErrs.txt">Validator script output for man pages</a>
|
|
</ul>
|
|
</li>
|
|
<li> <b> Reference pages (Core API only)</b>
|
|
<ul>
|
|
<li> <a href="1.0/apispec.html">Vulkan ref pages</a> (HTML, single document) </li>
|
|
<li> <a href="1.0/apispec.pdf">Vulkan ref pages</a> (PDF, single document) </li>
|
|
<li> <a href="1.0/man/html/">Vulkan ref pages</a> (HTML, separate files) </li>
|
|
<li> <a href="1.0/man/3/">Vulkan ref pages</a> (nroff / Unix man page markup, separate files) </li>
|
|
</ul>
|
|
</li>
|
|
<li> <b> The following targets are for internal use only and are probably
|
|
not included in, or if included, not up to date in the sandbox
|
|
</b> </li>
|
|
<ul>
|
|
<li> Core API <a href="1.0/html/vkspec.html">Single document</a> (HTML from
|
|
'asciibook') </li>
|
|
<li> Core+WSI API <a href="1.0-wsi_extensions/html/vkspec.html">Single
|
|
document</a> (HTML from 'asciibook') </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</body>
|
|
</html>
|