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