[dali_2.3.25] Merge branch 'devel/master'
[platform/core/uifw/dali-core.git] / dali / internal / update / manager / render-task-processor.h
1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_PROCESSOR_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_PROCESSOR_H
3
4 /*
5  * Copyright (c) 2021 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/internal/update/manager/render-instruction-processor.h>
23 #include <dali/internal/update/manager/sorted-layers.h>
24
25 namespace Dali
26 {
27 namespace Internal
28 {
29 namespace SceneGraph
30 {
31 class RenderTaskList;
32
33 /**
34  * @brief This class handles processing a given list of render tasks and generating render instructions from them.
35  */
36 class RenderTaskProcessor
37 {
38 public:
39   /**
40    * @brief Constructor.
41    */
42   RenderTaskProcessor();
43
44   /**
45    * @brief Destructor.
46    */
47   ~RenderTaskProcessor();
48
49   /**
50    * Process the list of render-tasks; the output is a series of render instructions.
51    * @note When ProcessRenderTasks is called, the layers should already the transparent/opaque renderers which are ready to render.
52    * If there is only one default render-task, then no further processing is required.
53    * @param[in]  updateBufferIndex  The current update buffer index.
54    * @param[in]  renderTasks        The list of render-tasks.
55    * @param[in]  sortedLayers       The layers containing lists of opaque / transparent renderables.
56    * @param[out] instructions       The instructions for rendering the next frame.
57    * @param[in]  renderToFboEnabled Whether rendering into the Frame Buffer Object is enabled (used to measure FPS above 60)
58    * @param[in]  isRenderingToFbo   Whether this frame is being rendered into the Frame Buffer Object (used to measure FPS above 60)
59    * @return true if rendering should be kept, false otherwise.
60    */
61   bool Process(BufferIndex                 updateBufferIndex,
62                RenderTaskList&             renderTasks,
63                SortedLayerPointers&        sortedLayers,
64                RenderInstructionContainer& instructions,
65                bool                        renderToFboEnabled,
66                bool                        isRenderingToFbo);
67
68 private:
69   /**
70    * Undefine copy and assignment operators.
71    */
72   RenderTaskProcessor(const RenderTaskProcessor& renderTaskProcessor);            ///< No definition
73   RenderTaskProcessor& operator=(const RenderTaskProcessor& renderTaskProcessor); ///< No definition
74
75 private:
76   RenderInstructionProcessor mRenderInstructionProcessor; ///< An instance of the RenderInstructionProcessor used to sort and handle the renderers for each layer.
77 };
78
79 } // namespace SceneGraph
80
81 } // namespace Internal
82
83 } // namespace Dali
84
85 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_TASK_PROCESSOR_H