Add Overlay Layer in scene

[platform/core/uifw/dali-core.git] / dali / internal / update / render-tasks / scene-graph-render-task-list.h

diff --git a/dali/internal/update/render-tasks/scene-graph-render-task-list.h b/dali/internal/update/render-tasks/scene-graph-render-task-list.h
index 90b84cf..2b7242d 100644 (file)
--- a/dali/internal/update/render-tasks/scene-graph-render-task-list.h
+++ b/dali/internal/update/render-tasks/scene-graph-render-task-list.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_LIST_H__
-#define __DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_LIST_H__
+#ifndef DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_LIST_H
+#define DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_LIST_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 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.
@@ -22,13 +22,12 @@
 #include <dali/devel-api/common/owner-container.h>
 #include <dali/internal/common/message.h>
 #include <dali/internal/event/common/event-thread-services.h>
+#include <dali/internal/update/render-tasks/scene-graph-render-task.h>
 
 namespace Dali
 {
-
 namespace Internal
 {
-
 class CompleteNotificationInterface;
 
 namespace SceneGraph
@@ -42,14 +41,13 @@ class RenderTask;
 class RenderTaskList
 {
 public:
-
-  typedef OwnerContainer< RenderTask* > RenderTaskContainer;
+  using RenderTaskContainer = OwnerContainer<RenderTask*>;
 
   /**
-   * Constructor
-   * @param renderMessageDispatcher to send messages
+   * Construct a new RenderTaskList.
+   * @return A new RenderTaskList
    */
-  RenderTaskList( RenderMessageDispatcher& renderMessageDispatcher );
+  static RenderTaskList* New();
 
   /**
    * Destructor
@@ -57,16 +55,40 @@ public:
   ~RenderTaskList();
 
   /**
+   * Overriden delete operator
+   * Deletes the RenderTaskList from its global memory pool
+   */
+  void operator delete(void* ptr);
+
+  /**
+   * Set the renderMessageDispatcher to send message.
+   * @param[in] renderMessageDispatcher The renderMessageDispatcher to send messages.
+   */
+  void SetRenderMessageDispatcher(RenderMessageDispatcher* renderMessageDispatcher);
+
+  /**
    * Add a new RenderTask to the list.
    * @param[in] newTask The RenderTaskList takes ownership of this task.
    */
-  void AddTask( RenderTask* newTask );
+  void AddTask(OwnerPointer<RenderTask>& newTask);
+
+  /**
+   * Add a overlay RenderTask to the list.
+   * @param[in] newTask The RenderTaskList takes ownership of this overlay task.
+   */
+  void AddOverlayTask(OwnerPointer<RenderTask>& newTask);
 
   /**
    * Remove a RenderTask from the list.
    * @param[in] task The RenderTaskList will destroy this task.
    */
-  void RemoveTask( RenderTask* task );
+  void RemoveTask(RenderTask* task);
+
+  /**
+   * Retrieve the count of RenderTasks.
+   * @return The count.
+   */
+  uint32_t GetTaskCount();
 
   /**
    * Retrieve the container of RenderTasks.
@@ -84,15 +106,25 @@ public:
    * Set the notification method to package in the NotifyFinishedMessage
    * @param object to store in notification managers queue
    */
-  void SetCompleteNotificationInterface( CompleteNotificationInterface* object );
+  void SetCompleteNotificationInterface(CompleteNotificationInterface* object);
 
   /**
    * Get the Notification interface for when 1+ render tasks have finished
    */
   CompleteNotificationInterface* GetCompleteNotificationInterface();
 
-private:
+  /**
+   * Get the capacity of the memory pools
+   */
+  static uint32_t GetMemoryPoolCapacity();
 
+protected:
+  /**
+   * Protected constructor. See New()
+   */
+  RenderTaskList();
+
+private:
   // Undefined
   RenderTaskList(const RenderTaskList&);
 
@@ -100,38 +132,38 @@ private:
   RenderTaskList& operator=(const RenderTaskList&);
 
 private:
-
-  CompleteNotificationInterface* mNotificationObject; ///< object to pass in to the complete notification
-  RenderMessageDispatcher& mRenderMessageDispatcher; ///< for sending messages to render thread
-  RenderTaskContainer mRenderTasks; ///< A container of owned RenderTasks
-
+  CompleteNotificationInterface* mNotificationObject;      ///< object to pass in to the complete notification
+  RenderMessageDispatcher*       mRenderMessageDispatcher; ///< for sending messages to render thread
+  RenderTaskContainer            mRenderTasks;             ///< A container of owned RenderTasks
+  RenderTask*                    mOverlayRenderTask;       ///< OverlayRenderTask.
 };
 
 // Messages for RenderTaskList
 
-inline void AddTaskMessage( EventThreadServices& eventThreadServices, RenderTaskList& list, RenderTask& task )
+inline void AddTaskMessage(EventThreadServices& eventThreadServices, const RenderTaskList& list, OwnerPointer<RenderTask>& task)
 {
-  typedef MessageValue1< RenderTaskList, RenderTask* > LocalType;
+  // Message has ownership of the RenderTask while in transit from event -> update
+  using LocalType = MessageValue1<RenderTaskList, OwnerPointer<RenderTask> >;
 
   // Reserve some memory inside the message queue
-  unsigned int* 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( &list, &RenderTaskList::AddTask, &task );
+  new(slot) LocalType(&list, &RenderTaskList::AddTask, task);
 }
 
-inline void RemoveTaskMessage( EventThreadServices& eventThreadServices, RenderTaskList& list, const RenderTask& constTask )
+inline void RemoveTaskMessage(EventThreadServices& eventThreadServices, const RenderTaskList& list, const RenderTask& constTask)
 {
   // Scene graph thread can destroy this object.
-  RenderTask& task = const_cast< RenderTask& >( constTask );
+  RenderTask& task = const_cast<RenderTask&>(constTask);
 
-  typedef MessageValue1< RenderTaskList, RenderTask* > LocalType;
+  using LocalType = MessageValue1<RenderTaskList, RenderTask*>;
 
   // Reserve some memory inside the message queue
-  unsigned int* 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( &list, &RenderTaskList::RemoveTask, &task );
+  new(slot) LocalType(&list, &RenderTaskList::RemoveTask, &task);
 }
 
 } // namespace SceneGraph
@@ -140,4 +172,4 @@ inline void RemoveTaskMessage( EventThreadServices& eventThreadServices, RenderT
 
 } // namespace Dali
 
-#endif // __DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_LIST_H__
+#endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_LIST_H