doc/uix_gesture_doc.h

   1 /*
   2  * Copyright (c) 2020 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_UIX_GESTURE_DOC_H__
  19 #define __TIZEN_UIX_GESTURE_DOC_H__
  20
  21
  22 /**
  23  * @ingroup CAPI_UIX_FRAMEWORK
  24  * @defgroup CAPI_UIX_GESTURE_MODULE Gesture
  25  * @brief The @ref CAPI_UIX_GESTURE_MODULE API provides functions for recognizing hand gestures from input sensor data.
  26  * @section CAPI_UIX_GESTURE_MODULE_HEADER Required Header
  27  * \#include <gesture.h>
  28  *
  29  * @section CAPI_UIX_GESTURE_MODULE_OVERVIEW Overview
  30  * You can use Gesture API to recognize a user's hand movement.
  31  * Applications can start and stop recognizing hand gestures and receive the corresponding results with the registered callback function.
  32  * To use Gesture, follow these steps:<br>
  33  * 1. Create a handle <br>
  34  * 2. Set options such as a hand type, a work mode, and other options necessary to recognize hand gestures <br>
  35  * 3. Start recognizing hand gestures <br>
  36  * 4. Stop recognizing <br>
  37  * 5. Destroy a handle <br>
  38  * The Gesture API also notifies you (by callback mechanism) when the input gesture is recognized.
  39  * An application should register a callback function to receive the recognized results with hand_gesture_start_recognition().
  40  *
  41  * @section CAPI_UIX_GESTURE_MODULE_FEATURE Related Features
  42  * This API is related with the following features:<br>
  43  * - %http://tizen.org/feature/sensor.gesture_recognition<br>
  44  * It is recommended to design feature related codes in your application for reliability.<br>
  45  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.<br>
  46  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.<br>
  47  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
  48  */
  49
  50
  51 #endif /* __TIZEN_UIX_GESTURE_DOC_H__ */