Methane Kit v0.8.0: enhance program bindings configuration, performance and simplified shader buffer arguments setup with root constants #147
Conversation
egorodet
added
enhancement
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #147 +/- ##
===========================================
+ Coverage 25.19% 36.20% +11.02%
===========================================
Files 367 381 +14
Lines 14372 19490 +5118
Branches 0 1786 +1786
===========================================
+ Hits 3619 7055 +3436
- Misses 10753 12257 +1504
- Partials 0 178 +178
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Win64_DX_SonarScan Test Results 8 files ± 0 8 suites ±0 5s ⏱️ ±0s Results for commit b5222a5. ± Comparison against base commit 4c66c85. This pull request removes 1 and adds 477 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Ubuntu_VK_SonarScan Test Results 8 files ± 0 8 suites ±0 1s ⏱️ ±0s Results for commit b5222a5. ± Comparison against base commit 4c66c85. This pull request removes 1 and adds 477 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
MacOS_MTL_SonarScan Test Results 8 files ± 0 8 suites ±0 1s ⏱️ ±0s Results for commit b5222a5. ± Comparison against base commit 4c66c85. This pull request removes 1 and adds 477 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Win64_VK_Release Test Results 8 files ± 0 8 suites ±0 0s ⏱️ ±0s Results for commit b5222a5. ± Comparison against base commit 4c66c85. This pull request removes 1 and adds 477 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Win32_DX_Release Test Results 8 files ± 0 8 suites ±0 0s ⏱️ ±0s Results for commit b5222a5. ± Comparison against base commit 4c66c85. This pull request removes 1 and adds 477 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
MacOS_VK_Release Test Results 8 files ± 0 8 suites ±0 1s ⏱️ ±0s Results for commit b5222a5. ± Comparison against base commit 4c66c85. This pull request removes 1 and adds 477 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Win32_VK_Release Test Results 8 files ± 0 8 suites ±0 0s ⏱️ ±0s Results for commit b5222a5. ± Comparison against base commit 4c66c85. This pull request removes 1 and adds 477 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
MacOS_MTL_Release Test Results 8 files ± 0 8 suites ±0 0s ⏱️ ±0s Results for commit b5222a5. ± Comparison against base commit 4c66c85. This pull request removes 1 and adds 477 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Ubuntu_VK_Release Test Results 8 files ± 0 8 suites ±0 11s ⏱️ ±0s Results for commit b5222a5. ± Comparison against base commit 4c66c85. This pull request removes 1 and adds 477 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Win64_DX_Release Test Results 8 files ± 0 8 suites ±0 0s ⏱️ ±0s Results for commit b5222a5. ± Comparison against base commit 4c66c85. This pull request removes 1 and adds 477 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Modules/Graphics/RHI/Base/Include/Methane/Graphics/Base/ProgramArgumentBinding.h
Dismissed
Show dismissed
Hide dismissed
Modules/Graphics/RHI/Vulkan/Sources/Methane/Graphics/Vulkan/ProgramBindings.cpp
Dismissed
Show dismissed
Hide dismissed
Modules/Graphics/RHI/Interface/Sources/Methane/Graphics/RHI/ProgramArgument.cpp
Dismissed
Show dismissed
Hide dismissed
|
|
|
Summary
In Methane Kit v0.8.0, several significant enhancements have been introduced:
Tutorial applications
Graphics libraries
META_ARG_CONSTANT,META_ARG_FRAME_CONSTANT,META_ARG_MUTABLE), to replace shader arguments configurationRhi::ProgramArgumentAccessorsinProgramSettings. RHI shader arguments reflection uses these register space definitions to add default argument accessors configuration, so that it is not necessary to be defined in user code ofProgramSettings.Rhi::RootConstantclass was added as a storage of constant data (derived fromData::Chunk), which can be set to buffer argument bindings, defined withProgramArgumentValueType::RootConstantBufferinRhi::ProgramArgumentAccessors.Rhi::IProgramBindings::SetRootConstantallows to set root constant data for such argument bindings. Internally managedRhi::RootConstantBufferobjects significantly simplify user code by eliminating the need in creating separate uniform buffers. Support ofRoot32BitConstantsin DirectX andPushConstantsin Vulkan andSetBytesin Metal was added viaRhi::ProgramArgumentValueType::RootConstantValue(close Extend Program Bindings with support of "Push Constants" native API #140).Metal::ProgramBindingsin Metal RHI were extended with Metal Argument Buffers API support for more efficient shader argument bindings, similar to descriptor tables in DirectX 12 and descriptor sets in Vulkan. CMake optionMETHANE_METAL_ARGUMENT_BUFFERS_ENABLEDwas added to allow switching between direct resource binding and argument buffers (enabled by default). Metal argument buffers are created independently for groups of shader arguments with different argument access types. (close Metal RHI improvement: Add support of MTLArgumentBuffer in program bindings #138)Metal::ProgramBindingswere refactored to reduce code duplication with help of templates.ProgramArgumentandProgramArgumentAccessortypes were moved fromIProgram.hheader toProgramArgument.h/cpp.ProgramArgumentAccessModifierenum was renamed toProgramArgumentValueType.ProgramArgument.hto simplify program argument accessors setup:META_PROGRAM_ARG_*(ROOT_CONSTANT,ROOT_FRAME_CONSTANT,ROOT_MUTABLE,RESOURCE_CONSTANT,RESOURCE_FRAME_CONSTANT,RESOURCE_MUTABLE, etc.).CommandListDebugGroupsub-group names now usestd::string_viewScreenQuadwas migrated to root constants instead of uniform buffer.Data libraries
priorityargument of methodEmitter<ICallback>::Connect(Receiver<ICallback>& receiver, uint32_t priority).Common changes
META_CHECK_ARG_*by removal of ARG suffix toMETA_CHECK_*.User Interface libraries
Tests
ViewStatetest was addedFencetest was extendedBufferSettest was addedCommandKittest was addedCommandListDebugGrouptest was addedProgramBindingstest was extended with root constant bindings.Data::EventsTestwas extended to check prioritizing of connected receivers.External libraries
v1.7.2308v1.3.296.0v1.1v0.40.5v0.11.2.1v1.3.296v1.3.296.0v2.0.6(oct 2024)v2.13.3v11.0.210.12.2024v3.25.3v3.7.1v0.9.7v5.0.0v1.87.0v3.5.3v3.8.0Build
CMakeModules/FindWindowsSDK.cmakewith fix for ARM64 architecture detection with VS2022 and Ninja and detection of the latest Windows SDK version 10.0.22621./usr/local/libwas added to findlibvulkan.1.libMETHANE_METAL_FRAMES_SYNC_WITH_DISPATCH_SEMAPHOREBuild\Windows\Build.batwas extended with more build options.Continuous Integration
macos-13hosted runners to use Intel h/w, instead of M1/ARM, which is not supported yet.Documentation
CubeMapArrayandParallelRenderingtutorials.