Methane Kit v0.7.2: add initial compute pipeline support and RHI unit tests #121

egorodet · 2023-05-28T07:41:17Z

Tutorial applications

Console Compute tutorial was added to demonstrate GPU compute pipeline on Conway's Game of Life example implemented in pure-console application with FTXUI library.

Graphics libraries

New Graphics RHI classes were added to support compute pipeline (close Compute pipeline support #8):
- ComputeContext
- ComputeCommandList
- ComputeState
Added ShaderType::Compute shader type support.
Added CommandListType::Compute support in CommandQueue.
Added DeviceCaps::compute_queues_count.
Added Unordered Access View support for read and write texture data from shader.
Added Texture and Buffer read-back support via GetData methods.
Removed common GetData and SetData methods from base interface IResource in favour of separate methods added in the derived IBuffer and ITexture interfaces to differentiate argument types and get rid of unwanted methods in ISampler interface.
IResource methods GetSubresourceCount and GetSubresourceDataSize methods from were moved to ITexture interface.
Fixed some DirectX and Vulkan validation warnings.

User Interface

Fix rare crash on text mesh update.

Data libraries

FpsCounter interface and implementation was moved from Graphics/RHI to Data/Primitives to allow using it independently from RHI RenderContext.
Enable Chunk copy and move constructors and operators.

Tests

Initial unit-tests were added for "Graphics RHI" layer, implemented using "Null RHI" backed (continue Add Graphics RHI unit tests #122):
- Shader Test
- Sampler Test
- Fence Test
- CommandQueue Test
- ComputeState Test
- Texture Test
- ProgramBindings Test
- TransferCommandList Test
- Program Test
- ComputeContext Test
- Buffer Test
- ComputeCommandList Test

External libraries

FTXUI library v4.0.0 was added
HLSL++ was updated to v3.3.1
CPM.cmake was update to v0.38.0
Tracy was updated to v0.9.1

Build

Cleaned up root CMakeLists.txt
Build with new Xcode 14.3 was supported by rewriting deprecated functions which were removed.
Apple deployment target versions were bumped to use new shader reflections API:
- MacOS 10.15 -> 13.0
- iOS 15.0 -> 16.0

Continuous Integration

Fixed reporting of failed unit tests: previously builds were terminating on any test failure, now builds are still failing by unit-tests but they perform all reporting operations.
Sonar-scan build is now automatically finding all test result xml files.
Added CodeCove components.

Documentation

ReadME documentation was added for "Console Compute" tutorial.
Update code in other tutorials documentation to reflect changes in Resource, Buffer and Texture methods.

…alsCache by default

…d Null RHI backends

…ompatibility check, fix Vulkan compute device creation

…eCompute tutorial

…lures

…nd List

ID3D12Device::CreateCommittedResource: Ignoring InitialState D3D12_RESOURCE_STATE_COPY_DEST. Buffers are effectively created in state D3D12_RESOURCE_STATE_COMMON.

codecov · 2023-05-28T07:59:17Z

Codecov Report

Patch coverage: 57.81% and project coverage change: -0.08 ⚠️

Comparison is base (499d420) 29.98% compared to head (0afb15f) 29.89%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #121      +/-   ##
==========================================
- Coverage   29.98%   29.89%   -0.08%     
==========================================
  Files         393      375      -18     
  Lines       23370    18455    -4915     
  Branches     1979     1075     -904     
==========================================
- Hits         7004     5516    -1488     
+ Misses      16225    12762    -3463     
- Partials      141      177      +36

Flag	Coverage Δ
linux	`23.64% <50.44%> (-1.61%)`	⬇️
macosx	`48.80% <68.30%> (+4.30%)`	⬆️
unittests	`29.89% <57.81%> (-0.08%)`	⬇️
windows	`53.00% <74.58%> (+27.11%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...mon/Instrumentation/Sources/Methane/ScopeTimer.cpp	`0.00% <ø> (ø)`
.../Data/Primitives/Include/Methane/Data/FpsCounter.h	`100.00% <ø> (ø)`
...Data/Primitives/Include/Methane/Data/IFpsCounter.h	`35.72% <ø> (ø)`
...ata/Primitives/Sources/Methane/Data/FpsCounter.cpp	`0.00% <ø> (ø)`
...ta/Primitives/Sources/Methane/Data/IFpsCounter.cpp	`0.00% <ø> (ø)`
.../Graphics/App/Sources/Methane/Graphics/AppBase.cpp	`0.00% <0.00%> (ø)`
...rimitives/Include/Methane/Graphics/MeshBuffers.hpp	`0.00% <0.00%> (ø)`
...rimitives/Sources/Methane/Graphics/ImageLoader.cpp	`0.00% <0.00%> (ø)`
...tives/Sources/Methane/Graphics/MeshBuffersBase.cpp	`0.00% <0.00%> (ø)`
...Primitives/Sources/Methane/Graphics/ScreenQuad.cpp	`0.00% <0.00%> (ø)`
... and 105 more

... and 84 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

sonarcloud · 2023-05-29T20:29:01Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

41.8% Coverage
2.0% Duplication

sonarcloud · 2023-05-29T20:33:12Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

39.5% Coverage
2.0% Duplication

sonarcloud · 2023-05-29T20:42:13Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
2 Code Smells

52.8% Coverage
2.0% Duplication

github-actions · 2023-05-29T20:53:02Z

Package	Line Rate	Branch Rate	Health
Default	51%	21%	➖
Summary	51% (12688 / 24964)	21% (3624 / 17168)	➖

github-actions · 2023-05-29T20:53:02Z

Package	Line Rate	Branch Rate	Health
Default	38%	100%	➖
Summary	38% (7679 / 20087)	100% (0 / 0)	➖

github-actions · 2023-05-29T20:53:04Z

Package	Line Rate	Branch Rate	Health
D:\a\MethaneKit\MethaneKit\Build\Output\Ninja-Win-DX-Scan\Install\Tests\MethaneDataEventsTest.exe	95%	100%	✔
D:\a\MethaneKit\MethaneKit\Build\Output\Ninja-Win-DX-Scan\Install\Tests\MethaneDataRangeSetTest.exe	91%	100%	✔
D:\a\MethaneKit\MethaneKit\Build\Output\Ninja-Win-DX-Scan\Install\Tests\MethaneDataTypesTest.exe	98%	100%	✔
D:\a\MethaneKit\MethaneKit\Build\Output\Ninja-Win-DX-Scan\Install\Tests\MethaneGraphicsCameraTest.exe	61%	100%	➖
D:\a\MethaneKit\MethaneKit\Build\Output\Ninja-Win-DX-Scan\Install\Tests\MethaneGraphicsRhiTest.exe	43%	100%	➖
D:\a\MethaneKit\MethaneKit\Build\Output\Ninja-Win-DX-Scan\Install\Tests\MethaneGraphicsTypesTest.exe	98%	100%	✔
D:\a\MethaneKit\MethaneKit\Build\Output\Ninja-Win-DX-Scan\Install\Tests\MethanePlatformInputTest.exe	43%	100%	➖
D:\a\MethaneKit\MethaneKit\Build\Output\Ninja-Win-DX-Scan\Install\Tests\MethaneUserInterfaceTypesTest.exe	9%	100%	❌
Summary	34% (4497 / 13281)	100% (0 / 0)	➖

github-actions · 2023-05-29T20:59:23Z

Win64_VK_Release Test Results

✅ 3125 tests passed
❌ 0 tests failed
⚠️ 0 tests skipped
⏱️ 988 ms. run duration

github-actions · 2023-05-29T20:59:23Z

Win32_VK_Release Test Results

✅ 3125 tests passed
❌ 0 tests failed
⚠️ 0 tests skipped
⏱️ 952 ms. run duration

github-actions · 2023-05-29T20:59:24Z

Ubuntu_VK_Release Test Results

✅ 3126 tests passed
❌ 0 tests failed
⚠️ 0 tests skipped
⏱️ 14136 ms. run duration

github-actions · 2023-05-29T20:59:25Z

Win32_DX_Release Test Results

✅ 3125 tests passed
❌ 0 tests failed
⚠️ 0 tests skipped
⏱️ 982 ms. run duration

github-actions · 2023-05-29T20:59:26Z

Win64_DX_Release Test Results

✅ 3125 tests passed
❌ 0 tests failed
⚠️ 0 tests skipped
⏱️ 999 ms. run duration

github-actions · 2023-05-29T20:59:27Z

MacOS_MTL_Release Test Results

✅ 3125 tests passed
❌ 0 tests failed
⚠️ 0 tests skipped
⏱️ 977 ms. run duration

egorodet added 30 commits February 11, 2023 20:02

Add ComputeCommandList dummy interface and implementations

3a375e9

Fix MacOS build

a7cc9cb

Cleanup root CMakeLists, move CPM source cache to Build/Output/Extern…

ff2524c

…alsCache by default

Add CodeCove components

10bcc85

Remove unused textures

59cce05

Re-enable CTest via root CMakeLists

e9c5664

Merge branch 'master' into develop

85106ee

Merge branch 'master' into develop

0f40102

Add ComputeState interface and implementations for DirectX, Vulkan an…

04d2ccc

…d Null RHI backends

Add ComputeState implementation for Metal backend and RHI PIMPL class

6680506

Add ComputeState factory function for Metal

f5713a3

Add Compute shaders support to Metal

5d8952f

Add Compute shaders support to DirectX and Vulkan

d84de04

Fix non-portable header paths

a78fd3c

Add RHI ComputeContext

cfa812b

Fix DirectX build

9c370fd

Fix DirectX Scan build

9fa8d92

Update CPM.cmake to v.0.38

1ec7e69

Update Tracy client to v.0.9.1

d661dc4

Update version of Tracy binaries in Profile builds

0d1b069

Add initial ConsoleCompute tutorial app based on FTXUI

45cf97e

Exclude tracy repository download when Tracy option is not enabled

1d57d50

Fix Build errors

f535ac8

Initial UI implementation for Console Compute tutorial

352e746

Add compute_command_queues count to DeviceCaps, fix device features c…

8a97501

…ompatibility check, fix Vulkan compute device creation

Add graphics API and available devices radio-box to Console Compute UI

33a7c1a

Fix DirectX device capabilities check

ca11529

Fix Apple build

9144fca

Add missing Compute PIMPL constructors and factory functions

c1f48d1

Add ComputeContext, Program and ComputeState initialization in Consol…

e598058

…eCompute tutorial

egorodet added 9 commits May 26, 2023 22:26

Fix tests running after failure on Linux and Mac (5-th attempt)

51577f8

Fix adding test result comments and collect GCov coverage on test fai…

a46a358

…lures

Fix ProgramBindings conversion to string operator

57395dd

Fix Vulkan validation error on set Resource Barriers in Compute Comma…

d97b641

…nd List

Fix DirectX debug warning (CREATERESOURCE_STATE_IGNORED):

8e1619a

ID3D12Device::CreateCommittedResource: Ignoring InitialState D3D12_RESOURCE_STATE_COPY_DEST. Buffers are effectively created in state D3D12_RESOURCE_STATE_COMMON.

Fix crash on text mesh update

d82148f

Fix graphics objects release

c145f3d

Fix Vulkan validation warning in VkImageSubresourceRange::aspectMask

d52105a

Add more controls description in Console Compute tutorial

e209f47

egorodet added enhancement New feature or request testing Tests automation labels May 28, 2023

egorodet added this to the v0.7 milestone May 28, 2023

egorodet self-assigned this May 28, 2023

egorodet added 3 commits May 28, 2023 23:36

Add FTXUI library to Externals README.md

444b85d

Remove odd noexcept

b3e10e9

Update SetData usage in documents

0afb15f

egorodet merged commit 4299e05 into master May 30, 2023
47 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Methane Kit v0.7.2: add initial compute pipeline support and RHI unit tests #121

Methane Kit v0.7.2: add initial compute pipeline support and RHI unit tests #121

egorodet commented May 28, 2023 •

edited

codecov bot commented May 28, 2023 •

edited

sonarcloud bot commented May 29, 2023

sonarcloud bot commented May 29, 2023

sonarcloud bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

Methane Kit v0.7.2: add initial compute pipeline support and RHI unit tests #121

Methane Kit v0.7.2: add initial compute pipeline support and RHI unit tests #121

Conversation

egorodet commented May 28, 2023 • edited

Tutorial applications

Graphics libraries

User Interface

Data libraries

Tests

External libraries

Build

Continuous Integration

Documentation

codecov bot commented May 28, 2023 • edited

Codecov Report

sonarcloud bot commented May 29, 2023

sonarcloud bot commented May 29, 2023

sonarcloud bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

Win64_VK_Release Test Results

github-actions bot commented May 29, 2023

Win32_VK_Release Test Results

github-actions bot commented May 29, 2023

Ubuntu_VK_Release Test Results

github-actions bot commented May 29, 2023

Win32_DX_Release Test Results

github-actions bot commented May 29, 2023

Win64_DX_Release Test Results

github-actions bot commented May 29, 2023

MacOS_MTL_Release Test Results

egorodet commented May 28, 2023 •

edited

codecov bot commented May 28, 2023 •

edited