adaptors/common/command-line-options.h

   1 #ifndef __DALI_INTERNAL_COMMAND_LINE_OPTIONS_H__
   2 #define __DALI_INTERNAL_COMMAND_LINE_OPTIONS_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 <string>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Internal
  28 {
  29
  30 namespace Adaptor
  31 {
  32
  33 /**
  34  * Parses the passed command line arguments and sets the values stored within this
  35  * class appropriately.
  36  *
  37  * The following options are supported:
  38  *
  39  * @code
  40  *     --no-vsync       Disable VSync on Render
  41  *  -w|--width          Stage Width
  42  *  -h|--height         Stage Height
  43  *  -d|--dpi            Emulated DPI
  44  *     --help           Help
  45  * @endcode
  46  *
  47  * When the above options are found, they are stripped from argv, and argc is updated appropriately.
  48  */
  49 struct CommandLineOptions
  50 {
  51 public:
  52
  53   /**
  54    * Constructor
  55    * @param[in,out]  argc  The number of arguments
  56    * @param[in,out]  argv  The argument list
  57    * @note Supported options are stripped from argv, and argc is updated appropriately.
  58    */
  59   CommandLineOptions(int *argc, char **argv[]);
  60
  61   /**
  62    * Destructor
  63    */
  64   ~CommandLineOptions();
  65
  66 public: // Command line parsed values
  67
  68   int noVSyncOnRender;  ///< If 1, then the user does not want VSync on Render
  69   int stageWidth;       ///< The width of the stage required.  0 if not set.
  70   int stageHeight;      ///< The height of the stage required.   0 if not set.
  71   int viewMode;         ///< Stereocopic 3D view mode (0=MONO, 1=STEREO_HORZ, 2=STEREO_VERT, 3=STEREO_INTERLACED)
  72   int stereoBase;       ///< The distance in millimeters between left/right cameras
  73   std::string stageDPI; ///< DPI stored as hxv, where h is horizontal DPI and v is vertical DPI
  74 };
  75
  76 } // namespace Adaptor
  77
  78 } // namespace Internal
  79
  80 } // namespace Dali
  81
  82 #endif // __DALI_INTERNAL_COMMAND_LINE_OPTIONS_H__