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