Replace renderOneFrame for per-workspace update calls

[darksylinc]

🎉 New feature

Implements #323 for ign-rendering

Summary

Explanation is in the ticket

The ticket shouldn't be closed until all modules are merged.

Test it

This PR is currently defaulting SetCameraPassCountPerGpuFlush to 0 avoid breaking ign-sensors.

In order to fully test it, checkout:

1. https://github.com/darksylinc/ign-rendering/tree/matias-PostFrame5
2. https://github.com/darksylinc/ign-gazebo/tree/matias-PostFrame5
3. https://github.com/darksylinc/ign-sensors/tree/matias-PostFrame5

And set SetCameraPassCountPerGpuFlush to non-0 (e.g. set Ogre2ScenePrivate::cameraPassCountPerGpuFlush to 6)

This change is mostly a performance one; but it also affects particle FXs (and possibly some postprocessing FXs) because without this PR, Ogre2GpuRays rendering a cubemap with particle FXs will render each of the 6 faces in a different time; i.e. as if the simulation moved forward 6 times

Checklist

• Signed all commits for DCO
• Added tests
• Added example and/or tutorial
• 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

[codecov]

Codecov Report

Merging #353 (2720eb8) into main (f3f75a5) will increase coverage by 0.17%.
The diff coverage is 86.76%.

@@            Coverage Diff             @@
##             main     #353      +/-   ##
==========================================
+ Coverage   58.02%   58.20%   +0.17%     
==========================================
  Files         170      170              
  Lines       16675    16787     +112     
==========================================
+ Hits         9676     9771      +95     
- Misses       6999     7016      +17     

Impacted Files	Coverage Δ
include/ignition/rendering/Camera.hh	100.00% <ø> (ø)
include/ignition/rendering/Scene.hh	0.00% <ø> (ø)
include/ignition/rendering/base/BaseScene.hh	0.00% <ø> (ø)
src/base/BaseScene.cc	74.80% <0.00%> (-0.94%)	⬇️
ogre2/src/Ogre2Scene.cc	81.39% <86.11%> (+0.65%)	⬆️
include/ignition/rendering/base/BaseCamera.hh	67.04% <100.00%> (+0.24%)	⬆️
ogre2/src/Ogre2DepthCamera.cc	91.07% <100.00%> (+0.09%)	⬆️
ogre2/src/Ogre2GpuRays.cc	95.03% <100.00%> (+0.09%)	⬆️
ogre2/src/Ogre2RenderTarget.cc	81.47% <100.00%> (+0.22%)	⬆️
ogre2/src/Ogre2SelectionBuffer.cc	80.59% <100.00%> (+0.90%)	⬆️
... and 2 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f3f75a5...2720eb8. Read the comment docs.

[ahcorde]

Suggested change

	void BaseScene::SetCameraPassCountPerGpuFlush(uint8_t _numPass)
	void BaseScene::SetCameraPassCountPerGpuFlush(uint8_t /*_numPass*/)

[ahcorde]

remove ?

[darksylinc]

Decided to better document this.

That line is very useful, specially if debugging "what should happen when you let Ogre do anything" vs "what happens when we do some lower level calls ourselves"

[chapulina]

Hi @darksylinc , mind updating the PR title to be a bit more descriptive? Thanks!

[darksylinc]

Hi @darksylinc , mind updating the PR title to be a bit more descriptive? Thanks!

Done! Sorry!!! 😦

[iche033]

This looks good. Can you also update your other branches (ign-sensors and ign-gazebo) to rebase off of main and create PRs for those (based on discussion here)? thanks

[darksylinc]

Done! Rebased all 3 to main branch.

1. Replace renderOneFrame for per-workspace update calls #353 (this PR)
2. Make Gazebo aware of SetCameraPassCountPerGpuFlush gz-sim#921
3. Make Sensors aware of CameraPassCountPerGpuFlush & Scene::PostFrame gz-sensors#145

I'll address style issues in a separate PR