dali/internal/window-system/common/display-connection.h

   1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_COMMON_DISPLAY_CONNECTION_H
   2 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_DISPLAY_CONNECTION_H
   3
   4 /*
   5  * Copyright (c) 2015 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/public-api/object/any.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/integration-api/render-surface.h>
  26 #include <dali/internal/graphics/common/graphics-interface.h>
  27
  28
  29 namespace Dali
  30 {
  31 namespace Internal
  32 {
  33 namespace Adaptor
  34 {
  35 class DisplayConnection;
  36 }
  37 }
  38
  39 class DisplayConnection
  40 {
  41 public:
  42
  43   /**
  44    * @brief Create an initialized DisplayConnection.
  45    *
  46    * @param[in] graphics The abstracted graphics interface
  47    * @return A handle to a newly allocated DisplayConnection resource.
  48    */
  49   static DisplayConnection* New( Dali::Internal::Adaptor::GraphicsInterface& graphics );
  50
  51   /**
  52    * @brief Create an initialized DisplayConnection.
  53    * Native surface will need this instead of DisplayConnection::New()
  54    *
  55    * @param[in] graphics The abstracted graphics interface
  56    * @param[in] type Render surface type
  57    * @return A handle to a newly allocated DisplayConnection resource.
  58    */
  59   static DisplayConnection* New( Dali::Internal::Adaptor::GraphicsInterface& graphics, Integration::RenderSurface::Type type );
  60
  61   /**
  62    * @brief Create a DisplayConnection handle; this can be initialised with DisplayConnection::New().
  63    *
  64    * Calling member functions with an uninitialised handle is not allowed.
  65    */
  66   DisplayConnection();
  67
  68   /**
  69    * @brief Destructor
  70    *
  71    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  72    */
  73   ~DisplayConnection();
  74
  75   /**
  76    * @brief Get display
  77    *
  78    * @return display
  79    */
  80   Any GetDisplay();
  81
  82   /**
  83    * @brief Consumes any possible events on the queue so that there is no leaking between frames
  84    */
  85   void ConsumeEvents();
  86
  87   /**
  88    * @brief Initialize the display
  89    */
  90   bool Initialize();
  91
  92 public:
  93
  94   /**
  95    * @brief This constructor is used by DisplayConnection New() methods.
  96    *
  97    * @param [in] handle A pointer to a newly allocated DisplayConnection resource
  98    */
  99   explicit DALI_INTERNAL DisplayConnection(Internal::Adaptor::DisplayConnection* impl);
 100
 101 private:
 102
 103   std::unique_ptr<Internal::Adaptor::DisplayConnection> mImpl;
 104 };
 105
 106 }
 107
 108 #endif // DALI_INTERNAL_WINDOWSYSTEM_COMMON_DISPLAY_CONNECTION_H