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

   1 /*
   2  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali/internal/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
  28 #include <dali/internal/event/common/scene-impl.h>
  29
  30 #include <dali/internal/update/common/scene-graph-scene.h>
  31 #include <dali/internal/update/nodes/scene-graph-layer.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/pipeline-cache.h>
  40 #include <dali/internal/render/renderers/render-frame-buffer.h>
  41 #include <dali/internal/render/renderers/render-texture.h>
  42 #include <dali/internal/render/renderers/shader-cache.h>
  43 #include <dali/internal/render/renderers/uniform-buffer-manager.h>
  44 #include <dali/internal/render/renderers/uniform-buffer-view-pool.h>
  45 #include <dali/internal/render/shaders/program-controller.h>
  46
  47 #include <memory>
  48
  49 namespace Dali
  50 {
  51 namespace Internal
  52 {
  53 namespace SceneGraph
  54 {
  55 #if defined(DEBUG_ENABLED)
  56 namespace
  57 {
  58 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_RENDER_MANAGER");
  59 } // unnamed namespace
  60 #endif
  61
  62 namespace
  63 {
  64 inline Graphics::Rect2D RecalculateScissorArea(Graphics::Rect2D scissorArea, int orientation, Rect<int32_t> viewportRect)
  65 {
  66   Graphics::Rect2D newScissorArea;
  67
  68   if(orientation == 90)
  69   {
  70     newScissorArea.x      = viewportRect.height - (scissorArea.y + scissorArea.height);
  71     newScissorArea.y      = scissorArea.x;
  72     newScissorArea.width  = scissorArea.height;
  73     newScissorArea.height = scissorArea.width;
  74   }
  75   else if(orientation == 180)
  76   {
  77     newScissorArea.x      = viewportRect.width - (scissorArea.x + scissorArea.width);
  78     newScissorArea.y      = viewportRect.height - (scissorArea.y + scissorArea.height);
  79     newScissorArea.width  = scissorArea.width;
  80     newScissorArea.height = scissorArea.height;
  81   }
  82   else if(orientation == 270)
  83   {
  84     newScissorArea.x      = scissorArea.y;
  85     newScissorArea.y      = viewportRect.width - (scissorArea.x + scissorArea.width);
  86     newScissorArea.width  = scissorArea.height;
  87     newScissorArea.height = scissorArea.width;
  88   }
  89   else
  90   {
  91     newScissorArea.x      = scissorArea.x;
  92     newScissorArea.y      = scissorArea.y;
  93     newScissorArea.width  = scissorArea.width;
  94     newScissorArea.height = scissorArea.height;
  95   }
  96   return newScissorArea;
  97 }
  98 } // namespace
  99
 100 /**
 101  * Structure to contain internal data
 102  */
 103 struct RenderManager::Impl
 104 {
 105   Impl(Graphics::Controller&               graphicsController,
 106        Integration::DepthBufferAvailable   depthBufferAvailableParam,
 107        Integration::StencilBufferAvailable stencilBufferAvailableParam,
 108        Integration::PartialUpdateAvailable partialUpdateAvailableParam)
 109   : graphicsController(graphicsController),
 110     renderQueue(),
 111     renderAlgorithms(graphicsController),
 112     frameCount(0u),
 113     renderBufferIndex(SceneGraphBuffers::INITIAL_UPDATE_BUFFER_INDEX),
 114     rendererContainer(),
 115     samplerContainer(),
 116     textureContainer(),
 117     frameBufferContainer(),
 118     lastFrameWasRendered(false),
 119     programController(graphicsController),
 120     shaderCache(graphicsController),
 121     depthBufferAvailable(depthBufferAvailableParam),
 122     stencilBufferAvailable(stencilBufferAvailableParam),
 123     partialUpdateAvailable(partialUpdateAvailableParam)
 124   {
 125     // Create thread pool with just one thread ( there may be a need to create more threads in the future ).
 126     threadPool = std::make_unique<Dali::ThreadPool>();
 127     threadPool->Initialize(1u);
 128
 129     uniformBufferManager = std::make_unique<Render::UniformBufferManager>(&graphicsController);
 130     pipelineCache        = std::make_unique<Render::PipelineCache>(graphicsController);
 131   }
 132
 133   ~Impl()
 134   {
 135     threadPool.reset(nullptr); // reset now to maintain correct destruction order
 136   }
 137
 138   void AddRenderTracker(Render::RenderTracker* renderTracker)
 139   {
 140     DALI_ASSERT_DEBUG(renderTracker != nullptr);
 141     mRenderTrackers.PushBack(renderTracker);
 142   }
 143
 144   void RemoveRenderTracker(Render::RenderTracker* renderTracker)
 145   {
 146     mRenderTrackers.EraseObject(renderTracker);
 147   }
 148
 149   void UpdateTrackers()
 150   {
 151     for(auto&& iter : mRenderTrackers)
 152     {
 153       iter->PollSyncObject();
 154     }
 155   }
 156
 157   // the order is important for destruction,
 158   Graphics::Controller& graphicsController;
 159   RenderQueue           renderQueue; ///< A message queue for receiving messages from the update-thread.
 160
 161   std::vector<SceneGraph::Scene*> sceneContainer; ///< List of pointers to the scene graph objects of the scenes
 162
 163   Render::RenderAlgorithms renderAlgorithms; ///< The RenderAlgorithms object is used to action the renders required by a RenderInstruction
 164
 165   uint32_t    frameCount;        ///< The current frame count
 166   BufferIndex renderBufferIndex; ///< The index of the buffer to read from; this is opposite of the "update" buffer
 167
 168   OwnerContainer<Render::Renderer*>     rendererContainer;     ///< List of owned renderers
 169   OwnerContainer<Render::Sampler*>      samplerContainer;      ///< List of owned samplers
 170   OwnerContainer<Render::Texture*>      textureContainer;      ///< List of owned textures
 171   OwnerContainer<Render::FrameBuffer*>  frameBufferContainer;  ///< List of owned framebuffers
 172   OwnerContainer<Render::VertexBuffer*> vertexBufferContainer; ///< List of owned vertex buffers
 173   OwnerContainer<Render::Geometry*>     geometryContainer;     ///< List of owned Geometries
 174
 175   bool lastFrameWasRendered; ///< Keeps track of the last frame being rendered due to having render instructions
 176
 177   OwnerContainer<Render::RenderTracker*> mRenderTrackers; ///< List of render trackers
 178
 179   ProgramController   programController; ///< Owner of the programs
 180   Render::ShaderCache shaderCache;       ///< The cache for the graphics shaders
 181
 182   std::unique_ptr<Render::UniformBufferManager> uniformBufferManager; ///< The uniform buffer manager
 183   std::unique_ptr<Render::PipelineCache>        pipelineCache;
 184
 185   Integration::DepthBufferAvailable   depthBufferAvailable;   ///< Whether the depth buffer is available
 186   Integration::StencilBufferAvailable stencilBufferAvailable; ///< Whether the stencil buffer is available
 187   Integration::PartialUpdateAvailable partialUpdateAvailable; ///< Whether the partial update is available
 188
 189   std::unique_ptr<Dali::ThreadPool> threadPool;            ///< The thread pool
 190   Vector<Graphics::Texture*>        boundTextures;         ///< The textures bound for rendering
 191   Vector<Graphics::Texture*>        textureDependencyList; ///< The dependency list of bound textures
 192
 193   bool commandBufferSubmitted{false};
 194 };
 195
 196 RenderManager* RenderManager::New(Graphics::Controller&               graphicsController,
 197                                   Integration::DepthBufferAvailable   depthBufferAvailable,
 198                                   Integration::StencilBufferAvailable stencilBufferAvailable,
 199                                   Integration::PartialUpdateAvailable partialUpdateAvailable)
 200 {
 201   auto* manager  = new RenderManager;
 202   manager->mImpl = new Impl(graphicsController,
 203                             depthBufferAvailable,
 204                             stencilBufferAvailable,
 205                             partialUpdateAvailable);
 206   return manager;
 207 }
 208
 209 RenderManager::RenderManager()
 210 : mImpl(nullptr)
 211 {
 212 }
 213
 214 RenderManager::~RenderManager()
 215 {
 216   delete mImpl;
 217 }
 218
 219 RenderQueue& RenderManager::GetRenderQueue()
 220 {
 221   return mImpl->renderQueue;
 222 }
 223
 224 void RenderManager::SetShaderSaver(ShaderSaver& upstream)
 225 {
 226 }
 227
 228 void RenderManager::AddRenderer(OwnerPointer<Render::Renderer>& renderer)
 229 {
 230   // Initialize the renderer as we are now in render thread
 231   renderer->Initialize(mImpl->graphicsController, mImpl->programController, mImpl->shaderCache, *(mImpl->uniformBufferManager.get()), *(mImpl->pipelineCache.get()));
 232
 233   mImpl->rendererContainer.PushBack(renderer.Release());
 234 }
 235
 236 void RenderManager::RemoveRenderer(Render::Renderer* renderer)
 237 {
 238   mImpl->rendererContainer.EraseObject(renderer);
 239 }
 240
 241 void RenderManager::AddSampler(OwnerPointer<Render::Sampler>& sampler)
 242 {
 243   sampler->Initialize(mImpl->graphicsController);
 244   mImpl->samplerContainer.PushBack(sampler.Release());
 245 }
 246
 247 void RenderManager::RemoveSampler(Render::Sampler* sampler)
 248 {
 249   mImpl->samplerContainer.EraseObject(sampler);
 250 }
 251
 252 void RenderManager::AddTexture(OwnerPointer<Render::Texture>& texture)
 253 {
 254   texture->Initialize(mImpl->graphicsController);
 255   mImpl->textureContainer.PushBack(texture.Release());
 256 }
 257
 258 void RenderManager::RemoveTexture(Render::Texture* texture)
 259 {
 260   DALI_ASSERT_DEBUG(NULL != texture);
 261
 262   // Find the texture, use std::find so we can do the erase safely
 263   auto iter = std::find(mImpl->textureContainer.begin(), mImpl->textureContainer.end(), texture);
 264
 265   if(iter != mImpl->textureContainer.end())
 266   {
 267     texture->Destroy();
 268     mImpl->textureContainer.Erase(iter); // Texture found; now destroy it
 269   }
 270 }
 271
 272 void RenderManager::UploadTexture(Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params)
 273 {
 274   texture->Upload(pixelData, params);
 275 }
 276
 277 void RenderManager::GenerateMipmaps(Render::Texture* texture)
 278 {
 279   texture->GenerateMipmaps();
 280 }
 281
 282 void RenderManager::SetFilterMode(Render::Sampler* sampler, uint32_t minFilterMode, uint32_t magFilterMode)
 283 {
 284   sampler->SetFilterMode(static_cast<Dali::FilterMode::Type>(minFilterMode),
 285                          static_cast<Dali::FilterMode::Type>(magFilterMode));
 286 }
 287
 288 void RenderManager::SetWrapMode(Render::Sampler* sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode)
 289 {
 290   sampler->SetWrapMode(static_cast<Dali::WrapMode::Type>(rWrapMode),
 291                        static_cast<Dali::WrapMode::Type>(sWrapMode),
 292                        static_cast<Dali::WrapMode::Type>(tWrapMode));
 293 }
 294
 295 void RenderManager::AddFrameBuffer(OwnerPointer<Render::FrameBuffer>& frameBuffer)
 296 {
 297   Render::FrameBuffer* frameBufferPtr = frameBuffer.Release();
 298   mImpl->frameBufferContainer.PushBack(frameBufferPtr);
 299   frameBufferPtr->Initialize(mImpl->graphicsController);
 300 }
 301
 302 void RenderManager::RemoveFrameBuffer(Render::FrameBuffer* frameBuffer)
 303 {
 304   DALI_ASSERT_DEBUG(nullptr != frameBuffer);
 305
 306   // Find the framebuffer, use std:find so we can safely do the erase
 307   auto iter = std::find(mImpl->frameBufferContainer.begin(), mImpl->frameBufferContainer.end(), frameBuffer);
 308
 309   if(iter != mImpl->frameBufferContainer.end())
 310   {
 311     frameBuffer->Destroy();
 312     mImpl->frameBufferContainer.Erase(iter); // frameBuffer found; now destroy it
 313   }
 314 }
 315
 316 void RenderManager::InitializeScene(SceneGraph::Scene* scene)
 317 {
 318   scene->Initialize(mImpl->graphicsController, mImpl->depthBufferAvailable, mImpl->stencilBufferAvailable);
 319   mImpl->sceneContainer.push_back(scene);
 320 }
 321
 322 void RenderManager::UninitializeScene(SceneGraph::Scene* scene)
 323 {
 324   auto iter = std::find(mImpl->sceneContainer.begin(), mImpl->sceneContainer.end(), scene);
 325   if(iter != mImpl->sceneContainer.end())
 326   {
 327     mImpl->sceneContainer.erase(iter);
 328   }
 329 }
 330
 331 void RenderManager::SurfaceReplaced(SceneGraph::Scene* scene)
 332 {
 333   scene->Initialize(mImpl->graphicsController, mImpl->depthBufferAvailable, mImpl->stencilBufferAvailable);
 334 }
 335
 336 void RenderManager::AttachColorTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer)
 337 {
 338   frameBuffer->AttachColorTexture(texture, mipmapLevel, layer);
 339 }
 340
 341 void RenderManager::AttachDepthTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel)
 342 {
 343   frameBuffer->AttachDepthTexture(texture, mipmapLevel);
 344 }
 345
 346 void RenderManager::AttachDepthStencilTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel)
 347 {
 348   frameBuffer->AttachDepthStencilTexture(texture, mipmapLevel);
 349 }
 350
 351 void RenderManager::SetMultiSamplingLevelToFrameBuffer(Render::FrameBuffer* frameBuffer, uint8_t multiSamplingLevel)
 352 {
 353   frameBuffer->SetMultiSamplingLevel(multiSamplingLevel);
 354 }
 355
 356 void RenderManager::AddVertexBuffer(OwnerPointer<Render::VertexBuffer>& vertexBuffer)
 357 {
 358   mImpl->vertexBufferContainer.PushBack(vertexBuffer.Release());
 359 }
 360
 361 void RenderManager::RemoveVertexBuffer(Render::VertexBuffer* vertexBuffer)
 362 {
 363   mImpl->vertexBufferContainer.EraseObject(vertexBuffer);
 364 }
 365
 366 void RenderManager::SetVertexBufferFormat(Render::VertexBuffer* vertexBuffer, OwnerPointer<Render::VertexBuffer::Format>& format)
 367 {
 368   vertexBuffer->SetFormat(format.Release());
 369 }
 370
 371 void RenderManager::SetVertexBufferData(Render::VertexBuffer* vertexBuffer, OwnerPointer<Vector<uint8_t>>& data, uint32_t size)
 372 {
 373   vertexBuffer->SetData(data.Release(), size);
 374 }
 375
 376 void RenderManager::SetIndexBuffer(Render::Geometry* geometry, Dali::Vector<uint16_t>& indices)
 377 {
 378   geometry->SetIndexBuffer(indices);
 379 }
 380
 381 void RenderManager::AddGeometry(OwnerPointer<Render::Geometry>& geometry)
 382 {
 383   mImpl->geometryContainer.PushBack(geometry.Release());
 384 }
 385
 386 void RenderManager::RemoveGeometry(Render::Geometry* geometry)
 387 {
 388   auto iter = std::find(mImpl->geometryContainer.begin(), mImpl->geometryContainer.end(), geometry);
 389
 390   if(iter != mImpl->geometryContainer.end())
 391   {
 392     mImpl->geometryContainer.Erase(iter);
 393   }
 394 }
 395
 396 void RenderManager::AttachVertexBuffer(Render::Geometry* geometry, Render::VertexBuffer* vertexBuffer)
 397 {
 398   DALI_ASSERT_DEBUG(nullptr != geometry);
 399
 400   // Find the geometry
 401   for(auto&& iter : mImpl->geometryContainer)
 402   {
 403     if(iter == geometry)
 404     {
 405       iter->AddVertexBuffer(vertexBuffer);
 406       break;
 407     }
 408   }
 409 }
 410
 411 void RenderManager::RemoveVertexBuffer(Render::Geometry* geometry, Render::VertexBuffer* vertexBuffer)
 412 {
 413   DALI_ASSERT_DEBUG(nullptr != geometry);
 414
 415   // Find the geometry
 416   for(auto&& iter : mImpl->geometryContainer)
 417   {
 418     if(iter == geometry)
 419     {
 420       iter->RemoveVertexBuffer(vertexBuffer);
 421       break;
 422     }
 423   }
 424 }
 425
 426 void RenderManager::SetGeometryType(Render::Geometry* geometry, uint32_t geometryType)
 427 {
 428   geometry->SetType(Render::Geometry::Type(geometryType));
 429 }
 430
 431 void RenderManager::AddRenderTracker(Render::RenderTracker* renderTracker)
 432 {
 433   mImpl->AddRenderTracker(renderTracker);
 434 }
 435
 436 void RenderManager::RemoveRenderTracker(Render::RenderTracker* renderTracker)
 437 {
 438   mImpl->RemoveRenderTracker(renderTracker);
 439 }
 440
 441 void RenderManager::PreRender(Integration::RenderStatus& status, bool forceClear)
 442 {
 443   DALI_PRINT_RENDER_START(mImpl->renderBufferIndex);
 444
 445   // Rollback
 446   mImpl->uniformBufferManager->GetUniformBufferViewPool(mImpl->renderBufferIndex)->Rollback();
 447
 448   // Increment the frame count at the beginning of each frame
 449   ++mImpl->frameCount;
 450
 451   // Process messages queued during previous update
 452   mImpl->renderQueue.ProcessMessages(mImpl->renderBufferIndex);
 453
 454   uint32_t count = 0u;
 455   for(auto& i : mImpl->sceneContainer)
 456   {
 457     count += i->GetRenderInstructions().Count(mImpl->renderBufferIndex);
 458   }
 459
 460   const bool haveInstructions = count > 0u;
 461
 462   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");
 463
 464   // Only render if we have instructions to render, or the last frame was rendered (and therefore a clear is required).
 465   if(haveInstructions || mImpl->lastFrameWasRendered || forceClear)
 466   {
 467     DALI_LOG_INFO(gLogFilter, Debug::General, "Render: Processing\n");
 468
 469     // Upload the geometries
 470     for(auto&& geom : mImpl->geometryContainer)
 471     {
 472       geom->Upload(mImpl->graphicsController);
 473     }
 474   }
 475
 476   mImpl->commandBufferSubmitted = false;
 477 }
 478
 479 void RenderManager::PreRender(Integration::Scene& scene, std::vector<Rect<int>>& damagedRects)
 480 {
 481   if(mImpl->partialUpdateAvailable != Integration::PartialUpdateAvailable::TRUE)
 482   {
 483     return;
 484   }
 485
 486   Internal::Scene&   sceneInternal = GetImplementation(scene);
 487   SceneGraph::Scene* sceneObject   = sceneInternal.GetSceneObject();
 488
 489   if(sceneObject->IsRenderingSkipped())
 490   {
 491     // We don't need to calculate dirty rects
 492     return;
 493   }
 494
 495   class DamagedRectsCleaner
 496   {
 497   public:
 498     explicit DamagedRectsCleaner(std::vector<Rect<int>>& damagedRects, Rect<int>& surfaceRect)
 499     : mDamagedRects(damagedRects),
 500       mSurfaceRect(surfaceRect),
 501       mCleanOnReturn(true)
 502     {
 503     }
 504
 505     void SetCleanOnReturn(bool cleanOnReturn)
 506     {
 507       mCleanOnReturn = cleanOnReturn;
 508     }
 509
 510     ~DamagedRectsCleaner()
 511     {
 512       if(mCleanOnReturn)
 513       {
 514         mDamagedRects.clear();
 515         mDamagedRects.push_back(mSurfaceRect);
 516       }
 517     }
 518
 519   private:
 520     std::vector<Rect<int>>& mDamagedRects;
 521     Rect<int>               mSurfaceRect;
 522     bool                    mCleanOnReturn;
 523   };
 524
 525   Rect<int32_t> surfaceRect = sceneObject->GetSurfaceRect();
 526
 527   // Clean collected dirty/damaged rects on exit if 3d layer or 3d node or other conditions.
 528   DamagedRectsCleaner damagedRectCleaner(damagedRects, surfaceRect);
 529   bool                cleanDamagedRect = false;
 530
 531   // Mark previous dirty rects in the sorted array. The array is already sorted by node and renderer, frame number.
 532   // so you don't need to sort: std::stable_sort(itemsDirtyRects.begin(), itemsDirtyRects.end());
 533   std::vector<DirtyRect>& itemsDirtyRects = sceneObject->GetItemsDirtyRects();
 534   for(DirtyRect& dirtyRect : itemsDirtyRects)
 535   {
 536     dirtyRect.visited = false;
 537   }
 538
 539   uint32_t instructionCount = sceneObject->GetRenderInstructions().Count(mImpl->renderBufferIndex);
 540   for(uint32_t i = 0; i < instructionCount; ++i)
 541   {
 542     RenderInstruction& instruction = sceneObject->GetRenderInstructions().At(mImpl->renderBufferIndex, i);
 543
 544     if(instruction.mFrameBuffer)
 545     {
 546       cleanDamagedRect = true;
 547       continue; // TODO: reset, we don't deal with render tasks with framebuffers (for now)
 548     }
 549
 550     const Camera* camera = instruction.GetCamera();
 551     if(camera && camera->mType == Camera::DEFAULT_TYPE && camera->mTargetPosition == Camera::DEFAULT_TARGET_POSITION)
 552     {
 553       Vector3    position;
 554       Vector3    scale;
 555       Quaternion orientation;
 556       camera->GetWorldMatrix(mImpl->renderBufferIndex).GetTransformComponents(position, orientation, scale);
 557
 558       Vector3 orientationAxis;
 559       Radian  orientationAngle;
 560       orientation.ToAxisAngle(orientationAxis, orientationAngle);
 561
 562       if(position.x > Math::MACHINE_EPSILON_10000 ||
 563          position.y > Math::MACHINE_EPSILON_10000 ||
 564          orientationAxis != Vector3(0.0f, 1.0f, 0.0f) ||
 565          orientationAngle != ANGLE_180 ||
 566          scale != Vector3(1.0f, 1.0f, 1.0f))
 567       {
 568         cleanDamagedRect = true;
 569         continue;
 570       }
 571     }
 572     else
 573     {
 574       cleanDamagedRect = true;
 575       continue;
 576     }
 577
 578     Rect<int32_t> viewportRect;
 579     if(instruction.mIsViewportSet)
 580     {
 581       const int32_t y = (surfaceRect.height - instruction.mViewport.height) - instruction.mViewport.y;
 582       viewportRect.Set(instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height);
 583       if(viewportRect.IsEmpty() || !viewportRect.IsValid())
 584       {
 585         cleanDamagedRect = true;
 586         continue; // just skip funny use cases for now, empty viewport means it is set somewhere else
 587       }
 588     }
 589     else
 590     {
 591       viewportRect = surfaceRect;
 592     }
 593
 594     const Matrix* viewMatrix       = instruction.GetViewMatrix(mImpl->renderBufferIndex);
 595     const Matrix* projectionMatrix = instruction.GetProjectionMatrix(mImpl->renderBufferIndex);
 596     if(viewMatrix && projectionMatrix)
 597     {
 598       const RenderListContainer::SizeType count = instruction.RenderListCount();
 599       for(RenderListContainer::SizeType index = 0u; index < count; ++index)
 600       {
 601         const RenderList* renderList = instruction.GetRenderList(index);
 602         if(renderList)
 603         {
 604           if(!renderList->IsEmpty())
 605           {
 606             const std::size_t listCount = renderList->Count();
 607             for(uint32_t listIndex = 0u; listIndex < listCount; ++listIndex)
 608             {
 609               RenderItem& item = renderList->GetItem(listIndex);
 610               // If the item does 3D transformation, make full update
 611               if(item.mUpdateArea == Vector4::ZERO)
 612               {
 613                 cleanDamagedRect = true;
 614
 615                 // Save the full rect in the damaged list. We need it when this item is removed
 616                 DirtyRect dirtyRect(item.mNode, item.mRenderer, surfaceRect);
 617                 auto      dirtyRectPos = std::lower_bound(itemsDirtyRects.begin(), itemsDirtyRects.end(), dirtyRect);
 618                 if(dirtyRectPos != itemsDirtyRects.end() && dirtyRectPos->node == item.mNode && dirtyRectPos->renderer == item.mRenderer)
 619                 {
 620                   // Replace the rect
 621                   dirtyRectPos->visited = true;
 622                   dirtyRectPos->rect    = dirtyRect.rect;
 623                 }
 624                 else
 625                 {
 626                   // Else, just insert the new dirtyrect in the correct position
 627                   itemsDirtyRects.insert(dirtyRectPos, dirtyRect);
 628                 }
 629                 continue;
 630               }
 631
 632               Rect<int> rect;
 633               DirtyRect dirtyRect(item.mNode, item.mRenderer, rect);
 634               // If the item refers to updated node or renderer.
 635               if(item.mIsUpdated ||
 636                  (item.mNode &&
 637                   (item.mNode->Updated() || (item.mRenderer && item.mRenderer->Updated(mImpl->renderBufferIndex)))))
 638               {
 639                 item.mIsUpdated = false;
 640
 641                 Vector4 updateArea = item.mRenderer ? item.mRenderer->GetVisualTransformedUpdateArea(mImpl->renderBufferIndex, item.mUpdateArea) : item.mUpdateArea;
 642
 643                 rect = RenderItem::CalculateViewportSpaceAABB(item.mModelViewMatrix, Vector3(updateArea.x, updateArea.y, 0.0f), Vector3(updateArea.z, updateArea.w, 0.0f), viewportRect.width, viewportRect.height);
 644                 if(rect.IsValid() && rect.Intersect(viewportRect) && !rect.IsEmpty())
 645                 {
 646                   const int left   = rect.x;
 647                   const int top    = rect.y;
 648                   const int right  = rect.x + rect.width;
 649                   const int bottom = rect.y + rect.height;
 650                   rect.x           = (left / 16) * 16;
 651                   rect.y           = (top / 16) * 16;
 652                   rect.width       = ((right + 16) / 16) * 16 - rect.x;
 653                   rect.height      = ((bottom + 16) / 16) * 16 - rect.y;
 654
 655                   // Found valid dirty rect.
 656                   dirtyRect.rect    = rect;
 657                   auto dirtyRectPos = std::lower_bound(itemsDirtyRects.begin(), itemsDirtyRects.end(), dirtyRect);
 658
 659                   if(dirtyRectPos != itemsDirtyRects.end() && dirtyRectPos->node == item.mNode && dirtyRectPos->renderer == item.mRenderer)
 660                   {
 661                     // Same item, merge it with the previous rect
 662                     rect.Merge(dirtyRectPos->rect);
 663
 664                     // Replace the rect
 665                     dirtyRectPos->visited = true;
 666                     dirtyRectPos->rect    = dirtyRect.rect;
 667                   }
 668                   else
 669                   {
 670                     // Else, just insert the new dirtyrect in the correct position
 671                     itemsDirtyRects.insert(dirtyRectPos, dirtyRect);
 672                   }
 673
 674                   damagedRects.push_back(rect);
 675                 }
 676               }
 677               else
 678               {
 679                 // 1. The item is not dirty, the node and renderer referenced by the item are still exist.
 680                 // 2. Mark the related dirty rects as visited so they will not be removed below.
 681                 auto dirtyRectPos = std::lower_bound(itemsDirtyRects.begin(), itemsDirtyRects.end(), dirtyRect);
 682                 if(dirtyRectPos != itemsDirtyRects.end() && dirtyRectPos->node == item.mNode && dirtyRectPos->renderer == item.mRenderer)
 683                 {
 684                   dirtyRectPos->visited = true;
 685                 }
 686                 else
 687                 {
 688                   // The item is not in the list for some reason. Add it!
 689                   dirtyRect.rect = surfaceRect;
 690                   itemsDirtyRects.insert(dirtyRectPos, dirtyRect);
 691                   cleanDamagedRect = true; // And make full update at this frame
 692                 }
 693               }
 694             }
 695           }
 696         }
 697       }
 698     }
 699   }
 700
 701   // Check removed nodes or removed renderers dirty rects
 702   auto i = itemsDirtyRects.begin();
 703   auto j = itemsDirtyRects.begin();
 704   while(i != itemsDirtyRects.end())
 705   {
 706     if(i->visited)
 707     {
 708       *j++ = *i;
 709     }
 710     else
 711     {
 712       Rect<int>& dirtRect = i->rect;
 713       damagedRects.push_back(dirtRect);
 714     }
 715     i++;
 716   }
 717
 718   itemsDirtyRects.resize(j - itemsDirtyRects.begin());
 719
 720   if(!cleanDamagedRect)
 721   {
 722     damagedRectCleaner.SetCleanOnReturn(false);
 723   }
 724 }
 725
 726 void RenderManager::RenderScene(Integration::RenderStatus& status, Integration::Scene& scene, bool renderToFbo)
 727 {
 728   SceneGraph::Scene* sceneObject  = GetImplementation(scene).GetSceneObject();
 729   Rect<int>          clippingRect = sceneObject->GetSurfaceRect();
 730
 731   RenderScene(status, scene, renderToFbo, clippingRect);
 732 }
 733
 734 void RenderManager::RenderScene(Integration::RenderStatus& status, Integration::Scene& scene, bool renderToFbo, Rect<int>& clippingRect)
 735 {
 736   if(mImpl->partialUpdateAvailable == Integration::PartialUpdateAvailable::TRUE && !renderToFbo && clippingRect.IsEmpty())
 737   {
 738     // ClippingRect is empty. Skip rendering
 739     return;
 740   }
 741
 742   // Reset main algorithms command buffer
 743   mImpl->renderAlgorithms.ResetCommandBuffer();
 744
 745   auto mainCommandBuffer = mImpl->renderAlgorithms.GetMainCommandBuffer();
 746
 747   Internal::Scene&   sceneInternal = GetImplementation(scene);
 748   SceneGraph::Scene* sceneObject   = sceneInternal.GetSceneObject();
 749
 750   uint32_t count = sceneObject->GetRenderInstructions().Count(mImpl->renderBufferIndex);
 751
 752   std::vector<Graphics::RenderTarget*> targetstoPresent;
 753
 754   Rect<int32_t> surfaceRect = sceneObject->GetSurfaceRect();
 755   if(clippingRect == surfaceRect)
 756   {
 757     // Full rendering case
 758     // Make clippingRect empty because we're doing full rendering now if the clippingRect is empty.
 759     // To reduce side effects, keep this logic now.
 760     clippingRect = Rect<int>();
 761   }
 762
 763   // Prepare to lock and map standalone uniform buffer.
 764   mImpl->uniformBufferManager->ReadyToLockUniformBuffer(mImpl->renderBufferIndex);
 765
 766   for(uint32_t i = 0; i < count; ++i)
 767   {
 768     RenderInstruction& instruction = sceneObject->GetRenderInstructions().At(mImpl->renderBufferIndex, i);
 769
 770     if((renderToFbo && !instruction.mFrameBuffer) || (!renderToFbo && instruction.mFrameBuffer))
 771     {
 772       continue; // skip
 773     }
 774
 775     // Mark that we will require a post-render step to be performed (includes swap-buffers).
 776     status.SetNeedsPostRender(true);
 777
 778     Rect<int32_t> viewportRect;
 779
 780     int32_t surfaceOrientation = sceneObject->GetSurfaceOrientation();
 781
 782     // @todo Should these be part of scene?
 783     Integration::DepthBufferAvailable   depthBufferAvailable   = mImpl->depthBufferAvailable;
 784     Integration::StencilBufferAvailable stencilBufferAvailable = mImpl->stencilBufferAvailable;
 785
 786     Graphics::RenderTarget*           currentRenderTarget = nullptr;
 787     Graphics::RenderPass*             currentRenderPass   = nullptr;
 788     std::vector<Graphics::ClearValue> currentClearValues{};
 789
 790     if(instruction.mFrameBuffer)
 791     {
 792       // Ensure graphics framebuffer is created, bind attachments and create render passes
 793       // Only happens once per framebuffer. If the create fails, e.g. no attachments yet,
 794       // then don't render to this framebuffer.
 795       if(!instruction.mFrameBuffer->GetGraphicsObject())
 796       {
 797         const bool created = instruction.mFrameBuffer->CreateGraphicsObjects();
 798         if(!created)
 799         {
 800           continue;
 801         }
 802       }
 803
 804       auto& clearValues = instruction.mFrameBuffer->GetGraphicsRenderPassClearValues();
 805
 806       // Set the clear color for first color attachment
 807       if(instruction.mIsClearColorSet && !clearValues.empty())
 808       {
 809         clearValues[0].color = {
 810           instruction.mClearColor.r,
 811           instruction.mClearColor.g,
 812           instruction.mClearColor.b,
 813           instruction.mClearColor.a};
 814       }
 815
 816       currentClearValues = clearValues;
 817
 818       auto loadOp = instruction.mIsClearColorSet ? Graphics::AttachmentLoadOp::CLEAR : Graphics::AttachmentLoadOp::LOAD;
 819
 820       // offscreen buffer
 821       currentRenderTarget = instruction.mFrameBuffer->GetGraphicsRenderTarget();
 822       currentRenderPass   = instruction.mFrameBuffer->GetGraphicsRenderPass(loadOp, Graphics::AttachmentStoreOp::STORE);
 823     }
 824     else // no framebuffer
 825     {
 826       // surface
 827       auto& clearValues = sceneObject->GetGraphicsRenderPassClearValues();
 828
 829       if(instruction.mIsClearColorSet)
 830       {
 831         clearValues[0].color = {
 832           instruction.mClearColor.r,
 833           instruction.mClearColor.g,
 834           instruction.mClearColor.b,
 835           instruction.mClearColor.a};
 836       }
 837
 838       currentClearValues = clearValues;
 839
 840       // @todo SceneObject should already have the depth clear / stencil clear in the clearValues array.
 841       // if the window has a depth/stencil buffer.
 842       if((depthBufferAvailable == Integration::DepthBufferAvailable::TRUE ||
 843           stencilBufferAvailable == Integration::StencilBufferAvailable::TRUE) &&
 844          (currentClearValues.size() <= 1))
 845       {
 846         currentClearValues.emplace_back();
 847         currentClearValues.back().depthStencil.depth   = 0;
 848         currentClearValues.back().depthStencil.stencil = 0;
 849       }
 850
 851       auto loadOp = instruction.mIsClearColorSet ? Graphics::AttachmentLoadOp::CLEAR : Graphics::AttachmentLoadOp::LOAD;
 852
 853       currentRenderTarget = sceneObject->GetSurfaceRenderTarget();
 854       currentRenderPass   = sceneObject->GetGraphicsRenderPass(loadOp, Graphics::AttachmentStoreOp::STORE);
 855     }
 856
 857     targetstoPresent.emplace_back(currentRenderTarget);
 858
 859     // reset the program matrices for all programs once per frame
 860     // this ensures we will set view and projection matrix once per program per camera
 861     mImpl->programController.ResetProgramMatrices();
 862
 863     if(instruction.mFrameBuffer)
 864     {
 865       // For each offscreen buffer, update the dependency list with the new texture id used by this frame buffer.
 866       for(unsigned int i0 = 0, i1 = instruction.mFrameBuffer->GetColorAttachmentCount(); i0 < i1; ++i0)
 867       {
 868         mImpl->textureDependencyList.PushBack(instruction.mFrameBuffer->GetTexture(i0));
 869       }
 870     }
 871
 872     if(!instruction.mIgnoreRenderToFbo && (instruction.mFrameBuffer != nullptr))
 873     {
 874       // Offscreen buffer rendering
 875       if(instruction.mIsViewportSet)
 876       {
 877         // For Viewport the lower-left corner is (0,0)
 878         const int32_t y = (instruction.mFrameBuffer->GetHeight() - instruction.mViewport.height) - instruction.mViewport.y;
 879         viewportRect.Set(instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height);
 880       }
 881       else
 882       {
 883         viewportRect.Set(0, 0, instruction.mFrameBuffer->GetWidth(), instruction.mFrameBuffer->GetHeight());
 884       }
 885       surfaceOrientation = 0;
 886     }
 887     else // No Offscreen frame buffer rendering
 888     {
 889       // Check whether a viewport is specified, otherwise the full surface size is used
 890       if(instruction.mIsViewportSet)
 891       {
 892         // For Viewport the lower-left corner is (0,0)
 893         const int32_t y = (surfaceRect.height - instruction.mViewport.height) - instruction.mViewport.y;
 894         viewportRect.Set(instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height);
 895       }
 896       else
 897       {
 898         viewportRect = surfaceRect;
 899       }
 900     }
 901
 902     // Set surface orientation
 903     // @todo Inform graphics impl by another route.
 904     // was: mImpl->currentContext->SetSurfaceOrientation(surfaceOrientation);
 905
 906     /*** Clear region of framebuffer or surface before drawing ***/
 907     bool clearFullFrameRect = (surfaceRect == viewportRect);
 908     if(instruction.mFrameBuffer != nullptr)
 909     {
 910       Viewport frameRect(0, 0, instruction.mFrameBuffer->GetWidth(), instruction.mFrameBuffer->GetHeight());
 911       clearFullFrameRect = (frameRect == viewportRect);
 912     }
 913
 914     if(!clippingRect.IsEmpty())
 915     {
 916       if(!clippingRect.Intersect(viewportRect))
 917       {
 918         DALI_LOG_ERROR("Invalid clipping rect %d %d %d %d\n", clippingRect.x, clippingRect.y, clippingRect.width, clippingRect.height);
 919         clippingRect = Rect<int>();
 920       }
 921       clearFullFrameRect = false;
 922     }
 923
 924     Graphics::Rect2D scissorArea{viewportRect.x, viewportRect.y, uint32_t(viewportRect.width), uint32_t(viewportRect.height)};
 925     if(instruction.mIsClearColorSet)
 926     {
 927       if(!clearFullFrameRect)
 928       {
 929         if(!clippingRect.IsEmpty())
 930         {
 931           scissorArea = {clippingRect.x, clippingRect.y, uint32_t(clippingRect.width), uint32_t(clippingRect.height)};
 932         }
 933       }
 934     }
 935
 936     // Scissor's value should be set based on the default system coordinates.
 937     // When the surface is rotated, the input values already were set with the rotated angle.
 938     // So, re-calculation is needed.
 939     scissorArea = RecalculateScissorArea(scissorArea, surfaceOrientation, surfaceRect);
 940
 941     // Begin render pass
 942     mainCommandBuffer->BeginRenderPass(
 943       currentRenderPass,
 944       currentRenderTarget,
 945       scissorArea,
 946       currentClearValues);
 947
 948     mainCommandBuffer->SetViewport({float(viewportRect.x),
 949                                     float(viewportRect.y),
 950                                     float(viewportRect.width),
 951                                     float(viewportRect.height)});
 952
 953     // Clear the list of bound textures
 954     mImpl->boundTextures.Clear();
 955
 956     mImpl->renderAlgorithms.ProcessRenderInstruction(
 957       instruction,
 958       mImpl->renderBufferIndex,
 959       depthBufferAvailable,
 960       stencilBufferAvailable,
 961       mImpl->boundTextures,
 962       viewportRect,
 963       clippingRect,
 964       surfaceOrientation,
 965       Uint16Pair(surfaceRect.width, surfaceRect.height));
 966
 967     Graphics::SyncObject* syncObject{nullptr};
 968     // If the render instruction has an associated render tracker (owned separately)
 969     // and framebuffer, create a one shot sync object, and use it to determine when
 970     // the render pass has finished executing on GPU.
 971     if(instruction.mRenderTracker && instruction.mFrameBuffer)
 972     {
 973       syncObject                 = instruction.mRenderTracker->CreateSyncObject(mImpl->graphicsController);
 974       instruction.mRenderTracker = nullptr;
 975     }
 976     mainCommandBuffer->EndRenderPass(syncObject);
 977   }
 978
 979   // Unlock standalone uniform buffer.
 980   mImpl->uniformBufferManager->UnlockUniformBuffer(mImpl->renderBufferIndex);
 981
 982   mImpl->renderAlgorithms.SubmitCommandBuffer();
 983   mImpl->commandBufferSubmitted = true;
 984
 985   std::sort(targetstoPresent.begin(), targetstoPresent.end());
 986
 987   Graphics::RenderTarget* rt = nullptr;
 988   for(auto& target : targetstoPresent)
 989   {
 990     if(target != rt)
 991     {
 992       mImpl->graphicsController.PresentRenderTarget(target);
 993       rt = target;
 994     }
 995   }
 996 }
 997
 998 void RenderManager::PostRender()
 999 {
1000   if(!mImpl->commandBufferSubmitted)
1001   {
1002     // Rendering is skipped but there may be pending tasks. Flush them.
1003     Graphics::SubmitInfo submitInfo;
1004     submitInfo.cmdBuffer.clear(); // Only flush
1005     submitInfo.flags = 0 | Graphics::SubmitFlagBits::FLUSH;
1006     mImpl->graphicsController.SubmitCommandBuffers(submitInfo);
1007
1008     mImpl->commandBufferSubmitted = true;
1009   }
1010
1011   // Notify RenderGeometries that rendering has finished
1012   for(auto&& iter : mImpl->geometryContainer)
1013   {
1014     iter->OnRenderFinished();
1015   }
1016
1017   // Notify RenderTexture that rendering has finished
1018   for(auto&& iter : mImpl->textureContainer)
1019   {
1020     iter->OnRenderFinished();
1021   }
1022
1023   mImpl->UpdateTrackers();
1024
1025   uint32_t count = 0u;
1026   for(auto& scene : mImpl->sceneContainer)
1027   {
1028     count += scene->GetRenderInstructions().Count(mImpl->renderBufferIndex);
1029   }
1030
1031   const bool haveInstructions = count > 0u;
1032
1033   // If this frame was rendered due to instructions existing, we mark this so we know to clear the next frame.
1034   mImpl->lastFrameWasRendered = haveInstructions;
1035
1036   /**
1037    * The rendering has finished; swap to the next buffer.
1038    * Ideally the update has just finished using this buffer; otherwise the render thread
1039    * should block until the update has finished.
1040    */
1041   mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
1042
1043   DALI_PRINT_RENDER_END();
1044 }
1045
1046 } // namespace SceneGraph
1047
1048 } // namespace Internal
1049
1050 } // namespace Dali