frame.h | frame.h | |||
---|---|---|---|---|
skipping to change at line 30 | skipping to change at line 30 | |||
************************************************************************** **/ | ************************************************************************** **/ | |||
/** | /** | |||
* @file utouch/frame.h | * @file utouch/frame.h | |||
* Definitions of the main and platform-generic API | * Definitions of the main and platform-generic API | |||
*/ | */ | |||
#ifndef UTOUCH_FRAME_UTOUCH_FRAME_H_ | #ifndef UTOUCH_FRAME_UTOUCH_FRAME_H_ | |||
#define UTOUCH_FRAME_UTOUCH_FRAME_H_ | #define UTOUCH_FRAME_UTOUCH_FRAME_H_ | |||
/* Clang provides __has_extension, but GCC does not */ | ||||
#ifdef __has_extension | ||||
#if __has_extension(c_generic_selections) | ||||
#define HAS_C_GENERIC_SELECTIONS | ||||
#endif // __has_extension | ||||
#endif // __has_extension(c_generic_selections) | ||||
#ifdef __cplusplus | #ifdef __cplusplus | |||
extern "C" { | extern "C" { | |||
#endif | #endif | |||
#include <stdint.h> | #include <stdint.h> | |||
/** | /** | |||
* @defgroup v1 uTouch-Frame 1.x | * @defgroup v1 uTouch-Frame 1.x | |||
* @{ | * @{ | |||
* @internal | * @internal | |||
skipping to change at line 367 | skipping to change at line 374 | |||
typedef enum UFStatus { | typedef enum UFStatus { | |||
UFStatusSuccess = 0, /**< The call was successful */ | UFStatusSuccess = 0, /**< The call was successful */ | |||
UFStatusErrorGeneric, /**< A platform-dependent error occurred */ | UFStatusErrorGeneric, /**< A platform-dependent error occurred */ | |||
UFStatusErrorResources, /**< An error occurred due to insufficient resour ces */ | UFStatusErrorResources, /**< An error occurred due to insufficient resour ces */ | |||
UFStatusErrorNoEvent, /**< No events were available to get */ | UFStatusErrorNoEvent, /**< No events were available to get */ | |||
UFStatusErrorUnknownProperty, /**< The requested property value was not s et */ | UFStatusErrorUnknownProperty, /**< The requested property value was not s et */ | |||
UFStatusErrorInvalidTouch, /**< The requested touch does not exist */ | UFStatusErrorInvalidTouch, /**< The requested touch does not exist */ | |||
UFStatusErrorInvalidAxis, /**< The requested axis does not exist */ | UFStatusErrorInvalidAxis, /**< The requested axis does not exist */ | |||
UFStatusErrorUnsupported, /**< The requested function is not supported by the | UFStatusErrorUnsupported, /**< The requested function is not supported by the | |||
window server */ | window server */ | |||
UFStatusErrorInvalidType, /**< The variable type passed as a void pointer | ||||
into | ||||
a property getter is invalid for the prope | ||||
rty | ||||
*/ | ||||
} UFStatus; | } UFStatus; | |||
/** Properties of a device */ | /** Properties of a device */ | |||
typedef enum UFDeviceProperty { | typedef enum UFDeviceProperty { | |||
/** | /** | |||
* The name of the device | * The name of the device | |||
* | * | |||
* Value type: const char * | * Value type: const char * | |||
* | * | |||
* The uTouch frame library owns the string. The string is valid until an | * The uTouch frame library owns the string. The string is valid until an | |||
skipping to change at line 635 | skipping to change at line 645 | |||
UFStatus frame_get_event(UFHandle handle, UFEvent *event); | UFStatus frame_get_event(UFHandle handle, UFEvent *event); | |||
/** | /** | |||
* Get the value of a property of a device | * Get the value of a property of a device | |||
* | * | |||
* @param [in] device The device object (const) | * @param [in] device The device object (const) | |||
* @param [in] property The property to retrieve a value for | * @param [in] property The property to retrieve a value for | |||
* @param [out] value The value retrieved | * @param [out] value The value retrieved | |||
* @return UFStatusSuccess or UFStatusErrorUnknownProperty | * @return UFStatusSuccess or UFStatusErrorUnknownProperty | |||
*/ | */ | |||
#ifndef HAS_C_GENERIC_SELECTIONS /* See frame_internal.h */ | ||||
UFStatus frame_device_get_property(UFDevice device, UFDeviceProperty proper ty, | UFStatus frame_device_get_property(UFDevice device, UFDeviceProperty proper ty, | |||
void *value); | void *value); | |||
#endif | ||||
/** | /** | |||
* Get a device touch axis by index | * Get a device touch axis by index | |||
* | * | |||
* @param [in] device The device object (const) | * @param [in] device The device object (const) | |||
* @param [in] index The index of the axis to get | * @param [in] index The index of the axis to get | |||
* @param [out] axis The axis retrieved | * @param [out] axis The axis retrieved | |||
* @return UFStatusSuccess or UFStatusErrorInvalidAxis | * @return UFStatusSuccess or UFStatusErrorInvalidAxis | |||
* | * | |||
* The index value must be greater than or equal to 0 and less than the num ber | * The index value must be greater than or equal to 0 and less than the num ber | |||
skipping to change at line 722 | skipping to change at line 734 | |||
void frame_event_unref(UFEvent event); | void frame_event_unref(UFEvent event); | |||
/** | /** | |||
* Get the value of a property of an event | * Get the value of a property of an event | |||
* | * | |||
* @param [in] event The event object (const) | * @param [in] event The event object (const) | |||
* @param [in] property The property to retrieve a value for | * @param [in] property The property to retrieve a value for | |||
* @param [out] value The value retrieved | * @param [out] value The value retrieved | |||
* @return UFStatusSuccess or UFStatusErrorUnknownProperty | * @return UFStatusSuccess or UFStatusErrorUnknownProperty | |||
*/ | */ | |||
#ifndef HAS_C_GENERIC_SELECTIONS /* See frame_internal.h */ | ||||
UFStatus frame_event_get_property(UFEvent event, UFEventProperty property, | UFStatus frame_event_get_property(UFEvent event, UFEventProperty property, | |||
void *value); | void *value); | |||
#endif | ||||
/** | /** | |||
* Get the value of a property of a frame | * Get the value of a property of a frame | |||
* | * | |||
* @param [in] frame The frame object (const) | * @param [in] frame The frame object (const) | |||
* @param [in] property The property to retrieve a value for | * @param [in] property The property to retrieve a value for | |||
* @param [out] value The value retrieved | * @param [out] value The value retrieved | |||
* @return UFStatusSuccess or UFStatusErrorUnknownProperty | * @return UFStatusSuccess or UFStatusErrorUnknownProperty | |||
*/ | */ | |||
#ifndef HAS_C_GENERIC_SELECTIONS /* See frame_internal.h */ | ||||
UFStatus frame_frame_get_property(UFFrame frame, UFFrameProperty property, | UFStatus frame_frame_get_property(UFFrame frame, UFFrameProperty property, | |||
void *value); | void *value); | |||
#endif | ||||
/** | /** | |||
* Get a touch of a frame by index | * Get a touch of a frame by index | |||
* | * | |||
* @param [in] frame The frame object (const) | * @param [in] frame The frame object (const) | |||
* @param [in] index The index of the touch to get | * @param [in] index The index of the touch to get | |||
* @param [out] touch The touch retrieved | * @param [out] touch The touch retrieved | |||
* @return UFStatusSuccess or UFStatusErrorInvalidTouch | * @return UFStatusSuccess or UFStatusErrorInvalidTouch | |||
* | * | |||
* The index value must be greater than or equal to 0 and less than the num ber | * The index value must be greater than or equal to 0 and less than the num ber | |||
skipping to change at line 806 | skipping to change at line 822 | |||
UFAxisType type, float* value ); | UFAxisType type, float* value ); | |||
/** | /** | |||
* Get the value of a property of a touch | * Get the value of a property of a touch | |||
* | * | |||
* @param [in] touch The touch object (const) | * @param [in] touch The touch object (const) | |||
* @param [in] property The property to retrieve a value for | * @param [in] property The property to retrieve a value for | |||
* @param [out] value The value retrieved | * @param [out] value The value retrieved | |||
* @return UFStatusSuccess or UFStatusErrorUnknownProperty | * @return UFStatusSuccess or UFStatusErrorUnknownProperty | |||
*/ | */ | |||
#ifndef HAS_C_GENERIC_SELECTIONS /* See frame_internal.h */ | ||||
UFStatus frame_touch_get_property(UFTouch touch, UFTouchProperty property, | UFStatus frame_touch_get_property(UFTouch touch, UFTouchProperty property, | |||
void *value); | void *value); | |||
#endif | ||||
/** | /** | |||
* Get the value of an axis of a touch | * Get the value of an axis of a touch | |||
* | * | |||
* @param [in] touch The touch object (const) | * @param [in] touch The touch object (const) | |||
* @param [in] type The axis to retrieve a value for | * @param [in] type The axis to retrieve a value for | |||
* @param [out] value The value retrieved | * @param [out] value The value retrieved | |||
* @return UFStatusSuccess or UFStatusErrorInvalidAxis | * @return UFStatusSuccess or UFStatusErrorInvalidAxis | |||
*/ | */ | |||
UFStatus frame_touch_get_value(UFTouch touch, UFAxisType type, float *value ); | UFStatus frame_touch_get_value(UFTouch touch, UFAxisType type, float *value ); | |||
skipping to change at line 943 | skipping to change at line 961 | |||
* | * | |||
* @param [in] touch The touch object (const) | * @param [in] touch The touch object (const) | |||
* @return The start time of the touch | * @return The start time of the touch | |||
*/ | */ | |||
uint64_t frame_touch_get_start_time(UFTouch touch); | uint64_t frame_touch_get_start_time(UFTouch touch); | |||
/** @} */ | /** @} */ | |||
/** @} */ | /** @} */ | |||
#include <utouch/frame_internal.h> | ||||
#ifdef __cplusplus | #ifdef __cplusplus | |||
} | } | |||
#endif | #endif | |||
#undef HAS_C_GENERIC_SELECTIONS | ||||
#endif // UTOUCH_FRAME_UTOUCH_FRAME_H_ | #endif // UTOUCH_FRAME_UTOUCH_FRAME_H_ | |||
End of changes. 12 change blocks. | ||||
0 lines changed or deleted | 24 lines changed or added | |||