Move mItemsDirtyRects from Scene to SceneGraph::Scene
[platform/core/uifw/dali-core.git] / dali / internal / update / common / scene-graph-scene.h
index 97af1d5..f1f0f5a 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_INTERNAL_SCENE_GRAPH_SCENE_H
 
 /*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@
  */
 
 // INTERNAL INCLUDES
+#include <dali/graphics-api/graphics-controller.h>
+#include <dali/integration-api/core.h>
 #include <dali/integration-api/scene.h>
 #include <dali/internal/common/message.h>
 #include <dali/internal/event/common/event-thread-services.h>
 
 namespace Dali
 {
-
 namespace Internal
 {
-
-class Context;
+namespace Render
+{
+class Renderer;
+}
 
 namespace SceneGraph
 {
 class RenderInstructionContainer;
+class Node;
+
+struct DirtyRect
+{
+  DirtyRect(Node* node, Render::Renderer* renderer, int32_t frame, Rect<int>& rect)
+  : node(node),
+    renderer(renderer),
+    frame(frame),
+    rect(rect),
+    visited(true)
+  {
+  }
+
+  DirtyRect() = default;
+
+  bool operator<(const DirtyRect& rhs) const
+  {
+    if(node == rhs.node)
+    {
+      if(renderer == rhs.renderer)
+      {
+        return frame > rhs.frame; // Most recent rects come first
+      }
+      else
+      {
+        return renderer < rhs.renderer;
+      }
+    }
+    else
+    {
+      return node < rhs.node;
+    }
+  }
+
+  Node*             node{nullptr};
+  Render::Renderer* renderer{nullptr};
+  int32_t           frame{0};
+  Rect<int32_t>     rect{};
+  bool              visited{true};
+};
 
 class Scene
 {
 public:
-
   /**
    * Constructor
    * @param[in] surface The render surface
@@ -53,15 +95,11 @@ public:
 
   /**
    * Creates a scene object in the GPU.
-   * @param[in] context The GL context
-   */
-  void Initialize( Context& context );
-
-  /**
-   * Gets the context holding the GL state of rendering for the scene
-   * @return the context
+   * @param[in] graphicsController The graphics controller
+   * @param[in] depthBufferAvailable True if there is a depth buffer
+   * @param[in] stencilBufferAvailable True if there is a stencil buffer
    */
-  Context* GetContext();
+  void Initialize(Graphics::Controller& graphicsController, Integration::DepthBufferAvailable depthBufferAvailable, Integration::StencilBufferAvailable stencilBufferAvailable);
 
   /**
    * Gets the render instructions for the scene
@@ -83,7 +121,7 @@ public:
    *
    * @note Ownership of the callback is passed onto this class.
    */
-  void AddFrameRenderedCallback( CallbackBase* callback, int32_t frameId );
+  void AddFrameRenderedCallback(CallbackBase* callback, int32_t frameId);
 
   /**
    * @brief Adds a callback that is called when the frame is displayed on the display.
@@ -99,56 +137,230 @@ public:
    *
    * @note Ownership of the callback is passed onto this class.
    */
-  void AddFramePresentedCallback( CallbackBase* callback, int32_t frameId );
+  void AddFramePresentedCallback(CallbackBase* callback, int32_t frameId);
 
   /**
    * @brief Gets the callback list that is called when the frame rendering is done by the graphics driver.
    *
    * @param[out] callbacks The callback list
    */
-  void GetFrameRenderedCallback( Dali::Integration::Scene::FrameCallbackContainer& callbacks );
+  void GetFrameRenderedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks);
 
   /**
    * @brief Gets the callback list that is called when the frame is displayed on the display.
    *
    * @param[out] callbacks The callback list
    */
-  void GetFramePresentedCallback( Dali::Integration::Scene::FrameCallbackContainer& callbacks );
+  void GetFramePresentedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks);
 
-private:
+  /**
+   * @brief Sets whether rendering should be skipped or not.
+   * @param[in] skip true if rendering should be skipped.
+   */
+  void SetSkipRendering(bool skip);
+
+  /**
+   * @brief Query whether rendering should be skipped or not.
+   * @return true if rendering should be skipped, false otherwise.
+   */
+  bool IsRenderingSkipped() const;
+
+  /**
+   * Set the surface rectangle when surface is resized.
+   *
+   * @param[in] scene The resized scene.
+   * @param[in] rect The retangle representing the surface.
+   */
+  void SetSurfaceRect(const Rect<int32_t>& rect);
+
+  /**
+   * Get the surface rectangle.
+   *
+   * @return the current surface rectangle
+   */
+  const Rect<int32_t>& GetSurfaceRect() const;
+
+  /**
+   * Set the surface orientation when surface is rotated.
+   *
+   * @param[in] orientation The orientation value representing the surface.
+   */
+  void SetSurfaceOrientation(int32_t orientation);
+
+  /**
+   * Get the surface orientation.
+   *
+   * @return the current surface orientation
+   */
+  int32_t GetSurfaceOrientation() const;
+
+  /**
+   * Query wheter the surface rect is changed or not.
+   * @return true if the surface rect is changed.
+   */
+  bool IsSurfaceRectChanged();
+
+  /**
+   * @brief Set the internal flag to acknowledge surface rotation.
+   */
+  void SetRotationCompletedAcknowledgement();
+
+  /**
+   * @brief Query wheter is set to acknowledge for completing surface rotation.
+   * @return true it should be acknowledged.
+   */
+  bool IsRotationCompletedAcknowledgementSet();
+
+  /**
+   * Set the render target of the surface
+   *
+   * @param[in] renderTarget The render target.
+   */
+  void SetSurfaceRenderTarget(Graphics::RenderTarget* renderTarget)
+  {
+    mRenderTarget = renderTarget;
+  }
+
+  /**
+   * Get the render target created for the scene
+   *
+   * @return the render target
+   */
+  [[nodiscard]] Graphics::RenderTarget* GetSurfaceRenderTarget() const
+  {
+    return mRenderTarget;
+  }
 
-  Context*                    mContext;   ///< The context holding the GL state of rendering for the scene, not owned
+  /**
+   * Get the graphics render pass created for the scene
+   *
+   * @return the graphics render pass
+   */
+  [[nodiscard]] Graphics::RenderPass* GetGraphicsRenderPass(Graphics::AttachmentLoadOp loadOp, Graphics::AttachmentStoreOp storeOp) const
+  {
+    if(loadOp == Graphics::AttachmentLoadOp::CLEAR)
+    {
+      return mRenderPass.get();
+    }
+    else
+    {
+      return mRenderPassNoClear.get();
+    }
+  }
 
+  /**
+   * Get an initialized array of clear values which then can be modified and accessed to BeginRenderPass() command.
+   *
+   * @return the array of clear values
+   */
+  [[nodiscard]] auto& GetGraphicsRenderPassClearValues()
+  {
+    return mClearValues;
+  }
+
+  /**
+   * @brief Get ItemsDirtyRects
+   *
+   * @return the ItemsDirtyRects
+   */
+  std::vector<DirtyRect>& GetItemsDirtyRects();
+
+private:
   // Render instructions describe what should be rendered during RenderManager::RenderScene()
   // Update manager updates instructions for the next frame while we render the current one
 
-  RenderInstructionContainer  mInstructions;   ///< Render instructions for the scene
+  RenderInstructionContainer mInstructions; ///< Render instructions for the scene
 
-  Dali::Integration::Scene::FrameCallbackContainer mFrameRenderedCallbacks;   ///< Frame rendered callbacks
-  Dali::Integration::Scene::FrameCallbackContainer mFramePresentedCallbacks;  ///< Frame presented callbacks
+  Dali::Integration::Scene::FrameCallbackContainer mFrameRenderedCallbacks;  ///< Frame rendered callbacks
+  Dali::Integration::Scene::FrameCallbackContainer mFramePresentedCallbacks; ///< Frame presented callbacks
+
+  bool mSkipRendering; ///< A flag to skip rendering
+
+  Rect<int32_t> mSurfaceRect;                      ///< The rectangle of surface which is related ot this scene.
+  int32_t       mSurfaceOrientation;               ///< The orientation of surface which is related of this scene
+  bool          mSurfaceRectChanged;               ///< The flag of surface's rectangle is changed when is resized, moved or rotated.
+  bool          mRotationCompletedAcknowledgement; ///< The flag of sending the acknowledgement to complete window rotation.
+
+  // Render pass and render target
+
+  /**
+   * Render pass is created on fly depending on Load and Store operations
+   * The default render pass (most likely to be used) is the load = CLEAR
+   * and store = STORE for color attachment.
+   */
+  Graphics::UniquePtr<Graphics::RenderPass> mRenderPass{nullptr};        ///< The render pass created to render the surface
+  Graphics::UniquePtr<Graphics::RenderPass> mRenderPassNoClear{nullptr}; ///< The render pass created to render the surface without clearing color
+  Graphics::RenderTarget*                   mRenderTarget{nullptr};      ///< This is created in the event thread when surface is created/resized/replaced
+
+  std::vector<Graphics::ClearValue>                  mClearValues{};     ///< Clear colors
+  std::vector<Dali::Internal::SceneGraph::DirtyRect> mItemsDirtyRects{}; ///< Dirty rect list
 };
 
 /// Messages
-inline void AddFrameRenderedCallbackMessage( EventThreadServices& eventThreadServices, const Scene& scene, const CallbackBase* callback, int32_t frameId )
+inline void AddFrameRenderedCallbackMessage(EventThreadServices& eventThreadServices, const Scene& scene, const CallbackBase* callback, int32_t frameId)
 {
   using LocalType = MessageValue2<Scene, CallbackBase*, int32_t>;
 
   // Reserve some memory inside the message queue
-  uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
+  uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
 
   // Construct message in the message queue memory; note that delete should not be called on the return value
-  new (slot) LocalType( &scene, &Scene::AddFrameRenderedCallback, const_cast< CallbackBase* >( callback ), frameId );
+  new(slot) LocalType(&scene, &Scene::AddFrameRenderedCallback, const_cast<CallbackBase*>(callback), frameId);
 }
 
-inline void AddFramePresentedCallbackMessage( EventThreadServices& eventThreadServices, const Scene& scene, const CallbackBase* callback, int32_t frameId )
+inline void AddFramePresentedCallbackMessage(EventThreadServices& eventThreadServices, const Scene& scene, const CallbackBase* callback, int32_t frameId)
 {
   using LocalType = MessageValue2<Scene, CallbackBase*, int32_t>;
 
   // Reserve some memory inside the message queue
-  uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
+  uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
 
   // Construct message in the message queue memory; note that delete should not be called on the return value
-  new (slot) LocalType( &scene, &Scene::AddFramePresentedCallback, const_cast< CallbackBase* >( callback ), frameId );
+  new(slot) LocalType(&scene, &Scene::AddFramePresentedCallback, const_cast<CallbackBase*>(callback), frameId);
+}
+
+inline void SetSurfaceRectMessage(EventThreadServices& eventThreadServices, const Scene& scene, const Rect<int32_t>& rect)
+{
+  using LocalType = MessageValue1<Scene, Rect<int32_t> >;
+
+  // Reserve some memory inside the message queue
+  uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
+
+  // Construct message in the message queue memory; note that delete should not be called on the return value
+  new(slot) LocalType(&scene, &Scene::SetSurfaceRect, rect);
+}
+
+inline void SetSurfaceOrientationMessage(EventThreadServices& eventThreadServices, const Scene& scene, int32_t orientation)
+{
+  using LocalType = MessageValue1<Scene, int32_t>;
+
+  // Reserve some memory inside the message queue
+  uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
+
+  // Construct message in the message queue memory; note that delete should not be called on the return value
+  new(slot) LocalType(&scene, &Scene::SetSurfaceOrientation, orientation);
+}
+
+inline void SetRotationCompletedAcknowledgementMessage(EventThreadServices& eventThreadServices, const Scene& scene)
+{
+  using LocalType = Message<Scene>;
+
+  // Reserve some memory inside the message queue
+  uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
+
+  // Construct message in the message queue memory; note that delete should not be called on the return value
+  new(slot) LocalType(&scene, &Scene::SetRotationCompletedAcknowledgement);
+}
+
+inline void SetSurfaceRenderTargetMessage(EventThreadServices& eventThreadServices, const Scene& scene, Graphics::RenderTarget* renderTarget)
+{
+  using LocalType = MessageValue1<Scene, Graphics::RenderTarget*>;
+
+  // Reserve some memory inside the message queue
+  uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
+
+  // Construct message in the message queue memory; note that delete should not be called on the return value
+  new(slot) LocalType(&scene, &Scene::SetSurfaceRenderTarget, renderTarget);
 }
 
 } // namespace SceneGraph
@@ -157,5 +369,4 @@ inline void AddFramePresentedCallbackMessage( EventThreadServices& eventThreadSe
 
 } // namespace Dali
 
-
 #endif // DALI_INTERNAL_SCENE_GRAPH_SCENE_H