1 #ifndef __DALI_INTERNAL_ADAPTOR_ENVIRONMENT_OPTIONS_H__
2 #define __DALI_INTERNAL_ADAPTOR_ENVIRONMENT_OPTIONS_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include <dali/integration-api/debug.h>
31 * Contains environment options which define settings and the ability to install a log function.
33 class EnvironmentOptions
44 * non-virtual destructor, not intended as a base class
46 ~EnvironmentOptions();
49 * @param logFunction logging function
50 * @param logFilterOptions bitmask of the logging options defined in intergration/debug.h (e.g.
51 * @param logFrameRateFrequency frequency of how often FPS is logged out (e.g. 0 = off, 2 = every 2 seconds).
52 * @param logupdateStatusFrequency frequency of how often the update status is logged in number of frames
53 * @param logPerformanceLevel performance logging, 0 = disabled, 1+ = enabled
54 * @param logPanGestureLevel pan-gesture logging, 0 = disabled, 1 = enabled
56 void SetLogOptions( const Dali::Integration::Log::LogFunction& logFunction,
57 unsigned int logFrameRateFrequency,
58 unsigned int logupdateStatusFrequency,
59 unsigned int logPerformanceLevel,
60 unsigned int logPanGestureLevel );
63 * Install the log function for the current thread.
65 void InstallLogFunction() const;
68 * Un-install the log function for the current thread.
70 void UnInstallLogFunction() const;
73 * @return frequency of how often FPS is logged out (e.g. 0 = off, 2 = every 2 seconds).
75 unsigned int GetFrameRateLoggingFrequency() const;
78 * @return frequency of how often Update Status is logged out (e.g. 0 = off, 60 = log every 60 frames = 1 second @ 60FPS).
80 unsigned int GetUpdateStatusLoggingFrequency() const;
83 * @return logPerformanceLevel performance log level ( 0 = off )
85 unsigned int GetPerformanceLoggingLevel() const;
88 * @return pan-gesture logging level ( 0 == off )
90 unsigned int GetPanGestureLoggingLevel() const;
93 * @return pan-gesture smoothing mode ( -1 means not set so no smoothing, 0 = no smoothing )
95 int GetPanGestureSmoothingMode() const;
98 * @return pan-gesture prediction amount
100 float GetPanGesturePredictionAmount() const;
103 * @brief Sets the mode used to smooth pan gesture movement properties calculated on the Update thread
105 * @param[in] mode The smoothing mode to use
107 void SetPanGesturePredictionMode(unsigned int mode);
110 * @brief Sets the prediction amount of the pan gesture
112 * @param[in] amount The prediction amount in milliseconds
114 void SetPanGesturePredictionAmount(unsigned int amount);
118 unsigned int mFpsFrequency; ///< how often fps is logged out in seconds
119 unsigned int mUpdateStatusFrequency; ///< how often update status is logged out in frames
120 unsigned int mPerformanceLoggingLevel; ///< performance log level
121 unsigned int mPanGestureLoggingLevel; ///< pan-gesture log level
122 int mPanGesturePredictionMode; ///< prediction mode for pan gestures
123 float mPanGesturePredictionAmount; ///< prediction amount for pan gestures
125 Dali::Integration::Log::LogFunction mLogFunction;
127 // Undefined copy constructor.
128 EnvironmentOptions( const EnvironmentOptions& );
130 // Undefined assignment operator.
131 EnvironmentOptions& operator=( const EnvironmentOptions& );
139 #endif // __DALI_INTERNAL_ADAPTOR_ENVIRONMENT_OPTIONS_H__