X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Frender-tasks%2Frender-task-list.h;h=0de427ca7fac41895d033ba18301f5bf80094399;hb=eacc080fe975c523d722dd17c044652317ddd6e8;hp=ccbefba0f17310769deafcc2eaa576b7cbc0814a;hpb=4bd2fbea750e7dc85627868d8d276cc416b01b5a;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/render-tasks/render-task-list.h b/dali/public-api/render-tasks/render-task-list.h index ccbefba..0de427c 100644 --- a/dali/public-api/render-tasks/render-task-list.h +++ b/dali/public-api/render-tasks/render-task-list.h @@ -1,8 +1,8 @@ -#ifndef __DALI_RENDER_TASK_LIST_H__ -#define __DALI_RENDER_TASK_LIST_H__ +#ifndef DALI_RENDER_TASK_LIST_H +#define DALI_RENDER_TASK_LIST_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 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,13 +18,16 @@ * */ +// EXTERNAL INCLUDES +#include // uint32_t + // INTERNAL INCLUDES #include namespace Dali { /** - * @addtogroup dali_core_render_tasks + * @addtogroup dali_core_rendering_effects * @{ */ @@ -39,39 +42,43 @@ class RenderTaskList; * @brief An ordered list of Dali::RenderTask%s. * * These tasks describe how the Dali scene should be rendered; @see Dali::RenderTask for more details. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API RenderTaskList : public BaseHandle +class DALI_CORE_API RenderTaskList : public BaseHandle { public: - /** - * @brief Create an empty RenderTaskList handle. + * @brief Creates an empty RenderTaskList handle. * * This can be initialised with Stage::GetRenderTaskList(). + * @SINCE_1_0.0 */ RenderTaskList(); /** - * @brief Downcast a handle to RenderTaskList handle. + * @brief Downcasts a handle to RenderTaskList handle. * * If handle points to a RenderTaskList the downcast produces valid - * handle. If not the returned handle is left uninitialized. + * handle. If not, the returned handle is left uninitialized. * - * @param[in] handle A handle to an object. - * @return A handle to a RenderTaskList or an uninitialized handle. + * @SINCE_1_0.0 + * @param[in] handle A handle to an object + * @return A handle to a RenderTaskList or an uninitialized handle */ - static RenderTaskList DownCast( BaseHandle handle ); + static RenderTaskList DownCast(BaseHandle handle); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~RenderTaskList(); /** * @brief This copy constructor is required for (smart) pointer semantics. * + * @SINCE_1_0.0 * @param [in] handle A reference to the copied handle */ RenderTaskList(const RenderTaskList& handle); @@ -79,49 +86,82 @@ public: /** * @brief This assignment operator is required for (smart) pointer semantics. * - * @param [in] rhs A reference to the copied handle + * @SINCE_1_0.0 + * @param [in] rhs A reference to the copied handle * @return A reference to this */ RenderTaskList& operator=(const RenderTaskList& rhs); /** - * @brief Create a new RenderTask. + * @brief Move constructor. + * + * @SINCE_1_9.22 + * @param[in] rhs A reference to the moved handle + */ + RenderTaskList(RenderTaskList&& rhs); + + /** + * @brief Move assignment operator. + * + * @SINCE_1_9.22 + * @param[in] rhs A reference to the moved handle + * @return A reference to this handle + */ + RenderTaskList& operator=(RenderTaskList&& rhs); + + /** + * @brief Creates a new RenderTask. * * This will be appended to the list of render-tasks. - * @return A valid handle to a new RenderTask. + * @SINCE_1_0.0 + * @return A valid handle to a new RenderTask */ RenderTask CreateTask(); /** - * @brief Remove a RenderTask from the list of render-tasks. + * @brief Removes a RenderTask from the list of render-tasks. + * @SINCE_1_0.0 * @param[in] task The render-task to remove. */ - void RemoveTask( RenderTask task ); + void RemoveTask(RenderTask task); /** - * @brief Query the number of render-tasks in the list. + * @brief Queries the number of render-tasks in the list. * * This is ordered i.e. the task with index 0 is the first to be processed each frame. - * @return The number of render-tasks. + * @SINCE_1_0.0 + * @return The number of render-tasks */ - unsigned int GetTaskCount() const; + uint32_t GetTaskCount() const; /** - * @brief Retrieve a render-task. + * @brief Retrieves a render-task. * - * @pre index should be in range i.e. less than GetTaskCount(). + * @SINCE_1_0.0 * @param[in] index The index of the render task to retrieve - * @return A handle to the render-task. + * @return A handle to the render-task + * @pre index should be in range i.e. less than GetTaskCount(). */ - RenderTask GetTask( unsigned int index ) const; + RenderTask GetTask(uint32_t index) const; -public: // Not intended for application developers + /** + * @brief Retrieves a RenderTask for Overlay + * @SINCE_2_2.10 + * @return A handle to the overlay RenderTask. + * If the scene has not created an overlay render task, this returns empty handle. + */ + RenderTask GetOverlayTask() const; +public: // Not intended for application developers + /// @cond internal /** - * @brief This constructor is used by Dali New() methods + * @brief This constructor is used by Dali New() methods. + * + * @SINCE_1_0.0 * @param [in] renderTask A pointer to a newly allocated render-task */ - explicit DALI_INTERNAL RenderTaskList( Internal::RenderTaskList* renderTask ); + explicit DALI_INTERNAL RenderTaskList(Internal::RenderTaskList* renderTask); + /// @endcond }; /** @@ -129,4 +169,4 @@ public: // Not intended for application developers */ } // namespace Dali -#endif //__DALI_RENDER_TASK_LIST_H__ +#endif //DALI_RENDER_TASK_LIST_H