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

   1 #ifndef DALI_INTERNAL_BASE_VSYNC_MONITOR_INTERFACE_H
   2 #define DALI_INTERNAL_BASE_VSYNC_MONITOR_INTERFACE_H
   3
   4 /*
   5  * Copyright (c) 2019 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 // INTERNAL INCLUDES
  23
  24 namespace Dali
  25 {
  26
  27 namespace Internal
  28 {
  29
  30 namespace Adaptor
  31 {
  32
  33 /**
  34  * Interface for monitoring VSync
  35  * Implementations must provide a DoSync method
  36  */
  37 class VSyncMonitorInterface
  38 {
  39 public:
  40
  41   /**
  42    * Initialize the vsync monitor.
  43    */
  44   virtual void Initialize() = 0;
  45
  46   /**
  47    * Terminate the vsync monitor
  48    */
  49   virtual void Terminate() = 0;
  50
  51   /**
  52    * Checks if hardware sync is available and enabled
  53    * @return true if hardware sync is available and enabled
  54    */
  55   virtual bool UseHardware() = 0;
  56
  57   /**
  58    * Wait for vertical blank sync.
  59    * @param[out] frameNumber  The current sequence number for this vsync (increments by one for each vsync)
  60    * @param[out] seconds      The timestamp (seconds) when the vsync occured
  61    * @param[out] microseconds The timestamp (microseconds) when the vsync occured
  62    * @return true if a valid sync was detected, false on error
  63    */
  64   virtual bool DoSync( unsigned int& frameNumber, unsigned int& seconds, unsigned int& microseconds ) = 0;
  65
  66 protected:
  67
  68   /**
  69    * Virtual protected destructor - no deletion through this interface
  70    */
  71   virtual ~VSyncMonitorInterface() {}
  72
  73 }; // class VSyncMonitorInterface
  74
  75 } // namespace Adaptor
  76
  77 } // namespace Internal
  78
  79 } // namespace Dali
  80
  81 #endif // DALI_INTERNAL_BASE_VSYNC_MONITOR_INTERFACE_H