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

Better D3D12 Convert #1362

Merged
merged 108 commits into from
Dec 1, 2023
Merged

Better D3D12 Convert #1362

merged 108 commits into from
Dec 1, 2023

Conversation

andrew-lunarg
Copy link
Contributor

@andrew-lunarg andrew-lunarg commented Nov 18, 2023 •
edited
Loading

  • Vulkan and DX12 Consumers and annotation handling piped through a common JsonWriter class.
  • DX12 Consumer using nlohmann JSON library with JsonWriter in same style as Vulkan consumer.
  • FieldToJson functions using nlohmann for DX12/DXGI enums.
  • FieldToJson functions using nlohmann for DX12/DXGI structs.
  • MetataData and Marker block Consumer template classes that can be shimmed into inheritance hierarchy of both consumers, to handle those block types uniformly with one definition of each process function but without any overhead of composition through virtual multiple inheritance or through indirection to achieve aggregation.

Fixes: #1349, ...

Extra Bonus Content

@andrew-lunarg andrew-lunarg added convert Issue with convert execution or output d3d12 Issue with D3D 12 support labels Nov 18, 2023
@andrew-lunarg andrew-lunarg self-assigned this Nov 18, 2023
@ci-tester-lunarg
Copy link

CI gfxreconstruct build queued with queue ID 86101.

@ci-tester-lunarg
Copy link

CI gfxreconstruct build # 3527 running.

@ci-tester-lunarg
Copy link

CI gfxreconstruct build queued with queue ID 86121.

This was referenced Nov 18, 2023
Merged
Open
@ci-tester-lunarg
Copy link

CI gfxreconstruct build # 3528 running.

@ci-tester-lunarg
Copy link

CI gfxreconstruct build queued with queue ID 86174.

@ci-tester-lunarg
Copy link

CI gfxreconstruct build # 3529 running.

@ci-tester-lunarg
Copy link

CI gfxreconstruct build # 3529 passed.

@andrew-lunarg andrew-lunarg force-pushed the andy-enhance-better-d3d12-convert branch from 105dce4 to d7fe08c Compare November 20, 2023 14:56
@ci-tester-lunarg
Copy link

CI gfxreconstruct build queued with queue ID 87216.

@ci-tester-lunarg
Copy link

CI gfxreconstruct build # 3532 running.

@ci-tester-lunarg
Copy link

CI gfxreconstruct build queued with queue ID 87274.

@andrew-lunarg
Copy link
Contributor Author

andrew-lunarg commented Nov 20, 2023 •
edited
Loading

Closing temporarily just to avoid kicking off CI builds as I refine the PR to be ready for review.

@andrew-lunarg andrew-lunarg reopened this Nov 26, 2023
andrew-lunarg and others added 23 commits December 1, 2023 20:10
@andrew-lunarg
Convert Custom Decoded_D3D12_STATE_SUBOBJECT
9d0824e
@andrew-lunarg
Comment Cleanup
4278ad6 
Trivia in json_blocklists.json
Various C++ and Python Comment Trivia
DX12 JSON Consumer Cleanup: Removed commented-out
self.APICALL_BLACKLIST.append()s after checking a bunch of them
for the generated code. All seemed fine.
@andrew-lunarg
Moved Some DX12 Json Helper Code
b17cc84 
Moved out of dx12_json_consumer_base.cpp
String code to util/strings.*
Json code to util/json_util.*
@andrew-lunarg
DX12 Convert - Better Return Value Generation
32374c8 
Enums printed prettily.
Fewer comments in generated file.
@andrew-lunarg
Convert DX12 --expand-flags Supported
f1f3f34
@andrew-lunarg
Moved AnnotationTypeToString to util/to_string.h
4197bd1
@andrew-lunarg
Custom D3D12_CPU_DESCRIPTOR_HANDLE to Json
2d3cc87
@andrew-lunarg
Reduced Verbosity of Some Convert D3D12 Warnings
9ebde99
@andrew-lunarg
Documented dx12_struct_decoders_to_json_body_...py
edecdde 
dx12_struct_decoders_to_json_body_generator.py
Big documentation block for the next person to work on it.
Moved function up for readability / understanding.
@andrew-lunarg
Quiet Github ClangFormat Whitespace Complaint
147466d 
These keep coming even though I run v14 locally on ubuntu (WSL)
which is same as used on runner according to logs.
This time: json_writer.cpp.
@andrew-lunarg
Convert Masks to Binary for D3D12
0f20611 
Convert masks which don't have enums defining possible bit values into
binary numbers encoded in strings using the same format as C++14
binary literals.

Examples:

"DepthStencilState": {
          "DepthEnable": true,
          "DepthWriteMask": "D3D12_DEPTH_WRITE_MASK_ALL",
          "DepthFunc": "D3D12_COMPARISON_FUNC_LESS",
          "StencilEnable": false,
          "StencilReadMask": "0b11111111",
          "StencilWriteMask": "0b11111111", <--------
          "FrontFace": {
            "StencilFailOp": "D3D12_STENCIL_OP_KEEP",
            "StencilDepthFailOp": "D3D12_STENCIL_OP_KEEP",

"RenderTarget": [
            {
              "BlendEnable": false,
              "LogicOpEnable": false,
              "SrcBlend": "D3D12_BLEND_ONE",
              "DestBlend": "D3D12_BLEND_ZERO",
              "BlendOp": "D3D12_BLEND_OP_ADD",
              "SrcBlendAlpha": "D3D12_BLEND_ONE",
              "DestBlendAlpha": "D3D12_BLEND_ZERO",
              "BlendOpAlpha": "D3D12_BLEND_OP_ADD",
              "LogicOp": "D3D12_LOGIC_OP_NOOP",
              "RenderTargetWriteMask": "0b00001111" <------------
            },
@andrew-lunarg
Convert ProcessInitDx12AccelerationStructureCom...
96a78ca 
Pretty output for ProcessInitDx12AccelerationStructureCommand
and InitDx12AccelerationStructureGeometryDesc.
@andrew-lunarg
Constant for Unknown ThreadID in JSON
5b1db65 
This is to cover for when thread ID is not passed to the consumers
even if it is known for the block.
When those cases are fixed, this will not be needed.
@andrew-lunarg
Deduplicated BITS_LIST Definition
0b3a153
@andrew-lunarg
DX12 Convert - Factored-out is_raw_bitflags()
762f9c1 
This Python function encapsulates the logic for deciding
whether a field or parameter is a set of flags without an
enum defining the valid flag bits.
@andrew-lunarg
DX12 Convert Comments
61d84f8 
Deleted ToDo Captured Externally - A DX12 Convert one: @todo
Optimise this include list... (Obviously we should optimise
all include lists)

Removed a ToDo and added some clarification in consumer gen of pointers
to enum flagsets.
@andrew-lunarg
Restored Enum Header Common DX12 Headers Use
d1e2500 
I had trimmed the list of headers and made the list manual but it
is better to generate the same list used by all the DX12 generated
modules.
@bradgrantham-lunarg @andrew-lunarg
fix spelling
640909b
@andrew-lunarg
Fixed Indent in Generated Struct Decoders to JSON
e6f4831
@andrew-lunarg
Removed Unused Python Variable
a203b0b
@andrew-lunarg
Removed Casts From Error Logging.
41ff04f
@andrew-lunarg
Removed Using Namespace Declarations, DX12 Convert
67dedce 
using namespace util;
@andrew-lunarg
Added Requested TODO to Move Custom Code
d0b53fd
@andrew-lunarg andrew-lunarg force-pushed the andy-enhance-better-d3d12-convert branch from 97dc6f8 to d0b53fd Compare December 1, 2023 20:11
@ci-tester-lunarg
Copy link

CI gfxreconstruct build queued with queue ID 93287.

@ci-tester-lunarg
Copy link

CI gfxreconstruct build # 3582 running.

@ci-tester-lunarg
Copy link

CI gfxreconstruct build # 3582 passed.

@andrew-lunarg andrew-lunarg merged commit 548080b into LunarG:dev Dec 1, 2023
6 checks passed
andrew-lunarg added a commit to andrew-lunarg/gfxreconstruct that referenced this pull request Dec 3, 2023
@andrew-lunarg
Convert DX12 Binary Blobs in Functions
0153c3c 
Provide a mechanism for registering function and method arguments
to be dumped to separate binary files with a single line in the
Python generator of the DX12 JSON Consumer.
Example usage provided for one argument:

    ID3D12Device.CreateRootSignature(...,pBlobWithRootSignature)

Follow-up to PR LunarG#1362
@andrew-lunarg andrew-lunarg mentioned this pull request Dec 3, 2023
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bradgrantham-lunarg bradgrantham-lunarg bradgrantham-lunarg approved these changes

@MarkY-LunarG MarkY-LunarG MarkY-LunarG left review comments

@charles-lunarg charles-lunarg Awaiting requested review from charles-lunarg

Assignees

@andrew-lunarg andrew-lunarg

Labels
convert Issue with convert execution or output d3d12 Issue with D3D 12 support
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Dx12 Convert Should Display Masks Typed as Enumerations In Full
4 participants
@andrew-lunarg @ci-tester-lunarg @MarkY-LunarG @bradgrantham-lunarg