-
Notifications
You must be signed in to change notification settings - Fork 15.3k
[DirectX] Updating DXContainer documentation to add Root Descriptors #129759
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.
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
Closed
joaosaffran
wants to merge
6
commits into
llvm:users/joaosaffran/129569
from
joaosaffran:documentation/root-descriptors
Closed
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b390cd2
Adding root descriptor subsection
joaosaffran 46face1
Fix git error
joaosaffran 6a260b3
Try fix test
joaosaffran b591fd8
Linking Direct X docs to details flags
joaosaffran 583e29c
Detail RootDescriptorFlags enum
joaosaffran 73c645d
Addressing comments
joaosaffran File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -497,3 +497,49 @@ signature and passed to the shader without requiring a constant buffer resource: | |||||||
| #. **Num32BitValues**: The number of 32-bit values included in this constant buffer. | ||||||||
|
|
||||||||
| Root constants provide a fast way to pass small amounts of data directly to the shader without the overhead of creating and binding a constant buffer resource. | ||||||||
|
|
||||||||
| Root Descriptor | ||||||||
| ~~~~~~~~~~~~~~~ | ||||||||
|
|
||||||||
| Root descriptors provide a direct mechanism for binding individual resources to shader stages in the Direct3D 12 | ||||||||
| rendering pipeline. They represent a critical interface for efficient resource management, allowing applications | ||||||||
| to specify how shader stages access specific GPU resources. | ||||||||
|
|
||||||||
| .. code-block:: cpp | ||||||||
|
|
||||||||
| enum RootDescriptorFlags { | ||||||||
| None = 0, | ||||||||
| DataVolatile = 0x2, | ||||||||
| DataStaticWhileSetAtExecute = 0x4, | ||||||||
| DataStatic = 0x8, | ||||||||
| } | ||||||||
|
|
||||||||
| // Version 1.0 Root Descriptor | ||||||||
| struct RootDescriptor_V1_0 { | ||||||||
| uint32_t ShaderRegister; | ||||||||
| uint32_t RegisterSpace; | ||||||||
| }; | ||||||||
|
|
||||||||
| // Version 1.1 Root Descriptor | ||||||||
| struct RootDescriptor_V1_1 { | ||||||||
| uint32_t ShaderRegister; | ||||||||
| uint32_t RegisterSpace; | ||||||||
| // Bitfield of flags from the Flags enum | ||||||||
| uint32_t Flags; | ||||||||
| }; | ||||||||
|
|
||||||||
| Version 1.1 of Root Descriptors has introduced some flags that can hint the drivers into | ||||||||
| performing further code optimizations. For details about it, check `Direct X documentation <https://learn.microsoft.com/en-us/windows/win32/direct3d12/root-signature-version-1-1#static-and-volatile-flags>`_. | ||||||||
|
||||||||
| performing further code optimizations. For details about it, check `Direct X documentation <https://learn.microsoft.com/en-us/windows/win32/direct3d12/root-signature-version-1-1#static-and-volatile-flags>`_. | |
| performing further code optimizations. For details, check | |
| `Direct X documentation <https://learn.microsoft.com/en-us/windows/win32/direct3d12/root-signature-version-1-1#static-and-volatile-flags>`_. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Imo, this strays away from the
what and howtone throughout this document and intowhy. I think the previous pr did a good job of keeping that tone, which I presume is what we would like.