adaptors/base/environment-options.h

   1 #ifndef __DALI_INTERNAL_ADAPTOR_ENVIRONMENT_OPTIONS_H__
   2 #define __DALI_INTERNAL_ADAPTOR_ENVIRONMENT_OPTIONS_H__
   3
   4 /*
   5  * Copyright (c) 2017 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 #include <dali/integration-api/debug.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <base/threading-mode.h>
  26
  27 namespace Dali
  28 {
  29 namespace Internal
  30 {
  31 namespace Adaptor
  32 {
  33
  34 /**
  35  * This class provides the environment options which define settings as well as
  36  * the ability to install a log function.
  37  *
  38  */
  39 class EnvironmentOptions
  40 {
  41
  42 public:
  43
  44   /**
  45    * Constructor
  46    */
  47   EnvironmentOptions();
  48
  49   /**
  50    * non-virtual destructor, not intended as a base class
  51    */
  52   ~EnvironmentOptions();
  53
  54   /**
  55    * @param logFunction logging function
  56    */
  57   void SetLogFunction( const Dali::Integration::Log::LogFunction& logFunction );
  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 whether network control is enabled or not ( 0 = off, 1 = on )
  71    */
  72   unsigned int GetNetworkControlMode() const;
  73
  74   /**
  75    * @return frequency of how often FPS is logged out (e.g. 0 = off, 2 = every 2 seconds).
  76    */
  77   unsigned int GetFrameRateLoggingFrequency() const;
  78
  79   /**
  80    * @return frequency of how often Update Status is logged out (e.g. 0 = off, 60 = log every 60 frames = 1 second @ 60FPS).
  81    */
  82   unsigned int GetUpdateStatusLoggingFrequency() const;
  83
  84   /**
  85    * @return object profiler status interval ( 0 == off )
  86    */
  87   unsigned int GetObjectProfilerInterval() const;
  88
  89   /**
  90    * @return performance statistics log level ( 0 == off )
  91    */
  92   unsigned int GetPerformanceStatsLoggingOptions() const;
  93
  94   /**
  95    * @return performance statistics log frequency in seconds
  96    */
  97   unsigned int GetPerformanceStatsLoggingFrequency() const;
  98
  99   /**
 100    * @return performance time stamp output ( 0 == off)
 101    */
 102   unsigned int GetPerformanceTimeStampOutput() const;
 103
 104   /**
 105    * @return pan-gesture logging level ( 0 == off )
 106    */
 107   unsigned int GetPanGestureLoggingLevel() const;
 108
 109   /**
 110    * @return pan-gesture prediction mode ( -1 means not set so no prediction, 0 = no prediction )
 111    */
 112   int GetPanGesturePredictionMode() const;
 113
 114   /**
 115    * @return pan-gesture prediction amount
 116    */
 117   int GetPanGesturePredictionAmount() const;
 118
 119   /**
 120    * @return maximum pan-gesture prediction amount
 121    */
 122   int GetPanGestureMaximumPredictionAmount() const;
 123
 124   /**
 125    * @return minimum pan-gesture prediction amount
 126    */
 127   int GetPanGestureMinimumPredictionAmount() const;
 128
 129   /**
 130    * @brief Gets the prediction amount to adjust when the pan velocity is changed.
 131    *
 132    * If the pan velocity is accelerating, the prediction amount will be increased
 133    * by the specified amount until it reaches the upper bound. If the pan velocity
 134    * is decelerating, the prediction amount will be decreased by the specified
 135    * amount until it reaches the lower bound.
 136    *
 137    * @return pan-gesture prediction amount adjustment
 138    */
 139   int GetPanGesturePredictionAmountAdjustment() const;
 140
 141   /**
 142    * @return pan-gesture smoothing mode ( -1 means not set so no smoothing, 0 = no smoothing )
 143    */
 144   int GetPanGestureSmoothingMode() const;
 145
 146   /**
 147    * @return pan-gesture smoothing amount
 148    */
 149   float GetPanGestureSmoothingAmount() const;
 150
 151   /**
 152    * @return The minimum distance before a pan can be started (-1 means it's not set)
 153    */
 154   int GetMinimumPanDistance() const;
 155
 156   /**
 157    * @return The minimum events before a pan can be started (-1 means it's not set)
 158    */
 159   int GetMinimumPanEvents() const;
 160
 161   /**
 162    * @return The width of the window
 163    */
 164   unsigned int GetWindowWidth() const;
 165
 166   /**
 167    * @return The height of the window
 168    */
 169   unsigned int GetWindowHeight() const;
 170
 171   /**
 172    * @brief Get the graphics status time
 173    */
 174   int GetGlesCallTime() const;
 175
 176   /**
 177    * @brief Get whether or not to accumulate gles call statistics
 178    */
 179   bool GetGlesCallAccumulate() const;
 180
 181   /**
 182    * @return true if performance server is required
 183    */
 184   bool PerformanceServerRequired() const;
 185
 186   /**
 187    * @return Gets the window name.
 188    */
 189   const std::string& GetWindowName() const;
 190
 191   /**
 192    * @return Gets the window class.
 193    */
 194   const std::string& GetWindowClassName() const;
 195
 196   /**
 197    * @return The thread mode that DALi should use.
 198    */
 199   ThreadingMode::Type GetThreadingMode() const;
 200
 201   /**
 202    * @return The render refresh rate.
 203    */
 204   unsigned int GetRenderRefreshRate() const;
 205
 206   /**
 207    * @return The number of samples required in multisample buffers
 208    */
 209   unsigned int GetMultiSamplingLevel() const;
 210
 211   /**
 212    * @return The maximum texture size
 213    */
 214   unsigned int GetMaxTextureSize() const;
 215
 216 private: // Internal
 217
 218   /**
 219    * Parses the environment options.
 220    * Called from the constructor
 221    */
 222   void ParseEnvironmentOptions();
 223
 224 private: // Data
 225
 226   std::string mWindowName;                        ///< name of the window
 227   std::string mWindowClassName;                   ///< name of the class the window belongs to
 228   unsigned int mNetworkControl;                   ///< whether network control is enabled
 229   unsigned int mFpsFrequency;                     ///< how often fps is logged out in seconds
 230   unsigned int mUpdateStatusFrequency;            ///< how often update status is logged out in frames
 231   unsigned int mObjectProfilerInterval;           ///< how often object counts are logged out in seconds
 232   unsigned int mPerformanceStatsLevel;            ///< performance statistics logging bitmask
 233   unsigned int mPerformanceStatsFrequency;        ///< performance statistics logging frequency (seconds)
 234   unsigned int mPerformanceTimeStampOutput;       ///< performance time stamp output ( bitmask)
 235   unsigned int mPanGestureLoggingLevel;           ///< pan-gesture log level
 236   int mPanGesturePredictionMode;                  ///< prediction mode for pan gestures
 237   int mPanGesturePredictionAmount;                ///< prediction amount for pan gestures
 238   int mPanGestureMaxPredictionAmount;             ///< maximum prediction amount for pan gestures
 239   int mPanGestureMinPredictionAmount;             ///< minimum prediction amount for pan gestures
 240   int mPanGesturePredictionAmountAdjustment;      ///< adjustment of prediction amount for pan gestures
 241   int mPanGestureSmoothingMode;                   ///< prediction mode for pan gestures
 242   float mPanGestureSmoothingAmount;               ///< prediction amount for pan gestures
 243   int mPanMinimumDistance;                        ///< minimum distance required before pan starts
 244   int mPanMinimumEvents;                          ///< minimum events required before pan starts
 245   int mGlesCallTime;                              ///< time in seconds between status updates
 246   unsigned int mWindowWidth;                      ///< width of the window
 247   unsigned int mWindowHeight;                     ///< height of the window
 248   ThreadingMode::Type mThreadingMode;             ///< threading mode
 249   unsigned int mRenderRefreshRate;                ///< render refresh rate
 250   bool mGlesCallAccumulate;                       ///< Whether or not to accumulate gles call statistics
 251   unsigned int mMultiSamplingLevel;               ///< The number of samples required in multisample buffers
 252   unsigned int mMaxTextureSize;                   ///< The maximum texture size that GL can handle
 253
 254   Dali::Integration::Log::LogFunction mLogFunction;
 255
 256   // Undefined copy constructor.
 257   EnvironmentOptions( const EnvironmentOptions& );
 258
 259   // Undefined assignment operator.
 260   EnvironmentOptions& operator=( const EnvironmentOptions& );
 261
 262 };
 263
 264 } // Adaptor
 265 } // Internal
 266 } // Dali
 267
 268 #endif // __DALI_INTERNAL_ADAPTOR_ENVIRONMENT_OPTIONS_H__