• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1// Copyright 2015-2021 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:geq: ≥
31:leq: ≤
32:neq: ≠
33:leftarrow: ←
34:uparrow: ↑
35:rightarrow: →
36:downarrow: ↓
37:elem: ∈
38:lnot: ¬
39:land: ∧
40:lor: ∨
41:oplus: ⊕
42:lceil: ⌈
43:rceil: ⌉
44:lfloor: ⌊
45:rfloor: ⌋
46:vert: |
47:partial: ∂
48:onehalf: ½
49:onequarter: ¼
50:ldots: …
51:forall: ∀
52:sqrt: √
53:inf: ∞
54:plusmn: ±
55
56// Greek letters
57:alpha: α
58:beta: β
59:gamma: γ
60:DeltaUpper: Δ
61:delta: δ
62:epsilon: ε
63:eta: η
64:theta: θ
65:lambda: λ
66:pi: π
67:rho: ρ
68:sigma: σ
69:tau: τ
70:phi: ϕ
71
72// Word break opportunity tag for HTML
73ifdef::backend-html5[]
74:wbro: pass:[<wbr>]
75endif::backend-html5[]
76ifndef::backend-html5[]
77:wbro:
78endif::backend-html5[]
79
80// header names
81:core_header: vulkan_core.h
82:full_header: vulkan.h
83
84// Placeholders for host synchronization block text
85:externsynctitle: Host Synchronization
86:externsyncprefix: Host access to
87
88// SPIR-V terms
89// macros are not case-sensitive but are defined as such for readability
90:ExecutionModel: code:Execution code:Model
91:ExecutionMode: code:Execution code:Mode
92:StorageClass: code:Storage code:Class
93
94// Human-readable names for XML 'specialuse' attributes, used in
95// chapters/extensions.txt for the <<extendingvulkan-specialuse-table>> table
96// as well as in some extension appendices.
97:cadsupport: CAD support
98:d3demulation: D3D support
99:devtools: Developer tools
100:debugging: Debugging tools
101:glemulation: OpenGL / ES support
102
103
104// URL prefix for the github repository containing the public specification,
105// used to generate links to separate extension proposal documents in
106// generated extension metadata.
107:specRepositoryURL: https://github.com/KhronosGroup/Vulkan-Docs/tree/main
108