dali/integration-api/render-task-list-integ.h

   1 #ifndef DALI_INTEGRATION_RENDER_TASK_LIST_H
   2 #define DALI_INTEGRATION_RENDER_TASK_LIST_H
   3
   4 /*
   5  * Copyright (c) 2020 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/render-tasks/render-task-list.h>
  23
  24 namespace Dali
  25 {
  26 class Actor;
  27 class CameraActor;
  28
  29 namespace Integration
  30 {
  31 namespace RenderTaskList
  32 {
  33 /**
  34    * @brief Helper function to create a new RenderTaskList object.
  35    *
  36    * A RenderTaskList is an ordered list of render tasks that describes
  37    * how the Dali scene should be rendered.
  38    *
  39    * @return A handle to a newly allocated RenderTaskList
  40    */
  41 DALI_CORE_API Dali::RenderTaskList New();
  42
  43 /**
  44    * @brief Helper function to create a new RenderTask.
  45    *
  46    * The created task will be appended to the list of render-tasks.
  47    *
  48    * @param[in] taskList 　　　The render task list containing all the render-tasks.
  49    * @param[in] sourceActor The actor and its children to be rendered for this render task.
  50    * @param[in] cameraActor The actor from which the scene is viewed for this render task.
  51    * @return A valid handle to a new RenderTask
  52    */
  53 DALI_CORE_API Dali::RenderTask CreateTask(Dali::RenderTaskList& taskList, Dali::Actor& sourceActor, Dali::CameraActor& cameraActor);
  54
  55 } // namespace RenderTaskList
  56
  57 } // namespace Integration
  58
  59 } // namespace Dali
  60
  61 #endif // DALI_INTEGRATION_RENDER_TASK_LIST_H