dali/internal/window-system/common/pixmap-render-surface.h

   1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_PIXMAP_RENDER_SURFACE_H
   2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_PIXMAP_RENDER_SURFACE_H
   3
   4 /*
   5  * Copyright (c) 2018 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/integration-api/render-surface.h>
  23
  24 namespace Dali
  25 {
  26
  27 class TriggerEventInterface;
  28
  29 namespace Internal
  30 {
  31 namespace Adaptor
  32 {
  33
  34 /**
  35  * Pixmap interface of render surface.
  36  */
  37 class PixmapRenderSurface : public Dali::RenderSurface
  38 {
  39 public:
  40
  41   /**
  42    * @brief Default constructor
  43    */
  44   PixmapRenderSurface() = default;
  45
  46   /**
  47    * @brief Destructor
  48    */
  49   virtual ~PixmapRenderSurface() = default;
  50
  51 public: // API
  52
  53   /**
  54    * @brief Get the render surface the adaptor is using to render to.
  55    * @return reference to current render surface
  56    */
  57   virtual Any GetSurface() = 0;
  58
  59   /**
  60    * @brief Sets the render notification trigger to call when render thread is completed a frame
  61    * @param renderNotification to use
  62    */
  63   virtual void SetRenderNotification( TriggerEventInterface* renderNotification ) = 0;
  64
  65 private:
  66
  67   /**
  68    * Second stage construction
  69    */
  70   virtual void Initialize( Any surface ) = 0;
  71
  72   /**
  73    * @brief Create a renderable
  74    */
  75   virtual void CreateRenderable() = 0;
  76
  77   /**
  78    * @brief Use an existing render surface
  79    * @param surfaceId the id of the surface
  80    */
  81   virtual void UseExistingRenderable( unsigned int surfaceId ) = 0;
  82
  83 protected:
  84
  85   // Undefined
  86   PixmapRenderSurface(const PixmapRenderSurface&) = delete;
  87
  88   // Undefined
  89   PixmapRenderSurface& operator=(const PixmapRenderSurface& rhs) = delete;
  90
  91 };
  92
  93 } // namespace Adaptor
  94
  95 } // namespace internal
  96
  97 } // namespace Dali
  98
  99 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_PIXMAP_RENDER_SURFACE_H