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   bool    nodeUpdateAreaUseHint(false);
 203   Matrix  nodeModelViewMatrix(false);
 204   bool    nodeModelViewMatrixSet(false);
 205
 206   // Don't cull items which have render callback
 207   bool hasRenderCallback = (renderable.mRenderer && renderable.mRenderer->GetRenderCallback());
 208
 209   if(cull && renderable.mRenderer && (hasRenderCallback || (!renderable.mRenderer->GetShader().HintEnabled(Dali::Shader::Hint::MODIFIES_GEOMETRY) && node->GetClippingMode() == ClippingMode::DISABLED)))
 210   {
 211     const Vector4& boundingSphere = node->GetBoundingSphere();
 212     inside                        = (boundingSphere.w > Math::MACHINE_EPSILON_1000) &&
 213              (camera.CheckSphereInFrustum(updateBufferIndex, Vector3(boundingSphere), boundingSphere.w));
 214
 215     if(inside && !isLayer3d && viewportSet)
 216     {
 217       nodeUpdateAreaUseHint = SetNodeUpdateArea(node, isLayer3d, nodeWorldMatrix, nodeSize, nodeUpdateArea);
 218       nodeUpdateAreaSet     = true;
 219
 220       const Vector3& scale = node->GetWorldScale(updateBufferIndex);
 221       const Vector3& size  = Vector3(nodeUpdateArea.z, nodeUpdateArea.w, 1.0f) * scale;
 222
 223       if(size.LengthSquared() > Math::MACHINE_EPSILON_1000)
 224       {
 225         MatrixUtils::Multiply(nodeModelViewMatrix, nodeWorldMatrix, viewMatrix);
 226         nodeModelViewMatrixSet = true;
 227
 228         // Assume actors are at z=0, compute AABB in view space & test rect intersection
 229         // against z=0 plane boundaries for frustum. (NOT viewport). This should take into account
 230         // magnification due to FOV etc.
 231
 232         // TODO : Below logic might need to refactor it.
 233         // If camera is Perspective, we need to calculate clipping box by FoV. Currently, we just believe default camera setup OrthographicSize well.
 234         //  - If then, It must use math calculate like tan(fov) internally. So, we might need calculate it only one times, and cache.
 235         ClippingBox boundingBox = RenderItem::CalculateTransformSpaceAABB(nodeModelViewMatrix, Vector3(nodeUpdateArea.x, nodeUpdateArea.y, 0.0f), Vector3(nodeUpdateArea.z, nodeUpdateArea.w, 0.0f));
 236         ClippingBox clippingBox = camera.GetOrthographicClippingBox(updateBufferIndex);
 237         inside                  = clippingBox.Intersects(boundingBox);
 238       }
 239     }
 240     /*
 241      * Note, the API Camera::CheckAABBInFrustum() can be used to test if a bounding box is (partially/fully) inside the view frustum.
 242      */
 243   }
 244
 245   if(inside)
 246   {
 247     bool skipRender(false);
 248     bool isOpaque = true;
 249     if(!hasRenderCallback)
 250     {
 251       Renderer::OpacityType opacityType = renderable.mRenderer ? renderable.mRenderer->GetOpacityType(updateBufferIndex, *node) : Renderer::OPAQUE;
 252
 253       // We can skip render when node is not clipping and transparent
 254       skipRender = (opacityType == Renderer::TRANSPARENT && node->GetClippingMode() == ClippingMode::DISABLED);
 255
 256       isOpaque = (opacityType == Renderer::OPAQUE);
 257     }
 258
 259     if(!skipRender)
 260     {
 261       // Get the next free RenderItem.
 262       RenderItem& item = renderList.GetNextFreeItem();
 263
 264       PartialRenderingData partialRenderingData;
 265
 266       partialRenderingData.node       = node;
 267       partialRenderingData.renderer   = renderable.mRenderer;
 268       partialRenderingData.color      = node->GetWorldColor(updateBufferIndex);
 269       partialRenderingData.depthIndex = node->GetDepthIndex();
 270       partialRenderingData.isOpaque   = isOpaque;
 271
 272       partialRenderingData.textureSet = nullptr;
 273       if(DALI_LIKELY(renderable.mRenderer))
 274       {
 275         partialRenderingData.color.a *= renderable.mRenderer->GetOpacity(updateBufferIndex);
 276         partialRenderingData.textureSet = renderable.mRenderer->GetTextureSet();
 277       }
 278
 279       item.mNode     = node;
 280       item.mIsOpaque = isOpaque;
 281       item.mColor    = node->GetColor(updateBufferIndex);
 282
 283       item.mDepthIndex = 0;
 284       if(!isLayer3d)
 285       {
 286         item.mDepthIndex = node->GetDepthIndex();
 287       }
 288
 289       if(DALI_LIKELY(renderable.mRenderer))
 290       {
 291         item.mRenderer   = &renderable.mRenderer->GetRenderer();
 292         item.mTextureSet = renderable.mRenderer->GetTextureSet();
 293         item.mDepthIndex += renderable.mRenderer->GetDepthIndex();
 294
 295         // Get whether collected map is up to date
 296         item.mIsUpdated |= renderable.mRenderer->UniformMapUpdated();
 297       }
 298       else
 299       {
 300         item.mRenderer = nullptr;
 301       }
 302
 303       item.mIsUpdated |= isLayer3d;
 304
 305       if(!nodeUpdateAreaSet)
 306       {
 307         nodeUpdateAreaUseHint = SetNodeUpdateArea(node, isLayer3d, nodeWorldMatrix, nodeSize, nodeUpdateArea);
 308       }
 309
 310       item.mSize        = nodeSize;
 311       item.mUpdateArea  = nodeUpdateArea;
 312       item.mModelMatrix = nodeWorldMatrix;
 313
 314       // Apply transform informations if node doesn't have update size hint and use VisualRenderer.
 315       if(!nodeUpdateAreaUseHint && renderable.mRenderer && renderable.mRenderer->GetVisualProperties())
 316       {
 317         Vector3 updateSize = renderable.mRenderer->CalculateVisualTransformedUpdateSize(updateBufferIndex, Vector3(item.mUpdateArea.z, item.mUpdateArea.w, 0.0f));
 318         item.mUpdateArea.z = updateSize.x;
 319         item.mUpdateArea.w = updateSize.y;
 320       }
 321
 322       if(!nodeModelViewMatrixSet)
 323       {
 324         MatrixUtils::Multiply(nodeModelViewMatrix, nodeWorldMatrix, viewMatrix);
 325       }
 326       item.mModelViewMatrix = nodeModelViewMatrix;
 327
 328       partialRenderingData.matrix              = item.mModelViewMatrix;
 329       partialRenderingData.updatedPositionSize = item.mUpdateArea;
 330       partialRenderingData.size                = item.mSize;
 331
 332       auto& nodePartialRenderingData = node->GetPartialRenderingData();
 333       item.mIsUpdated                = nodePartialRenderingData.IsUpdated(partialRenderingData) || item.mIsUpdated;
 334
 335       nodePartialRenderingData.Update(partialRenderingData);
 336     }
 337     else
 338     {
 339       // Mark as not rendered
 340       auto& nodePartialRenderingData     = node->GetPartialRenderingData();
 341       nodePartialRenderingData.mRendered = false;
 342     }
 343
 344     node->SetCulled(updateBufferIndex, false);
 345   }
 346   else
 347   {
 348     // Mark as not rendered
 349     auto& nodePartialRenderingData     = node->GetPartialRenderingData();
 350     nodePartialRenderingData.mRendered = false;
 351
 352     node->SetCulled(updateBufferIndex, true);
 353   }
 354 }
 355
 356 /**
 357  * Add all renderers to the list
 358  * @param updateBufferIndex to read the model matrix from
 359  * @param renderList to add the items to
 360  * @param renderers to render
 361  * NodeRendererContainer Node-Renderer pairs
 362  * @param viewMatrix used to calculate modelview matrix for the items
 363  * @param camera The camera used to render
 364  * @param isLayer3d Whether we are processing a 3D layer or not
 365  * @param cull Whether frustum culling is enabled or not
 366  */
 367 inline void AddRenderersToRenderList(BufferIndex               updateBufferIndex,
 368                                      RenderList&               renderList,
 369                                      RenderableContainer&      renderers,
 370                                      const Matrix&             viewMatrix,
 371                                      const SceneGraph::Camera& camera,
 372                                      bool                      isLayer3d,
 373                                      bool                      viewportSet,
 374                                      const Viewport&           viewport,
 375                                      bool                      cull)
 376 {
 377   DALI_LOG_INFO(gRenderListLogFilter, Debug::Verbose, "AddRenderersToRenderList()\n");
 378
 379   for(auto&& renderer : renderers)
 380   {
 381     AddRendererToRenderList(updateBufferIndex,
 382                             renderList,
 383                             renderer,
 384                             viewMatrix,
 385                             camera,
 386                             isLayer3d,
 387                             viewportSet,
 388                             viewport,
 389                             cull);
 390   }
 391 }
 392
 393 /**
 394  * Try to reuse cached RenderItems from the RenderList
 395  * This avoids recalculating the model view matrices in case this part of the scene was static
 396  * An example case is a toolbar layer that rarely changes or a popup on top of the rest of the stage
 397  * @param layer that is being processed
 398  * @param renderList that is cached from frame N-1
 399  * @param renderables list of renderables
 400  */
 401 inline bool TryReuseCachedRenderers(Layer&               layer,
 402                                     RenderList&          renderList,
 403                                     RenderableContainer& renderables)
 404 {
 405   bool     retValue        = false;
 406   uint32_t renderableCount = static_cast<uint32_t>(renderables.Size());
 407   // Check that the cached list originates from this layer and that the counts match
 408   if((renderList.GetSourceLayer() == &layer) &&
 409      (renderList.GetCachedItemCount() == renderableCount))
 410   {
 411     // Check that all the same renderers are there. This gives us additional security in avoiding rendering the wrong things.
 412     // Render list is sorted so at this stage renderers may be in different order.
 413     // Therefore we check a combined sum of all renderer addresses.
 414     size_t checkSumNew = 0;
 415     size_t checkSumOld = 0;
 416     for(uint32_t index = 0; index < renderableCount; ++index)
 417     {
 418       if(DALI_LIKELY(renderables[index].mRenderer))
 419       {
 420         const Render::Renderer& renderer = renderables[index].mRenderer->GetRenderer();
 421         checkSumNew += reinterpret_cast<std::size_t>(&renderer);
 422       }
 423       if(DALI_LIKELY(renderList.GetItem(index).mRenderer))
 424       {
 425         checkSumOld += reinterpret_cast<std::size_t>(&renderList.GetRenderer(index));
 426       }
 427     }
 428     if(checkSumNew == checkSumOld)
 429     {
 430       // tell list to reuse its existing items
 431       renderList.ReuseCachedItems();
 432       retValue = true;
 433     }
 434   }
 435
 436   return retValue;
 437 }
 438
 439 inline bool SetupRenderList(RenderableContainer& renderables,
 440                             Layer&               layer,
 441                             RenderInstruction&   instruction,
 442                             bool                 tryReuseRenderList,
 443                             RenderList**         renderList)
 444 {
 445   *renderList = &(instruction.GetNextFreeRenderList(renderables.Size()));
 446   (*renderList)->SetClipping(layer.IsClipping(), layer.GetClippingBox());
 447   (*renderList)->SetSourceLayer(&layer);
 448
 449   // Try to reuse cached RenderItems from last time around.
 450   return (tryReuseRenderList && TryReuseCachedRenderers(layer, **renderList, renderables));
 451 }
 452
 453 } // Anonymous namespace.
 454
 455 RenderInstructionProcessor::RenderInstructionProcessor()
 456 : mSortingHelper()
 457 {
 458   // Set up a container of comparators for fast run-time selection.
 459   mSortComparitors.Reserve(3u);
 460
 461   mSortComparitors.PushBack(CompareItems);
 462   mSortComparitors.PushBack(CompareItems3D);
 463   mSortComparitors.PushBack(CompareItems3DWithClipping);
 464 }
 465
 466 RenderInstructionProcessor::~RenderInstructionProcessor() = default;
 467
 468 inline void RenderInstructionProcessor::SortRenderItems(BufferIndex bufferIndex, RenderList& renderList, Layer& layer, bool respectClippingOrder, bool isOrthographicCamera)
 469 {
 470   const uint32_t renderableCount = static_cast<uint32_t>(renderList.Count());
 471   // Reserve space if needed.
 472   const uint32_t oldcapacity = static_cast<uint32_t>(mSortingHelper.size());
 473   if(oldcapacity < renderableCount)
 474   {
 475     mSortingHelper.reserve(renderableCount);
 476     // Add real objects (reserve does not construct objects).
 477     mSortingHelper.insert(mSortingHelper.begin() + oldcapacity,
 478                           (renderableCount - oldcapacity),
 479                           RenderInstructionProcessor::SortAttributes());
 480   }
 481   else
 482   {
 483     // Clear extra elements from helper, does not decrease capability.
 484     mSortingHelper.resize(renderableCount);
 485   }
 486
 487   // Calculate the sorting value, once per item by calling the layers sort function.
 488   // Using an if and two for-loops rather than if inside for as its better for branch prediction.
 489
 490   // List of zValue calculating functions.
 491   const Dali::Layer::SortFunctionType zValueFunctionFromVector3[] = {
 492     [](const Vector3& position)
 493     { return position.z; },
 494     [](const Vector3& position)
 495     { return position.LengthSquared(); },
 496     layer.GetSortFunction(),
 497   };
 498
 499   // Determine whether we need to use zValue as Euclidean distance or translatoin's z value.
 500   // If layer is LAYER_UI or camera is OrthographicProjection mode, we don't need to calculate
 501   // renderItem's distance from camera.
 502
 503   // Here we determine which zValue SortFunctionType (of the 3) to use.
 504   //   0 is position z value : Default LAYER_UI or Orthographic camera
 505   //   1 is distance square value : Default LAYER_3D and Perspective camera
 506   //   2 is user defined function.
 507   const int zValueFunctionIndex = layer.UsesDefaultSortFunction() ? ((layer.GetBehavior() == Dali::Layer::LAYER_UI || isOrthographicCamera) ? 0 : 1) : 2;
 508
 509   for(uint32_t index = 0; index < renderableCount; ++index)
 510   {
 511     RenderItem& item = renderList.GetItem(index);
 512
 513     if(DALI_LIKELY(item.mRenderer))
 514     {
 515       item.mRenderer->SetSortAttributes(mSortingHelper[index]);
 516     }
 517
 518     // texture set
 519     mSortingHelper[index].textureSet = item.mTextureSet;
 520
 521     mSortingHelper[index].zValue = zValueFunctionFromVector3[zValueFunctionIndex](item.mModelViewMatrix.GetTranslation3()) - static_cast<float>(item.mDepthIndex);
 522
 523     // Keep the renderitem pointer in the helper so we can quickly reorder items after sort.
 524     mSortingHelper[index].renderItem = &item;
 525   }
 526
 527   // Here we determine which comparitor (of the 3) to use.
 528   //   0 is LAYER_UI
 529   //   1 is LAYER_3D
 530   //   2 is LAYER_3D + Clipping
 531   const unsigned int comparitorIndex = layer.GetBehavior() == Dali::Layer::LAYER_3D ? respectClippingOrder ? 2u : 1u : 0u;
 532
 533   std::stable_sort(mSortingHelper.begin(), mSortingHelper.end(), mSortComparitors[comparitorIndex]);
 534
 535   // Reorder / re-populate the RenderItems in the RenderList to correct order based on the sortinghelper.
 536   DALI_LOG_INFO(gRenderListLogFilter, Debug::Verbose, "Sorted Transparent List:\n");
 537   RenderItemContainer::Iterator renderListIter = renderList.GetContainer().Begin();
 538   for(uint32_t index = 0; index < renderableCount; ++index, ++renderListIter)
 539   {
 540     *renderListIter = mSortingHelper[index].renderItem;
 541     DALI_LOG_INFO(gRenderListLogFilter, Debug::Verbose, "  sortedList[%d] = %p\n", index, mSortingHelper[index].renderItem->mRenderer);
 542   }
 543 }
 544
 545 void RenderInstructionProcessor::Prepare(BufferIndex                 updateBufferIndex,
 546                                          SortedLayerPointers&        sortedLayers,
 547                                          RenderTask&                 renderTask,
 548                                          bool                        cull,
 549                                          bool                        hasClippingNodes,
 550                                          RenderInstructionContainer& instructions)
 551 {
 552   // Retrieve the RenderInstruction buffer from the RenderInstructionContainer
 553   // then populate with instructions.
 554   RenderInstruction& instruction             = renderTask.PrepareRenderInstruction(updateBufferIndex);
 555   bool               viewMatrixHasNotChanged = !renderTask.ViewMatrixUpdated();
 556   bool               isRenderListAdded       = false;
 557   bool               isRootLayerDirty        = false;
 558
 559   const Matrix&             viewMatrix           = renderTask.GetViewMatrix(updateBufferIndex);
 560   const SceneGraph::Camera& camera               = renderTask.GetCamera();
 561   const bool                isOrthographicCamera = camera.mProjectionMode == Dali::Camera::ProjectionMode::ORTHOGRAPHIC_PROJECTION;
 562
 563   Viewport viewport;
 564   bool     viewportSet = renderTask.QueryViewport(updateBufferIndex, viewport);
 565
 566   const SortedLayersIter endIter = sortedLayers.end();
 567   for(SortedLayersIter iter = sortedLayers.begin(); iter != endIter; ++iter)
 568   {
 569     Layer&      layer = **iter;
 570     const bool  tryReuseRenderList(viewMatrixHasNotChanged && layer.CanReuseRenderers(&camera));
 571     const bool  isLayer3D  = layer.GetBehavior() == Dali::Layer::LAYER_3D;
 572     RenderList* renderList = nullptr;
 573
 574     if(layer.IsRoot() && (layer.GetDirtyFlags() != NodePropertyFlags::NOTHING))
 575     {
 576       // 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
 577       isRootLayerDirty = true;
 578     }
 579
 580     if(!layer.colorRenderables.Empty())
 581     {
 582       RenderableContainer& renderables = layer.colorRenderables;
 583
 584       if(!SetupRenderList(renderables, layer, instruction, tryReuseRenderList, &renderList))
 585       {
 586         renderList->SetHasColorRenderItems(true);
 587         AddRenderersToRenderList(updateBufferIndex,
 588                                  *renderList,
 589                                  renderables,
 590                                  viewMatrix,
 591                                  camera,
 592                                  isLayer3D,
 593                                  viewportSet,
 594                                  viewport,
 595                                  cull);
 596
 597         // We only use the clipping version of the sort comparitor if any clipping nodes exist within the RenderList.
 598         SortRenderItems(updateBufferIndex, *renderList, layer, hasClippingNodes, isOrthographicCamera);
 599       }
 600
 601       isRenderListAdded = true;
 602     }
 603
 604     if(!layer.overlayRenderables.Empty())
 605     {
 606       RenderableContainer& renderables = layer.overlayRenderables;
 607
 608       if(!SetupRenderList(renderables, layer, instruction, tryReuseRenderList, &renderList))
 609       {
 610         renderList->SetHasColorRenderItems(false);
 611         AddRenderersToRenderList(updateBufferIndex,
 612                                  *renderList,
 613                                  renderables,
 614                                  viewMatrix,
 615                                  camera,
 616                                  isLayer3D,
 617                                  viewportSet,
 618                                  viewport,
 619                                  cull);
 620
 621         // Clipping hierarchy is irrelevant when sorting overlay items, so we specify using the non-clipping version of the sort comparitor.
 622         SortRenderItems(updateBufferIndex, *renderList, layer, false, isOrthographicCamera);
 623       }
 624
 625       isRenderListAdded = true;
 626     }
 627   }
 628
 629   // Inform the render instruction that all renderers have been added and this frame is complete.
 630   instruction.UpdateCompleted();
 631
 632   if(isRenderListAdded || instruction.mIsClearColorSet || isRootLayerDirty)
 633   {
 634     instructions.PushBack(updateBufferIndex, &instruction);
 635   }
 636 }
 637
 638 } // namespace SceneGraph
 639
 640 } // namespace Internal
 641
 642 } // namespace Dali