Dali 3D User Interface Engine
List of all members | Public Member Functions | Private Member Functions | Private Attributes
Dali::Internal::Adaptor::EnvironmentOptions Class Reference

This class provides the environment options which define settings as well as the ability to install a log function. More...

#include <environment-options.h>

Collaboration diagram for Dali::Internal::Adaptor::EnvironmentOptions:
Collaboration graph
[legend]

Public Member Functions

 EnvironmentOptions ()
 Constructor. More...
 
 ~EnvironmentOptions ()
 non-virtual destructor, not intended as a base class More...
 
void SetLogFunction (const Dali::Integration::Log::LogFunction &logFunction)
 
void InstallLogFunction () const
 Install the log function for the current thread. More...
 
void UnInstallLogFunction () const
 Un-install the log function for the current thread. More...
 
unsigned int GetNetworkControlMode () const
 
unsigned int GetFrameRateLoggingFrequency () const
 
unsigned int GetUpdateStatusLoggingFrequency () const
 
unsigned int GetObjectProfilerInterval () const
 
unsigned int GetPerformanceStatsLoggingOptions () const
 
unsigned int GetPerformanceStatsLoggingFrequency () const
 
unsigned int GetPerformanceTimeStampOutput () const
 
unsigned int GetPanGestureLoggingLevel () const
 
int GetPanGesturePredictionMode () const
 
int GetPanGesturePredictionAmount () const
 
int GetPanGestureMaximumPredictionAmount () const
 
int GetPanGestureMinimumPredictionAmount () const
 
int GetPanGesturePredictionAmountAdjustment () const
 Gets the prediction amount to adjust when the pan velocity is changed. More...
 
int GetPanGestureSmoothingMode () const
 
float GetPanGestureSmoothingAmount () const
 
int GetMinimumPanDistance () const
 
int GetMinimumPanEvents () const
 
unsigned int GetWindowWidth () const
 
unsigned int GetWindowHeight () const
 
int GetGlesCallTime () const
 Get the graphics status time. More...
 
bool PerformanceServerRequired () const
 
const std::string & GetWindowName () const
 
const std::string & GetWindowClassName () const
 
ThreadingMode::Type GetThreadingMode () const
 
unsigned int GetRenderRefreshRate () const
 

Private Member Functions

void ParseEnvironmentOptions ()
 Parses the environment options. More...
 
 EnvironmentOptions (const EnvironmentOptions &)
 
EnvironmentOptionsoperator= (const EnvironmentOptions &)
 

Private Attributes

std::string mWindowName
 name of the window More...
 
std::string mWindowClassName
 name of the class the window belongs to More...
 
unsigned int mNetworkControl
 whether network control is enabled More...
 
unsigned int mFpsFrequency
 how often fps is logged out in seconds More...
 
unsigned int mUpdateStatusFrequency
 how often update status is logged out in frames More...
 
unsigned int mObjectProfilerInterval
 how often object counts are logged out in seconds More...
 
unsigned int mPerformanceStatsLevel
 performance statistics logging bitmask More...
 
unsigned int mPerformanceStatsFrequency
 performance statistics logging frequency (seconds) More...
 
unsigned int mPerformanceTimeStampOutput
 performance time stamp output ( bitmask) More...
 
unsigned int mPanGestureLoggingLevel
 pan-gesture log level More...
 
int mPanGesturePredictionMode
 prediction mode for pan gestures More...
 
int mPanGesturePredictionAmount
 prediction amount for pan gestures More...
 
int mPanGestureMaxPredictionAmount
 maximum prediction amount for pan gestures More...
 
int mPanGestureMinPredictionAmount
 minimum prediction amount for pan gestures More...
 
int mPanGesturePredictionAmountAdjustment
 adjustment of prediction amount for pan gestures More...
 
int mPanGestureSmoothingMode
 prediction mode for pan gestures More...
 
float mPanGestureSmoothingAmount
 prediction amount for pan gestures More...
 
int mPanMinimumDistance
 minimum distance required before pan starts More...
 
int mPanMinimumEvents
 minimum events required before pan starts More...
 
int mGlesCallTime
 time in seconds between status updates More...
 
unsigned int mWindowWidth
 width of the window More...
 
unsigned int mWindowHeight
 height of the window More...
 
ThreadingMode::Type mThreadingMode
 threading mode More...
 
unsigned int mRenderRefreshRate
 render refresh rate More...
 
Dali::Integration::Log::LogFunction mLogFunction
 

Detailed Description

This class provides the environment options which define settings as well as the ability to install a log function.

Definition at line 39 of file environment-options.h.

Constructor & Destructor Documentation

Dali::Internal::Adaptor::EnvironmentOptions::EnvironmentOptions ( )

Constructor.

Definition at line 84 of file environment-options.cpp.

References ParseEnvironmentOptions().

Here is the call graph for this function:

Dali::Internal::Adaptor::EnvironmentOptions::~EnvironmentOptions ( )

non-virtual destructor, not intended as a base class

Definition at line 114 of file environment-options.cpp.

Dali::Internal::Adaptor::EnvironmentOptions::EnvironmentOptions ( const EnvironmentOptions )
private

Member Function Documentation

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetFrameRateLoggingFrequency ( ) const
Returns
frequency of how often FPS is logged out (e.g. 0 = off, 2 = every 2 seconds).

Definition at line 137 of file environment-options.cpp.

References mFpsFrequency.

int Dali::Internal::Adaptor::EnvironmentOptions::GetGlesCallTime ( ) const

Get the graphics status time.

Definition at line 225 of file environment-options.cpp.

References mGlesCallTime.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize(), and Dali::Internal::Adaptor::GlProxyImplementation::PostRender().

Here is the caller graph for this function:

int Dali::Internal::Adaptor::EnvironmentOptions::GetMinimumPanDistance ( ) const
Returns
The minimum distance before a pan can be started (-1 means it's not set)

Definition at line 205 of file environment-options.cpp.

References mPanMinimumDistance.

Referenced by Dali::Internal::Adaptor::PanGestureDetectorBase::PanGestureDetectorBase().

Here is the caller graph for this function:

int Dali::Internal::Adaptor::EnvironmentOptions::GetMinimumPanEvents ( ) const
Returns
The minimum events before a pan can be started (-1 means it's not set)

Definition at line 210 of file environment-options.cpp.

References mPanMinimumEvents.

Referenced by Dali::Internal::Adaptor::PanGestureDetectorBase::PanGestureDetectorBase().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetNetworkControlMode ( ) const
Returns
whether network control is enabled or not ( 0 = off, 1 = on )

Definition at line 133 of file environment-options.cpp.

References mNetworkControl.

Referenced by PerformanceServerRequired().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetObjectProfilerInterval ( ) const
Returns
object profiler status interval ( 0 == off )

Definition at line 147 of file environment-options.cpp.

References mObjectProfilerInterval.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetPanGestureLoggingLevel ( ) const
Returns
pan-gesture logging level ( 0 == off )

Definition at line 165 of file environment-options.cpp.

References mPanGestureLoggingLevel.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the caller graph for this function:

int Dali::Internal::Adaptor::EnvironmentOptions::GetPanGestureMaximumPredictionAmount ( ) const
Returns
maximum pan-gesture prediction amount

Definition at line 180 of file environment-options.cpp.

References mPanGestureMaxPredictionAmount.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the caller graph for this function:

int Dali::Internal::Adaptor::EnvironmentOptions::GetPanGestureMinimumPredictionAmount ( ) const
Returns
minimum pan-gesture prediction amount

Definition at line 185 of file environment-options.cpp.

References mPanGestureMinPredictionAmount.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the caller graph for this function:

int Dali::Internal::Adaptor::EnvironmentOptions::GetPanGesturePredictionAmount ( ) const
Returns
pan-gesture prediction amount

Definition at line 175 of file environment-options.cpp.

References mPanGesturePredictionAmount.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the caller graph for this function:

int Dali::Internal::Adaptor::EnvironmentOptions::GetPanGesturePredictionAmountAdjustment ( ) const

Gets the prediction amount to adjust when the pan velocity is changed.

If the pan velocity is accelerating, the prediction amount will be increased by the specified amount until it reaches the upper bound. If the pan velocity is decelerating, the prediction amount will be decreased by the specified amount until it reaches the lower bound.

Returns
pan-gesture prediction amount adjustment

Definition at line 190 of file environment-options.cpp.

References mPanGesturePredictionAmountAdjustment.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the caller graph for this function:

int Dali::Internal::Adaptor::EnvironmentOptions::GetPanGesturePredictionMode ( ) const
Returns
pan-gesture prediction mode ( -1 means not set so no prediction, 0 = no prediction )

Definition at line 170 of file environment-options.cpp.

References mPanGesturePredictionMode.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the caller graph for this function:

float Dali::Internal::Adaptor::EnvironmentOptions::GetPanGestureSmoothingAmount ( ) const
Returns
pan-gesture smoothing amount

Definition at line 200 of file environment-options.cpp.

References mPanGestureSmoothingAmount.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the caller graph for this function:

int Dali::Internal::Adaptor::EnvironmentOptions::GetPanGestureSmoothingMode ( ) const
Returns
pan-gesture smoothing mode ( -1 means not set so no smoothing, 0 = no smoothing )

Definition at line 195 of file environment-options.cpp.

References mPanGestureSmoothingMode.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetPerformanceStatsLoggingFrequency ( ) const
Returns
performance statistics log frequency in seconds

Definition at line 156 of file environment-options.cpp.

References mPerformanceStatsFrequency.

Referenced by Dali::Internal::Adaptor::PerformanceServer::PerformanceServer().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetPerformanceStatsLoggingOptions ( ) const
Returns
performance statistics log level ( 0 == off )

Definition at line 152 of file environment-options.cpp.

References mPerformanceStatsLevel.

Referenced by Dali::Internal::Adaptor::PerformanceServer::PerformanceServer(), and PerformanceServerRequired().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetPerformanceTimeStampOutput ( ) const
Returns
performance time stamp output ( 0 == off)

Definition at line 160 of file environment-options.cpp.

References mPerformanceTimeStampOutput.

Referenced by Dali::Internal::Adaptor::PerformanceServer::PerformanceServer(), and PerformanceServerRequired().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetRenderRefreshRate ( ) const
Returns
The render refresh rate.

Definition at line 245 of file environment-options.cpp.

References mRenderRefreshRate.

Referenced by Dali::Internal::Adaptor::CombinedUpdateRenderController::CombinedUpdateRenderController().

Here is the caller graph for this function:

ThreadingMode::Type Dali::Internal::Adaptor::EnvironmentOptions::GetThreadingMode ( ) const
Returns
The thread mode that DALi should use.

Definition at line 240 of file environment-options.cpp.

References mThreadingMode.

Referenced by Dali::Internal::Adaptor::ThreadController::ThreadController().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetUpdateStatusLoggingFrequency ( ) const
Returns
frequency of how often Update Status is logged out (e.g. 0 = off, 60 = log every 60 frames = 1 second @ 60FPS).

Definition at line 142 of file environment-options.cpp.

References mUpdateStatusFrequency.

const std::string & Dali::Internal::Adaptor::EnvironmentOptions::GetWindowClassName ( ) const
Returns
Gets the window class.

Definition at line 235 of file environment-options.cpp.

References mWindowClassName.

Referenced by Dali::Internal::Adaptor::Application::CreateWindow().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetWindowHeight ( ) const
Returns
The height of the window

Definition at line 220 of file environment-options.cpp.

References mWindowHeight.

Referenced by Dali::Internal::Adaptor::Application::CreateWindow().

Here is the caller graph for this function:

const std::string & Dali::Internal::Adaptor::EnvironmentOptions::GetWindowName ( ) const
Returns
Gets the window name.

Definition at line 230 of file environment-options.cpp.

References mWindowName.

Referenced by Dali::Internal::Adaptor::Application::Application().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::GetWindowWidth ( ) const
Returns
The width of the window

Definition at line 215 of file environment-options.cpp.

References mWindowWidth.

Referenced by Dali::Internal::Adaptor::Application::CreateWindow().

Here is the caller graph for this function:

void Dali::Internal::Adaptor::EnvironmentOptions::InstallLogFunction ( ) const
EnvironmentOptions& Dali::Internal::Adaptor::EnvironmentOptions::operator= ( const EnvironmentOptions )
private
void Dali::Internal::Adaptor::EnvironmentOptions::ParseEnvironmentOptions ( )
private

Parses the environment options.

Called from the constructor

Definition at line 257 of file environment-options.cpp.

References Dali::Clamp(), Dali::Internal::Adaptor::ThreadingMode::COMBINED_UPDATE_RENDER, DALI_ENV_FPS_TRACKING, DALI_ENV_LOG_PAN_GESTURE, DALI_ENV_LOG_PERFORMANCE_STATS, DALI_ENV_LOG_PERFORMANCE_STATS_FREQUENCY, DALI_ENV_NETWORK_CONTROL, DALI_ENV_OBJECT_PROFILER_INTERVAL, DALI_ENV_PAN_MAX_PREDICTION_AMOUNT, DALI_ENV_PAN_MIN_PREDICTION_AMOUNT, DALI_ENV_PAN_MINIMUM_DISTANCE, DALI_ENV_PAN_MINIMUM_EVENTS, DALI_ENV_PAN_PREDICTION_AMOUNT, DALI_ENV_PAN_PREDICTION_AMOUNT_ADJUSTMENT, DALI_ENV_PAN_PREDICTION_MODE, DALI_ENV_PAN_SMOOTHING_AMOUNT, DALI_ENV_PAN_SMOOTHING_MODE, DALI_ENV_PERFORMANCE_TIMESTAMP_OUTPUT, DALI_ENV_UPDATE_STATUS_INTERVAL, DALI_GLES_CALL_TIME, DALI_REFRESH_RATE, DALI_THREADING_MODE, DALI_WINDOW_CLASS_NAME, DALI_WINDOW_HEIGHT, DALI_WINDOW_NAME, DALI_WINDOW_WIDTH, Dali::Internal::Adaptor::anonymous_namespace{environment-options.cpp}::GetCharEnvironmentVariable(), Dali::Internal::Adaptor::anonymous_namespace{environment-options.cpp}::GetFloatEnvironmentVariable(), Dali::Internal::Adaptor::anonymous_namespace{environment-options.cpp}::GetIntegerEnvironmentVariable(), mFpsFrequency, mGlesCallTime, mNetworkControl, mObjectProfilerInterval, mPanGestureLoggingLevel, mPanGestureMaxPredictionAmount, mPanGestureMinPredictionAmount, mPanGesturePredictionAmount, mPanGesturePredictionAmountAdjustment, mPanGesturePredictionMode, mPanGestureSmoothingAmount, mPanGestureSmoothingMode, mPanMinimumDistance, mPanMinimumEvents, mPerformanceStatsFrequency, mPerformanceStatsLevel, mPerformanceTimeStampOutput, mRenderRefreshRate, mThreadingMode, mUpdateStatusFrequency, mWindowClassName, mWindowHeight, mWindowName, mWindowWidth, Dali::Internal::Adaptor::ThreadingMode::SEPARATE_UPDATE_RENDER, and Dali::Internal::Adaptor::ThreadingMode::SINGLE_THREADED.

Referenced by EnvironmentOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Internal::Adaptor::EnvironmentOptions::PerformanceServerRequired ( ) const
Returns
true if performance server is required

Definition at line 250 of file environment-options.cpp.

References GetNetworkControlMode(), GetPerformanceStatsLoggingOptions(), and GetPerformanceTimeStampOutput().

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Internal::Adaptor::EnvironmentOptions::SetLogFunction ( const Dali::Integration::Log::LogFunction logFunction)
Parameters
logFunctionlogging function

Definition at line 118 of file environment-options.cpp.

References mLogFunction.

Referenced by Dali::Internal::Adaptor::Adaptor::Initialize().

Here is the caller graph for this function:

void Dali::Internal::Adaptor::EnvironmentOptions::UnInstallLogFunction ( ) const

Member Data Documentation

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mFpsFrequency
private

how often fps is logged out in seconds

Definition at line 214 of file environment-options.h.

Referenced by GetFrameRateLoggingFrequency(), and ParseEnvironmentOptions().

int Dali::Internal::Adaptor::EnvironmentOptions::mGlesCallTime
private

time in seconds between status updates

Definition at line 230 of file environment-options.h.

Referenced by GetGlesCallTime(), and ParseEnvironmentOptions().

Dali::Integration::Log::LogFunction Dali::Internal::Adaptor::EnvironmentOptions::mLogFunction
private

Definition at line 236 of file environment-options.h.

Referenced by InstallLogFunction(), and SetLogFunction().

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mNetworkControl
private

whether network control is enabled

Definition at line 213 of file environment-options.h.

Referenced by GetNetworkControlMode(), and ParseEnvironmentOptions().

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mObjectProfilerInterval
private

how often object counts are logged out in seconds

Definition at line 216 of file environment-options.h.

Referenced by GetObjectProfilerInterval(), and ParseEnvironmentOptions().

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mPanGestureLoggingLevel
private

pan-gesture log level

Definition at line 220 of file environment-options.h.

Referenced by GetPanGestureLoggingLevel(), and ParseEnvironmentOptions().

int Dali::Internal::Adaptor::EnvironmentOptions::mPanGestureMaxPredictionAmount
private

maximum prediction amount for pan gestures

Definition at line 223 of file environment-options.h.

Referenced by GetPanGestureMaximumPredictionAmount(), and ParseEnvironmentOptions().

int Dali::Internal::Adaptor::EnvironmentOptions::mPanGestureMinPredictionAmount
private

minimum prediction amount for pan gestures

Definition at line 224 of file environment-options.h.

Referenced by GetPanGestureMinimumPredictionAmount(), and ParseEnvironmentOptions().

int Dali::Internal::Adaptor::EnvironmentOptions::mPanGesturePredictionAmount
private

prediction amount for pan gestures

Definition at line 222 of file environment-options.h.

Referenced by GetPanGesturePredictionAmount(), and ParseEnvironmentOptions().

int Dali::Internal::Adaptor::EnvironmentOptions::mPanGesturePredictionAmountAdjustment
private

adjustment of prediction amount for pan gestures

Definition at line 225 of file environment-options.h.

Referenced by GetPanGesturePredictionAmountAdjustment(), and ParseEnvironmentOptions().

int Dali::Internal::Adaptor::EnvironmentOptions::mPanGesturePredictionMode
private

prediction mode for pan gestures

Definition at line 221 of file environment-options.h.

Referenced by GetPanGesturePredictionMode(), and ParseEnvironmentOptions().

float Dali::Internal::Adaptor::EnvironmentOptions::mPanGestureSmoothingAmount
private

prediction amount for pan gestures

Definition at line 227 of file environment-options.h.

Referenced by GetPanGestureSmoothingAmount(), and ParseEnvironmentOptions().

int Dali::Internal::Adaptor::EnvironmentOptions::mPanGestureSmoothingMode
private

prediction mode for pan gestures

Definition at line 226 of file environment-options.h.

Referenced by GetPanGestureSmoothingMode(), and ParseEnvironmentOptions().

int Dali::Internal::Adaptor::EnvironmentOptions::mPanMinimumDistance
private

minimum distance required before pan starts

Definition at line 228 of file environment-options.h.

Referenced by GetMinimumPanDistance(), and ParseEnvironmentOptions().

int Dali::Internal::Adaptor::EnvironmentOptions::mPanMinimumEvents
private

minimum events required before pan starts

Definition at line 229 of file environment-options.h.

Referenced by GetMinimumPanEvents(), and ParseEnvironmentOptions().

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mPerformanceStatsFrequency
private

performance statistics logging frequency (seconds)

Definition at line 218 of file environment-options.h.

Referenced by GetPerformanceStatsLoggingFrequency(), and ParseEnvironmentOptions().

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mPerformanceStatsLevel
private

performance statistics logging bitmask

Definition at line 217 of file environment-options.h.

Referenced by GetPerformanceStatsLoggingOptions(), and ParseEnvironmentOptions().

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mPerformanceTimeStampOutput
private

performance time stamp output ( bitmask)

Definition at line 219 of file environment-options.h.

Referenced by GetPerformanceTimeStampOutput(), and ParseEnvironmentOptions().

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mRenderRefreshRate
private

render refresh rate

Definition at line 234 of file environment-options.h.

Referenced by GetRenderRefreshRate(), and ParseEnvironmentOptions().

ThreadingMode::Type Dali::Internal::Adaptor::EnvironmentOptions::mThreadingMode
private

threading mode

Definition at line 233 of file environment-options.h.

Referenced by GetThreadingMode(), and ParseEnvironmentOptions().

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mUpdateStatusFrequency
private

how often update status is logged out in frames

Definition at line 215 of file environment-options.h.

Referenced by GetUpdateStatusLoggingFrequency(), and ParseEnvironmentOptions().

std::string Dali::Internal::Adaptor::EnvironmentOptions::mWindowClassName
private

name of the class the window belongs to

Definition at line 212 of file environment-options.h.

Referenced by GetWindowClassName(), and ParseEnvironmentOptions().

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mWindowHeight
private

height of the window

Definition at line 232 of file environment-options.h.

Referenced by GetWindowHeight(), and ParseEnvironmentOptions().

std::string Dali::Internal::Adaptor::EnvironmentOptions::mWindowName
private

name of the window

Definition at line 211 of file environment-options.h.

Referenced by GetWindowName(), and ParseEnvironmentOptions().

unsigned int Dali::Internal::Adaptor::EnvironmentOptions::mWindowWidth
private

width of the window

Definition at line 231 of file environment-options.h.

Referenced by GetWindowWidth(), and ParseEnvironmentOptions().


The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali