/ vkspec.txt
vkspec.txt
  1  // Copyright (c) 2014-2019 Khronos Group. This work is licensed under a
  2  // Creative Commons Attribution 4.0 International License; see
  3  // http://creativecommons.org/licenses/by/4.0/
  4  
  5  // The mysterious :regtitle: attribute is explained in
  6  // http://discuss.asciidoctor.org/How-to-add-markup-to-author-information-in-document-title-td6488.html
  7  
  8  = Vulkan^®^ {revnumber} - A Specification {apititle}
  9  :regtitle: pass:q,r[^®^]
 10  The Khronos{regtitle} Vulkan Working Group
 11  :data-uri:
 12  :icons: font
 13  :toc2:
 14  :toclevels: 2
 15  :max-width: 100
 16  :numbered:
 17  :source-highlighter: coderay
 18  // Various special / math symbols. This is easier to edit with than Unicode.
 19  include::config/attribs.txt[]
 20  
 21  //:editing-notes:
 22  
 23  <<<<
 24  
 25  include::copyright-spec.txt[]
 26  
 27  <<<<
 28  
 29  // Table of contents is inserted here
 30  toc::[]
 31  
 32  :leveloffset: 1
 33  
 34  :test: 0
 35  
 36  ifeval::["{test}"=="1"]
 37  
 38  // Include or insert trivial test markup here, to bypass building full spec
 39  // include::chapters/textest.txt[]
 40  
 41  endif::[]
 42  
 43  ifeval::["{test}"!="1"]
 44  include::chapters/introduction.txt[]
 45  
 46  include::chapters/fundamentals.txt[]
 47  
 48  include::chapters/initialization.txt[]
 49  
 50  include::chapters/devsandqueues.txt[]
 51  
 52  include::chapters/cmdbuffers.txt[]
 53  
 54  include::chapters/synchronization.txt[]
 55  
 56  include::chapters/renderpass.txt[]
 57  
 58  include::chapters/shaders.txt[]
 59  
 60  include::chapters/pipelines.txt[]
 61  
 62  include::chapters/memory.txt[]
 63  
 64  include::chapters/resources.txt[]
 65  
 66  include::chapters/samplers.txt[]
 67  
 68  include::chapters/descriptorsets.txt[]
 69  
 70  include::chapters/interfaces.txt[]
 71  
 72  include::chapters/textures.txt[]
 73  
 74  ifdef::VK_EXT_fragment_density_map[]
 75  include::chapters/fragmentdensitymapops.txt[]
 76  endif::VK_EXT_fragment_density_map[]
 77  
 78  include::chapters/queries.txt[]
 79  
 80  // Transfer operations
 81  include::chapters/clears.txt[]
 82  
 83  include::chapters/copies.txt[]
 84  
 85  // Graphics Operations
 86  include::chapters/drawing.txt[]
 87  
 88  include::chapters/fxvertex.txt[]
 89  
 90  include::chapters/tessellation.txt[]
 91  
 92  include::chapters/geometry.txt[]
 93  
 94  ifdef::VK_NV_mesh_shader[]
 95  include::chapters/VK_NV_mesh_shader/mesh.txt[]
 96  endif::VK_NV_mesh_shader[]
 97  
 98  include::chapters/vertexpostproc.txt[]
 99  
100  include::chapters/primsrast.txt[]
101  
102  include::chapters/fragops.txt[]
103  
104  include::chapters/framebuffer.txt[]
105  
106  // Compute
107  include::chapters/dispatch.txt[]
108  
109  // Device Generated Commands
110  ifdef::VK_NVX_device_generated_commands[]
111  include::chapters/VK_NVX_device_generated_commands/generatedcommands.txt[]
112  endif::VK_NVX_device_generated_commands[]
113  
114  // Sparse
115  include::chapters/sparsemem.txt[]
116  
117  ifdef::VK_KHR_surface[]
118  include::chapters/VK_KHR_surface/wsi.txt[]
119  endif::VK_KHR_surface[]
120  
121  // Raytracing
122  ifdef::VK_NV_ray_tracing[]
123  include::chapters/VK_NV_ray_tracing/raytracing.txt[]
124  endif::VK_NV_ray_tracing[]
125  
126  // Sort of an appendix
127  include::chapters/extensions.txt[]
128  
129  include::chapters/features.txt[]
130  
131  include::chapters/limits.txt[]
132  
133  include::chapters/formats.txt[]
134  
135  include::chapters/capabilities.txt[]
136  
137  include::chapters/debugging.txt[]
138  
139  // Appendices
140  :numbered!:
141  
142  include::appendices/spirvenv.txt[]
143  
144  ifdef::VK_KHR_vulkan_memory_model[]
145  include::appendices/memorymodel.txt[]
146  endif::VK_KHR_vulkan_memory_model[]
147  
148  include::appendices/compressedtex.txt[]
149  
150  ifdef::VK_VERSION_1_1[]
151  include::appendices/versions.txt[]
152  endif::VK_VERSION_1_1[]
153  
154  // Extension appendices are now included from extensions.txt
155  include::appendices/extensions.txt[]
156  
157  include::appendices/boilerplate.txt[]
158  
159  include::appendices/invariance.txt[]
160  
161  include::appendices/glossary.txt[]
162  
163  include::appendices/credits.txt[]
164  
165  endif::[]