[dali_2.3.22] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / gl-view / drawable-view-impl.h
1 #ifndef DALI_TOOLKIT_INTERNAL_DRAWABLE_VIEW_H
2 #define DALI_TOOLKIT_INTERNAL_DRAWABLE_VIEW_H
3
4 /*
5  * Copyright (c) 2022 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 // EXTERNAL INCLUDES
22 #include <dali/devel-api/actors/actor-devel.h>
23 #include <dali/devel-api/adaptor-framework/native-image-source-queue.h>
24 #include <dali/public-api/adaptor-framework/window.h>
25 #include <dali/public-api/rendering/geometry.h>
26 #include <dali/public-api/rendering/shader.h>
27 #include <dali/public-api/signals/render-callback.h>
28 #include "gl-view-interface-impl.h"
29
30 // INTERNAL INCLUDES
31 #include <dali-toolkit/internal/controls/gl-view/drawable-view-native-renderer.h>
32 #include <dali-toolkit/internal/controls/gl-view/gl-view-interface-impl.h>
33 #include <dali-toolkit/public-api/controls/control-impl.h>
34 #include <dali-toolkit/public-api/controls/gl-view/gl-view.h>
35
36 namespace Dali::Toolkit
37 {
38 class GlView;
39
40 namespace Internal
41 {
42 class DrawableView : public Dali::Toolkit::Internal::GlViewImpl
43 {
44 protected:
45   virtual ~DrawableView();
46
47 public:
48   /**
49    * @brief Creates GlView interface object using DrawableView implementation
50    *
51    * @param[in] backendMode Backend mode to be used. Only DIRECT_RENDERING and DIRECT_RENDERING_THREADED
52    *                        are accepted.
53    * @return Valid GlView object or nullptr on error
54    */
55   static Dali::Toolkit::GlView New(GlView::BackendMode backendMode);
56
57   /**
58    * @brief Constructor creates GlView interface object using DrawableView implementation
59    *
60    * @param[in] backendMode Backend mode to be used. Only DIRECT_RENDERING and DIRECT_RENDERING_THREADED
61    *                        are accepted.
62    */
63   explicit DrawableView(GlView::BackendMode backendMode);
64
65   /**
66    * @copydoc Dali::Toolkit::GlView::RegisterGlCallbacks()
67    */
68   void RegisterGlCallbacks(CallbackBase* initCallback, CallbackBase* renderFrameCallback, CallbackBase* terminateCallback) override;
69
70   /**
71    * @copydoc Dali::Toolkit::GlView::SetResizeCallback()
72    */
73   void SetResizeCallback(CallbackBase* resizeCallback) override;
74
75   /**
76    * @copydoc Dali::Toolkit::GlView::SetGraphicsConfig()
77    */
78   bool SetGraphicsConfig(bool depth, bool stencil, int msaa, Dali::Toolkit::GlView::GraphicsApiVersion version) override;
79
80   /**
81    * @copydoc Dali::Toolkit::GlView::SetRenderingMode()
82    */
83   void SetRenderingMode(Dali::Toolkit::GlView::RenderingMode mode) override;
84
85   /**
86    * @copydoc Dali::Toolkit::GlView::GetRenderingMode()
87    */
88   Dali::Toolkit::GlView::RenderingMode GetRenderingMode() const override;
89
90   /**
91    * @copydoc Dali::Toolkit::GlView::RenderOnce()
92    */
93   void RenderOnce() override;
94
95   /**
96    * @copydoc Dali::Toolkit::GlView::BindTextureResources()
97    */
98   void BindTextureResources(std::vector<Dali::Texture> textures) override;
99
100 private: // From Control
101   /**
102    * @copydoc Toolkit::Control::OnInitialize()
103    */
104   virtual void OnInitialize() override;
105
106   /**
107    * @copydoc Toolkit::Control::OnSceneConnection()
108    */
109   void OnSceneConnection(int depth) override;
110
111   /**
112    * @copydoc Toolkit::Control::OnSceneDisconnection()
113    */
114   void OnSceneDisconnection() override;
115
116   /**
117    * @copydoc Toolkit::Control::OnSizeSet()
118    */
119   void OnSizeSet(const Vector3& targetSize) override;
120
121 private:
122   // Undefined copy constructor and assignment operators
123   DrawableView(const DrawableView& GlView);
124   DrawableView& operator=(const DrawableView& GlView);
125
126   /**
127    * Callback when the visibility of the GlView is changed
128    */
129   void OnControlVisibilityChanged(Dali::Actor actor, bool visible, Dali::DevelActor::VisibilityChange::Type type);
130
131   /**
132    * Callback when the visibility of the window is changed
133    */
134   void OnWindowVisibilityChanged(Dali::Window window, bool visible);
135
136   /**
137    * Adds renderer to Actor.
138    */
139   void AddRenderer();
140
141 private:
142   bool OnRenderCallback(const RenderCallbackInput& renderCallbackInput);
143
144 private:
145   Dali::Toolkit::GlView::RenderingMode mRenderingMode;
146
147   bool mDepth;
148   bool mStencil;
149   int  mMSAA;
150
151   std::unique_ptr<RenderCallback> mRenderCallback;
152
153   /*
154    * Used within RenderCallback to handle the current render state
155    */
156   enum class ViewState
157   {
158     INIT,
159     RENDER,
160     TERMINATE
161   };
162
163   ViewState mCurrentViewState{ViewState::INIT}; ///< state within RenderCallback
164
165   std::unique_ptr<CallbackBase> mOnResizeCallback; ///< Resize callback called when surface size changes
166
167   std::atomic_bool mSurfaceResized{false}; ///< Flag to invoke surface resize callback
168
169   Size mSurfaceSize{}; ///< Surface size
170
171   std::unique_ptr<Dali::Internal::DrawableViewNativeRenderer> mNativeRenderer; ///< Pointer to the native renderer
172 };
173
174 } // namespace Internal
175
176 } // namespace Dali::Toolkit
177
178 #endif // DALI_TOOLKIT_INTERNAL_DRAWABLE_VIEW_H