mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-11 22:44:11 +00:00
eaea7d2709
* Bump API patch number and header version number to 26 for this update.
Github Issues:
* Bring sample code in the +VK_KHR_surface+ and +VK_KHR_swapchain+
extension summary appendices up to date, and note they will be replaced
with pointers to the LunarG SDK examples in the future (public issue
279).
* Add a new <<fundamentals-commandsyntax-results-lifetime,Lifetime of
Retrieved Results>> section specifying that ftext:vkGet* and
ftext:VkEnumerate* results are invariant unless otherwise specified, and
specify behavior for individual commands which are not invariant (public
issue 280).
* Remove conflicting definition of
slink:VkDisplayPlaneCapabilitiesKHR::pname:maxSrcPosition and clean up
language of the remaining definition (public issue 351).
* Fix many minor spelling errors and add rules to the style guide to
prevent recurrences (public issue 352).
Internal Issues:
* Remove redundant descriptions of the etext:VK_USE_PLATFORM_* macros from
the <<wsi,Window System Integration>> chapter in favor of the
description in the <<boilerplate-wsi-header,Window System-Specific
Header Control>> appendix (internal issue 6).
* Replace misleading 'can: be destroyed when not X' with more correct
'must: not be destroyed while X' in the
<<fundamentals-objectmodel-lifetime,Object Lifetime>> section. Disallow
destroying a pipeline layout while a command buffer using it is
recording (internal issue 241).
* Clarify that ename:VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT is valid for
all images used as attachments in elink:VkImageUsageFlagBits and the
slink:VkImageLayout validity language (internal issue 320).
* Note that <<extended-functionality-layers,Layers>> may wrap object
handles, but that this is a generally discouraged. A link to additional
information in the documentation for layer authors is provided (issue
398)
* Replace the mustnot: and shouldnot: macros with equivalent must: not and
should: not to get rid of non-English words while still highlighting
normative language (internal issue 407).
* Disallow creating multisampled images with
ename:VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT in the slink:VkImageLayout
validity language and the <<features-supported-sample-counts,Supported
Sample Counts>> section (internal issue 445).
* Fix typo so that flink:vkCmdDrawIndexedIndirect is defined in terms of
flink:vkCmdDrawIndexed rather than flink:vkCmdDrawIndirect (internal
issue 446).
* Reorganize the per-extension information sections to all be in the
<<extensions,Layers & Extensions>> appendix. Also fix a typo in
+VK_IMG_filter_cubic+ which incorrectly identified it as a +KHR+
extension (internal issue 461).
Other Issues:
* Use asciidoc markup instead of latexmath to simplify diagrams in the
<<features-formats-non-packed,byte mapping tables>> for color formats.
* Fix a markup problem with the wildcarded enumerant names in a NOTE in
the <<textures-texel-replacement,Texel Replacement>> section.
* Fix missing attributes in the XML interface for
elink:VkExternalMemoryHandleTypeFlagBitsNV and
elink:VkExternalMemoryFeatureFlagBitsNV (KhronosGroup/Vulkan-Hpp issue
#25)
* Cleanup reference page builds so only core pages are built for releases.
75 lines
3.1 KiB
HTML
75 lines
3.1 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/registry.html">Vulkan API Registry</a> document
|
|
describes the XML schema used in <tt>vk.xml</tt> in considerable
|
|
detail, for use when adding to or modifying the API. </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>
|
|
</ul>
|
|
</li>
|
|
<li> <b> Core + Khronos Extensions 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>
|
|
</ul>
|
|
</li>
|
|
<li> <b> Core + All Extensions API Specifications </b>
|
|
<ul>
|
|
<li> <a href="1.0-extensions/xhtml/vkspec.html">Single document</a> (XHTML from 'a2x') </li>
|
|
<li> <a href="1.0-extensions/pdf/vkspec.pdf"> Vulkan API spec (PDF)</a> </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>
|
|
</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>
|
|
(HTML5 from 'asciidoc') </li>
|
|
<li> Core + KHR API <a
|
|
href="1.0-wsi_extensions/html/vkspec.html">Single document</a>
|
|
(HTML5 from 'asciidoc') </li>
|
|
<li> Core + All Extensions API <a
|
|
href="1.0-extensions/html/vkspec.html">Single document</a> (HTML5
|
|
from 'asciidoc') </li>
|
|
<li> <a href="1.0/man/3/">Vulkan ref pages</a> (nroff / Unix man page markup, separate files - <b>deprecated</b>) </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</body>
|
|
</html>
|