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

   1 /*
   2  * Copyright (c) 2020 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/public-api/actors/layer.h>
  23 #include <dali/integration-api/debug.h>
  24 #include <dali/internal/event/actors/layer-impl.h> // for the default sorting function
  25 #include <dali/internal/update/manager/sorted-layers.h>
  26 #include <dali/internal/update/render-tasks/scene-graph-render-task.h>
  27 #include <dali/internal/update/rendering/scene-graph-texture-set.h>
  28 #include <dali/internal/render/common/render-item.h>
  29 #include <dali/internal/render/common/render-tracker.h>
  30 #include <dali/internal/render/common/render-instruction.h>
  31 #include <dali/internal/render/common/render-instruction-container.h>
  32 #include <dali/internal/render/shaders/scene-graph-shader.h>
  33 #include <dali/internal/render/renderers/render-renderer.h>
  34 #include <dali/internal/update/nodes/scene-graph-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 }
  42
  43 namespace Dali
  44 {
  45
  46 namespace Internal
  47 {
  48
  49 namespace SceneGraph
  50 {
  51
  52 namespace
  53 {
  54
  55 /**
  56  * Function which compares render items by shader/textureSet/geometry
  57  * @param[in] lhs Left hand side item
  58  * @param[in] rhs Right hand side item
  59  * @return True if left item is greater than right
  60  */
  61 inline bool PartialCompareItems( const RenderInstructionProcessor::SortAttributes& lhs,
  62                                  const RenderInstructionProcessor::SortAttributes& rhs )
  63 {
  64   if( lhs.shader == rhs.shader )
  65   {
  66     if( lhs.textureSet == rhs.textureSet )
  67     {
  68       return lhs.geometry < rhs.geometry;
  69     }
  70     return lhs.textureSet < rhs.textureSet;
  71   }
  72   return lhs.shader < rhs.shader;
  73 }
  74
  75 /**
  76  * Function which sorts render items by depth index then by instance
  77  * ptrs of shader/textureSet/geometry.
  78  * @param[in] lhs Left hand side item
  79  * @param[in] rhs Right hand side item
  80  * @return True if left item is greater than right
  81  */
  82 bool CompareItems( const RenderInstructionProcessor::SortAttributes& lhs, const RenderInstructionProcessor::SortAttributes& rhs )
  83 {
  84   // @todo Consider replacing all these sortAttributes with a single long int that
  85   // encapsulates the same data (e.g. the middle-order bits of the ptrs).
  86   if( lhs.renderItem->mDepthIndex == rhs.renderItem->mDepthIndex )
  87   {
  88     return PartialCompareItems( lhs, rhs );
  89   }
  90   return lhs.renderItem->mDepthIndex < rhs.renderItem->mDepthIndex;
  91 }
  92
  93 /**
  94  * Function which sorts the render items by Z function, then
  95  * by instance ptrs of shader / geometry / material.
  96  * @param[in] lhs Left hand side item
  97  * @param[in] rhs Right hand side item
  98  * @return True if left item is greater than right
  99  */
 100 bool CompareItems3D( const RenderInstructionProcessor::SortAttributes& lhs, const RenderInstructionProcessor::SortAttributes& rhs )
 101 {
 102   const bool lhsIsOpaque = lhs.renderItem->mIsOpaque;
 103   if( lhsIsOpaque == rhs.renderItem->mIsOpaque )
 104   {
 105     if( lhsIsOpaque )
 106     {
 107       // If both RenderItems are opaque, sort using shader, then material then geometry.
 108       return PartialCompareItems( lhs, rhs );
 109     }
 110     else
 111     {
 112       // If both RenderItems are transparent, sort using Z, then shader, then material, then geometry.
 113       if( Equals( lhs.zValue, rhs.zValue ) )
 114       {
 115         return PartialCompareItems( lhs, rhs );
 116       }
 117       return lhs.zValue > rhs.zValue;
 118     }
 119   }
 120   else
 121   {
 122     return lhsIsOpaque;
 123   }
 124 }
 125
 126 /**
 127  * Function which sorts render items by clipping hierarchy, then Z function and instance ptrs of shader / geometry / material.
 128  * @param[in] lhs Left hand side item
 129  * @param[in] rhs Right hand side item
 130  * @return True if left item is greater than right
 131  */
 132 bool CompareItems3DWithClipping( const RenderInstructionProcessor::SortAttributes& lhs, const RenderInstructionProcessor::SortAttributes& rhs )
 133 {
 134   // Items must be sorted in order of clipping first, otherwise incorrect clipping regions could be used.
 135   if( lhs.renderItem->mNode->mClippingSortModifier == rhs.renderItem->mNode->mClippingSortModifier )
 136   {
 137     return CompareItems3D( lhs, rhs );
 138   }
 139
 140   return lhs.renderItem->mNode->mClippingSortModifier < rhs.renderItem->mNode->mClippingSortModifier;
 141 }
 142
 143 /**
 144  * Add a renderer to the list
 145  * @param updateBufferIndex to read the model matrix from
 146  * @param renderList to add the item to
 147  * @param renderable Node-Renderer pair
 148  * @param viewMatrix used to calculate modelview matrix for the item
 149  * @param camera The camera used to render
 150  * @param isLayer3d Whether we are processing a 3D layer or not
 151  * @param cull Whether frustum culling is enabled or not
 152  */
 153 inline void AddRendererToRenderList(BufferIndex updateBufferIndex,
 154                                     RenderList& renderList,
 155                                     Renderable& renderable,
 156                                     const Matrix& viewMatrix,
 157                                     SceneGraph::Camera& camera,
 158                                     bool isLayer3d,
 159                                     bool cull)
 160 {
 161   bool inside(true);
 162   Node* node = renderable.mNode;
 163
 164   if (cull && renderable.mRenderer && !renderable.mRenderer->GetShader().HintEnabled(Dali::Shader::Hint::MODIFIES_GEOMETRY))
 165   {
 166     const Vector4& boundingSphere = node->GetBoundingSphere();
 167     inside = (boundingSphere.w > Math::MACHINE_EPSILON_1000) &&
 168              (camera.CheckSphereInFrustum(updateBufferIndex, Vector3(boundingSphere), boundingSphere.w));
 169   }
 170
 171   if (inside)
 172   {
 173     Renderer::OpacityType opacityType = renderable.mRenderer ? renderable.mRenderer->GetOpacityType( updateBufferIndex, *renderable.mNode ) : Renderer::OPAQUE;
 174     if (opacityType != Renderer::TRANSPARENT || node->GetClippingMode() == ClippingMode::CLIP_CHILDREN)
 175     {
 176       // Get the next free RenderItem.
 177       RenderItem& item = renderList.GetNextFreeItem();
 178
 179       item.mIsUpdated = (item.mNode != renderable.mNode);
 180       item.mNode = renderable.mNode;
 181
 182       bool prevIsOpaque = item.mIsOpaque;
 183       item.mIsOpaque = (opacityType == Renderer::OPAQUE);
 184       item.mIsUpdated |= (prevIsOpaque != item.mIsOpaque);
 185
 186       Vector4 prevColor = item.mColor;
 187       item.mColor = renderable.mNode->GetColor(updateBufferIndex);
 188       item.mIsUpdated |= (prevColor != item.mColor);
 189
 190       int prevDepthIndex = item.mDepthIndex;
 191       item.mDepthIndex = 0;
 192       if (!isLayer3d)
 193       {
 194         item.mDepthIndex = renderable.mNode->GetDepthIndex();
 195       }
 196
 197       Render::Renderer* prevRenderer = item.mRenderer;
 198       if (DALI_LIKELY(renderable.mRenderer))
 199       {
 200         item.mRenderer = &renderable.mRenderer->GetRenderer();
 201         const void* prevTextureSet = item.mTextureSet;
 202         item.mTextureSet = renderable.mRenderer->GetTextures();
 203         item.mIsUpdated |= (prevTextureSet != item.mTextureSet);
 204         item.mDepthIndex += renderable.mRenderer->GetDepthIndex();
 205       }
 206       else
 207       {
 208         item.mRenderer = nullptr;
 209       }
 210
 211       item.mIsUpdated |= (prevDepthIndex != item.mDepthIndex);
 212       item.mIsUpdated |= (prevRenderer != item.mRenderer);
 213       item.mIsUpdated |= isLayer3d;
 214
 215       if (!item.mIsUpdated)
 216       {
 217         Matrix prevModelViewMatrix = item.mModelViewMatrix;
 218         Vector3 prevSize = item.mSize;
 219
 220         // Save ModelView matrix onto the item.
 221         node->GetWorldMatrixAndSize( item.mModelMatrix, item.mSize );
 222         Matrix::Multiply( item.mModelViewMatrix, item.mModelMatrix, viewMatrix );
 223
 224         item.mIsUpdated = ((prevSize != item.mSize) || (item.mModelViewMatrix != prevModelViewMatrix));
 225       }
 226       else
 227       {
 228         // Save ModelView matrix onto the item.
 229         node->GetWorldMatrixAndSize( item.mModelMatrix, item.mSize );
 230         Matrix::Multiply( item.mModelViewMatrix, item.mModelMatrix, viewMatrix );
 231       }
 232
 233       item.mUpdateSize = node->GetUpdateSizeHint();
 234       if (item.mUpdateSize == Vector3::ZERO)
 235       {
 236         // RenderItem::CalculateViewportSpaceAABB cannot cope with z transform
 237         // I don't use item.mModelMatrix.GetTransformComponents() for z transform, would be to slow
 238         if (!isLayer3d && item.mModelMatrix.GetZAxis() == Vector3(0.0f, 0.0f, 1.0f))
 239         {
 240           item.mUpdateSize = item.mSize;
 241         }
 242       }
 243     }
 244
 245     node->SetCulled( updateBufferIndex, false );
 246   }
 247   else
 248   {
 249     node->SetCulled( updateBufferIndex, true );
 250   }
 251 }
 252
 253 /**
 254  * Add all renderers to the list
 255  * @param updateBufferIndex to read the model matrix from
 256  * @param renderList to add the items to
 257  * @param renderers to render
 258  * NodeRendererContainer Node-Renderer pairs
 259  * @param viewMatrix used to calculate modelview matrix for the items
 260  * @param camera The camera used to render
 261  * @param isLayer3d Whether we are processing a 3D layer or not
 262  * @param cull Whether frustum culling is enabled or not
 263  */
 264 inline void AddRenderersToRenderList( BufferIndex updateBufferIndex,
 265                                       RenderList& renderList,
 266                                       RenderableContainer& renderers,
 267                                       const Matrix& viewMatrix,
 268                                       SceneGraph::Camera& camera,
 269                                       bool isLayer3d,
 270                                       bool cull )
 271 {
 272   DALI_LOG_INFO( gRenderListLogFilter, Debug::Verbose, "AddRenderersToRenderList()\n");
 273
 274   for( auto&& renderer : renderers )
 275   {
 276     AddRendererToRenderList( updateBufferIndex,
 277                              renderList,
 278                              renderer,
 279                              viewMatrix,
 280                              camera,
 281                              isLayer3d,
 282                              cull);
 283   }
 284 }
 285
 286 /**
 287  * Try to reuse cached RenderItems from the RenderList
 288  * This avoids recalculating the model view matrices in case this part of the scene was static
 289  * An example case is a toolbar layer that rarely changes or a popup on top of the rest of the stage
 290  * @param layer that is being processed
 291  * @param renderList that is cached from frame N-1
 292  * @param renderables list of renderables
 293  */
 294 inline bool TryReuseCachedRenderers( Layer& layer,
 295                                      RenderList& renderList,
 296                                      RenderableContainer& renderables )
 297 {
 298   bool retValue = false;
 299   uint32_t renderableCount = static_cast<uint32_t>( renderables.Size() );
 300   // Check that the cached list originates from this layer and that the counts match
 301   if( ( renderList.GetSourceLayer() == &layer )&&
 302       ( renderList.GetCachedItemCount() == renderableCount ) )
 303   {
 304     // Check that all the same renderers are there. This gives us additional security in avoiding rendering the wrong things.
 305     // Render list is sorted so at this stage renderers may be in different order.
 306     // Therefore we check a combined sum of all renderer addresses.
 307     size_t checkSumNew = 0;
 308     size_t checkSumOld = 0;
 309     for( uint32_t index = 0; index < renderableCount; ++index )
 310     {
 311       const Render::Renderer& renderer = renderables[index].mRenderer->GetRenderer();
 312       checkSumNew += reinterpret_cast<std::size_t>( &renderer );
 313       checkSumOld += reinterpret_cast<std::size_t>( &renderList.GetRenderer( index ) );
 314     }
 315     if( checkSumNew == checkSumOld )
 316     {
 317       // tell list to reuse its existing items
 318       renderList.ReuseCachedItems();
 319       retValue = true;
 320     }
 321   }
 322
 323   return retValue;
 324 }
 325
 326 inline bool SetupRenderList( RenderableContainer& renderables,
 327                              Layer& layer,
 328                              RenderInstruction& instruction,
 329                              bool tryReuseRenderList,
 330                              RenderList** renderList )
 331 {
 332   *renderList = &( instruction.GetNextFreeRenderList( renderables.Size() ) );
 333   ( *renderList )->SetClipping( layer.IsClipping(), layer.GetClippingBox() );
 334   ( *renderList )->SetSourceLayer( &layer );
 335
 336   // Try to reuse cached RenderItems from last time around.
 337   return ( tryReuseRenderList && TryReuseCachedRenderers( layer, **renderList, renderables ) );
 338 }
 339
 340 } // Anonymous namespace.
 341
 342
 343 RenderInstructionProcessor::RenderInstructionProcessor()
 344 : mSortingHelper()
 345 {
 346   // Set up a container of comparators for fast run-time selection.
 347   mSortComparitors.Reserve( 3u );
 348
 349   mSortComparitors.PushBack( CompareItems );
 350   mSortComparitors.PushBack( CompareItems3D );
 351   mSortComparitors.PushBack( CompareItems3DWithClipping );
 352 }
 353
 354 RenderInstructionProcessor::~RenderInstructionProcessor() = default;
 355
 356 inline void RenderInstructionProcessor::SortRenderItems( BufferIndex bufferIndex, RenderList& renderList, Layer& layer, bool respectClippingOrder )
 357 {
 358   const uint32_t renderableCount = static_cast<uint32_t>( renderList.Count() );
 359   // Reserve space if needed.
 360   const uint32_t oldcapacity = static_cast<uint32_t>( mSortingHelper.size() );
 361   if( oldcapacity < renderableCount )
 362   {
 363     mSortingHelper.reserve( renderableCount );
 364     // Add real objects (reserve does not construct objects).
 365     mSortingHelper.insert( mSortingHelper.begin() + oldcapacity,
 366                           (renderableCount - oldcapacity),
 367                           RenderInstructionProcessor::SortAttributes() );
 368   }
 369   else
 370   {
 371     // Clear extra elements from helper, does not decrease capability.
 372     mSortingHelper.resize( renderableCount );
 373   }
 374
 375   // Calculate the sorting value, once per item by calling the layers sort function.
 376   // Using an if and two for-loops rather than if inside for as its better for branch prediction.
 377   if( layer.UsesDefaultSortFunction() )
 378   {
 379     for( uint32_t index = 0; index < renderableCount; ++index )
 380     {
 381       RenderItem& item = renderList.GetItem( index );
 382
 383       if( item.mRenderer )
 384       {
 385         item.mRenderer->SetSortAttributes( bufferIndex, mSortingHelper[ index ] );
 386       }
 387
 388       // texture set
 389       mSortingHelper[ index ].textureSet = item.mTextureSet;
 390
 391       // The default sorting function should get inlined here.
 392       mSortingHelper[ index ].zValue = Internal::Layer::ZValue( item.mModelViewMatrix.GetTranslation3() ) - static_cast<float>( item.mDepthIndex );
 393
 394       // Keep the renderitem pointer in the helper so we can quickly reorder items after sort.
 395       mSortingHelper[ index ].renderItem = &item;
 396     }
 397   }
 398   else
 399   {
 400     const Dali::Layer::SortFunctionType sortFunction = layer.GetSortFunction();
 401     for( uint32_t index = 0; index < renderableCount; ++index )
 402     {
 403       RenderItem& item = renderList.GetItem( index );
 404
 405       item.mRenderer->SetSortAttributes( bufferIndex, mSortingHelper[ index ] );
 406
 407       // texture set
 408       mSortingHelper[ index ].textureSet = item.mTextureSet;
 409
 410
 411       mSortingHelper[ index ].zValue = (*sortFunction)( item.mModelViewMatrix.GetTranslation3() ) - static_cast<float>( item.mDepthIndex );
 412
 413       // Keep the RenderItem pointer in the helper so we can quickly reorder items after sort.
 414       mSortingHelper[ index ].renderItem = &item;
 415     }
 416   }
 417
 418   // Here we determine which comparitor (of the 3) to use.
 419   //   0 is LAYER_UI
 420   //   1 is LAYER_3D
 421   //   2 is LAYER_3D + Clipping
 422   const unsigned int comparitorIndex = layer.GetBehavior() == Dali::Layer::LAYER_3D ? respectClippingOrder ? 2u : 1u : 0u;
 423
 424   std::stable_sort( mSortingHelper.begin(), mSortingHelper.end(), mSortComparitors[ comparitorIndex ] );
 425
 426   // Reorder / re-populate the RenderItems in the RenderList to correct order based on the sortinghelper.
 427   DALI_LOG_INFO( gRenderListLogFilter, Debug::Verbose, "Sorted Transparent List:\n");
 428   RenderItemContainer::Iterator renderListIter = renderList.GetContainer().Begin();
 429   for( uint32_t index = 0; index < renderableCount; ++index, ++renderListIter )
 430   {
 431     *renderListIter = mSortingHelper[ index ].renderItem;
 432     DALI_LOG_INFO( gRenderListLogFilter, Debug::Verbose, "  sortedList[%d] = %p\n", index, mSortingHelper[ index ].renderItem->mRenderer);
 433   }
 434 }
 435
 436 void RenderInstructionProcessor::Prepare( BufferIndex updateBufferIndex,
 437                                           SortedLayerPointers& sortedLayers,
 438                                           RenderTask& renderTask,
 439                                           bool cull,
 440                                           bool hasClippingNodes,
 441                                           RenderInstructionContainer& instructions )
 442 {
 443   // Retrieve the RenderInstruction buffer from the RenderInstructionContainer
 444   // then populate with instructions.
 445   RenderInstruction& instruction = renderTask.PrepareRenderInstruction( updateBufferIndex );
 446   bool viewMatrixHasNotChanged = !renderTask.ViewMatrixUpdated();
 447   bool isRenderListAdded = false;
 448   bool isRootLayerDirty = false;
 449
 450   const Matrix& viewMatrix = renderTask.GetViewMatrix( updateBufferIndex );
 451   SceneGraph::Camera& camera = renderTask.GetCamera();
 452
 453   const SortedLayersIter endIter = sortedLayers.end();
 454   for( SortedLayersIter iter = sortedLayers.begin(); iter != endIter; ++iter )
 455   {
 456     Layer& layer = **iter;
 457     const bool tryReuseRenderList( viewMatrixHasNotChanged && layer.CanReuseRenderers( &renderTask.GetCamera() ) );
 458     const bool isLayer3D = layer.GetBehavior() == Dali::Layer::LAYER_3D;
 459     RenderList* renderList = nullptr;
 460
 461     if( layer.IsRoot() && ( layer.GetDirtyFlags() != NodePropertyFlags::NOTHING ) )
 462     {
 463       // 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
 464       isRootLayerDirty = true;
 465     }
 466
 467     if( !layer.colorRenderables.Empty() )
 468     {
 469       RenderableContainer& renderables = layer.colorRenderables;
 470
 471       if( !SetupRenderList( renderables, layer, instruction, tryReuseRenderList, &renderList ) )
 472       {
 473         renderList->SetHasColorRenderItems( true );
 474         AddRenderersToRenderList( updateBufferIndex,
 475                                   *renderList,
 476                                   renderables,
 477                                   viewMatrix,
 478                                   camera,
 479                                   isLayer3D,
 480                                   cull );
 481
 482         // We only use the clipping version of the sort comparitor if any clipping nodes exist within the RenderList.
 483         SortRenderItems( updateBufferIndex, *renderList, layer, hasClippingNodes );
 484       }
 485
 486       isRenderListAdded = true;
 487     }
 488
 489     if( !layer.overlayRenderables.Empty() )
 490     {
 491       RenderableContainer& renderables = layer.overlayRenderables;
 492
 493       if( !SetupRenderList( renderables, layer, instruction, tryReuseRenderList, &renderList ) )
 494       {
 495         renderList->SetHasColorRenderItems( false );
 496         AddRenderersToRenderList( updateBufferIndex,
 497                                   *renderList,
 498                                   renderables,
 499                                   viewMatrix,
 500                                   camera,
 501                                   isLayer3D,
 502                                   cull );
 503
 504         // Clipping hierarchy is irrelevant when sorting overlay items, so we specify using the non-clipping version of the sort comparitor.
 505         SortRenderItems( updateBufferIndex, *renderList, layer, false );
 506       }
 507
 508       isRenderListAdded = true;
 509     }
 510   }
 511
 512   // Inform the render instruction that all renderers have been added and this frame is complete.
 513   instruction.UpdateCompleted();
 514
 515   if( isRenderListAdded || instruction.mIsClearColorSet || isRootLayerDirty )
 516   {
 517     instructions.PushBack( updateBufferIndex, &instruction );
 518   }
 519 }
 520
 521 } // SceneGraph
 522
 523 } // Internal
 524
 525 } // Dali