Fix ambiguous text of GetCopyableFootprints function #2131
Merged
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.
The current explanation for
BaseOffsetparameter is ambiguous. It is described asThe offset, in bytes, to the resource., which can be incorrectly interpreted as an offset of the resource represented by thepResourceDescparameter.In the function,
BaseOffsetis not an offset for the resource. Instead, it is a value that is simply added to theOffsetof each subresource layout in the outputpLayoutsarray.For reference, see
d3dx12.hversion ofGetCopyableFootprints: https://github.com/microsoft/DirectX-Headers/blob/18d5bfe96452667b201fd26aa25c6c305ae57e07/include/directx/d3dx12_resource_helpers.h#L520