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