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