Skip to content

Commit d4aeb18

Browse files
authored
Document All Capability Atoms and Profiles (shader-slang#5008)
* Document All Capability Atoms and Profiles Fixes: shader-slang#4125 Unimplemented Considerations: 1. This PR does not add support to query all capability-atom's from a command-line option. It is understood that this might be desired, due to this, the logic to generate `docs\user-guide\a3-02-reference-capability-atoms.md` was made to be "command-line friendly" so minimal changes are needed to pipe our documentation into a command-line option if this change is to be added. Changes: 1. Added a way to document atoms inside `.capdef`. Method to document is described under `source\slang\slang-capabilities.capdef`. The goal is to error if a public atom does not have any form of documentation to ensure we always have up-to-date documentation to guide user on what an atom is/does. * The following `.capdef` file syntax was added * /// [HEADER_GROUP] * /// regular comment 2. When capability generator runs it auto-generates `docs\user-guide\a3-02-reference-capability-atoms.md` 3. Added to the user-guide 3 sections: `Reference`, `Reference -> Capability Profiles`, `Reference -> Capability atoms` section
1 parent 65dd3b7 commit d4aeb18

8 files changed

+2657
-61
lines changed

docs/user-guide/a2-target-specific-features.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
---
32
layout: user-guide
43
---
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
layout: user-guide
3+
---
4+
5+
Capability Profiles
6+
============================
7+
8+
### Accepted values of `-profile`:
9+
10+
> Note: To 'make' your own 'profile's, try mixing capabilities with `-capability`.
11+
12+
sm_{4_0,4_1,5_0,5_1,6_0,6_1,6_2,6_3,6_4,6_5,6_6,6_7}
13+
* HLSL shader model
14+
15+
vs_{4_0,4_1,5_0,5_1,6_0,6_1,6_2,6_3,6_4,6_5,6_6,6_7}
16+
* HLSL shader model + vertex shader
17+
18+
ps_{4_0,4_1,5_0,5_1,6_0,6_1,6_2,6_3,6_4,6_5,6_6,6_7}
19+
* HLSL shader model + pixel shader
20+
21+
hs_{4_0,4_1,5_0,5_1,6_0,6_1,6_2,6_3,6_4,6_5,6_6,6_7}
22+
* HLSL shader model + hull shader
23+
24+
gs_{4_0,4_1,5_0,5_1,6_0,6_1,6_2,6_3,6_4,6_5,6_6,6_7}
25+
* HLSL shader model + geometry shader
26+
27+
ds_{4_0,4_1,5_0,5_1,6_0,6_1,6_2,6_3,6_4,6_5,6_6,6_7}
28+
* HLSL shader model + domain shader
29+
30+
cs_{4_0,4_1,5_0,5_1,6_0,6_1,6_2,6_3,6_4,6_5,6_6,6_7}
31+
* HLSL shader model + compute shader
32+
33+
ms_6_{5,6,7}
34+
* HLSL shader model + mesh shader
35+
36+
as_6_{5,6,7}
37+
* HLSL shader model + amplification shader
38+
39+
lib_6_{1,2,3,4,5,6,7}
40+
* HLSL shader model for libraries
41+
42+
glsl_{110,120,130,140,150,330,400,410,420,430,440,450,460}
43+
* GLSL versions
44+
45+
spirv_1_{1,2,3,4,5,6}
46+
* SPIRV versions
47+
48+
metallib_2_{3,4}
49+
* Metal versions

0 commit comments

Comments
 (0)