egorodet commented 1 year ago

Graphics

Fixed Vulkan support on MacOS via MoltenVK with a workaround of MoltenVK bug by disabling timeline semaphore values attached to vk::SubmitInfo in vk::Queue::submit call (see FIXME comment in Vulkan::CommandListSet::Execute()). All tutorials can now run on MacOS using Vulkan RHI.
Fixed memory corruption and occasional crash on Linux on attemp to set debug name for surface using vkSetDebugUtilsObjectNameEXT in Vulkan::RenderContext. It is not possible to set debug name for surface because it is not created with devide object, unfortunately Vulkan validation layer does not report this error but simply corrupts memory, which is resulting in undefined behaviour.
Improved Vulkan::RenderContext frame synchronization reliability by adding vk::Fence wait of the previously acquired images before aquiring next frame image.
Added support of ErrorSurfaceLostKHR on acquireNextImageKHR by recreating surface and swap-chain in Vulkan::RenderContext.
Fixed race in multi-threaded access to CommandListSet shared pointers in Base::CommandQueueTracking.
Fixed invalid Vulkan buffer size alignment resulting in heap memory overrun.
Removed explicit BufferSettings::size alignment by 256 bytes in RHI/IBuffer.h/cpp, but do it implicitly inside DirectX RHI implementation.

Tutorials

Replaced IndexedName function with explicit fmt::format.
All tutorials were cleaned up from memory errors and can run successfully with Memory Address Sanitizer enabled in build options for all APIs and platforms.

External Libraries

Catch2 was updated v3.1.0 -> v3.4.0,
CLI11 was updated v2.2.0 -> v2.3.2,
CMRC was updated v2.0.1 -> v2.0.2,
CPM was updated v0.38.0 -> v0.38.2,
FMT was updated v8.1.1 -> v10.0.0,
FTXUI was updated v4.0.0 -> v4.1.1
ITT Api was updated v3.23.0 -> v3.24.2
MagicEnum was updated v0.8.0 -> v0.9.3
TaskFlow was updated v3.4.0 -> v3.6.0
STB was updated 2021-09-10 -> 2023-01-29

Build

Added new CMake option METHANE_MEMORY_SANITIZER_ENABLED to enable build with memory address sanitizer.
Added MacOS_VK_Release job to CI Build workflow, which builds Methane Kit with Vulkan RHI on MacOS using static linking with MoltenVK framework from Vulkan SDK.
Added optional step to CI Build jobs "Install Vulkan SDK", which is currently required for MacOS_VK_Release job only to link with MoltenVK framework.
Disabled some CI Build steps and workflows in Forked GitHub repositories to let CI pass successfully for pushes.
Updated GitHub Action sonarcloud-github-c-cpp to v2 in "CI Scan" workflow. Sonar Scanner was upgraded from v4.8 to v5.0 as well.

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 12.58% and project coverage change: -0.05% :warning:

Comparison is base (7733343) 29.59% compared to head (2627d3b) 29.53%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #128 +/- ## ========================================== - Coverage 29.59% 29.53% -0.05% ========================================== Files 376 376 Lines 18647 18698 +51 Branches 1082 1083 +1 ========================================== + Hits 5516 5521 +5 - Misses 12954 13000 +46 Partials 177 177 ``` | Flag | Coverage Δ | | |---|---|---| | linux | `23.33% <11.45%> (-0.03%)` | :arrow_down: | | macosx | `48.41% <34.29%> (-0.04%)` | :arrow_down: | | unittests | `29.53% <12.58%> (-0.05%)` | :arrow_down: | | windows | `52.64% <37.04%> (-0.03%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files Changed](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered) | Coverage Δ | | |---|---|---| | [...dules/Data/RangeSet/Include/Methane/Data/Range.hpp](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#diff-TW9kdWxlcy9EYXRhL1JhbmdlU2V0L0luY2x1ZGUvTWV0aGFuZS9EYXRhL1JhbmdlLmhwcA==) | `100.00% <ø> (ø)` | | | [.../Data/RangeSet/Include/Methane/Data/RangeUtils.hpp](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#diff-TW9kdWxlcy9EYXRhL1JhbmdlU2V0L0luY2x1ZGUvTWV0aGFuZS9EYXRhL1JhbmdlVXRpbHMuaHBw) | `0.00% <ø> (ø)` | | | [Modules/Data/Types/Include/Methane/Data/Math.hpp](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#diff-TW9kdWxlcy9EYXRhL1R5cGVzL0luY2x1ZGUvTWV0aGFuZS9EYXRhL01hdGguaHBw) | `85.72% <0.00%> (ø)` | | | [...ules/Graphics/App/Include/Methane/Graphics/App.hpp](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#diff-TW9kdWxlcy9HcmFwaGljcy9BcHAvSW5jbHVkZS9NZXRoYW5lL0dyYXBoaWNzL0FwcC5ocHA=) | `0.00% <0.00%> (ø)` | | | [...es/Graphics/App/Include/Methane/Graphics/AppBase.h](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#diff-TW9kdWxlcy9HcmFwaGljcy9BcHAvSW5jbHVkZS9NZXRoYW5lL0dyYXBoaWNzL0FwcEJhc2UuaA==) | `0.00% <ø> (ø)` | | | [.../Graphics/App/Sources/Methane/Graphics/AppBase.cpp](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#diff-TW9kdWxlcy9HcmFwaGljcy9BcHAvU291cmNlcy9NZXRoYW5lL0dyYXBoaWNzL0FwcEJhc2UuY3Bw) | `0.00% <ø> (ø)` | | | [...rimitives/Include/Methane/Graphics/MeshBuffers.hpp](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#diff-TW9kdWxlcy9HcmFwaGljcy9QcmltaXRpdmVzL0luY2x1ZGUvTWV0aGFuZS9HcmFwaGljcy9NZXNoQnVmZmVycy5ocHA=) | `0.00% <0.00%> (ø)` | | | [...rimitives/Sources/Methane/Graphics/ImageLoader.cpp](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#diff-TW9kdWxlcy9HcmFwaGljcy9QcmltaXRpdmVzL1NvdXJjZXMvTWV0aGFuZS9HcmFwaGljcy9JbWFnZUxvYWRlci5jcHA=) | `0.00% <ø> (ø)` | | | [...tives/Sources/Methane/Graphics/MeshBuffersBase.cpp](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#diff-TW9kdWxlcy9HcmFwaGljcy9QcmltaXRpdmVzL1NvdXJjZXMvTWV0aGFuZS9HcmFwaGljcy9NZXNoQnVmZmVyc0Jhc2UuY3Bw) | `0.00% <ø> (ø)` | | | [...Base/Include/Methane/Graphics/Base/RenderContext.h](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered#diff-TW9kdWxlcy9HcmFwaGljcy9SSEkvQmFzZS9JbmNsdWRlL01ldGhhbmUvR3JhcGhpY3MvQmFzZS9SZW5kZXJDb250ZXh0Lmg=) | `42.86% <ø> (ø)` | | | ... and [23 more](https://app.codecov.io/gh/MethanePowered/MethaneKit/pull/128?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MethanePowered) | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

17.1% Coverage
2.5% Duplication

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

10.3% Coverage
2.5% Duplication

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

10.7% Coverage
2.5% Duplication