1 #ifndef __DALI_RENDER_TASK_LIST_H__
2 #define __DALI_RENDER_TASK_LIST_H__
5 * Copyright (c) 2015 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/public-api/object/base-handle.h>
27 * @addtogroup dali_core_rendering_effects
33 namespace Internal DALI_INTERNAL
39 * @brief An ordered list of Dali::RenderTask%s.
41 * These tasks describe how the Dali scene should be rendered; @see Dali::RenderTask for more details.
44 class DALI_IMPORT_API RenderTaskList : public BaseHandle
49 * @brief Create an empty RenderTaskList handle.
51 * This can be initialised with Stage::GetRenderTaskList().
57 * @brief Downcast a handle to RenderTaskList handle.
59 * If handle points to a RenderTaskList the downcast produces valid
60 * handle. If not the returned handle is left uninitialized.
63 * @param[in] handle A handle to an object.
64 * @return A handle to a RenderTaskList or an uninitialized handle.
66 static RenderTaskList DownCast( BaseHandle handle );
71 * This is non-virtual since derived Handle types must not contain data or virtual methods.
77 * @brief This copy constructor is required for (smart) pointer semantics.
80 * @param [in] handle A reference to the copied handle
82 RenderTaskList(const RenderTaskList& handle);
85 * @brief This assignment operator is required for (smart) pointer semantics.
88 * @param [in] rhs A reference to the copied handle
89 * @return A reference to this
91 RenderTaskList& operator=(const RenderTaskList& rhs);
94 * @brief Create a new RenderTask.
96 * This will be appended to the list of render-tasks.
98 * @return A valid handle to a new RenderTask.
100 RenderTask CreateTask();
103 * @brief Remove a RenderTask from the list of render-tasks.
105 * @param[in] task The render-task to remove.
107 void RemoveTask( RenderTask task );
110 * @brief Query the number of render-tasks in the list.
112 * This is ordered i.e. the task with index 0 is the first to be processed each frame.
114 * @return The number of render-tasks.
116 unsigned int GetTaskCount() const;
119 * @brief Retrieve a render-task.
122 * @param[in] index The index of the render task to retrieve
123 * @return A handle to the render-task.
124 * @pre index should be in range i.e. less than GetTaskCount().
126 RenderTask GetTask( unsigned int index ) const;
128 public: // Not intended for application developers
132 * @brief This constructor is used by Dali New() methods
135 * @param [in] renderTask A pointer to a newly allocated render-task
137 explicit DALI_INTERNAL RenderTaskList( Internal::RenderTaskList* renderTask );
146 #endif //__DALI_RENDER_TASK_LIST_H__