dali/internal/render/common/render-manager.cpp

   1 /*
   2  * Copyright (c) 2021 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/render/common/render-manager.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <memory.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/devel-api/threading/thread-pool.h>
  26 #include <dali/integration-api/core.h>
  27 #include <dali/integration-api/gl-context-helper-abstraction.h>
  28
  29 #include <dali/internal/event/common/scene-impl.h>
  30
  31 #include <dali/internal/update/common/scene-graph-scene.h>
  32 #include <dali/internal/update/render-tasks/scene-graph-camera.h>
  33
  34 #include <dali/internal/render/common/render-algorithms.h>
  35 #include <dali/internal/render/common/render-debug.h>
  36 #include <dali/internal/render/common/render-instruction.h>
  37 #include <dali/internal/render/common/render-tracker.h>
  38 #include <dali/internal/render/queue/render-queue.h>
  39 #include <dali/internal/render/renderers/render-frame-buffer.h>
  40 #include <dali/internal/render/renderers/render-texture.h>
  41 #include <dali/internal/render/shaders/program-controller.h>
  42
  43 namespace Dali
  44 {
  45 namespace Internal
  46 {
  47 namespace SceneGraph
  48 {
  49 #if defined(DEBUG_ENABLED)
  50 namespace
  51 {
  52 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_RENDER_MANAGER");
  53 } // unnamed namespace
  54 #endif
  55
  56 /**
  57  * Structure to contain internal data
  58  */
  59 struct RenderManager::Impl
  60 {
  61   Impl(Graphics::Controller&               graphicsController,
  62        Integration::DepthBufferAvailable   depthBufferAvailableParam,
  63        Integration::StencilBufferAvailable stencilBufferAvailableParam,
  64        Integration::PartialUpdateAvailable partialUpdateAvailableParam)
  65   : context(graphicsController.GetGlAbstraction(), &sceneContextContainer),
  66     currentContext(&context),
  67     graphicsController(graphicsController),
  68     renderQueue(),
  69     renderAlgorithms(),
  70     frameCount(0u),
  71     renderBufferIndex(SceneGraphBuffers::INITIAL_UPDATE_BUFFER_INDEX),
  72     rendererContainer(),
  73     samplerContainer(),
  74     textureContainer(),
  75     frameBufferContainer(),
  76     lastFrameWasRendered(false),
  77     programController(graphicsController),
  78     depthBufferAvailable(depthBufferAvailableParam),
  79     stencilBufferAvailable(stencilBufferAvailableParam),
  80     partialUpdateAvailable(partialUpdateAvailableParam)
  81   {
  82     // Create thread pool with just one thread ( there may be a need to create more threads in the future ).
  83     threadPool = std::unique_ptr<Dali::ThreadPool>(new Dali::ThreadPool());
  84     threadPool->Initialize(1u);
  85   }
  86
  87   ~Impl()
  88   {
  89     threadPool.reset(nullptr); // reset now to maintain correct destruction order
  90   }
  91
  92   void AddRenderTracker(Render::RenderTracker* renderTracker)
  93   {
  94     DALI_ASSERT_DEBUG(renderTracker != NULL);
  95     mRenderTrackers.PushBack(renderTracker);
  96   }
  97
  98   void RemoveRenderTracker(Render::RenderTracker* renderTracker)
  99   {
 100     mRenderTrackers.EraseObject(renderTracker);
 101   }
 102
 103   Context* CreateSceneContext()
 104   {
 105     Context* context = new Context(graphicsController.GetGlAbstraction());
 106     sceneContextContainer.PushBack(context);
 107     return context;
 108   }
 109
 110   void DestroySceneContext(Context* sceneContext)
 111   {
 112     auto iter = std::find(sceneContextContainer.Begin(), sceneContextContainer.End(), sceneContext);
 113     if(iter != sceneContextContainer.End())
 114     {
 115       (*iter)->GlContextDestroyed();
 116       sceneContextContainer.Erase(iter);
 117     }
 118   }
 119
 120   Context* ReplaceSceneContext(Context* oldSceneContext)
 121   {
 122     Context* newContext = new Context(graphicsController.GetGlAbstraction());
 123
 124     oldSceneContext->GlContextDestroyed();
 125
 126     std::replace(sceneContextContainer.begin(), sceneContextContainer.end(), oldSceneContext, newContext);
 127     return newContext;
 128   }
 129
 130   void UpdateTrackers()
 131   {
 132     for(auto&& iter : mRenderTrackers)
 133     {
 134       iter->PollSyncObject();
 135     }
 136   }
 137
 138   // the order is important for destruction,
 139   // programs are owned by context at the moment.
 140   Context                  context;               ///< Holds the GL state of the share resource context
 141   Context*                 currentContext;        ///< Holds the GL state of the current context for rendering
 142   OwnerContainer<Context*> sceneContextContainer; ///< List of owned contexts holding the GL state per scene
 143   Graphics::Controller&    graphicsController;
 144   RenderQueue              renderQueue; ///< A message queue for receiving messages from the update-thread.
 145
 146   std::vector<SceneGraph::Scene*> sceneContainer; ///< List of pointers to the scene graph objects of the scenes
 147
 148   Render::RenderAlgorithms renderAlgorithms; ///< The RenderAlgorithms object is used to action the renders required by a RenderInstruction
 149
 150   uint32_t    frameCount;        ///< The current frame count
 151   BufferIndex renderBufferIndex; ///< The index of the buffer to read from; this is opposite of the "update" buffer
 152
 153   OwnerContainer<Render::Renderer*>     rendererContainer;     ///< List of owned renderers
 154   OwnerContainer<Render::Sampler*>      samplerContainer;      ///< List of owned samplers
 155   OwnerContainer<Render::Texture*>      textureContainer;      ///< List of owned textures
 156   OwnerContainer<Render::FrameBuffer*>  frameBufferContainer;  ///< List of owned framebuffers
 157   OwnerContainer<Render::VertexBuffer*> vertexBufferContainer; ///< List of owned vertex buffers
 158   OwnerContainer<Render::Geometry*>     geometryContainer;     ///< List of owned Geometries
 159
 160   bool lastFrameWasRendered; ///< Keeps track of the last frame being rendered due to having render instructions
 161
 162   OwnerContainer<Render::RenderTracker*> mRenderTrackers; ///< List of render trackers
 163
 164   ProgramController programController; ///< Owner of the GL programs
 165
 166   Integration::DepthBufferAvailable   depthBufferAvailable;   ///< Whether the depth buffer is available
 167   Integration::StencilBufferAvailable stencilBufferAvailable; ///< Whether the stencil buffer is available
 168   Integration::PartialUpdateAvailable partialUpdateAvailable; ///< Whether the partial update is available
 169
 170   std::unique_ptr<Dali::ThreadPool> threadPool;            ///< The thread pool
 171   Vector<GLuint>                    boundTextures;         ///< The textures bound for rendering
 172   Vector<GLuint>                    textureDependencyList; ///< The dependency list of binded textures
 173 };
 174
 175 RenderManager* RenderManager::New(Graphics::Controller&               graphicsController,
 176                                   Integration::DepthBufferAvailable   depthBufferAvailable,
 177                                   Integration::StencilBufferAvailable stencilBufferAvailable,
 178                                   Integration::PartialUpdateAvailable partialUpdateAvailable)
 179 {
 180   RenderManager* manager = new RenderManager;
 181   manager->mImpl         = new Impl(graphicsController,
 182                             depthBufferAvailable,
 183                             stencilBufferAvailable,
 184                             partialUpdateAvailable);
 185   return manager;
 186 }
 187
 188 RenderManager::RenderManager()
 189 : mImpl(nullptr)
 190 {
 191 }
 192
 193 RenderManager::~RenderManager()
 194 {
 195   delete mImpl;
 196 }
 197
 198 RenderQueue& RenderManager::GetRenderQueue()
 199 {
 200   return mImpl->renderQueue;
 201 }
 202
 203 void RenderManager::ContextCreated()
 204 {
 205   mImpl->context.GlContextCreated();
 206   mImpl->programController.GlContextCreated();
 207
 208   // renderers, textures and gpu buffers cannot reinitialize themselves
 209   // so they rely on someone reloading the data for them
 210 }
 211
 212 void RenderManager::ContextDestroyed()
 213 {
 214   mImpl->context.GlContextDestroyed();
 215   mImpl->programController.GlContextDestroyed();
 216
 217   //Inform textures
 218   for(auto&& texture : mImpl->textureContainer)
 219   {
 220     texture->GlContextDestroyed();
 221   }
 222
 223   //Inform framebuffers
 224   for(auto&& framebuffer : mImpl->frameBufferContainer)
 225   {
 226     framebuffer->GlContextDestroyed();
 227   }
 228
 229   // inform renderers
 230   for(auto&& renderer : mImpl->rendererContainer)
 231   {
 232     renderer->GlContextDestroyed();
 233   }
 234
 235   // inform context
 236   for(auto&& context : mImpl->sceneContextContainer)
 237   {
 238     context->GlContextDestroyed();
 239   }
 240 }
 241
 242 void RenderManager::SetShaderSaver(ShaderSaver& upstream)
 243 {
 244   mImpl->programController.SetShaderSaver(upstream);
 245 }
 246
 247 void RenderManager::AddRenderer(OwnerPointer<Render::Renderer>& renderer)
 248 {
 249   // Initialize the renderer as we are now in render thread
 250   renderer->Initialize(mImpl->context, mImpl->programController);
 251
 252   mImpl->rendererContainer.PushBack(renderer.Release());
 253 }
 254
 255 void RenderManager::RemoveRenderer(Render::Renderer* renderer)
 256 {
 257   mImpl->rendererContainer.EraseObject(renderer);
 258 }
 259
 260 void RenderManager::AddSampler(OwnerPointer<Render::Sampler>& sampler)
 261 {
 262   mImpl->samplerContainer.PushBack(sampler.Release());
 263 }
 264
 265 void RenderManager::RemoveSampler(Render::Sampler* sampler)
 266 {
 267   mImpl->samplerContainer.EraseObject(sampler);
 268 }
 269
 270 void RenderManager::AddTexture(OwnerPointer<Render::Texture>& texture)
 271 {
 272   texture->Initialize(mImpl->context);
 273   mImpl->textureContainer.PushBack(texture.Release());
 274 }
 275
 276 void RenderManager::RemoveTexture(Render::Texture* texture)
 277 {
 278   DALI_ASSERT_DEBUG(NULL != texture);
 279
 280   // Find the texture, use reference to pointer so we can do the erase safely
 281   for(auto&& iter : mImpl->textureContainer)
 282   {
 283     if(iter == texture)
 284     {
 285       texture->Destroy(mImpl->context);
 286       mImpl->textureContainer.Erase(&iter); // Texture found; now destroy it
 287       return;
 288     }
 289   }
 290 }
 291
 292 void RenderManager::UploadTexture(Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params)
 293 {
 294   texture->Upload(mImpl->context, pixelData, params);
 295 }
 296
 297 void RenderManager::GenerateMipmaps(Render::Texture* texture)
 298 {
 299   texture->GenerateMipmaps(mImpl->context);
 300 }
 301
 302 void RenderManager::SetFilterMode(Render::Sampler* sampler, uint32_t minFilterMode, uint32_t magFilterMode)
 303 {
 304   sampler->mMinificationFilter  = static_cast<Dali::FilterMode::Type>(minFilterMode);
 305   sampler->mMagnificationFilter = static_cast<Dali::FilterMode::Type>(magFilterMode);
 306 }
 307
 308 void RenderManager::SetWrapMode(Render::Sampler* sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode)
 309 {
 310   sampler->mRWrapMode = static_cast<Dali::WrapMode::Type>(rWrapMode);
 311   sampler->mSWrapMode = static_cast<Dali::WrapMode::Type>(sWrapMode);
 312   sampler->mTWrapMode = static_cast<Dali::WrapMode::Type>(tWrapMode);
 313 }
 314
 315 void RenderManager::AddFrameBuffer(OwnerPointer<Render::FrameBuffer>& frameBuffer)
 316 {
 317   Render::FrameBuffer* frameBufferPtr = frameBuffer.Release();
 318   mImpl->frameBufferContainer.PushBack(frameBufferPtr);
 319   frameBufferPtr->Initialize(mImpl->context);
 320 }
 321
 322 void RenderManager::RemoveFrameBuffer(Render::FrameBuffer* frameBuffer)
 323 {
 324   DALI_ASSERT_DEBUG(NULL != frameBuffer);
 325
 326   // Find the sampler, use reference so we can safely do the erase
 327   for(auto&& iter : mImpl->frameBufferContainer)
 328   {
 329     if(iter == frameBuffer)
 330     {
 331       frameBuffer->Destroy(mImpl->context);
 332       mImpl->frameBufferContainer.Erase(&iter); // frameBuffer found; now destroy it
 333
 334       break;
 335     }
 336   }
 337 }
 338
 339 void RenderManager::InitializeScene(SceneGraph::Scene* scene)
 340 {
 341   scene->Initialize(*mImpl->CreateSceneContext());
 342   mImpl->sceneContainer.push_back(scene);
 343 }
 344
 345 void RenderManager::UninitializeScene(SceneGraph::Scene* scene)
 346 {
 347   mImpl->DestroySceneContext(scene->GetContext());
 348
 349   auto iter = std::find(mImpl->sceneContainer.begin(), mImpl->sceneContainer.end(), scene);
 350   if(iter != mImpl->sceneContainer.end())
 351   {
 352     mImpl->sceneContainer.erase(iter);
 353   }
 354 }
 355
 356 void RenderManager::SurfaceReplaced(SceneGraph::Scene* scene)
 357 {
 358   Context* newContext = mImpl->ReplaceSceneContext(scene->GetContext());
 359   scene->Initialize(*newContext);
 360 }
 361
 362 void RenderManager::AttachColorTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer)
 363 {
 364   frameBuffer->AttachColorTexture(mImpl->context, texture, mipmapLevel, layer);
 365 }
 366
 367 void RenderManager::AttachDepthTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel)
 368 {
 369   frameBuffer->AttachDepthTexture(mImpl->context, texture, mipmapLevel);
 370 }
 371
 372 void RenderManager::AttachDepthStencilTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel)
 373 {
 374   frameBuffer->AttachDepthStencilTexture(mImpl->context, texture, mipmapLevel);
 375 }
 376
 377 void RenderManager::AddVertexBuffer(OwnerPointer<Render::VertexBuffer>& vertexBuffer)
 378 {
 379   mImpl->vertexBufferContainer.PushBack(vertexBuffer.Release());
 380 }
 381
 382 void RenderManager::RemoveVertexBuffer(Render::VertexBuffer* vertexBuffer)
 383 {
 384   mImpl->vertexBufferContainer.EraseObject(vertexBuffer);
 385 }
 386
 387 void RenderManager::SetVertexBufferFormat(Render::VertexBuffer* vertexBuffer, OwnerPointer<Render::VertexBuffer::Format>& format)
 388 {
 389   vertexBuffer->SetFormat(format.Release());
 390 }
 391
 392 void RenderManager::SetVertexBufferData(Render::VertexBuffer* vertexBuffer, OwnerPointer<Vector<uint8_t>>& data, uint32_t size)
 393 {
 394   vertexBuffer->SetData(data.Release(), size);
 395 }
 396
 397 void RenderManager::SetIndexBuffer(Render::Geometry* geometry, Dali::Vector<uint16_t>& indices)
 398 {
 399   geometry->SetIndexBuffer(indices);
 400 }
 401
 402 void RenderManager::AddGeometry(OwnerPointer<Render::Geometry>& geometry)
 403 {
 404   mImpl->geometryContainer.PushBack(geometry.Release());
 405 }
 406
 407 void RenderManager::RemoveGeometry(Render::Geometry* geometry)
 408 {
 409   mImpl->geometryContainer.EraseObject(geometry);
 410 }
 411
 412 void RenderManager::AttachVertexBuffer(Render::Geometry* geometry, Render::VertexBuffer* vertexBuffer)
 413 {
 414   DALI_ASSERT_DEBUG(NULL != geometry);
 415
 416   // Find the geometry
 417   for(auto&& iter : mImpl->geometryContainer)
 418   {
 419     if(iter == geometry)
 420     {
 421       iter->AddVertexBuffer(vertexBuffer);
 422       break;
 423     }
 424   }
 425 }
 426
 427 void RenderManager::RemoveVertexBuffer(Render::Geometry* geometry, Render::VertexBuffer* vertexBuffer)
 428 {
 429   DALI_ASSERT_DEBUG(NULL != geometry);
 430
 431   // Find the geometry
 432   for(auto&& iter : mImpl->geometryContainer)
 433   {
 434     if(iter == geometry)
 435     {
 436       iter->RemoveVertexBuffer(vertexBuffer);
 437       break;
 438     }
 439   }
 440 }
 441
 442 void RenderManager::SetGeometryType(Render::Geometry* geometry, uint32_t geometryType)
 443 {
 444   geometry->SetType(Render::Geometry::Type(geometryType));
 445 }
 446
 447 void RenderManager::AddRenderTracker(Render::RenderTracker* renderTracker)
 448 {
 449   mImpl->AddRenderTracker(renderTracker);
 450 }
 451
 452 void RenderManager::RemoveRenderTracker(Render::RenderTracker* renderTracker)
 453 {
 454   mImpl->RemoveRenderTracker(renderTracker);
 455 }
 456
 457 ProgramCache* RenderManager::GetProgramCache()
 458 {
 459   return &(mImpl->programController);
 460 }
 461
 462 void RenderManager::PreRender(Integration::RenderStatus& status, bool forceClear, bool uploadOnly)
 463 {
 464   DALI_PRINT_RENDER_START(mImpl->renderBufferIndex);
 465
 466   // Core::Render documents that GL context must be current before calling Render
 467   DALI_ASSERT_DEBUG(mImpl->context.IsGlContextCreated());
 468
 469   // Increment the frame count at the beginning of each frame
 470   ++mImpl->frameCount;
 471
 472   // Process messages queued during previous update
 473   mImpl->renderQueue.ProcessMessages(mImpl->renderBufferIndex);
 474
 475   uint32_t count = 0u;
 476   for(uint32_t i = 0; i < mImpl->sceneContainer.size(); ++i)
 477   {
 478     count += mImpl->sceneContainer[i]->GetRenderInstructions().Count(mImpl->renderBufferIndex);
 479   }
 480
 481   const bool haveInstructions = count > 0u;
 482
 483   DALI_LOG_INFO(gLogFilter, Debug::General, "Render: haveInstructions(%s) || mImpl->lastFrameWasRendered(%s) || forceClear(%s)\n", haveInstructions ? "true" : "false", mImpl->lastFrameWasRendered ? "true" : "false", forceClear ? "true" : "false");
 484
 485   // Only render if we have instructions to render, or the last frame was rendered (and therefore a clear is required).
 486   if(haveInstructions || mImpl->lastFrameWasRendered || forceClear)
 487   {
 488     DALI_LOG_INFO(gLogFilter, Debug::General, "Render: Processing\n");
 489
 490     // Switch to the shared context
 491     if(mImpl->currentContext != &mImpl->context)
 492     {
 493       mImpl->currentContext = &mImpl->context;
 494
 495       if(mImpl->currentContext->IsSurfacelessContextSupported())
 496       {
 497         mImpl->graphicsController.GetGlContextHelperAbstraction().MakeSurfacelessContextCurrent();
 498       }
 499
 500       // Clear the current cached program when the context is switched
 501       mImpl->programController.ClearCurrentProgram();
 502     }
 503
 504     // Upload the geometries
 505     for(uint32_t i = 0; i < mImpl->sceneContainer.size(); ++i)
 506     {
 507       RenderInstructionContainer& instructions = mImpl->sceneContainer[i]->GetRenderInstructions();
 508       for(uint32_t j = 0; j < instructions.Count(mImpl->renderBufferIndex); ++j)
 509       {
 510         RenderInstruction& instruction = instructions.At(mImpl->renderBufferIndex, j);
 511
 512         const Matrix* viewMatrix       = instruction.GetViewMatrix(mImpl->renderBufferIndex);
 513         const Matrix* projectionMatrix = instruction.GetProjectionMatrix(mImpl->renderBufferIndex);
 514
 515         DALI_ASSERT_DEBUG(viewMatrix);
 516         DALI_ASSERT_DEBUG(projectionMatrix);
 517
 518         if(viewMatrix && projectionMatrix)
 519         {
 520           const RenderListContainer::SizeType renderListCount = instruction.RenderListCount();
 521
 522           // Iterate through each render list.
 523           for(RenderListContainer::SizeType index = 0; index < renderListCount; ++index)
 524           {
 525             const RenderList* renderList = instruction.GetRenderList(index);
 526
 527             if(renderList && !renderList->IsEmpty())
 528             {
 529               const std::size_t itemCount = renderList->Count();
 530               for(uint32_t itemIndex = 0u; itemIndex < itemCount; ++itemIndex)
 531               {
 532                 const RenderItem& item = renderList->GetItem(itemIndex);
 533                 if(DALI_LIKELY(item.mRenderer))
 534                 {
 535                   item.mRenderer->Upload(*mImpl->currentContext);
 536                 }
 537               }
 538             }
 539           }
 540         }
 541       }
 542     }
 543   }
 544 }
 545
 546 void RenderManager::PreRender(Integration::Scene& scene, std::vector<Rect<int>>& damagedRects)
 547 {
 548   if(mImpl->partialUpdateAvailable != Integration::PartialUpdateAvailable::TRUE)
 549   {
 550     return;
 551   }
 552
 553   Internal::Scene&   sceneInternal = GetImplementation(scene);
 554   SceneGraph::Scene* sceneObject   = sceneInternal.GetSceneObject();
 555
 556   if(sceneObject->IsRenderingSkipped())
 557   {
 558     // We don't need to calculate dirty rects
 559     return;
 560   }
 561
 562   class DamagedRectsCleaner
 563   {
 564   public:
 565     DamagedRectsCleaner(std::vector<Rect<int>>& damagedRects)
 566     : mDamagedRects(damagedRects),
 567       mCleanOnReturn(true)
 568     {
 569     }
 570
 571     void SetCleanOnReturn(bool cleanOnReturn)
 572     {
 573       mCleanOnReturn = cleanOnReturn;
 574     }
 575
 576     ~DamagedRectsCleaner()
 577     {
 578       if(mCleanOnReturn)
 579       {
 580         mDamagedRects.clear();
 581       }
 582     }
 583
 584   private:
 585     std::vector<Rect<int>>& mDamagedRects;
 586     bool                    mCleanOnReturn;
 587   };
 588
 589   Rect<int32_t> surfaceRect = sceneObject->GetSurfaceRect();
 590
 591   // Clean collected dirty/damaged rects on exit if 3d layer or 3d node or other conditions.
 592   DamagedRectsCleaner damagedRectCleaner(damagedRects);
 593
 594   // Mark previous dirty rects in the sorted array. The array is already sorted by node and renderer, frame number.
 595   // so you don't need to sort: std::stable_sort(itemsDirtyRects.begin(), itemsDirtyRects.end());
 596   std::vector<DirtyRect>& itemsDirtyRects = sceneInternal.GetItemsDirtyRects();
 597   for(DirtyRect& dirtyRect : itemsDirtyRects)
 598   {
 599     dirtyRect.visited = false;
 600   }
 601
 602   uint32_t count = sceneObject->GetRenderInstructions().Count(mImpl->renderBufferIndex);
 603   for(uint32_t i = 0; i < count; ++i)
 604   {
 605     RenderInstruction& instruction = sceneObject->GetRenderInstructions().At(mImpl->renderBufferIndex, i);
 606
 607     if(instruction.mFrameBuffer)
 608     {
 609       return; // TODO: reset, we don't deal with render tasks with framebuffers (for now)
 610     }
 611
 612     const Camera* camera = instruction.GetCamera();
 613     if(camera->mType == Camera::DEFAULT_TYPE && camera->mTargetPosition == Camera::DEFAULT_TARGET_POSITION)
 614     {
 615       const Node* node = instruction.GetCamera()->GetNode();
 616       if(node)
 617       {
 618         Vector3    position;
 619         Vector3    scale;
 620         Quaternion orientation;
 621         node->GetWorldMatrix(mImpl->renderBufferIndex).GetTransformComponents(position, orientation, scale);
 622
 623         Vector3 orientationAxis;
 624         Radian  orientationAngle;
 625         orientation.ToAxisAngle(orientationAxis, orientationAngle);
 626
 627         if(position.x > Math::MACHINE_EPSILON_10000 ||
 628            position.y > Math::MACHINE_EPSILON_10000 ||
 629            orientationAxis != Vector3(0.0f, 1.0f, 0.0f) ||
 630            orientationAngle != ANGLE_180 ||
 631            scale != Vector3(1.0f, 1.0f, 1.0f))
 632         {
 633           return;
 634         }
 635       }
 636     }
 637     else
 638     {
 639       return;
 640     }
 641
 642     Rect<int32_t> viewportRect;
 643     if(instruction.mIsViewportSet)
 644     {
 645       const int32_t y = (surfaceRect.height - instruction.mViewport.height) - instruction.mViewport.y;
 646       viewportRect.Set(instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height);
 647       if(viewportRect.IsEmpty() || !viewportRect.IsValid())
 648       {
 649         return; // just skip funny use cases for now, empty viewport means it is set somewhere else
 650       }
 651     }
 652     else
 653     {
 654       viewportRect = surfaceRect;
 655     }
 656
 657     const Matrix* viewMatrix       = instruction.GetViewMatrix(mImpl->renderBufferIndex);
 658     const Matrix* projectionMatrix = instruction.GetProjectionMatrix(mImpl->renderBufferIndex);
 659     if(viewMatrix && projectionMatrix)
 660     {
 661       const RenderListContainer::SizeType count = instruction.RenderListCount();
 662       for(RenderListContainer::SizeType index = 0u; index < count; ++index)
 663       {
 664         const RenderList* renderList = instruction.GetRenderList(index);
 665         if(renderList && !renderList->IsEmpty())
 666         {
 667           const std::size_t count = renderList->Count();
 668           for(uint32_t index = 0u; index < count; ++index)
 669           {
 670             RenderItem& item = renderList->GetItem(index);
 671             // If the item does 3D transformation, do early exit and clean the damaged rect array
 672             if(item.mUpdateSize == Vector3::ZERO)
 673             {
 674               return;
 675             }
 676
 677             Rect<int> rect;
 678             DirtyRect dirtyRect(item.mNode, item.mRenderer, mImpl->frameCount, rect);
 679             // If the item refers to updated node or renderer.
 680             if(item.mIsUpdated ||
 681                (item.mNode &&
 682                 (item.mNode->Updated() || (item.mRenderer && item.mRenderer->Updated(mImpl->renderBufferIndex, item.mNode)))))
 683             {
 684               item.mIsUpdated = false;
 685               item.mNode->SetUpdated(false);
 686
 687               rect = item.CalculateViewportSpaceAABB(item.mUpdateSize, viewportRect.width, viewportRect.height);
 688               if(rect.IsValid() && rect.Intersect(viewportRect) && !rect.IsEmpty())
 689               {
 690                 const int left   = rect.x;
 691                 const int top    = rect.y;
 692                 const int right  = rect.x + rect.width;
 693                 const int bottom = rect.y + rect.height;
 694                 rect.x           = (left / 16) * 16;
 695                 rect.y           = (top / 16) * 16;
 696                 rect.width       = ((right + 16) / 16) * 16 - rect.x;
 697                 rect.height      = ((bottom + 16) / 16) * 16 - rect.y;
 698
 699                 // Found valid dirty rect.
 700                 // 1. Insert it in the sorted array of the dirty rects.
 701                 // 2. Mark the related dirty rects as visited so they will not be removed below.
 702                 // 3. Keep only last 3 dirty rects for the same node and renderer (Tizen uses 3 back buffers, Ubuntu 1).
 703                 dirtyRect.rect    = rect;
 704                 auto dirtyRectPos = std::lower_bound(itemsDirtyRects.begin(), itemsDirtyRects.end(), dirtyRect);
 705                 dirtyRectPos      = itemsDirtyRects.insert(dirtyRectPos, dirtyRect);
 706
 707                 int c = 1;
 708                 while(++dirtyRectPos != itemsDirtyRects.end())
 709                 {
 710                   if(dirtyRectPos->node != item.mNode || dirtyRectPos->renderer != item.mRenderer)
 711                   {
 712                     break;
 713                   }
 714
 715                   dirtyRectPos->visited = true;
 716                   Rect<int>& dirtRect   = dirtyRectPos->rect;
 717                   rect.Merge(dirtRect);
 718
 719                   c++;
 720                   if(c > 3) // no more then 3 previous rects
 721                   {
 722                     itemsDirtyRects.erase(dirtyRectPos);
 723                     break;
 724                   }
 725                 }
 726
 727                 damagedRects.push_back(rect);
 728               }
 729             }
 730             else
 731             {
 732               // 1. The item is not dirty, the node and renderer referenced by the item are still exist.
 733               // 2. Mark the related dirty rects as visited so they will not be removed below.
 734               auto dirtyRectPos = std::lower_bound(itemsDirtyRects.begin(), itemsDirtyRects.end(), dirtyRect);
 735               while(dirtyRectPos != itemsDirtyRects.end())
 736               {
 737                 if(dirtyRectPos->node != item.mNode || dirtyRectPos->renderer != item.mRenderer)
 738                 {
 739                   break;
 740                 }
 741
 742                 dirtyRectPos->visited = true;
 743                 dirtyRectPos++;
 744               }
 745             }
 746           }
 747         }
 748       }
 749     }
 750   }
 751
 752   // Check removed nodes or removed renderers dirty rects
 753   auto i = itemsDirtyRects.begin();
 754   auto j = itemsDirtyRects.begin();
 755   while(i != itemsDirtyRects.end())
 756   {
 757     if(i->visited)
 758     {
 759       *j++ = *i;
 760     }
 761     else
 762     {
 763       Rect<int>& dirtRect = i->rect;
 764       damagedRects.push_back(dirtRect);
 765     }
 766     i++;
 767   }
 768
 769   itemsDirtyRects.resize(j - itemsDirtyRects.begin());
 770   damagedRectCleaner.SetCleanOnReturn(false);
 771 }
 772
 773 void RenderManager::RenderScene(Integration::RenderStatus& status, Integration::Scene& scene, bool renderToFbo)
 774 {
 775   Rect<int> clippingRect;
 776   RenderScene(status, scene, renderToFbo, clippingRect);
 777 }
 778
 779 void RenderManager::RenderScene(Integration::RenderStatus& status, Integration::Scene& scene, bool renderToFbo, Rect<int>& clippingRect)
 780 {
 781   Internal::Scene&   sceneInternal = GetImplementation(scene);
 782   SceneGraph::Scene* sceneObject   = sceneInternal.GetSceneObject();
 783
 784   uint32_t count = sceneObject->GetRenderInstructions().Count(mImpl->renderBufferIndex);
 785
 786   for(uint32_t i = 0; i < count; ++i)
 787   {
 788     RenderInstruction& instruction = sceneObject->GetRenderInstructions().At(mImpl->renderBufferIndex, i);
 789
 790     if((renderToFbo && !instruction.mFrameBuffer) || (!renderToFbo && instruction.mFrameBuffer))
 791     {
 792       continue; // skip
 793     }
 794
 795     // Mark that we will require a post-render step to be performed (includes swap-buffers).
 796     status.SetNeedsPostRender(true);
 797
 798     Rect<int32_t> viewportRect;
 799     Vector4       clearColor;
 800
 801     if(instruction.mIsClearColorSet)
 802     {
 803       clearColor = instruction.mClearColor;
 804     }
 805     else
 806     {
 807       clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
 808     }
 809
 810     Rect<int32_t> surfaceRect        = sceneObject->GetSurfaceRect();
 811     int32_t       surfaceOrientation = sceneObject->GetSurfaceOrientation();
 812
 813     Integration::DepthBufferAvailable   depthBufferAvailable   = mImpl->depthBufferAvailable;
 814     Integration::StencilBufferAvailable stencilBufferAvailable = mImpl->stencilBufferAvailable;
 815
 816     if(instruction.mFrameBuffer)
 817     {
 818       // offscreen buffer
 819       if(mImpl->currentContext != &mImpl->context)
 820       {
 821         // Switch to shared context for off-screen buffer
 822         mImpl->currentContext = &mImpl->context;
 823
 824         if(mImpl->currentContext->IsSurfacelessContextSupported())
 825         {
 826           mImpl->graphicsController.GetGlContextHelperAbstraction().MakeSurfacelessContextCurrent();
 827         }
 828
 829         // Clear the current cached program when the context is switched
 830         mImpl->programController.ClearCurrentProgram();
 831       }
 832     }
 833     else
 834     {
 835       if(mImpl->currentContext->IsSurfacelessContextSupported())
 836       {
 837         if(mImpl->currentContext != sceneObject->GetContext())
 838         {
 839           // Switch the correct context if rendering to a surface
 840           mImpl->currentContext = sceneObject->GetContext();
 841
 842           // Clear the current cached program when the context is switched
 843           mImpl->programController.ClearCurrentProgram();
 844         }
 845       }
 846     }
 847
 848     // Make sure that GL context must be created
 849     mImpl->currentContext->GlContextCreated();
 850
 851     // reset the program matrices for all programs once per frame
 852     // this ensures we will set view and projection matrix once per program per camera
 853     mImpl->programController.ResetProgramMatrices();
 854
 855     if(instruction.mFrameBuffer)
 856     {
 857       instruction.mFrameBuffer->Bind(*mImpl->currentContext);
 858
 859       // For each offscreen buffer, update the dependency list with the new texture id used by this frame buffer.
 860       for(unsigned int i0 = 0, i1 = instruction.mFrameBuffer->GetColorAttachmentCount(); i0 < i1; ++i0)
 861       {
 862         mImpl->textureDependencyList.PushBack(instruction.mFrameBuffer->GetTextureId(i0));
 863       }
 864     }
 865     else
 866     {
 867       mImpl->currentContext->BindFramebuffer(GL_FRAMEBUFFER, 0u);
 868     }
 869
 870     if(!instruction.mFrameBuffer)
 871     {
 872       mImpl->currentContext->Viewport(surfaceRect.x,
 873                                       surfaceRect.y,
 874                                       surfaceRect.width,
 875                                       surfaceRect.height);
 876     }
 877
 878     // Clear the entire color, depth and stencil buffers for the default framebuffer, if required.
 879     // It is important to clear all 3 buffers when they are being used, for performance on deferred renderers
 880     // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
 881     // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
 882     GLbitfield clearMask = GL_COLOR_BUFFER_BIT;
 883
 884     mImpl->currentContext->ColorMask(true);
 885
 886     if(depthBufferAvailable == Integration::DepthBufferAvailable::TRUE)
 887     {
 888       mImpl->currentContext->DepthMask(true);
 889       clearMask |= GL_DEPTH_BUFFER_BIT;
 890     }
 891
 892     if(stencilBufferAvailable == Integration::StencilBufferAvailable::TRUE)
 893     {
 894       mImpl->currentContext->ClearStencil(0);
 895       mImpl->currentContext->StencilMask(0xFF); // 8 bit stencil mask, all 1's
 896       clearMask |= GL_STENCIL_BUFFER_BIT;
 897     }
 898
 899     if(!instruction.mIgnoreRenderToFbo && (instruction.mFrameBuffer != nullptr))
 900     {
 901       // Offscreen buffer rendering
 902       if(instruction.mIsViewportSet)
 903       {
 904         // For glViewport the lower-left corner is (0,0)
 905         const int32_t y = (instruction.mFrameBuffer->GetHeight() - instruction.mViewport.height) - instruction.mViewport.y;
 906         viewportRect.Set(instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height);
 907       }
 908       else
 909       {
 910         viewportRect.Set(0, 0, instruction.mFrameBuffer->GetWidth(), instruction.mFrameBuffer->GetHeight());
 911       }
 912       surfaceOrientation = 0;
 913     }
 914     else // No Offscreen frame buffer rendering
 915     {
 916       // Check whether a viewport is specified, otherwise the full surface size is used
 917       if(instruction.mIsViewportSet)
 918       {
 919         // For glViewport the lower-left corner is (0,0)
 920         const int32_t y = (surfaceRect.height - instruction.mViewport.height) - instruction.mViewport.y;
 921         viewportRect.Set(instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height);
 922       }
 923       else
 924       {
 925         viewportRect = surfaceRect;
 926       }
 927     }
 928
 929     // Set surface orientation
 930     mImpl->currentContext->SetSurfaceOrientation(surfaceOrientation);
 931
 932     bool clearFullFrameRect = true;
 933     if(instruction.mFrameBuffer != nullptr)
 934     {
 935       Viewport frameRect(0, 0, instruction.mFrameBuffer->GetWidth(), instruction.mFrameBuffer->GetHeight());
 936       clearFullFrameRect = (frameRect == viewportRect);
 937     }
 938     else
 939     {
 940       clearFullFrameRect = (surfaceRect == viewportRect);
 941     }
 942
 943     if(!clippingRect.IsEmpty())
 944     {
 945       if(!clippingRect.Intersect(viewportRect))
 946       {
 947         DALI_LOG_ERROR("Invalid clipping rect %d %d %d %d\n", clippingRect.x, clippingRect.y, clippingRect.width, clippingRect.height);
 948         clippingRect = Rect<int>();
 949       }
 950       clearFullFrameRect = false;
 951     }
 952
 953     mImpl->currentContext->Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
 954
 955     if(instruction.mIsClearColorSet)
 956     {
 957       mImpl->currentContext->ClearColor(clearColor.r,
 958                                         clearColor.g,
 959                                         clearColor.b,
 960                                         clearColor.a);
 961       if(!clearFullFrameRect)
 962       {
 963         if(!clippingRect.IsEmpty())
 964         {
 965           mImpl->currentContext->SetScissorTest(true);
 966           mImpl->currentContext->Scissor(clippingRect.x, clippingRect.y, clippingRect.width, clippingRect.height);
 967           mImpl->currentContext->Clear(clearMask, Context::FORCE_CLEAR);
 968           mImpl->currentContext->SetScissorTest(false);
 969         }
 970         else
 971         {
 972           mImpl->currentContext->SetScissorTest(true);
 973           mImpl->currentContext->Scissor(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
 974           mImpl->currentContext->Clear(clearMask, Context::FORCE_CLEAR);
 975           mImpl->currentContext->SetScissorTest(false);
 976         }
 977       }
 978       else
 979       {
 980         mImpl->currentContext->SetScissorTest(false);
 981         mImpl->currentContext->Clear(clearMask, Context::FORCE_CLEAR);
 982       }
 983     }
 984
 985     // Clear the list of bound textures
 986     mImpl->boundTextures.Clear();
 987
 988     mImpl->renderAlgorithms.ProcessRenderInstruction(
 989       instruction,
 990       *mImpl->currentContext,
 991       mImpl->renderBufferIndex,
 992       depthBufferAvailable,
 993       stencilBufferAvailable,
 994       mImpl->boundTextures,
 995       clippingRect);
 996
 997     // Synchronise the FBO/Texture access when there are multiple contexts
 998     if(mImpl->currentContext->IsSurfacelessContextSupported())
 999     {
1000       // Check whether any binded texture is in the dependency list
1001       bool textureFound = false;
1002
1003       if(mImpl->boundTextures.Count() > 0u && mImpl->textureDependencyList.Count() > 0u)
1004       {
1005         for(auto textureId : mImpl->textureDependencyList)
1006         {
1007           textureFound = std::find_if(mImpl->boundTextures.Begin(), mImpl->boundTextures.End(), [textureId](GLuint id) {
1008                            return textureId == id;
1009                          }) != mImpl->boundTextures.End();
1010         }
1011       }
1012
1013       if(textureFound)
1014       {
1015         if(instruction.mFrameBuffer)
1016         {
1017           // For off-screen buffer
1018
1019           // Wait until all rendering calls for the currently context are executed
1020           mImpl->graphicsController.GetGlContextHelperAbstraction().WaitClient();
1021
1022           // Clear the dependency list
1023           mImpl->textureDependencyList.Clear();
1024         }
1025         else
1026         {
1027           // Worker thread lambda function
1028           auto& glContextHelperAbstraction = mImpl->graphicsController.GetGlContextHelperAbstraction();
1029           auto  workerFunction             = [&glContextHelperAbstraction](int workerThread) {
1030             // Switch to the shared context in the worker thread
1031             glContextHelperAbstraction.MakeSurfacelessContextCurrent();
1032
1033             // Wait until all rendering calls for the shared context are executed
1034             glContextHelperAbstraction.WaitClient();
1035
1036             // Must clear the context in the worker thread
1037             // Otherwise the shared context cannot be switched to from the render thread
1038             glContextHelperAbstraction.MakeContextNull();
1039           };
1040
1041           auto future = mImpl->threadPool->SubmitTask(0u, workerFunction);
1042           if(future)
1043           {
1044             mImpl->threadPool->Wait();
1045
1046             // Clear the dependency list
1047             mImpl->textureDependencyList.Clear();
1048           }
1049         }
1050       }
1051     }
1052
1053     if(instruction.mRenderTracker && instruction.mFrameBuffer)
1054     {
1055       // This will create a sync object every frame this render tracker
1056       // is alive (though it should be now be created only for
1057       // render-once render tasks)
1058       instruction.mRenderTracker->CreateSyncObject(mImpl->graphicsController.GetGlSyncAbstraction());
1059       instruction.mRenderTracker = nullptr; // Only create once.
1060     }
1061
1062     if(renderToFbo)
1063     {
1064       mImpl->currentContext->Flush();
1065     }
1066   }
1067
1068   GLenum attachments[] = {GL_DEPTH, GL_STENCIL};
1069   mImpl->currentContext->InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
1070 }
1071
1072 void RenderManager::PostRender(bool uploadOnly)
1073 {
1074   if(!uploadOnly)
1075   {
1076     if(mImpl->currentContext->IsSurfacelessContextSupported())
1077     {
1078       mImpl->graphicsController.GetGlContextHelperAbstraction().MakeSurfacelessContextCurrent();
1079     }
1080
1081     GLenum attachments[] = {GL_DEPTH, GL_STENCIL};
1082     mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
1083   }
1084
1085   //Notify RenderGeometries that rendering has finished
1086   for(auto&& iter : mImpl->geometryContainer)
1087   {
1088     iter->OnRenderFinished();
1089   }
1090
1091   mImpl->UpdateTrackers();
1092
1093   uint32_t count = 0u;
1094   for(uint32_t i = 0; i < mImpl->sceneContainer.size(); ++i)
1095   {
1096     count += mImpl->sceneContainer[i]->GetRenderInstructions().Count(mImpl->renderBufferIndex);
1097   }
1098
1099   const bool haveInstructions = count > 0u;
1100
1101   // If this frame was rendered due to instructions existing, we mark this so we know to clear the next frame.
1102   mImpl->lastFrameWasRendered = haveInstructions;
1103
1104   /**
1105    * The rendering has finished; swap to the next buffer.
1106    * Ideally the update has just finished using this buffer; otherwise the render thread
1107    * should block until the update has finished.
1108    */
1109   mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
1110
1111   DALI_PRINT_RENDER_END();
1112 }
1113
1114 } // namespace SceneGraph
1115
1116 } // namespace Internal
1117
1118 } // namespace Dali