Add fallback rendering for other APIs #357

darksylinc · 2022-02-19T19:18:42Z

🦟 Bug fix

No ticket has been assigned for this issue.

Order in which PRs must be merged

Add necessary headers for Vulkan QML GUI backend gz-rendering#706
This PR.
- or optionally, merge this one as part of the next one aka PR 467, which includes it
Add Vulkan QML backend #467
Add CLI to switch to Vulkan & Metal backends gz-sim#1735

Summary

Until we get native API to Qt implemented, fallback system can be used
to transfer GPU (Ogre) -> CPU -> GPU (Qt)

This is important for getting APIs other than OpenGL to work with Qt.

This is slow, but it works.

Signed-off-by: Matias N. Goldberg dark_sylinc@yahoo.com.ar

Dependency

After the CI failed, I realized this PR depends on either gazebosim/gz-rendering#553 or gazebosim/gz-rendering#565 and thus cannot be merged until then.

Checklist

Signed all commits for DCO
Added tests
Updated documentation (as needed)
Updated migration guide (as needed)
codecheck passed (See contributing)
All tests passed (See test coverage)
While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

jennuine

Did a first pass and left some minor comments. Is it possible to add a test?

Friendly ping to @ahcorde , @WilliamLewww , or @iche033 to take a look please.

src/plugins/minimal_scene/EngineToQtInterface.cc

src/plugins/minimal_scene/EngineToQtInterface.hh

iche033 · 2022-02-22T23:39:25Z

I did a quick test with just gazebosim/gz-rendering#565 and there are some rendering issues:

looks like we'll need to test this with ogre 2.3 from gazebosim/gz-rendering#553

darksylinc · 2022-02-23T02:32:49Z

I did a quick test with just gazebosim/gz-rendering#565 and there are some rendering issues:

Was gazebosim/gz-rendering#564 merged into gazebosim/gz-rendering#565? We need the copy to work correctly otherwise the download will be problematic. In fact we force RGBA8888 and without #564 it will trigger an out of bounds read due to a preexisting bug.

iche033 · 2022-02-23T06:09:19Z

Was gazebosim/gz-rendering#564 merged into gazebosim/gz-rendering#565? We need the copy to work correctly otherwise the download will be problematic. In fact we force RGBA8888 and without #564 it will trigger an out of bounds read due to a preexisting bug.

oh I see, I didn't try this with gazebosim/gz-rendering#564 merged into gazebosim/gz-rendering#565. I'll do that first before testing with ogre 2.3

iche033 · 2022-03-05T00:12:33Z

Testing with just gazebosim/gz-rendering#564 was not enough and I got the same result. I then tested this with gazebosim/gz-rendering#553 + ogre-next v2-3 branch and it's working fine now.

So this depends on gazebosim/gz-rendering#553 so we'll need to have ign-rendering7 + ogre 2.3 ready before merging this.

darksylinc · 2022-08-07T01:18:58Z

I thought this one was already merged and had a sudden shock when I couldn't see the code in main and worse I couldn't find this PR.

I upgraded the PR to the latest changes; so it's rebased with latest main.

azeey · 2022-11-14T19:45:22Z

This requires a version bump and it needs to be retargetted to main.

Until we get native API to Qt implemented, fallback system can be used to transfer GPU (Ogre) -> CPU -> GPU (Qt) This is slow, but it works. Also simplify abstractions by merging IgnCameraTextureRhi into RenderThreadRhi. Fix codecheck errors Add documentation Use GraphicsAPI instead of CurrentGraphicsAPI Fix CMake project Signed-off-by: Matias N. Goldberg <dark_sylinc@yahoo.com.ar>

darksylinc · 2022-12-11T23:33:06Z

Rebased and retarget to main (well, this one was easy. I'd wish they'd all be like that)

codecov · 2022-12-11T23:46:34Z

Codecov Report

Merging #357 (8a272bf) into main (cc82c6d) will decrease coverage by 0.71%.
The diff coverage is 32.00%.

❗ Current head 8a272bf differs from pull request most recent head 7d77cc0. Consider uploading reports for the commit 7d77cc0 to get more accurate results

@@            Coverage Diff             @@
##             main     #357      +/-   ##
==========================================
- Coverage   69.11%   68.40%   -0.72%     
==========================================
  Files          44       45       +1     
  Lines        4919     4979      +60     
==========================================
+ Hits         3400     3406       +6     
- Misses       1519     1573      +54

Impacted Files	Coverage Δ
src/plugins/minimal_scene/MinimalScene.hh	`100.00% <ø> (ø)`
src/plugins/minimal_scene/MinimalSceneRhi.hh	`100.00% <ø> (ø)`
src/plugins/minimal_scene/MinimalSceneRhiOpenGL.hh	`100.00% <ø> (ø)`
src/plugins/minimal_scene/EngineToQtInterface.cc	`17.74% <17.74%> (ø)`
src/plugins/minimal_scene/MinimalScene.cc	`62.17% <100.00%> (-0.19%)`	⬇️
src/plugins/minimal_scene/MinimalSceneRhiOpenGL.cc	`92.22% <100.00%> (-3.29%)`	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

iche033 · 2022-12-12T23:07:59Z

src/plugins/minimal_scene/MinimalSceneRhiMetal.mm

+{
+ void *texturePtr = nullptr;
+ _camera->RenderTextureMetalId(&texturePtr);
+ this->dataPtr->metalTexture = CFBridgingRelease(texturePtr);


homebrew build caught a compile error here:

error: no member named 'metalTexture' in 'gz::gui::plugins::RenderThreadRhiMetalPrivate'

src/plugins/minimal_scene/EngineToQtInterface.cc

Signed-off-by: Matias N. Goldberg <dark_sylinc@yahoo.com.ar>

iche033 · 2022-12-20T00:05:07Z

src/plugins/minimal_scene/MinimalSceneRhiMetal.mm

 }

 /////////////////////////////////////////////////
 void* RenderThreadRhiMetal::TexturePtr() const
 {
- return this->dataPtr->texturePtr;
+ void *texturePtr = CFBridgingRetain(this->dataPtr->metalTexture);


homebrew caught another build error here. This fixes the problem for me:

- void *texturePtr = CFBridgingRetain(this->dataPtr->metalTexture); + void *texturePtr = (void *)CFBridgingRetain(this->dataPtr->metalTexture);

Grrrr, thanks.

iche033 · 2022-12-20T00:13:30Z

src/plugins/minimal_scene/EngineToQtInterface.cc

+/////////////////////////////////////////////////
+void EngineToQtInterface::DestroyFallbackTexture()
+{
+ glDeleteTextures(1, &this->dataPtr->fallbackTexture);


windows build error here. Maybe the following helps

- glDeleteTextures(1, &this->dataPtr->fallbackTexture); + QOpenGLFunctions *glFuncs = this->dataPtr->glContext->functions(); + glFuncs->glDeleteTextures(1, &this->dataPtr->fallbackTexture);

Agree! That'd probably be the best solution!

Signed-off-by: Ian Chen <ichen@osrfoundation.org>

iche033 · 2022-12-20T21:33:48Z

builds fixed in 7d77cc0.

darksylinc requested review from chapulina and jennuine as code owners February 19, 2022 19:18

github-actions bot added the 🌱 garden Ignition Garden label Feb 19, 2022

jennuine added the needs upstream release Blocked by a release of an upstream library label Feb 22, 2022

jennuine reviewed Feb 22, 2022

View reviewed changes

darksylinc mentioned this pull request Mar 4, 2022

Add Metal support to MinimalScene and Qt Application #323

Merged

8 tasks

iche033 mentioned this pull request Mar 5, 2022

Port ign-rendering to Ogre 2.3 gazebosim/gz-rendering#553

Merged

7 tasks

darksylinc force-pushed the matias-fallbackQt branch from f6e9f16 to 2807d86 Compare May 1, 2022 20:10

chapulina added the bug Something isn't working label Jul 23, 2022

chapulina requested a review from mjcarroll August 1, 2022 18:48

chapulina changed the base branch from main to gz-gui7 August 5, 2022 19:01

darksylinc force-pushed the matias-fallbackQt branch from 2807d86 to 2a8954a Compare August 7, 2022 01:11

darksylinc mentioned this pull request Aug 14, 2022

Add Vulkan QML backend #467

Merged

14 tasks

chapulina removed the needs upstream release Blocked by a release of an upstream library label Aug 26, 2022

This was referenced Sep 25, 2022

Add CLI to switch to Vulkan & Metal backends gazebosim/gz-sim#1735

Merged

Add necessary headers for Vulkan QML GUI backend gazebosim/gz-rendering#706

Merged

darksylinc force-pushed the matias-fallbackQt branch from 2a8954a to 8a272bf Compare December 11, 2022 23:32

darksylinc changed the base branch from gz-gui7 to main December 11, 2022 23:32

iche033 reviewed Dec 12, 2022

View reviewed changes

darksylinc added 2 commits December 18, 2022 22:43

Fix macOS build error

f705c4a

Signed-off-by: Matias N. Goldberg <dark_sylinc@yahoo.com.ar>

Fix MSVC build error

eb0b154

Signed-off-by: Matias N. Goldberg <dark_sylinc@yahoo.com.ar>

iche033 reviewed Dec 20, 2022

View reviewed changes

fix build on windows and homebrew

7d77cc0

Signed-off-by: Ian Chen <ichen@osrfoundation.org>

iche033 approved these changes Dec 20, 2022

View reviewed changes

iche033 merged commit fce993b into gazebosim:main Dec 20, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add fallback rendering for other APIs #357

Add fallback rendering for other APIs #357

darksylinc commented Feb 19, 2022 •

edited

Loading

jennuine left a comment

iche033 commented Feb 22, 2022

darksylinc commented Feb 23, 2022 •

edited

Loading

iche033 commented Feb 23, 2022

iche033 commented Mar 5, 2022

darksylinc commented Aug 7, 2022

azeey commented Nov 14, 2022

darksylinc commented Dec 11, 2022

codecov bot commented Dec 11, 2022 •

edited

Loading

iche033 Dec 12, 2022

iche033 Dec 20, 2022

darksylinc Dec 20, 2022

iche033 Dec 20, 2022

darksylinc Dec 20, 2022

iche033 commented Dec 20, 2022

Add fallback rendering for other APIs #357

Add fallback rendering for other APIs #357

Conversation

darksylinc commented Feb 19, 2022 • edited Loading

🦟 Bug fix

Order in which PRs must be merged

Summary

Dependency

Checklist

jennuine left a comment

Choose a reason for hiding this comment

iche033 commented Feb 22, 2022

darksylinc commented Feb 23, 2022 • edited Loading

iche033 commented Feb 23, 2022

iche033 commented Mar 5, 2022

darksylinc commented Aug 7, 2022

azeey commented Nov 14, 2022

darksylinc commented Dec 11, 2022

codecov bot commented Dec 11, 2022 • edited Loading

Codecov Report

iche033 Dec 12, 2022

Choose a reason for hiding this comment

iche033 Dec 20, 2022

Choose a reason for hiding this comment

darksylinc Dec 20, 2022

Choose a reason for hiding this comment

iche033 Dec 20, 2022

Choose a reason for hiding this comment

darksylinc Dec 20, 2022

Choose a reason for hiding this comment

iche033 commented Dec 20, 2022

darksylinc commented Feb 19, 2022 •

edited

Loading

darksylinc commented Feb 23, 2022 •

edited

Loading

codecov bot commented Dec 11, 2022 •

edited

Loading