adaptors/base/log-options.h

   1 #ifndef __DALI_INTERNAL_ADAPTOR_LOG_OPTIONS_H__
   2 #define __DALI_INTERNAL_ADAPTOR_LOG_OPTIONS_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 #include <dali/integration-api/debug.h>
  21
  22 namespace Dali
  23 {
  24 namespace Internal
  25 {
  26 namespace Adaptor
  27 {
  28
  29 /**
  30  * Contains log settings and the ability to install a log function.
  31  */
  32 class LogOptions
  33 {
  34
  35 public:
  36
  37   /**
  38    * Constructor
  39    */
  40   LogOptions();
  41
  42   /**
  43    * non-virtual destructor, not intended as a base class
  44    */
  45   ~LogOptions();
  46
  47   /**
  48    * @param logFunction logging function
  49    * @param logFilterOptions bitmask of the logging options defined in intergration/debug.h (e.g.
  50    * @param logFrameRateFrequency frequency of how often FPS is logged out (e.g. 0 = off, 2 = every 2 seconds).
  51    * @param logupdateStatusFrequency frequency of how often the update status is logged in number of frames
  52    * @param logPerformanceLevel performance logging, 0 = disabled,  1+ =  enabled
  53    */
  54   void SetOptions( const Dali::Integration::Log::LogFunction& logFunction,
  55                    unsigned int logFrameRateFrequency,
  56                    unsigned int logupdateStatusFrequency,
  57                    unsigned int logPerformanceLevel );
  58
  59   /**
  60    * Install the log function for the current thread.
  61    */
  62   void InstallLogFunction() const;
  63
  64   /**
  65    * Un-install the log function for the current thread.
  66    */
  67   void UnInstallLogFunction() const;
  68
  69   /**
  70    * @return frequency of how often FPS is logged out (e.g. 0 = off, 2 = every 2 seconds).
  71    */
  72   unsigned int GetFrameRateLoggingFrequency() const;
  73
  74   /**
  75    * @return frequency of how often Update Status is logged out (e.g. 0 = off, 60 = log every 60 frames = 1 second @ 60FPS).
  76    */
  77   unsigned int GetUpdateStatusLoggingFrequency() const;
  78
  79   /**
  80    * @return logPerformanceLevel performance log level ( 0 = off )
  81    */
  82   unsigned int GetPerformanceLoggingLevel() const;
  83
  84 private:
  85
  86   unsigned int mFpsFrequency;                     ///< how often fps is logged out in seconds
  87   unsigned int mUpdateStatusFrequency;            ///< how often update status is logged out in frames
  88   unsigned int mPerformanceLoggingLevel;          ///< performance log level
  89
  90   Dali::Integration::Log::LogFunction mLogFunction;
  91
  92   // Undefined copy constructor.
  93   LogOptions( const LogOptions& );
  94
  95   // Undefined assignment operator.
  96   LogOptions& operator=( const LogOptions& );
  97
  98 };
  99
 100 } // Adaptor
 101 } // Internal
 102 } // Dali
 103
 104 #endif // __DALI_INTERNAL_ADAPTOR_LOG_OPTIONS_H__