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

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