dali/internal/graphics/common/graphics-interface.h

   1 #ifndef DALI_INTERNAL_BASE_GRAPHICS_INTERFACE_H
   2 #define DALI_INTERNAL_BASE_GRAPHICS_INTERFACE_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/internal/system/common/environment-options.h>
  23 #include <dali/integration-api/core-enumerations.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Internal
  29 {
  30
  31 namespace Adaptor
  32 {
  33
  34 /**
  35  * Factory interface for creating Graphics Factory implementation
  36  */
  37 class GraphicsInterface
  38 {
  39 public:
  40
  41   /**
  42    * Constructor
  43    */
  44   GraphicsInterface()
  45   : mDepthBufferRequired( Integration::DepthBufferAvailable::FALSE ),
  46     mStencilBufferRequired( Integration::StencilBufferAvailable::FALSE ),
  47     mPartialUpdateRequired( Integration::PartialUpdateAvailable::FALSE )
  48   {
  49   };
  50
  51   /**
  52    * Destructor
  53    */
  54   virtual ~GraphicsInterface() {}
  55
  56   /**
  57    * Initialize the graphics interface
  58    * @param[in]  environmentOptions  The environment options.
  59    */
  60   virtual void Initialize( EnvironmentOptions* environmentOptions ) = 0;
  61
  62   /**
  63    * Destroy the Graphics Factory implementation
  64    */
  65   virtual void Destroy() = 0;
  66
  67   /**
  68    * Get whether the depth buffer is required
  69    * @return TRUE if the depth buffer is required
  70    */
  71   Integration::DepthBufferAvailable& GetDepthBufferRequired()
  72   {
  73     return mDepthBufferRequired;
  74   };
  75
  76   /**
  77    * Get whether the stencil buffer is required
  78    * @return TRUE if the stencil buffer is required
  79    */
  80   Integration::StencilBufferAvailable GetStencilBufferRequired()
  81   {
  82     return mStencilBufferRequired;
  83   };
  84
  85   /**
  86    * Get whether the stencil buffer is required
  87    * @return TRUE if the stencil buffer is required
  88    */
  89   Integration::PartialUpdateAvailable GetPartialUpdateRequired()
  90   {
  91     return mPartialUpdateRequired;
  92   };
  93
  94 protected:
  95
  96   Integration::DepthBufferAvailable mDepthBufferRequired;       ///< Whether the depth buffer is required
  97   Integration::StencilBufferAvailable mStencilBufferRequired;   ///< Whether the stencil buffer is required
  98   Integration::PartialUpdateAvailable mPartialUpdateRequired;   ///< Whether the partial update is required
  99 };
 100
 101 } // Adaptor
 102
 103 } // Internal
 104
 105 } // Dali
 106
 107 #endif // DALI_INTERNAL_BASE_GRAPHICS_INTERFACE_H