Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add metadata schema to root signature #12

Merged
merged 7 commits into from
Oct 24, 2024
Merged

Add metadata schema to root signature #12

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e26d9c4
Add metadata schema to root signature
python3kgae Aug 5, 2024
a7a5e59
Update per comment.
python3kgae Aug 14, 2024
0af84e8
Update per comment.
python3kgae Sep 5, 2024
a7ed69f
Update per comment.
python3kgae Sep 6, 2024
a576ee9
Update proposals/0002-root-signature-in-clang.md
python3kgae Sep 9, 2024
3d58e78
Add missing ParameterType to StaticSampler
damyanp Oct 16, 2024
b2938ec
Editorial / typographical fixes
damyanp Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 58 additions & 6 deletions proposals/0002-root-signature-in-clang.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,23 +402,75 @@ registers are bound multiple times, or where there are multiple RootFlags
entries, so subsequent stages should not assume that any given root signature in
IR is valid.

#### Metadata Schema
damyanp marked this conversation as resolved.
Show resolved Hide resolved

> **Open Question**: what should the named metadata be? There's options I
> think...
* RootConstant

| ParameterType | ShaderVisibility | ShaderRegister | RegisterSpace | Num32BitValues |
|---------------|------------------|----------------|---------------|----------------|
| String | int | int | int | int |
damyanp marked this conversation as resolved.
Show resolved Hide resolved


* RootDescriptor

| ParameterType | ShaderVisibility | ShaderRegister | RegisterSpace | RootDescriptorFlags |
|---------------|------------------|----------------|---------------|---------------------|
| String | int | int | int | int |


* DescriptorRange

| RangeType | NumDescriptors | BaseShaderRegister | RegisterSpace | DescriptorRangeFlags |
|-----------|----------------|--------------------|---------------|----------------------|
| String | int | int | int | int |


* DescriptorTable
damyanp marked this conversation as resolved.
Show resolved Hide resolved

| DescriptorRanges |
|---------------------------|
| list of DescriptorRanges |

* StaticSampler

| Filter | AddressU | AddressV | AddressW | MipLODBias | MaxAnisotropy | ComparisonFunc | BorderColor | MinLOD | MaxLOD | ShaderRegister | RegisterSpace | ShaderVisibility |
damyanp marked this conversation as resolved.
Show resolved Hide resolved
|--------|----------|----------|----------|------------|---------------|----------------|-------------|--------|--------|----------------|---------------|------------------|
| int | int | int | int | float | int | int | int | float | float | int | int | int |
damyanp marked this conversation as resolved.
Show resolved Hide resolved

* RootSignature

| RootFlag | Parameters | StaticSamplers |
|----------|-------------------------------------------------|-------------------------|
| int | list of RootDescriptor/RootConstant/DescriptorTable | list of StaticSamplers |
damyanp marked this conversation as resolved.
Show resolved Hide resolved

* Function RootSignature pair

| EntryFunction | RootSignature |
|----------|----------------|
| Function | RootSignature |

* RootSignature table

Named metadata with name "dx.rootsignatures".

| Function RootSignature Pairs |
|-------------------------------------|
| list of Function RootSignature Pair |
damyanp marked this conversation as resolved.
Show resolved Hide resolved

Example for same root signature as above:

```llvm
; placeholder - update this once detailed design complete
!directx.rootsignatures = !{!2}
!dx.rootsignatures = !{!2}
!2 = !{ptr @main, !3 }
!3 = !{ !4, !5, !6, !7 } ; reference 4 root parameters
!4 = !{ !"RootFlags", i32 1 } ; root flags, 1 is numeric value of flags
!5 = !{ !"RootCBV", i32 0, i32 1, i32 0, i32 0 } ; register 0, space 1, 0 = visiblity, 0 = flags
!6 = !{ !"StaticSampler", i32 1, i32 0, ... } ; register 1, space 0, (additional params omitted)
!7 = !{ !"DescriptorTable", i32 0, !8, !9 } ; 0 = visibility, 2 ranges,!8 and !9
!8 = !{ !"SRV", i32 0, i32 0, i32 -1, i32 0 } ; register 0, space 0, unbounded, flags 0
!9 = !{ !"UAV", i32 5, i32 1, i32 10, i32 0 } ; register 5, space 1, 10 descriptors, flags 0
!7 = !{ !"DescriptorTable", i32 0, !8 } ; 0 = visibility, range list !8
!8 = !{ !9, !10} ; reference 2 descriptor ranges
!9 = !{ !"SRV", i32 0, i32 0, i32 -1, i32 0 } ; register 0, space 0, unbounded, flags 0
!10 = !{ !"UAV", i32 5, i32 1, i32 10, i32 0 } ; register 5, space 1, 10 descriptors, flags 0
```


Expand Down