mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-25 12:35:11 +00:00
95dd2f34c5
* Bump API patch number and header version number to 28 for this update.
Github Issues:
* Minor spelling and typography cleanup, add definitions of
ename:VK_FALSE and ename:VK_TRUE as just what their names say
(public issues 220, 318, 325, 365; internal issues 451, 496)
* Clarify that the pname:maxDescriptorSet limits in the
<<features-limits-required,Required Limits>> table are n *
maxPerStage limit (where n=number of supported stages) (public issue
254).
* Minor cleanup to <<boilerplate-platform-macros,Platform-Specific
Macro Definitions>> appendix (public issue 314).
* Add valid usage statement to slink:VkPipelineLayoutCreateInfo
disallowing multiple push constant ranges for the same shader stage
(public issue 340).
* Clarify the elink:VkSharingMode description of what executing the
"same" barriers means in case of ownership transfer (public issue
347).
* Rename copyright.txt and add COPYING.md to try and reduce confusion
about applicable copyrights (public issue 350).
* Extend the table in the <<boilerplate-wsi-header, Window System-Specific
Header Control>> section to describe the external headers included when
each etext:VK_USE_PLATFORM_* macro is defined (public issue 376).
Internal Issues:
* Add "Revision History" to the PDF outputs following the table of
contents, to match HTML outputs (internal issue 43).
* Clarified that flink:vkMapMemory may fail due to virtual address
space limitations (internal issue 346).
* Add +refBody+ comment markup for ref page autoextraction when required
(internal issue 400).
* Document proper use of "mipmap" and "mip" in the style guide API
naming rules, matching the spelling rules (internal issue 471).
* Tweak the <<extensions,Layers and Extensions>> appendix to note that
the Specification may be built with arbitrary combinations of
extensions (internal issue 483).
* Remove incorrect statement allowing
slink:VkClearAttachment::pname:colorAttachment to be >=
slink:VkSubpassDescription::pname:colorAttachmentCount (internal
issue 488).
* The <<features-limits-viewportboundsrange,viewportBoundsRange>> is
expressed in terms of the pname:maxViewportDimensions but this is
actually two values. Clarify that it's based on the larger of the two
(if they differ) (internal issue 499).
Other Issues:
* Reflowed text of the entire spec using the 'reflow' Makefile gater,
to (hopefully) reduce future internal git churn as edits are made
and extensions added in return for one-time pain. This has no
perceptible change on the spec outputs but considerable changes on
the asciidoc source (internal issue 367).
135 lines
2.4 KiB
Plaintext
135 lines
2.4 KiB
Plaintext
// Copyright (c) 2014-2016 The Khronos Group Inc.
|
|
// Copyright notice at https://www.khronos.org/registry/speccopyright.html
|
|
|
|
include::specversion.txt[]
|
|
|
|
= Vulkan {apirevision} - A Specification {apititle}
|
|
The Khronos Vulkan Working Group
|
|
:icons:
|
|
:toc2:
|
|
:toclevels: 2
|
|
:toc-placement: manual
|
|
:max-width: 100
|
|
:numbered:
|
|
:doctype: book
|
|
:imagewidth: 800
|
|
:fullimagewidth: {svgpdf@pdf:scaledwidth="75%":width="800"}
|
|
:sym1: ✓
|
|
:sym2: †
|
|
:times: ×
|
|
:geq: ≥
|
|
:leq: ≤
|
|
:downarrow: ↓
|
|
|
|
//:editing-notes:
|
|
|
|
// asciidoc automatically generates this information block in XHTML outputs
|
|
ifeval::["{a2x-format}"=="pdf"]
|
|
|
|
[width="100%",options="header"]
|
|
|====
|
|
2+| Revision History
|
|
| Revision {revnumber} | {revdate}
|
|
2+| {revremark}
|
|
|====
|
|
endif::[]
|
|
|
|
<<<<
|
|
|
|
include::copyright-spec.txt[]
|
|
|
|
<<<<
|
|
|
|
// Table of contents is inserted here
|
|
toc::[]
|
|
|
|
:leveloffset: 1
|
|
include::chapters/introduction.txt[]
|
|
|
|
include::chapters/fundamentals.txt[]
|
|
|
|
include::chapters/initialization.txt[]
|
|
|
|
include::chapters/devsandqueues.txt[]
|
|
|
|
include::chapters/cmdbuffers.txt[]
|
|
|
|
include::chapters/synchronization.txt[]
|
|
|
|
include::chapters/renderpass.txt[]
|
|
|
|
include::chapters/shaders.txt[]
|
|
|
|
include::chapters/pipelines.txt[]
|
|
|
|
include::chapters/memory.txt[]
|
|
|
|
include::chapters/resources.txt[]
|
|
|
|
include::chapters/samplers.txt[]
|
|
|
|
include::chapters/descriptorsets.txt[]
|
|
|
|
include::chapters/interfaces.txt[]
|
|
|
|
include::chapters/textures.txt[]
|
|
|
|
include::chapters/queries.txt[]
|
|
|
|
// Transfer operations
|
|
include::chapters/clears.txt[]
|
|
|
|
include::chapters/copies.txt[]
|
|
|
|
// Graphics Operations
|
|
include::chapters/drawing.txt[]
|
|
|
|
include::chapters/fxvertex.txt[]
|
|
|
|
include::chapters/tessellation.txt[]
|
|
|
|
include::chapters/geometry.txt[]
|
|
|
|
include::chapters/vertexpostproc.txt[]
|
|
|
|
include::chapters/primsrast.txt[]
|
|
|
|
include::chapters/fragops.txt[]
|
|
|
|
include::chapters/framebuffer.txt[]
|
|
|
|
// Compute
|
|
include::chapters/dispatch.txt[]
|
|
|
|
// Sparse
|
|
include::chapters/sparsemem.txt[]
|
|
|
|
ifdef::VK_KHR_surface[]
|
|
include::chapters/VK_KHR_surface/wsi.txt[]
|
|
endif::VK_KHR_surface[]
|
|
|
|
// Sort of an appendix
|
|
include::chapters/extensions.txt[]
|
|
|
|
include::chapters/features.txt[]
|
|
|
|
include::chapters/debugging.txt[]
|
|
|
|
// Appendices
|
|
:numbered!:
|
|
|
|
include::appendices/spirvenv.txt[]
|
|
|
|
include::appendices/compressedtex.txt[]
|
|
|
|
// Extension appendices are now included from extensions.txt
|
|
include::appendices/extensions.txt[]
|
|
|
|
include::appendices/boilerplate.txt[]
|
|
|
|
include::appendices/invariance.txt[]
|
|
|
|
include::appendices/glossary.txt[]
|
|
|
|
include::appendices/credits.txt[]
|