mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-01 09:06:43 +00:00
f4c4113d07
* Bump API patch number and header version number to 21 for this update.
Github Issues:
* Clarify how <<features-supported-sample-counts,sample count queries>>
relate to the limits in slink:VkPhysicalDeviceLimits. (public issue
185).
* Clarify in the <<interfaces-iointerfaces,Shader Input and Output
Interfaces>> section that shader output variables have undefined values
until the shader writes to them (public issue 240).
* Specify the implicit value of image parameters that cannot be set in
slink:VkSwapchainCreateInfo::pname:flags, pname:imageType,
pname:mipLevels, pname:samples, pname:tiling, and pname:initialLayout
(public issue 243).
* Make use of code:NULL and code:VK_NULL_HANDLE consistent in the
VK_KHR_swapchain extension (public issue 276).
Internal Issues:
* Clarify that presenting an image to a display surface swapchain applies
the display surface's mode, and that destroying a display surface
swapchain may reset the display's mode, in the VK_KHR_display_swapchain
extension (internal issue 247).
* Better describe what a slink:VkSurfaceKHR is, and that creating one does
not set a mode, in the VK_KHR_display extension. This is a round-about
way of pointing out that mode setting is not covered by the extension,
but rather is performed as a side effect of presentation (internal issue
247).
* Add more valid usage statements to flink:vkQueuePresentKHR command when
the VK_KHR_display_swapchain extension is present (internal issue
247).
* Add more includes to the VK_KHR_swapchain extension to better document
interactions with VK_KHR_display_swapchain (internal issue 247).
* Clarify restrictions on location aliasing in the
<<fxvertex,Fixed-Function Vertex Processing>> section (internal issue
370).
* Add mathematical description of blitting to flink:vkCmdBlitImage, and
link it to the <<textures,Image Operations>> chapter. Use mathematical
notation for ranges of texel coordinates in the <<textures,Image
Operations>> chapter. Fixed miscellaneous validity statements for
flink:vkCmdBlit and slink:VkImageBlit (internal issue 382).
Other Commits:
* Added a valid usage rule to flink:VkGraphicsPipelineCreateInfo that the
ename:VK_PRIMITIVE_TOPOLOGY_PATCH_LIST topology must only be used when
tessellation shaders are used.
* Expand the style guide into a formal "Procedures and Conventions"
document. Add a API Naming Conventions section, move most of the API
Specification Appendix C (Layers and Extensions) content into the new
document, and define the resulting procedures as mandatory (where
relevant). This more clearly separates use vs. specification of Vulkan
APIs.
* Update vk_platform.h to handle 32-bit ARMv8 binaries.
* Various minor cleanups to the Makefile and build process.
66 lines
2.8 KiB
HTML
66 lines
2.8 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 API and Documentation
|
|
Style Guide</a> defines mandatory and recommended practices
|
|
for writing and modigying Specifications, extensions,
|
|
and reference page language. </li>
|
|
<li> The <a href="1.0/readme.pdf">XML Registry README (PDF)</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
|
|
'asciidoc') </li>
|
|
<li> Core+WSI API <a href="1.0-wsi_extensions/html/vkspec.html">Single
|
|
document</a> (HTML from 'asciidoc') </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</body>
|
|
</html>
|