Replace renderOneFrame for per-workspace update calls #353
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
ahcorde
previously requested changes
Jun 29, 2021
src/base/BaseScene.cc
Outdated
| } | ||
|
|
||
| ////////////////////////////////////////////////// | ||
| void BaseScene::SetCameraPassCountPerGpuFlush(uint8_t _numPass) |
There was a problem hiding this comment.
Suggested change
| void BaseScene::SetCameraPassCountPerGpuFlush(uint8_t _numPass) | |
| void BaseScene::SetCameraPassCountPerGpuFlush(uint8_t /*_numPass*/) |
ogre2/src/Ogre2Scene.cc
Outdated
| auto ogreRoot = engine->OgreRoot(); | ||
| Ogre::CompositorManager2 *ogreCompMgr = ogreRoot->getCompositorManager2(); | ||
|
|
||
| // engine->OgreRoot()->renderOneFrame(); |
There was a problem hiding this comment.
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"
|
Hi @darksylinc , mind updating the PR title to be a bit more descriptive? Thanks! |
darksylinc
changed the title
Done! Sorry!!! 😦 |
iche033
reviewed
Jul 6, 2021
darksylinc
force-pushed
the
matias-PostFrame5
branch
from
8b904d8 to
f2d70cd
Compare
|
This looks good. Can you also update your other branches (ign-sensors and ign-gazebo) to rebase off of |
Signed-off-by: Louise Poubel <[email protected]>
Add Scene::PostRenderGpuFlush Breaks ABI. Needs changes to other components as well, so they call Scene::PostRenderGpuFlush Affects gazebosim#323 Signed-off-by: Matias N. Goldberg <[email protected]>
Affects gazebosim#323 Signed-off-by: Matias N. Goldberg <[email protected]>
Renamed PostRenderGpuFlush to PostRender PostRenderGpuFlush was leaking too much internal behavior of how the engine works into the user. The new way of forcing the user to pair PreRender and PostRender calls is much easier to understand and user-friendly Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
Fixes GpuRays/GpuRaysTest.RaysParticles failure Particle FXs should now be working as intended Signed-off-by: Matias N. Goldberg <[email protected]>
SetNumCameraPassesPerGpuFlush -> SetCameraPassCountPerGpuFlush GetNumCameraPassesPerGpuFlush -> GetCameraPassCountPerGpuFlush GetLegacyAutoGpuFlush -> LegacyAutoGpuFlush Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
INTEGRATION_depth_camera now succeeds Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
Fix wrong documentation about currNumCameraPasses Signed-off-by: Matias N. Goldberg <[email protected]>
Signed-off-by: Matias N. Goldberg <[email protected]>
Better document code in FlushGpuCommandsOnly Signed-off-by: Matias N. Goldberg <[email protected]>
- Do not recommend the user to call Camera::PreRender in docs. This is done implicitly via Scene::PreRender - Rename GetCameraPassCountPerGpuFlush -> CameraPassCountPerGpuFlush - CameraPassCountPerGpuFlush was incorrectly always returning 0 - Grammar mistakes in comments Signed-off-by: Matias N. Goldberg <[email protected]>
darksylinc
force-pushed
the
matias-PostFrame5
branch
from
2ce934c to
4421164
Compare
This was referenced Jul 17, 2021
Signed-off-by: Matias N. Goldberg <[email protected]>
darksylinc
force-pushed
the
matias-PostFrame5
branch
from
b5ea685 to
2720eb8
Compare
iche033
approved these changes
Jul 19, 2021
iche033
dismissed
ahcorde’s stale review
I'll address style issues in a separate PR
7 tasks
8 tasks
WilliamLewww
pushed a commit
to WilliamLewww/ign-rendering
that referenced
this pull request
Dec 7, 2021
* 🎈 5.1.0 (gazebosim#351) Signed-off-by: Louise Poubel <[email protected]> * Replace renderOneFrame for per-workspace update calls Add Scene::PostRenderGpuFlush Breaks ABI. Needs changes to other components as well, so they call Scene::PostRenderGpuFlush Affects gazebosim#323 Signed-off-by: Matias N. Goldberg <[email protected]> * Add Scene::SetLegacyAutoGpuFlush Affects gazebosim#323 Signed-off-by: Matias N. Goldberg <[email protected]> * Add Scene::SetNumCameraPassesPerGpuFlush Renamed PostRenderGpuFlush to PostRender PostRenderGpuFlush was leaking too much internal behavior of how the engine works into the user. The new way of forcing the user to pair PreRender and PostRender calls is much easier to understand and user-friendly Signed-off-by: Matias N. Goldberg <[email protected]> * Assert when PreRender/PostRender calls are used incorrectly Signed-off-by: Matias N. Goldberg <[email protected]> * Fix warnings generated by gazebo in legacy mode Signed-off-by: Matias N. Goldberg <[email protected]> * Add missing listener triggers Fixes GpuRays/GpuRaysTest.RaysParticles failure Particle FXs should now be working as intended Signed-off-by: Matias N. Goldberg <[email protected]> * Rename functions to be consistent w/ Ignition naming convention SetNumCameraPassesPerGpuFlush -> SetCameraPassCountPerGpuFlush GetNumCameraPassesPerGpuFlush -> GetCameraPassCountPerGpuFlush GetLegacyAutoGpuFlush -> LegacyAutoGpuFlush Signed-off-by: Matias N. Goldberg <[email protected]> * Document that SetCameraPassCountPerGpuFlush is an upper bound Signed-off-by: Matias N. Goldberg <[email protected]> * Document Camera::Update shouldn't be called if there's many cameras Signed-off-by: Matias N. Goldberg <[email protected]> * Check in Render() call that we're inside PreRender / PostRender Signed-off-by: Matias N. Goldberg <[email protected]> * Fix INTEGRATION_camera crash Signed-off-by: Matias N. Goldberg <[email protected]> * Fix EndFrame not getting called when in non-legacy mode INTEGRATION_depth_camera now succeeds Signed-off-by: Matias N. Goldberg <[email protected]> * Fix wrong documentation about Camera::Capture Signed-off-by: Matias N. Goldberg <[email protected]> * Update Migration notes w/ Scene::PostRender Signed-off-by: Matias N. Goldberg <[email protected]> * Add missing call in doc's recomendations Signed-off-by: Matias N. Goldberg <[email protected]> * Improve documentation and make asserts more helpful Signed-off-by: Matias N. Goldberg <[email protected]> * Default cameraPassCountPerGpuFlush until all modules are merged Fix wrong documentation about currNumCameraPasses Signed-off-by: Matias N. Goldberg <[email protected]> * Remove unnecessary headers Signed-off-by: Matias N. Goldberg <[email protected]> * Style changes for consistency with the rest of the codebase Better document code in FlushGpuCommandsOnly Signed-off-by: Matias N. Goldberg <[email protected]> * Multiple fixes - Do not recommend the user to call Camera::PreRender in docs. This is done implicitly via Scene::PreRender - Rename GetCameraPassCountPerGpuFlush -> CameraPassCountPerGpuFlush - CameraPassCountPerGpuFlush was incorrectly always returning 0 - Grammar mistakes in comments Signed-off-by: Matias N. Goldberg <[email protected]> * Make cameraPassCountPerGpuFlush default to 6 Signed-off-by: Matias N. Goldberg <[email protected]> Co-authored-by: Louise Poubel <[email protected]> Signed-off-by: William Lew <[email protected]>
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🎉 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
SetCameraPassCountPerGpuFlushto 0 avoid breaking ign-sensors.In order to fully test it, checkout:
And set
SetCameraPassCountPerGpuFlushto non-0 (e.g. setOgre2ScenePrivate::cameraPassCountPerGpuFlushto 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
codecheckpassed (See contributing)Note to maintainers: Remember to use Squash-Merge