1// Copyright 2015-2023 The Khronos Group Inc.
2//
3// SPDX-License-Identifier: CC-BY-4.0
4
5// Various special / math symbols, matching LaTeX names.
6// The pass:[+ ] notation avoids asciidoctor EOL treatment of the attribute.
7
8// Macro just to avoid typing the messy expression many times.
9// \' does not work in title, captions, link text, etc.
10:YCbCr: pass:q[Y′C~B~C~R~]
11:RGBprime: pass:q[R′G′B′]
12:prime: ′
13
14// Used when an italicized 'i' is wanted in the middle of an enum name,
15// such as `VK_IMAGE_ASPECT_PLANE__{ibit}__BIT`
16:ibit: _i_
17
18// Special symbols - not used in [eq] spans
19:sym1: ✓
20:sym2: †
21:sym3: ‡
22:reg: ®
23:trade: ™
24:harr: ↔
25
26// Math operators and logic symbols
27:times: ×
28:cdot: ⋅
29:plus: pass:[+ ]
30:minus: pass:[- ]
31:geq: ≥
32:leq: ≤
33:neq: ≠
34:leftarrow: ←
35:uparrow: ↑
36:rightarrow: →
37:downarrow: ↓
38:elem: ∈
39:lnot: ¬
40:land: ∧
41:lor: ∨
42:oplus: ⊕
43:lceil: ⌈
44:rceil: ⌉
45:lfloor: ⌊
46:rfloor: ⌋
47:vert: |
48:partial: ∂
49:onehalf: ½
50:onequarter: ¼
51:ldots: …
52:forall: ∀
53:sqrt: √
54:inf: ∞
55:plusmn: ±
56
57// Greek letters
58:alpha: α
59:beta: β
60:gamma: γ
61:DeltaUpper: Δ
62:delta: δ
63:epsilon: ε
64:eta: η
65:theta: θ
66:lambda: λ
67:pi: π
68:rho: ρ
69:sigma: σ
70:tau: τ
71:phi: ϕ
72
73// Word break opportunity tag for HTML
74ifdef::backend-html5[]
75:wbro: pass:[<wbr>]
76endif::backend-html5[]
77ifndef::backend-html5[]
78:wbro:
79endif::backend-html5[]
80
81// header names
82ifndef::VKSC_VERSION_1_0[]
83:core_header: vulkan_core.h
84:full_header: vulkan.h
85endif::VKSC_VERSION_1_0[]
86ifdef::VKSC_VERSION_1_0[]
87:core_header: vulkan_sc_core.h
88:core_header_hpp: vulkan_sc_core.hpp
89:full_header: vulkan_sc.h
90endif::VKSC_VERSION_1_0[]
91
92// Placeholders for host synchronization block text
93:externsynctitle: Host Synchronization
94:externsyncprefix: Host access to
95
96// SPIR-V terms
97// macros are not case-sensitive but are defined as such for readability
98:ExecutionModel: code:Execution code:Model
99:ExecutionMode: code:Execution code:Mode
100:StorageClass: code:Storage code:Class
101
102// Human-readable names for XML 'specialuse' attributes, used in
103// chapters/extensions.adoc for the <<extendingvulkan-specialuse-table>> table
104// as well as in some extension appendices.
105:cadsupport: CAD support
106:d3demulation: D3D support
107:devtools: Developer tools
108:debugging: Debugging tools
109:glemulation: OpenGL / ES support
110
111
112// URL prefix for the github repository containing the public specification,
113// used to generate links to separate extension proposal documents in
114// generated extension metadata.
115:specRepositoryURL: https://github.com/KhronosGroup/Vulkan-Docs/tree/main
116
117// URL prefix for the GLSL extensions registry
118:GLSLregistry: https://github.com/KhronosGroup/GLSL/blob/master/extensions
119// URL prefix for the OpenGL extensions registry
120:GLregistry: https://registry.khronos.org/OpenGL/extensions
121// URL prefix for the SPIR-V extensions registry
122:spirv: https://htmlpreview.github.io/?https://github.com/KhronosGroup/SPIRV-Registry/blob/master/extensions
123
124// Prefix for anchors that are encountered twice by the validusagei
125// extractor. Set on the command line for VU extraction.
126ifndef::vuprefix[:vuprefix:]
127