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   mPartialUpdateAvailable( Integration::PartialUpdateAvailable::FALSE )
  48   {
  49   };
  50
  51   /**
  52    * Initialize the graphics interface
  53    * @param[in]  environmentOptions  The environment options.
  54    */
  55   virtual void Initialize( EnvironmentOptions* environmentOptions ) = 0;
  56
  57   /**
  58    * Destroy the Graphics Factory implementation
  59    */
  60   virtual void Destroy() = 0;
  61
  62   /**
  63    * Get whether the depth buffer is required
  64    * @return TRUE if the depth buffer is required
  65    */
  66   Integration::DepthBufferAvailable& GetDepthBufferRequired()
  67   {
  68     return mDepthBufferRequired;
  69   };
  70
  71   /**
  72    * Get whether the stencil buffer is required
  73    * @return TRUE if the stencil buffer is required
  74    */
  75   Integration::StencilBufferAvailable GetStencilBufferRequired()
  76   {
  77     return mStencilBufferRequired;
  78   };
  79
  80   /**
  81    * Get whether the partial update is available
  82    * @return TRUE if the partial update is available
  83    */
  84   Integration::PartialUpdateAvailable PartialUpdateAvailable()
  85   {
  86     return mPartialUpdateAvailable;
  87   };
  88
  89 protected:
  90   /**
  91    * Virtual protected destructor - no deletion through this interface
  92    */
  93   virtual ~GraphicsInterface() {};
  94
  95
  96 protected:
  97
  98   Integration::DepthBufferAvailable mDepthBufferRequired;       ///< Whether the depth buffer is required
  99   Integration::StencilBufferAvailable mStencilBufferRequired;   ///< Whether the stencil buffer is required
 100   Integration::PartialUpdateAvailable mPartialUpdateAvailable; ///Whether the partial update is available
 101 };
 102
 103 } // Adaptor
 104
 105 } // Internal
 106
 107 } // Dali
 108
 109 #endif // DALI_INTERNAL_BASE_GRAPHICS_INTERFACE_H