dali/internal/update/manager/render-instruction-processor.cpp

   1 /*
   2  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali/internal/update/manager/render-instruction-processor.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/integration-api/debug.h>
  23 #include <dali/internal/common/matrix-utils.h>
  24 #include <dali/internal/event/actors/layer-impl.h> // for the default sorting function
  25 #include <dali/internal/render/common/render-instruction-container.h>
  26 #include <dali/internal/render/common/render-instruction.h>
  27 #include <dali/internal/render/common/render-item.h>
  28 #include <dali/internal/render/common/render-tracker.h>
  29 #include <dali/internal/render/renderers/render-renderer.h>
  30 #include <dali/internal/render/shaders/render-shader.h>
  31 #include <dali/internal/update/manager/sorted-layers.h>
  32 #include <dali/internal/update/nodes/partial-rendering-data.h>
  33 #include <dali/internal/update/nodes/scene-graph-layer.h>
  34 #include <dali/internal/update/render-tasks/scene-graph-render-task.h>
  35 #include <dali/internal/update/rendering/scene-graph-texture-set.h>
  36 #include <dali/public-api/actors/layer.h>
  37
  38 namespace
  39 {
  40 #if defined(DEBUG_ENABLED)
  41 Debug::Filter* gRenderListLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_RENDER_LISTS");
  42 #endif
  43 } // namespace
  44
  45 namespace Dali
  46 {
  47 namespace Internal
  48 {
  49 namespace SceneGraph
  50 {
  51 namespace
  52 {
  53 /**
  54  * Function which compares render items by shader/textureSet/geometry
  55  * @param[in] lhs Left hand side item
  56  * @param[in] rhs Right hand side item
  57  * @return True if left item is greater than right
  58  */
  59 inline bool PartialCompareItems(const RenderInstructionProcessor::SortAttributes& lhs,
  60                                 const RenderInstructionProcessor::SortAttributes& rhs)
  61 {
  62   if(lhs.shader == rhs.shader)
  63   {
  64     if(lhs.textureSet == rhs.textureSet)
  65     {
  66       return lhs.geometry < rhs.geometry;
  67     }
  68     return lhs.textureSet < rhs.textureSet;
  69   }
  70   return lhs.shader < rhs.shader;
  71 }
  72
  73 /**
  74  * Function which sorts render items by depth index then by instance
  75  * ptrs of shader/textureSet/geometry.
  76  * @param[in] lhs Left hand side item
  77  * @param[in] rhs Right hand side item
  78  * @return True if left item is greater than right
  79  */
  80 bool CompareItems(const RenderInstructionProcessor::SortAttributes& lhs, const RenderInstructionProcessor::SortAttributes& rhs)
  81 {
  82   // @todo Consider replacing all these sortAttributes with a single long int that
  83   // encapsulates the same data (e.g. the middle-order bits of the ptrs).
  84   if(lhs.renderItem->mDepthIndex == rhs.renderItem->mDepthIndex)
  85   {
  86     return PartialCompareItems(lhs, rhs);
  87   }
  88   return lhs.renderItem->mDepthIndex < rhs.renderItem->mDepthIndex;
  89 }
  90
  91 /**
  92  * Function which sorts the render items by Z function, then
  93  * by instance ptrs of shader / geometry / material.
  94  * @param[in] lhs Left hand side item
  95  * @param[in] rhs Right hand side item
  96  * @return True if left item is greater than right
  97  */
  98 bool CompareItems3D(const RenderInstructionProcessor::SortAttributes& lhs, const RenderInstructionProcessor::SortAttributes& rhs)
  99 {
 100   const bool lhsIsOpaque = lhs.renderItem->mIsOpaque;
 101   if(lhsIsOpaque == rhs.renderItem->mIsOpaque)
 102   {
 103     if(lhsIsOpaque)
 104     {
 105       // If both RenderItems are opaque, sort using shader, then material then geometry.
 106       return PartialCompareItems(lhs, rhs);
 107     }
 108     else
 109     {
 110       // If both RenderItems are transparent, sort using Z, then shader, then material, then geometry.
 111       if(Equals(lhs.zValue, rhs.zValue))
 112       {
 113         return PartialCompareItems(lhs, rhs);
 114       }
 115       return lhs.zValue > rhs.zValue;
 116     }
 117   }
 118   else
 119   {
 120     return lhsIsOpaque;
 121   }
 122 }
 123
 124 /**
 125  * Function which sorts render items by clipping hierarchy, then Z function and instance ptrs of shader / geometry / material.
 126  * @param[in] lhs Left hand side item
 127  * @param[in] rhs Right hand side item
 128  * @return True if left item is greater than right
 129  */
 130 bool CompareItems3DWithClipping(const RenderInstructionProcessor::SortAttributes& lhs, const RenderInstructionProcessor::SortAttributes& rhs)
 131 {
 132   // Items must be sorted in order of clipping first, otherwise incorrect clipping regions could be used.
 133   if(lhs.renderItem->mNode->mClippingSortModifier == rhs.renderItem->mNode->mClippingSortModifier)
 134   {
 135     return CompareItems3D(lhs, rhs);
 136   }
 137
 138   return lhs.renderItem->mNode->mClippingSortModifier < rhs.renderItem->mNode->mClippingSortModifier;
 139 }
 140
 141 /**
 142  * Set the update area of the node
 143  * @param[in] node The node of the renderer
 144  * @param[in] isLayer3d Whether we are processing a 3D layer or not
 145  * @param[in,out] nodeWorldMatrix The world matrix of the node
 146  * @param[in,out] nodeSize The size of the node
 147  * @param[in,out] nodeUpdateArea The update area of the node
 148  *
 149  * @return True if node use it's own UpdateAreaHint, or z transform occured. False if we use nodeUpdateArea equal with Vector4(0, 0, nodeSize.width, nodeSize.height).
 150  */
 151 inline bool SetNodeUpdateArea(Node* node, bool isLayer3d, Matrix& nodeWorldMatrix, Vector3& nodeSize, Vector4& nodeUpdateArea)
 152 {
 153   node->GetWorldMatrixAndSize(nodeWorldMatrix, nodeSize);
 154
 155   if(node->GetUpdateAreaHint() == Vector4::ZERO)
 156   {
 157     // RenderItem::CalculateViewportSpaceAABB cannot cope with z transform
 158     // I don't use item.mModelMatrix.GetTransformComponents() for z transform, would be too slow
 159     if(!isLayer3d && nodeWorldMatrix.GetZAxis() == Vector3(0.0f, 0.0f, 1.0f))
 160     {
 161       nodeUpdateArea = Vector4(0.0f, 0.0f, nodeSize.width, nodeSize.height);
 162       return false;
 163     }
 164     // Keep nodeUpdateArea as Vector4::ZERO, and return true.
 165     return true;
 166   }
 167   else
 168   {
 169     nodeUpdateArea = node->GetUpdateAreaHint();
 170     return true;
 171   }
 172 }
 173
 174 /**
 175  * Add a renderer to the list
 176  * @param updateBufferIndex to read the model matrix from
 177  * @param renderList to add the item to
 178  * @param renderable Node-Renderer pair
 179  * @param viewMatrix used to calculate modelview matrix for the item
 180  * @param camera The camera used to render
 181  * @param isLayer3d Whether we are processing a 3D layer or not
 182  * @param viewportSet Whether the viewport is set or not
 183  * @param viewport The viewport
 184  * @param cull Whether frustum culling is enabled or not
 185  */
 186 inline void AddRendererToRenderList(BufferIndex               updateBufferIndex,
 187                                     RenderList&               renderList,
 188                                     Renderable&               renderable,
 189                                     const Matrix&             viewMatrix,
 190                                     const SceneGraph::Camera& camera,
 191                                     bool                      isLayer3d,
 192                                     bool                      viewportSet,
 193                                     const Viewport&           viewport,
 194                                     bool                      cull)
 195 {
 196   bool    inside(true);
 197   Node*   node = renderable.mNode;
 198   Matrix  nodeWorldMatrix(false);
 199   Vector3 nodeSize;
 200   Vector4 nodeUpdateArea;
 201   bool    nodeUpdateAreaSet(false);
 202   Matrix  nodeModelViewMatrix(false);
 203   bool    nodeModelViewMatrixSet(false);
 204
 205   // Don't cull items which have render callback
 206   bool hasRenderCallback = (renderable.mRenderer && renderable.mRenderer->GetRenderCallback());
 207
 208   if(cull && renderable.mRenderer && !hasRenderCallback && !renderable.mRenderer->GetShader().HintEnabled(Dali::Shader::Hint::MODIFIES_GEOMETRY) && node->GetClippingMode() == ClippingMode::DISABLED)
 209   {
 210     const Vector4& boundingSphere = node->GetBoundingSphere();
 211     inside                        = (boundingSphere.w > Math::MACHINE_EPSILON_1000) &&
 212              (camera.CheckSphereInFrustum(updateBufferIndex, Vector3(boundingSphere), boundingSphere.w));
 213
 214     if(inside && !isLayer3d && viewportSet)
 215     {
 216       SetNodeUpdateArea(node, isLayer3d, nodeWorldMatrix, nodeSize, nodeUpdateArea);
 217       nodeUpdateAreaSet = true;
 218
 219       const Vector3& scale = node->GetWorldScale(updateBufferIndex);
 220       const Vector3& size  = Vector3(nodeUpdateArea.z, nodeUpdateArea.w, 1.0f) * scale;
 221
 222       if(size.LengthSquared() > Math::MACHINE_EPSILON_1000)
 223       {
 224         MatrixUtils::Multiply(nodeModelViewMatrix, nodeWorldMatrix, viewMatrix);
 225         nodeModelViewMatrixSet = true;
 226
 227         // Assume actors are at z=0, compute AABB in view space & test rect intersection
 228         // against z=0 plane boundaries for frustum. (NOT viewport). This should take into account
 229         // magnification due to FOV etc.
 230
 231         // TODO : Below logic might need to refactor it.
 232         // If camera is Perspective, we need to calculate clipping box by FoV. Currently, we just believe default camera setup OrthographicSize well.
 233         //  - If then, It must use math calculate like tan(fov) internally. So, we might need calculate it only one times, and cache.
 234         ClippingBox boundingBox = RenderItem::CalculateTransformSpaceAABB(nodeModelViewMatrix, Vector3(nodeUpdateArea.x, nodeUpdateArea.y, 0.0f), Vector3(nodeUpdateArea.z, nodeUpdateArea.w, 0.0f));
 235         ClippingBox clippingBox = camera.GetOrthographicClippingBox(updateBufferIndex);
 236         inside                  = clippingBox.Intersects(boundingBox);
 237       }
 238     }
 239     /*
 240      * Note, the API Camera::CheckAABBInFrustum() can be used to test if a bounding box is (partially/fully) inside the view frustum.
 241      */
 242   }
 243
 244   if(inside)
 245   {
 246     bool skipRender(false);
 247     bool isOpaque = true;
 248     if(!hasRenderCallback)
 249     {
 250       Renderer::OpacityType opacityType = renderable.mRenderer ? renderable.mRenderer->GetOpacityType(updateBufferIndex, *node) : Renderer::OPAQUE;
 251
 252       // We can skip render when node is not clipping and transparent
 253       skipRender = (opacityType == Renderer::TRANSPARENT && node->GetClippingMode() == ClippingMode::DISABLED);
 254
 255       isOpaque = (opacityType == Renderer::OPAQUE);
 256     }
 257
 258     if(!skipRender)
 259     {
 260       // Get the next free RenderItem.
 261       RenderItem& item = renderList.GetNextFreeItem();
 262
 263       item.mNode     = node;
 264       item.mIsOpaque = isOpaque;
 265       item.mColor    = node->GetColor(updateBufferIndex);
 266
 267       item.mDepthIndex = 0;
 268       if(!isLayer3d)
 269       {
 270         item.mDepthIndex = node->GetDepthIndex();
 271       }
 272
 273       if(DALI_LIKELY(renderable.mRenderer))
 274       {
 275         item.mRenderer   = &renderable.mRenderer->GetRenderer();
 276         item.mTextureSet = renderable.mRenderer->GetTextureSet();
 277         item.mDepthIndex += renderable.mRenderer->GetDepthIndex();
 278       }
 279       else
 280       {
 281         item.mRenderer = nullptr;
 282       }
 283
 284       item.mIsUpdated |= isLayer3d;
 285
 286       if(!nodeUpdateAreaSet)
 287       {
 288         SetNodeUpdateArea(node, isLayer3d, nodeWorldMatrix, nodeSize, nodeUpdateArea);
 289       }
 290
 291       item.mSize        = nodeSize;
 292       item.mUpdateArea  = nodeUpdateArea;
 293       item.mModelMatrix = nodeWorldMatrix;
 294
 295       if(!nodeModelViewMatrixSet)
 296       {
 297         MatrixUtils::Multiply(nodeModelViewMatrix, nodeWorldMatrix, viewMatrix);
 298       }
 299       item.mModelViewMatrix = nodeModelViewMatrix;
 300
 301       PartialRenderingData partialRenderingData;
 302       partialRenderingData.color               = node->GetWorldColor(updateBufferIndex);
 303       partialRenderingData.depthIndex          = node->GetDepthIndex();
 304       partialRenderingData.matrix              = item.mModelViewMatrix;
 305       partialRenderingData.updatedPositionSize = item.mUpdateArea;
 306       partialRenderingData.size                = item.mSize;
 307
 308       auto& nodePartialRenderingData = node->GetPartialRenderingData();
 309       item.mIsUpdated                = nodePartialRenderingData.IsUpdated(partialRenderingData) || item.mIsUpdated;
 310
 311       nodePartialRenderingData.Update(partialRenderingData);
 312     }
 313     else
 314     {
 315       // Mark as not rendered
 316       auto& nodePartialRenderingData     = node->GetPartialRenderingData();
 317       nodePartialRenderingData.mRendered = false;
 318     }
 319
 320     node->SetCulled(updateBufferIndex, false);
 321   }
 322   else
 323   {
 324     // Mark as not rendered
 325     auto& nodePartialRenderingData     = node->GetPartialRenderingData();
 326     nodePartialRenderingData.mRendered = false;
 327
 328     node->SetCulled(updateBufferIndex, true);
 329   }
 330 }
 331
 332 /**
 333  * Add all renderers to the list
 334  * @param updateBufferIndex to read the model matrix from
 335  * @param renderList to add the items to
 336  * @param renderers to render
 337  * NodeRendererContainer Node-Renderer pairs
 338  * @param viewMatrix used to calculate modelview matrix for the items
 339  * @param camera The camera used to render
 340  * @param isLayer3d Whether we are processing a 3D layer or not
 341  * @param cull Whether frustum culling is enabled or not
 342  */
 343 inline void AddRenderersToRenderList(BufferIndex               updateBufferIndex,
 344                                      RenderList&               renderList,
 345                                      RenderableContainer&      renderers,
 346                                      const Matrix&             viewMatrix,
 347                                      const SceneGraph::Camera& camera,
 348                                      bool                      isLayer3d,
 349                                      bool                      viewportSet,
 350                                      const Viewport&           viewport,
 351                                      bool                      cull)
 352 {
 353   DALI_LOG_INFO(gRenderListLogFilter, Debug::Verbose, "AddRenderersToRenderList()\n");
 354
 355   for(auto&& renderer : renderers)
 356   {
 357     AddRendererToRenderList(updateBufferIndex,
 358                             renderList,
 359                             renderer,
 360                             viewMatrix,
 361                             camera,
 362                             isLayer3d,
 363                             viewportSet,
 364                             viewport,
 365                             cull);
 366   }
 367 }
 368
 369 /**
 370  * Try to reuse cached RenderItems from the RenderList
 371  * This avoids recalculating the model view matrices in case this part of the scene was static
 372  * An example case is a toolbar layer that rarely changes or a popup on top of the rest of the stage
 373  * @param layer that is being processed
 374  * @param renderList that is cached from frame N-1
 375  * @param renderables list of renderables
 376  */
 377 inline bool TryReuseCachedRenderers(Layer&               layer,
 378                                     RenderList&          renderList,
 379                                     RenderableContainer& renderables)
 380 {
 381   bool     retValue        = false;
 382   uint32_t renderableCount = static_cast<uint32_t>(renderables.Size());
 383   // Check that the cached list originates from this layer and that the counts match
 384   if((renderList.GetSourceLayer() == &layer) &&
 385      (renderList.GetCachedItemCount() == renderableCount))
 386   {
 387     // Check that all the same renderers are there. This gives us additional security in avoiding rendering the wrong things.
 388     // Render list is sorted so at this stage renderers may be in different order.
 389     // Therefore we check a combined sum of all renderer addresses.
 390     size_t checkSumNew = 0;
 391     size_t checkSumOld = 0;
 392     for(uint32_t index = 0; index < renderableCount; ++index)
 393     {
 394       if(DALI_LIKELY(renderables[index].mRenderer))
 395       {
 396         const Render::Renderer& renderer = renderables[index].mRenderer->GetRenderer();
 397         checkSumNew += reinterpret_cast<std::size_t>(&renderer);
 398       }
 399       if(DALI_LIKELY(renderList.GetItem(index).mRenderer))
 400       {
 401         checkSumOld += reinterpret_cast<std::size_t>(&renderList.GetRenderer(index));
 402       }
 403     }
 404     if(checkSumNew == checkSumOld)
 405     {
 406       // tell list to reuse its existing items
 407       renderList.ReuseCachedItems();
 408       retValue = true;
 409     }
 410   }
 411
 412   return retValue;
 413 }
 414
 415 inline bool SetupRenderList(RenderableContainer& renderables,
 416                             Layer&               layer,
 417                             RenderInstruction&   instruction,
 418                             bool                 tryReuseRenderList,
 419                             RenderList**         renderList)
 420 {
 421   *renderList = &(instruction.GetNextFreeRenderList(renderables.Size()));
 422   (*renderList)->SetClipping(layer.IsClipping(), layer.GetClippingBox());
 423   (*renderList)->SetSourceLayer(&layer);
 424
 425   // Try to reuse cached RenderItems from last time around.
 426   return (tryReuseRenderList && TryReuseCachedRenderers(layer, **renderList, renderables));
 427 }
 428
 429 } // Anonymous namespace.
 430
 431 RenderInstructionProcessor::RenderInstructionProcessor()
 432 : mSortingHelper()
 433 {
 434   // Set up a container of comparators for fast run-time selection.
 435   mSortComparitors.Reserve(3u);
 436
 437   mSortComparitors.PushBack(CompareItems);
 438   mSortComparitors.PushBack(CompareItems3D);
 439   mSortComparitors.PushBack(CompareItems3DWithClipping);
 440 }
 441
 442 RenderInstructionProcessor::~RenderInstructionProcessor() = default;
 443
 444 inline void RenderInstructionProcessor::SortRenderItems(BufferIndex bufferIndex, RenderList& renderList, Layer& layer, bool respectClippingOrder, bool isOrthographicCamera)
 445 {
 446   const uint32_t renderableCount = static_cast<uint32_t>(renderList.Count());
 447   // Reserve space if needed.
 448   const uint32_t oldcapacity = static_cast<uint32_t>(mSortingHelper.size());
 449   if(oldcapacity < renderableCount)
 450   {
 451     mSortingHelper.reserve(renderableCount);
 452     // Add real objects (reserve does not construct objects).
 453     mSortingHelper.insert(mSortingHelper.begin() + oldcapacity,
 454                           (renderableCount - oldcapacity),
 455                           RenderInstructionProcessor::SortAttributes());
 456   }
 457   else
 458   {
 459     // Clear extra elements from helper, does not decrease capability.
 460     mSortingHelper.resize(renderableCount);
 461   }
 462
 463   // Calculate the sorting value, once per item by calling the layers sort function.
 464   // Using an if and two for-loops rather than if inside for as its better for branch prediction.
 465
 466   // List of zValue calculating functions.
 467   const Dali::Layer::SortFunctionType zValueFunctionFromVector3[] = {
 468     [](const Vector3& position) { return position.z; },
 469     [](const Vector3& position) { return position.LengthSquared(); },
 470     layer.GetSortFunction(),
 471   };
 472
 473   // Determine whether we need to use zValue as Euclidean distance or translatoin's z value.
 474   // If layer is LAYER_UI or camera is OrthographicProjection mode, we don't need to calculate
 475   // renderItem's distance from camera.
 476
 477   // Here we determine which zValue SortFunctionType (of the 3) to use.
 478   //   0 is position z value : Default LAYER_UI or Orthographic camera
 479   //   1 is distance square value : Default LAYER_3D and Perspective camera
 480   //   2 is user defined function.
 481   const int zValueFunctionIndex = layer.UsesDefaultSortFunction() ? ((layer.GetBehavior() == Dali::Layer::LAYER_UI || isOrthographicCamera) ? 0 : 1) : 2;
 482
 483   for(uint32_t index = 0; index < renderableCount; ++index)
 484   {
 485     RenderItem& item = renderList.GetItem(index);
 486
 487     if(DALI_LIKELY(item.mRenderer))
 488     {
 489       item.mRenderer->SetSortAttributes(mSortingHelper[index]);
 490     }
 491
 492     // texture set
 493     mSortingHelper[index].textureSet = item.mTextureSet;
 494
 495     mSortingHelper[index].zValue = zValueFunctionFromVector3[zValueFunctionIndex](item.mModelViewMatrix.GetTranslation3()) - static_cast<float>(item.mDepthIndex);
 496
 497     // Keep the renderitem pointer in the helper so we can quickly reorder items after sort.
 498     mSortingHelper[index].renderItem = &item;
 499   }
 500
 501   // Here we determine which comparitor (of the 3) to use.
 502   //   0 is LAYER_UI
 503   //   1 is LAYER_3D
 504   //   2 is LAYER_3D + Clipping
 505   const unsigned int comparitorIndex = layer.GetBehavior() == Dali::Layer::LAYER_3D ? respectClippingOrder ? 2u : 1u : 0u;
 506
 507   std::stable_sort(mSortingHelper.begin(), mSortingHelper.end(), mSortComparitors[comparitorIndex]);
 508
 509   // Reorder / re-populate the RenderItems in the RenderList to correct order based on the sortinghelper.
 510   DALI_LOG_INFO(gRenderListLogFilter, Debug::Verbose, "Sorted Transparent List:\n");
 511   RenderItemContainer::Iterator renderListIter = renderList.GetContainer().Begin();
 512   for(uint32_t index = 0; index < renderableCount; ++index, ++renderListIter)
 513   {
 514     *renderListIter = mSortingHelper[index].renderItem;
 515     DALI_LOG_INFO(gRenderListLogFilter, Debug::Verbose, "  sortedList[%d] = %p\n", index, mSortingHelper[index].renderItem->mRenderer);
 516   }
 517 }
 518
 519 void RenderInstructionProcessor::Prepare(BufferIndex                 updateBufferIndex,
 520                                          SortedLayerPointers&        sortedLayers,
 521                                          RenderTask&                 renderTask,
 522                                          bool                        cull,
 523                                          bool                        hasClippingNodes,
 524                                          RenderInstructionContainer& instructions)
 525 {
 526   // Retrieve the RenderInstruction buffer from the RenderInstructionContainer
 527   // then populate with instructions.
 528   RenderInstruction& instruction             = renderTask.PrepareRenderInstruction(updateBufferIndex);
 529   bool               viewMatrixHasNotChanged = !renderTask.ViewMatrixUpdated();
 530   bool               isRenderListAdded       = false;
 531   bool               isRootLayerDirty        = false;
 532
 533   const Matrix&             viewMatrix           = renderTask.GetViewMatrix(updateBufferIndex);
 534   const SceneGraph::Camera& camera               = renderTask.GetCamera();
 535   const bool                isOrthographicCamera = camera.mProjectionMode == Dali::Camera::ProjectionMode::ORTHOGRAPHIC_PROJECTION;
 536
 537   Viewport viewport;
 538   bool     viewportSet = renderTask.QueryViewport(updateBufferIndex, viewport);
 539
 540   const SortedLayersIter endIter = sortedLayers.end();
 541   for(SortedLayersIter iter = sortedLayers.begin(); iter != endIter; ++iter)
 542   {
 543     Layer&      layer = **iter;
 544     const bool  tryReuseRenderList(viewMatrixHasNotChanged && layer.CanReuseRenderers(&camera));
 545     const bool  isLayer3D  = layer.GetBehavior() == Dali::Layer::LAYER_3D;
 546     RenderList* renderList = nullptr;
 547
 548     if(layer.IsRoot() && (layer.GetDirtyFlags() != NodePropertyFlags::NOTHING))
 549     {
 550       // If root-layer & dirty, i.e. a property has changed or a child has been deleted, then we need to ensure we render once more
 551       isRootLayerDirty = true;
 552     }
 553
 554     if(!layer.colorRenderables.Empty())
 555     {
 556       RenderableContainer& renderables = layer.colorRenderables;
 557
 558       if(!SetupRenderList(renderables, layer, instruction, tryReuseRenderList, &renderList))
 559       {
 560         renderList->SetHasColorRenderItems(true);
 561         AddRenderersToRenderList(updateBufferIndex,
 562                                  *renderList,
 563                                  renderables,
 564                                  viewMatrix,
 565                                  camera,
 566                                  isLayer3D,
 567                                  viewportSet,
 568                                  viewport,
 569                                  cull);
 570
 571         // We only use the clipping version of the sort comparitor if any clipping nodes exist within the RenderList.
 572         SortRenderItems(updateBufferIndex, *renderList, layer, hasClippingNodes, isOrthographicCamera);
 573       }
 574
 575       isRenderListAdded = true;
 576     }
 577
 578     if(!layer.overlayRenderables.Empty())
 579     {
 580       RenderableContainer& renderables = layer.overlayRenderables;
 581
 582       if(!SetupRenderList(renderables, layer, instruction, tryReuseRenderList, &renderList))
 583       {
 584         renderList->SetHasColorRenderItems(false);
 585         AddRenderersToRenderList(updateBufferIndex,
 586                                  *renderList,
 587                                  renderables,
 588                                  viewMatrix,
 589                                  camera,
 590                                  isLayer3D,
 591                                  viewportSet,
 592                                  viewport,
 593                                  cull);
 594
 595         // Clipping hierarchy is irrelevant when sorting overlay items, so we specify using the non-clipping version of the sort comparitor.
 596         SortRenderItems(updateBufferIndex, *renderList, layer, false, isOrthographicCamera);
 597       }
 598
 599       isRenderListAdded = true;
 600     }
 601   }
 602
 603   // Inform the render instruction that all renderers have been added and this frame is complete.
 604   instruction.UpdateCompleted();
 605
 606   if(isRenderListAdded || instruction.mIsClearColorSet || isRootLayerDirty)
 607   {
 608     instructions.PushBack(updateBufferIndex, &instruction);
 609   }
 610 }
 611
 612 } // namespace SceneGraph
 613
 614 } // namespace Internal
 615
 616 } // namespace Dali