1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_LIST_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_LIST_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/devel-api/common/owner-container.h>
23 #include <dali/internal/common/message.h>
24 #include <dali/internal/event/common/event-thread-services.h>
25 #include <dali/internal/update/render-tasks/scene-graph-render-task.h>
31 class CompleteNotificationInterface;
35 class RenderMessageDispatcher;
39 * An ordered list of render-tasks.
44 using RenderTaskContainer = OwnerContainer<RenderTask*>;
47 * Construct a new RenderTaskList.
48 * @return A new RenderTaskList
50 static RenderTaskList* New();
58 * Overriden delete operator
59 * Deletes the RenderTaskList from its global memory pool
61 void operator delete(void* ptr);
64 * Set the renderMessageDispatcher to send message.
65 * @param[in] renderMessageDispatcher The renderMessageDispatcher to send messages.
67 void SetRenderMessageDispatcher(RenderMessageDispatcher* renderMessageDispatcher);
70 * Add a new RenderTask to the list.
71 * @param[in] newTask The RenderTaskList takes ownership of this task.
73 void AddTask(OwnerPointer<RenderTask>& newTask);
76 * Add a overlay RenderTask to the list.
77 * @param[in] newTask The RenderTaskList takes ownership of this overlay task.
79 void AddOverlayTask(OwnerPointer<RenderTask>& newTask);
82 * Remove a RenderTask from the list.
83 * @param[in] task The RenderTaskList will destroy this task.
85 void RemoveTask(RenderTask* task);
88 * Retrieve the count of RenderTasks.
91 uint32_t GetTaskCount();
94 * Retrieve the container of RenderTasks.
95 * @return The container.
97 RenderTaskContainer& GetTasks();
100 * Retrieve the container of RenderTasks.
101 * @return The container.
103 const RenderTaskContainer& GetTasks() const;
106 * Set the notification method to package in the NotifyFinishedMessage
107 * @param object to store in notification managers queue
109 void SetCompleteNotificationInterface(CompleteNotificationInterface* object);
112 * Get the Notification interface for when 1+ render tasks have finished
114 CompleteNotificationInterface* GetCompleteNotificationInterface();
117 * Get the capacity of the memory pools
119 static uint32_t GetMemoryPoolCapacity();
123 * Protected constructor. See New()
129 RenderTaskList(const RenderTaskList&);
132 RenderTaskList& operator=(const RenderTaskList&);
135 CompleteNotificationInterface* mNotificationObject; ///< object to pass in to the complete notification
136 RenderMessageDispatcher* mRenderMessageDispatcher; ///< for sending messages to render thread
137 RenderTaskContainer mRenderTasks; ///< A container of owned RenderTasks
138 RenderTask* mOverlayRenderTask; ///< OverlayRenderTask.
141 // Messages for RenderTaskList
143 inline void AddTaskMessage(EventThreadServices& eventThreadServices, const RenderTaskList& list, OwnerPointer<RenderTask>& task)
145 // Message has ownership of the RenderTask while in transit from event -> update
146 using LocalType = MessageValue1<RenderTaskList, OwnerPointer<RenderTask> >;
148 // Reserve some memory inside the message queue
149 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
151 // Construct message in the message queue memory; note that delete should not be called on the return value
152 new(slot) LocalType(&list, &RenderTaskList::AddTask, task);
155 inline void AddOverlayTaskMessage(EventThreadServices& eventThreadServices, const RenderTaskList& list, OwnerPointer<RenderTask>& task)
157 // Message has ownership of the RenderTask while in transit from event -> update
158 using LocalType = MessageValue1<RenderTaskList, OwnerPointer<RenderTask> >;
160 // Reserve some memory inside the message queue
161 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
163 // Construct message in the message queue memory; note that delete should not be called on the return value
164 new(slot) LocalType(&list, &RenderTaskList::AddOverlayTask, task);
167 inline void RemoveTaskMessage(EventThreadServices& eventThreadServices, const RenderTaskList& list, const RenderTask& constTask)
169 // Scene graph thread can destroy this object.
170 RenderTask& task = const_cast<RenderTask&>(constTask);
172 using LocalType = MessageValue1<RenderTaskList, RenderTask*>;
174 // Reserve some memory inside the message queue
175 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
177 // Construct message in the message queue memory; note that delete should not be called on the return value
178 new(slot) LocalType(&list, &RenderTaskList::RemoveTask, &task);
181 } // namespace SceneGraph
183 } // namespace Internal
187 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_LIST_H