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

   1 /*
   2  * Copyright (c) 2016 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-task-processor.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/internal/update/manager/sorted-layers.h>
  23 #include <dali/internal/update/render-tasks/scene-graph-render-task.h>
  24 #include <dali/internal/update/render-tasks/scene-graph-render-task-list.h>
  25 #include <dali/internal/update/nodes/scene-graph-layer.h>
  26 #include <dali/internal/render/common/render-item.h>
  27 #include <dali/internal/render/common/render-tracker.h>
  28 #include <dali/internal/render/common/render-instruction.h>
  29 #include <dali/internal/render/common/render-instruction-container.h>
  30 #include <dali/internal/render/renderers/render-renderer.h>
  31 #include <dali/integration-api/debug.h>
  32
  33 #if defined(DEBUG_ENABLED)
  34 extern Debug::Filter* gRenderTaskLogFilter;
  35 #endif
  36
  37 namespace Dali
  38 {
  39
  40 namespace Internal
  41 {
  42
  43
  44 namespace SceneGraph
  45 {
  46
  47 namespace //Unnamed namespace
  48 {
  49
  50 // Return false if the node or it's parents are exclusive to another render-task.
  51 bool CheckExclusivity( const Node& node, const RenderTask& task )
  52 {
  53   const RenderTask* exclusiveTo = node.GetExclusiveRenderTask();
  54   if( exclusiveTo )
  55   {
  56     return ( exclusiveTo == &task );
  57   }
  58
  59   const Node* parent = node.GetParent();
  60   if ( parent )
  61   {
  62     return CheckExclusivity( *parent, task );
  63   }
  64
  65   // No exclusive flags set.
  66   return true;
  67 }
  68
  69 Layer* FindLayer( Node& node )
  70 {
  71   Node* currentNode( &node );
  72   Layer* layer( NULL );
  73   while( currentNode )
  74   {
  75     if( ( layer = currentNode->GetLayer() ) != NULL )
  76     {
  77       return layer;
  78     }
  79
  80     currentNode = currentNode->GetParent();
  81   }
  82
  83   return NULL;
  84 }
  85
  86 /**
  87  * Rebuild the Layer::colorRenderables and overlayRenderables members,
  88  * including only renderers which are included in the current render-task.
  89  * Returns true if all renderers have finished acquiring resources.
  90  *
  91  * @param[in] updateBufferIndex The current update buffer index.
  92  * @param[in] node The current node of the scene-graph.
  93  * @param[in] currentLayer The current layer containing lists of opaque/transparent renderables.
  94  * @param[in] renderTask The current render-task.
  95  * @param[in] inheritedDrawMode The draw mode of the parent
  96  * @param[in] parentDepthIndex The inherited parent node depth index
  97  * @param[in] currentClippingId The current Clipping Id
  98  *              Note: ClippingId is passed by reference, so it is permanently modified when traversing back up the tree for uniqueness.
  99  * @param[in] clippingDepth The current clipping depth
 100  */
 101 bool AddRenderablesForTask( BufferIndex updateBufferIndex,
 102                             Node& node,
 103                             Layer& currentLayer,
 104                             RenderTask& renderTask,
 105                             int inheritedDrawMode,
 106                             uint32_t& currentClippingId,
 107                             uint32_t clippingDepth )
 108 {
 109   bool resourcesFinished = true;
 110
 111   // Short-circuit for invisible nodes
 112   if( !node.IsVisible( updateBufferIndex ) )
 113   {
 114     return resourcesFinished;
 115   }
 116
 117   // Check whether node is exclusive to a different render-task
 118   const RenderTask* exclusiveTo = node.GetExclusiveRenderTask();
 119   if( exclusiveTo && ( exclusiveTo != &renderTask ) )
 120   {
 121     return resourcesFinished;
 122   }
 123
 124   // Assume all children go to this layer (if this node is a layer).
 125   Layer* layer = node.GetLayer();
 126   if( layer )
 127   {
 128     // Layers do not inherit the DrawMode from their parents
 129     inheritedDrawMode = node.GetDrawMode();
 130   }
 131   else
 132   {
 133     // This node is not a layer.
 134     layer = &currentLayer;
 135     inheritedDrawMode |= node.GetDrawMode();
 136   }
 137
 138   DALI_ASSERT_DEBUG( NULL != layer );
 139
 140   // Update the clipping Id and depth for this node (if clipping is enabled).
 141   if( DALI_UNLIKELY( node.GetClippingMode() != ClippingMode::DISABLED ) )
 142   {
 143     ++currentClippingId; // This modifies the reference passed in as well as the local value, causing the value to be global to the recursion.
 144     ++clippingDepth;     // This only modifies the local value (which is passed in when the method recurses).
 145   }
 146   // Set the information in the node.
 147   node.SetClippingInformation( currentClippingId, clippingDepth );
 148
 149   const unsigned int count = node.GetRendererCount();
 150   for( unsigned int i = 0; i < count; ++i )
 151   {
 152     SceneGraph::Renderer* renderer = node.GetRendererAt( i );
 153     bool ready = false;
 154     bool complete = false;
 155     renderer->GetReadyAndComplete( ready, complete );
 156
 157     DALI_LOG_INFO( gRenderTaskLogFilter, Debug::General, "Testing renderable:%p ready:%s complete:%s\n", renderer, ready ? "T" : "F", complete ? "T" : "F" );
 158
 159     resourcesFinished &= complete;
 160
 161     if( ready ) // IE. should be rendered (all resources are available)
 162     {
 163       // Normal is the more-likely draw mode to occur.
 164       if( DALI_LIKELY( inheritedDrawMode == DrawMode::NORMAL ) )
 165       {
 166         layer->colorRenderables.PushBack( Renderable( &node, renderer ) );
 167       }
 168       else
 169       {
 170         layer->overlayRenderables.PushBack( Renderable( &node, renderer ) );
 171       }
 172     }
 173   }
 174
 175   // Recurse children.
 176   NodeContainer& children = node.GetChildren();
 177   const NodeIter endIter = children.End();
 178   for( NodeIter iter = children.Begin(); iter != endIter; ++iter )
 179   {
 180     Node& child = **iter;
 181     bool childResourcesComplete = AddRenderablesForTask( updateBufferIndex, child, *layer, renderTask, inheritedDrawMode, currentClippingId, clippingDepth );
 182     resourcesFinished &= childResourcesComplete;
 183   }
 184
 185   return resourcesFinished;
 186 }
 187
 188 } // Anonymous namespace.
 189
 190
 191 RenderTaskProcessor::RenderTaskProcessor()
 192 {
 193 }
 194
 195 RenderTaskProcessor::~RenderTaskProcessor()
 196 {
 197 }
 198
 199 void RenderTaskProcessor::Process( BufferIndex updateBufferIndex,
 200                                    RenderTaskList& renderTasks,
 201                                    Layer& rootNode,
 202                                    SortedLayerPointers& sortedLayers,
 203                                    RenderInstructionContainer& instructions )
 204 {
 205   RenderTaskList::RenderTaskContainer& taskContainer = renderTasks.GetTasks();
 206
 207   if( taskContainer.IsEmpty() )
 208   {
 209     // Early-exit if there are no tasks to process
 210     return;
 211   }
 212
 213   // For each render-task:
 214   //   1) Prepare the render-task
 215   //   2) Clear the layer-stored lists of renderers (TODO check if the layer is not changed and don't clear in this case)
 216   //   3) Traverse the scene-graph, filling the lists for the current render-task
 217   //   4) Prepare render-instructions
 218
 219   DALI_LOG_INFO( gRenderTaskLogFilter, Debug::General, "RenderTaskProcessor::Process() Offscreens first\n" );
 220
 221   // First process off screen render tasks - we may need the results of these for the on screen renders
 222   uint32_t clippingId = 0u;
 223   bool hasClippingNodes = false;
 224
 225   RenderTaskList::RenderTaskContainer::ConstIterator endIter = taskContainer.End();
 226   for( RenderTaskList::RenderTaskContainer::Iterator iter = taskContainer.Begin(); endIter != iter; ++iter )
 227   {
 228     RenderTask& renderTask = **iter;
 229
 230     // Off screen only.
 231     if( ( renderTask.GetFrameBuffer() == 0 ) || ( !renderTask.ReadyToRender( updateBufferIndex ) ) )
 232     {
 233       // Skip to next task.
 234       continue;
 235     }
 236
 237     Node* sourceNode = renderTask.GetSourceNode();
 238     DALI_ASSERT_DEBUG( NULL != sourceNode ); // Otherwise Prepare() should return false
 239
 240     // Check that the source node is not exclusive to another task.
 241     if( ! CheckExclusivity( *sourceNode, renderTask ) )
 242     {
 243       continue;
 244     }
 245
 246     Layer* layer = FindLayer( *sourceNode );
 247     if( !layer )
 248     {
 249       // Skip to next task as no layer.
 250       continue;
 251     }
 252
 253     bool resourcesFinished = false;
 254     if( renderTask.IsRenderRequired() )
 255     {
 256       size_t layerCount( sortedLayers.size() );
 257       for( size_t i(0); i<layerCount; ++i )
 258       {
 259         sortedLayers[i]->ClearRenderables();
 260       }
 261
 262       resourcesFinished = AddRenderablesForTask( updateBufferIndex,
 263                                                  *sourceNode,
 264                                                  *layer,
 265                                                  renderTask,
 266                                                  sourceNode->GetDrawMode(),
 267                                                  clippingId,
 268                                                  0u );
 269
 270       renderTask.SetResourcesFinished( resourcesFinished );
 271
 272       // If the clipping Id is still 0 after adding all Renderables, there is no clipping required for this RenderTaskList.
 273       hasClippingNodes = clippingId != 0u;
 274
 275       mRenderInstructionProcessor.Prepare( updateBufferIndex,
 276                                   sortedLayers,
 277                                   renderTask,
 278                                   renderTask.GetCullMode(),
 279                                   hasClippingNodes,
 280                                   instructions );
 281     }
 282     else
 283     {
 284       renderTask.SetResourcesFinished( resourcesFinished );
 285     }
 286   }
 287
 288   DALI_LOG_INFO( gRenderTaskLogFilter, Debug::General, "RenderTaskProcessor::Process() Onscreen\n" );
 289
 290   // Now that the off screen renders are done we can process on screen render tasks.
 291   // Reset the clipping Id for the OnScreen render tasks.
 292   clippingId = 0u;
 293   for ( RenderTaskList::RenderTaskContainer::Iterator iter = taskContainer.Begin(); endIter != iter; ++iter )
 294   {
 295     RenderTask& renderTask = **iter;
 296
 297     // On screen only.
 298     if( ( renderTask.GetFrameBuffer() != 0 )   || ( !renderTask.ReadyToRender( updateBufferIndex ) ) )
 299     {
 300       // Skip to next task.
 301       continue;
 302     }
 303
 304     Node* sourceNode = renderTask.GetSourceNode();
 305     DALI_ASSERT_DEBUG( NULL != sourceNode ); // Otherwise Prepare() should return false.
 306
 307     // Check that the source node is not exclusive to another task.
 308     if( ! CheckExclusivity( *sourceNode, renderTask ) )
 309     {
 310       continue;
 311     }
 312
 313     Layer* layer = FindLayer( *sourceNode );
 314     if( !layer )
 315     {
 316       // Skip to next task as no layer.
 317       continue;
 318     }
 319
 320     bool resourcesFinished = false;
 321     if( renderTask.IsRenderRequired() )
 322     {
 323       size_t layerCount( sortedLayers.size() );
 324       for( size_t i(0); i < layerCount; ++i )
 325       {
 326         sortedLayers[i]->ClearRenderables();
 327       }
 328
 329       resourcesFinished = AddRenderablesForTask( updateBufferIndex,
 330                                                  *sourceNode,
 331                                                  *layer,
 332                                                  renderTask,
 333                                                  sourceNode->GetDrawMode(),
 334                                                  clippingId,
 335                                                  0u );
 336
 337       // If the clipping Id is still 0 after adding all Renderables, there is no clipping required for this RenderTaskList.
 338       hasClippingNodes = clippingId != 0;
 339
 340       mRenderInstructionProcessor.Prepare( updateBufferIndex,
 341                                   sortedLayers,
 342                                   renderTask,
 343                                   renderTask.GetCullMode(),
 344                                   hasClippingNodes,
 345                                   instructions );
 346     }
 347
 348     renderTask.SetResourcesFinished( resourcesFinished );
 349   }
 350 }
 351
 352
 353 } // SceneGraph
 354
 355 } // Internal
 356
 357 } // Dali