1 #ifndef DALI_RENDER_TASK_LIST_H
2 #define DALI_RENDER_TASK_LIST_H
5 * Copyright (c) 2020 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 <cstdint> // uint32_t
25 #include <dali/public-api/object/base-handle.h>
30 * @addtogroup dali_core_rendering_effects
36 namespace Internal DALI_INTERNAL
42 * @brief An ordered list of Dali::RenderTask%s.
44 * These tasks describe how the Dali scene should be rendered; @see Dali::RenderTask for more details.
47 class DALI_CORE_API RenderTaskList : public BaseHandle
51 * @brief Creates an empty RenderTaskList handle.
53 * This can be initialised with Stage::GetRenderTaskList().
59 * @brief Downcasts a handle to RenderTaskList handle.
61 * If handle points to a RenderTaskList the downcast produces valid
62 * handle. If not, the returned handle is left uninitialized.
65 * @param[in] handle A handle to an object
66 * @return A handle to a RenderTaskList or an uninitialized handle
68 static RenderTaskList DownCast(BaseHandle handle);
73 * This is non-virtual since derived Handle types must not contain data or virtual methods.
79 * @brief This copy constructor is required for (smart) pointer semantics.
82 * @param [in] handle A reference to the copied handle
84 RenderTaskList(const RenderTaskList& handle);
87 * @brief This assignment operator is required for (smart) pointer semantics.
90 * @param [in] rhs A reference to the copied handle
91 * @return A reference to this
93 RenderTaskList& operator=(const RenderTaskList& rhs);
96 * @brief Move constructor.
99 * @param[in] rhs A reference to the moved handle
101 RenderTaskList(RenderTaskList&& rhs) noexcept;
104 * @brief Move assignment operator.
107 * @param[in] rhs A reference to the moved handle
108 * @return A reference to this handle
110 RenderTaskList& operator=(RenderTaskList&& rhs) noexcept;
113 * @brief Creates a new RenderTask.
115 * This will be appended to the list of render-tasks.
117 * @return A valid handle to a new RenderTask
119 RenderTask CreateTask();
122 * @brief Removes a RenderTask from the list of render-tasks.
124 * @param[in] task The render-task to remove.
126 void RemoveTask(RenderTask task);
129 * @brief Queries the number of render-tasks in the list.
131 * This is ordered i.e. the task with index 0 is the first to be processed each frame.
133 * @return The number of render-tasks
135 uint32_t GetTaskCount() const;
138 * @brief Retrieves a render-task.
141 * @param[in] index The index of the render task to retrieve
142 * @return A handle to the render-task
143 * @pre index should be in range i.e. less than GetTaskCount().
145 RenderTask GetTask(uint32_t index) const;
148 * @brief Retrieves a RenderTask for Overlay
150 * @return A handle to the overlay RenderTask.
151 * If the scene has not created an overlay render task, this returns empty handle.
153 RenderTask GetOverlayTask() const;
155 public: // Not intended for application developers
158 * @brief This constructor is used by Dali New() methods.
161 * @param [in] renderTask A pointer to a newly allocated render-task
163 explicit DALI_INTERNAL RenderTaskList(Internal::RenderTaskList* renderTask);
172 #endif //DALI_RENDER_TASK_LIST_H