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