Cache light/renderable/computable vectors

This avoids running these jobs when lights / renderables have
not changed in a frame

Change-Id: I604180fe3442ab67648c4ba5d9effb8639c68ef7
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

2 files changed, 97 insertions, 22 deletions

diff --git a/tests/auto/render/renderer/tst_renderer.cpp b/tests/auto/render/renderer/tst_renderer.cpp
index e67e0ed55..892e13b25 100644
--- a/tests/auto/render/renderer/tst_renderer.cpp
+++ b/tests/auto/render/renderer/tst_renderer.cpp
@@ -77,11 +77,8 @@ private Q_SLOTS:
         const int layerCacheJobCount = 2;
         // filterEntityByLayerJob,
         // syncFilterEntityByLayerJob
-        const int singleRenderViewJobCount = 11 + Qt3DRender::Render::RenderViewBuilder::optimalJobCount();
+        const int singleRenderViewJobCount = 8 + Qt3DRender::Render::RenderViewBuilder::optimalJobCount();
         // RenderViewBuilder renderViewJob,
-        //                   renderableEntityFilterJob,
-        //                   lightGatherJob,
-        //                   computableEntityFilterJob,
         //                   syncRenderViewInitializationJob,
         //                   syncFrustumCullingJob,
         //                   filterProximityJob,
@@ -192,6 +189,8 @@ private Q_SLOTS:
                  1 + // UpdateMeshTriangleListJob
                  1 + // updateSkinningPaletteJob
                  1 + // ExpandBoundingVolumeJob
+                 1 + // RenderableEntityFilterPtr
+                 1 + // SyncRenderableEntities
                  singleRenderViewJobCount);
 
         renderer.clearDirtyBits(Qt3DRender::Render::AbstractRenderer::AllDirty);
@@ -299,6 +298,12 @@ private Q_SLOTS:
                  1 + // TexturesGathererJob
                  1 + // SyncTextureLoadingJob
                  1 + // UpdateEntityLayersJob
+                 1 + // RenderableEntityFilterPtr
+                 1 + // SyncRenderableEntities
+                 1 + // ComputableEntityFilterPtr
+                 1 + // SyncComputableEntities
+                 1 + // LightGathererPtr
+                 1 + // SyncLightsGatherer
                  singleRenderViewJobCount +
                  layerCacheJobCount +
                  renderViewBuilderMaterialCacheJobCount);
diff --git a/tests/auto/render/renderviewbuilder/tst_renderviewbuilder.cpp b/tests/auto/render/renderviewbuilder/tst_renderviewbuilder.cpp
index 24f56f25b..27671bb68 100644
--- a/tests/auto/render/renderviewbuilder/tst_renderviewbuilder.cpp
+++ b/tests/auto/render/renderviewbuilder/tst_renderviewbuilder.cpp
@@ -38,6 +38,9 @@
 #include <Qt3DRender/qdispatchcompute.h>
 #include <Qt3DRender/qfrustumculling.h>
 #include <Qt3DRender/qmaterial.h>
+#include <Qt3DRender/qspotlight.h>
+#include <Qt3DRender/qpointlight.h>
+#include <Qt3DRender/qenvironmentlight.h>
 #include <Qt3DRender/qgeometryrenderer.h>
 #include <Qt3DRender/qcomputecommand.h>
 #include <Qt3DRender/qlayerfilter.h>
@@ -132,6 +135,27 @@ Qt3DCore::QEntity *buildSimpleScene(Qt3DRender::QFrameGraphNode *fg)
         e->setParent(root);
     }
 
+    {
+        Qt3DCore::QEntity *e = new Qt3DCore::QEntity();
+        Qt3DRender::QPointLight *light = new Qt3DRender::QPointLight();
+        e->addComponent(light);
+        e->setParent(root);
+    }
+
+    {
+        Qt3DCore::QEntity *e = new Qt3DCore::QEntity();
+        Qt3DRender::QSpotLight *light = new Qt3DRender::QSpotLight();
+        e->addComponent(light);
+        e->setParent(root);
+    }
+
+    {
+        Qt3DCore::QEntity *e = new Qt3DCore::QEntity();
+        Qt3DRender::QEnvironmentLight *light = new Qt3DRender::QEnvironmentLight();
+        e->addComponent(light);
+        e->setParent(root);
+    }
+
     return root;
 }
 
@@ -188,9 +212,6 @@ private Q_SLOTS:
             QCOMPARE(renderViewBuilder.layerCacheNeedsToBeRebuilt(), false);
             QCOMPARE(renderViewBuilder.materialGathererCacheNeedsToBeRebuilt(), false);
             QVERIFY(!renderViewBuilder.renderViewJob().isNull());
-            QVERIFY(!renderViewBuilder.lightGathererJob().isNull());
-            QVERIFY(!renderViewBuilder.renderableEntityFilterJob().isNull());
-            QVERIFY(!renderViewBuilder.computableEntityFilterJob().isNull());
             QVERIFY(!renderViewBuilder.frustumCullingJob().isNull());
             QVERIFY(!renderViewBuilder.syncFrustumCullingJob().isNull());
             QVERIFY(!renderViewBuilder.setClearDrawBufferIndexJob().isNull());
@@ -216,7 +237,7 @@ private Q_SLOTS:
 
             QCOMPARE(renderViewBuilder.renderViewBuilderJobs().size(), Qt3DRender::Render::RenderViewBuilder::optimalJobCount());
             QCOMPARE(renderViewBuilder.materialGathererJobs().size(), 0);
-            QCOMPARE(renderViewBuilder.buildJobHierachy().size(), 11 + 1 * Qt3DRender::Render::RenderViewBuilder::optimalJobCount());
+            QCOMPARE(renderViewBuilder.buildJobHierachy().size(), 8 + 1 * Qt3DRender::Render::RenderViewBuilder::optimalJobCount());
         }
 
         {
@@ -231,7 +252,7 @@ private Q_SLOTS:
             QVERIFY(!renderViewBuilder.syncFilterEntityByLayerJob().isNull());
 
             // mark jobs dirty and recheck
-            QCOMPARE(renderViewBuilder.buildJobHierachy().size(), 13 + 1 * Qt3DRender::Render::RenderViewBuilder::optimalJobCount());
+            QCOMPARE(renderViewBuilder.buildJobHierachy().size(), 10 + 1 * Qt3DRender::Render::RenderViewBuilder::optimalJobCount());
         }
 
         {
@@ -246,7 +267,40 @@ private Q_SLOTS:
             QVERIFY(!renderViewBuilder.syncMaterialGathererJob().isNull());
 
             // mark jobs dirty and recheck
-            QCOMPARE(renderViewBuilder.buildJobHierachy().size(), 12 + 2 * Qt3DRender::Render::RenderViewBuilder::optimalJobCount());
+            QCOMPARE(renderViewBuilder.buildJobHierachy().size(), 9 + 2 * Qt3DRender::Render::RenderViewBuilder::optimalJobCount());
+        }
+
+        {
+            // WHEN
+            Qt3DRender::Render::RenderViewBuilder renderViewBuilder(leafNode, 0, testAspect.renderer());
+            renderViewBuilder.setLightGathererCacheNeedsToBeRebuilt(true);
+            renderViewBuilder.prepareJobs();
+
+             // THEN
+            QCOMPARE(renderViewBuilder.lightGathererCacheNeedsToBeRebuilt(), true);
+            QCOMPARE(renderViewBuilder.buildJobHierachy().size(), 10 + 1 * Qt3DRender::Render::RenderViewBuilder::optimalJobCount());
+        }
+
+        {
+            // WHEN
+            Qt3DRender::Render::RenderViewBuilder renderViewBuilder(leafNode, 0, testAspect.renderer());
+            renderViewBuilder.setRenderableCacheNeedsToBeRebuilt(true);
+            renderViewBuilder.prepareJobs();
+
+             // THEN
+            QCOMPARE(renderViewBuilder.renderableCacheNeedsToBeRebuilt(), true);
+            QCOMPARE(renderViewBuilder.buildJobHierachy().size(), 10 + 1 * Qt3DRender::Render::RenderViewBuilder::optimalJobCount());
+        }
+
+        {
+            // WHEN
+            Qt3DRender::Render::RenderViewBuilder renderViewBuilder(leafNode, 0, testAspect.renderer());
+            renderViewBuilder.setComputableCacheNeedsToBeRebuilt(true);
+            renderViewBuilder.prepareJobs();
+
+             // THEN
+            QCOMPARE(renderViewBuilder.computableCacheNeedsToBeRebuilt(), true);
+            QCOMPARE(renderViewBuilder.buildJobHierachy().size(), 10 + 1 * Qt3DRender::Render::RenderViewBuilder::optimalJobCount());
         }
     }
 
@@ -270,9 +324,7 @@ private Q_SLOTS:
             // THEN
             // Step 1
             QCOMPARE(renderViewBuilder.renderViewJob()->dependencies().size(), 1); // Depends upon skinning palette update
-            QCOMPARE(renderViewBuilder.lightGathererJob()->dependencies().size(), 0);
-            QCOMPARE(renderViewBuilder.renderableEntityFilterJob()->dependencies().size(),0);
-            QCOMPARE(renderViewBuilder.computableEntityFilterJob()->dependencies().size(), 0);
+
 
             // Step 2
             QCOMPARE(renderViewBuilder.syncRenderViewInitializationJob()->dependencies().size(), 1);
@@ -300,11 +352,9 @@ private Q_SLOTS:
             QVERIFY(renderViewBuilder.frustumCullingJob()->dependencies().contains(testAspect.renderer()->expandBoundingVolumeJob()));
 
 
+            QCOMPARE(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().size(), renderViewBuilder.materialGathererJobs().size() + 6);
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.syncRenderViewInitializationJob()));
-            QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.renderableEntityFilterJob()));
-            QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.computableEntityFilterJob()));
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.filterProximityJob()));
-            QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.lightGathererJob()));
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.frustumCullingJob()));
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(testAspect.renderer()->introspectShadersJob()));
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(testAspect.renderer()->bufferGathererJob()));
@@ -333,9 +383,6 @@ private Q_SLOTS:
             // THEN
             // Step 1
             QCOMPARE(renderViewBuilder.renderViewJob()->dependencies().size(), 1); // Depends upon skinning palette update
-            QCOMPARE(renderViewBuilder.lightGathererJob()->dependencies().size(), 0);
-            QCOMPARE(renderViewBuilder.renderableEntityFilterJob()->dependencies().size(),0);
-            QCOMPARE(renderViewBuilder.computableEntityFilterJob()->dependencies().size(), 0);
 
             // Step 2
             QCOMPARE(renderViewBuilder.syncRenderViewInitializationJob()->dependencies().size(), 1);
@@ -377,10 +424,7 @@ private Q_SLOTS:
             QCOMPARE(renderViewBuilder.syncMaterialGathererJob()->dependencies().size(), renderViewBuilder.materialGathererJobs().size());
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.syncMaterialGathererJob()));
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.syncRenderViewInitializationJob()));
-            QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.renderableEntityFilterJob()));
-            QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.computableEntityFilterJob()));
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.syncFilterEntityByLayerJob()));
-            QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.lightGathererJob()));
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.frustumCullingJob()));
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(renderViewBuilder.filterProximityJob()));
             QVERIFY(renderViewBuilder.syncRenderCommandBuildingJob()->dependencies().contains(testAspect.renderer()->introspectShadersJob()));
@@ -422,6 +466,29 @@ private Q_SLOTS:
         QVERIFY(renderViewBuilder.renderViewJob()->renderView() != nullptr);
     }
 
+    void checkLightGatherExecution()
+    {
+        // GIVEN
+        Qt3DRender::QViewport *viewport = new Qt3DRender::QViewport();
+        Qt3DRender::QClearBuffers *clearBuffer = new Qt3DRender::QClearBuffers(viewport);
+        Qt3DRender::TestAspect testAspect(buildSimpleScene(viewport));
+
+        // THEN
+        Qt3DRender::Render::FrameGraphNode *leafNode = testAspect.nodeManagers()->frameGraphManager()->lookupNode(clearBuffer->id());
+        QVERIFY(leafNode != nullptr);
+
+        // WHEN
+        Qt3DRender::Render::RenderViewBuilder renderViewBuilder(leafNode, 0, testAspect.renderer());
+        renderViewBuilder.setLightGathererCacheNeedsToBeRebuilt(true);
+        renderViewBuilder.prepareJobs();
+        renderViewBuilder.buildJobHierachy();
+        renderViewBuilder.lightGathererJob()->run();
+
+        // THEN
+        QCOMPARE(renderViewBuilder.lightGathererJob()->lights().size(), 2);
+        QVERIFY(renderViewBuilder.lightGathererJob()->takeEnvironmentLight() != nullptr);
+    }
+
     void checkRenderableEntitiesFilteringExecution()
     {
         // GIVEN
@@ -435,6 +502,7 @@ private Q_SLOTS:
 
         // WHEN
         Qt3DRender::Render::RenderViewBuilder renderViewBuilder(leafNode, 0, testAspect.renderer());
+        renderViewBuilder.setRenderableCacheNeedsToBeRebuilt(true);
         renderViewBuilder.prepareJobs();
         renderViewBuilder.buildJobHierachy();
         renderViewBuilder.renderableEntityFilterJob()->run();
@@ -456,6 +524,7 @@ private Q_SLOTS:
 
         // WHEN
         Qt3DRender::Render::RenderViewBuilder renderViewBuilder(leafNode, 0, testAspect.renderer());
+        renderViewBuilder.setComputableCacheNeedsToBeRebuilt(true);
         renderViewBuilder.prepareJobs();
         renderViewBuilder.buildJobHierachy();
         renderViewBuilder.computableEntityFilterJob()->run();
@@ -586,6 +655,7 @@ private Q_SLOTS:
         // WHEN
         Qt3DRender::Render::RenderViewBuilder renderViewBuilder(leafNode, 0, testAspect.renderer());
         renderViewBuilder.setLayerCacheNeedsToBeRebuilt(true);
+        renderViewBuilder.setRenderableCacheNeedsToBeRebuilt(true);
         renderViewBuilder.prepareJobs();
         renderViewBuilder.buildJobHierachy();