dali/public-api/render-tasks/render-task-list.h

   1 #ifndef __DALI_RENDER_TASK_LIST_H__
   2 #define __DALI_RENDER_TASK_LIST_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/object/base-handle.h>
  23
  24 namespace Dali
  25 {
  26 /**
  27  * @addtogroup dali_core_rendering_effects
  28  * @{
  29  */
  30
  31 class RenderTask;
  32
  33 namespace Internal DALI_INTERNAL
  34 {
  35 class RenderTaskList;
  36 }
  37
  38 /**
  39  * @brief An ordered list of Dali::RenderTask%s.
  40  *
  41  * These tasks describe how the Dali scene should be rendered; @see Dali::RenderTask for more details.
  42  * @SINCE_1_0.0
  43  */
  44 class DALI_IMPORT_API RenderTaskList : public BaseHandle
  45 {
  46 public:
  47
  48   /**
  49    * @brief Create an empty RenderTaskList handle.
  50    *
  51    * This can be initialised with Stage::GetRenderTaskList().
  52    * @SINCE_1_0.0
  53    */
  54   RenderTaskList();
  55
  56   /**
  57    * @brief Downcast a handle to RenderTaskList handle.
  58    *
  59    * If handle points to a RenderTaskList the downcast produces valid
  60    * handle. If not the returned handle is left uninitialized.
  61    *
  62    * @SINCE_1_0.0
  63    * @param[in] handle A handle to an object.
  64    * @return A handle to a RenderTaskList or an uninitialized handle.
  65    */
  66   static RenderTaskList DownCast( BaseHandle handle );
  67
  68   /**
  69    * @brief Destructor
  70    *
  71    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  72    * @SINCE_1_0.0
  73    */
  74   ~RenderTaskList();
  75
  76   /**
  77    * @brief This copy constructor is required for (smart) pointer semantics.
  78    *
  79    * @SINCE_1_0.0
  80    * @param [in] handle A reference to the copied handle
  81    */
  82   RenderTaskList(const RenderTaskList& handle);
  83
  84   /**
  85    * @brief This assignment operator is required for (smart) pointer semantics.
  86    *
  87    * @SINCE_1_0.0
  88    * @param [in] rhs  A reference to the copied handle
  89    * @return A reference to this
  90    */
  91   RenderTaskList& operator=(const RenderTaskList& rhs);
  92
  93   /**
  94    * @brief Create a new RenderTask.
  95    *
  96    * This will be appended to the list of render-tasks.
  97    * @SINCE_1_0.0
  98    * @return A valid handle to a new RenderTask.
  99    */
 100   RenderTask CreateTask();
 101
 102   /**
 103    * @brief Remove a RenderTask from the list of render-tasks.
 104    * @SINCE_1_0.0
 105    * @param[in] task The render-task to remove.
 106    */
 107   void RemoveTask( RenderTask task );
 108
 109   /**
 110    * @brief Query the number of render-tasks in the list.
 111    *
 112    * This is ordered i.e. the task with index 0 is the first to be processed each frame.
 113    * @SINCE_1_0.0
 114    * @return The number of render-tasks.
 115    */
 116   unsigned int GetTaskCount() const;
 117
 118   /**
 119    * @brief Retrieve a render-task.
 120    *
 121    * @SINCE_1_0.0
 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().
 125    */
 126   RenderTask GetTask( unsigned int index ) const;
 127
 128 public: // Not intended for application developers
 129
 130   /**
 131    * @brief This constructor is used by Dali New() methods
 132    * @SINCE_1_0.0
 133    * @param [in] renderTask A pointer to a newly allocated render-task
 134    */
 135   explicit DALI_INTERNAL RenderTaskList( Internal::RenderTaskList* renderTask );
 136 };
 137
 138 /**
 139  * @}
 140  */
 141 } // namespace Dali
 142
 143 #endif //__DALI_RENDER_TASK_LIST_H__