| /* Generated by wayland-scanner 1.13.0 */ |
| |
| #ifndef GAMING_INPUT_UNSTABLE_V1_CLIENT_PROTOCOL_H |
| #define GAMING_INPUT_UNSTABLE_V1_CLIENT_PROTOCOL_H |
| |
| #include <stdint.h> |
| #include <stddef.h> |
| #include "wayland-client.h" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /** |
| * @page page_gaming_input_unstable_v1 The gaming_input_unstable_v1 protocol |
| * @section page_ifaces_gaming_input_unstable_v1 Interfaces |
| * - @subpage page_iface_zcr_gaming_input_v1 - extends wl_seat with gaming input devices |
| * - @subpage page_iface_zcr_gamepad_v1 - gamepad input device |
| * @section page_copyright_gaming_input_unstable_v1 Copyright |
| * <pre> |
| * |
| * Copyright 2016 The Chromium Authors. |
| * |
| * Permission is hereby granted, free of charge, to any person obtaining a |
| * copy of this software and associated documentation files (the "Software"), |
| * to deal in the Software without restriction, including without limitation |
| * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| * and/or sell copies of the Software, and to permit persons to whom the |
| * Software is furnished to do so, subject to the following conditions: |
| * |
| * The above copyright notice and this permission notice (including the next |
| * paragraph) shall be included in all copies or substantial portions of the |
| * Software. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| * DEALINGS IN THE SOFTWARE. |
| * </pre> |
| */ |
| struct wl_seat; |
| struct zcr_gamepad_v1; |
| struct zcr_gaming_input_v1; |
| |
| /** |
| * @page page_iface_zcr_gaming_input_v1 zcr_gaming_input_v1 |
| * @section page_iface_zcr_gaming_input_v1_desc Description |
| * |
| * A global interface to provide gaming input devices for a given seat. |
| * |
| * Currently only gamepad devices are supported. |
| * |
| * Warning! The protocol described in this file is experimental and |
| * backward incompatible changes may be made. Backward compatible changes |
| * may be added together with the corresponding uinterface version bump. |
| * Backward incompatible changes are done by bumping the version number in |
| * the protocol and uinterface names and resetting the interface version. |
| * Once the protocol is to be declared stable, the 'z' prefix and the |
| * version number in the protocol and interface names are removed and the |
| * interface version number is reset. |
| * @section page_iface_zcr_gaming_input_v1_api API |
| * See @ref iface_zcr_gaming_input_v1. |
| */ |
| /** |
| * @defgroup iface_zcr_gaming_input_v1 The zcr_gaming_input_v1 interface |
| * |
| * A global interface to provide gaming input devices for a given seat. |
| * |
| * Currently only gamepad devices are supported. |
| * |
| * Warning! The protocol described in this file is experimental and |
| * backward incompatible changes may be made. Backward compatible changes |
| * may be added together with the corresponding uinterface version bump. |
| * Backward incompatible changes are done by bumping the version number in |
| * the protocol and uinterface names and resetting the interface version. |
| * Once the protocol is to be declared stable, the 'z' prefix and the |
| * version number in the protocol and interface names are removed and the |
| * interface version number is reset. |
| */ |
| extern const struct wl_interface zcr_gaming_input_v1_interface; |
| /** |
| * @page page_iface_zcr_gamepad_v1 zcr_gamepad_v1 |
| * @section page_iface_zcr_gamepad_v1_desc Description |
| * |
| * The zcr_gamepad_v1 interface represents one or more gamepad input devices, |
| * which are reported as a normalized 'Standard Gamepad' as it is specified |
| * by the W3C Gamepad API at: https://w3c.github.io/gamepad/#remapping |
| * @section page_iface_zcr_gamepad_v1_api API |
| * See @ref iface_zcr_gamepad_v1. |
| */ |
| /** |
| * @defgroup iface_zcr_gamepad_v1 The zcr_gamepad_v1 interface |
| * |
| * The zcr_gamepad_v1 interface represents one or more gamepad input devices, |
| * which are reported as a normalized 'Standard Gamepad' as it is specified |
| * by the W3C Gamepad API at: https://w3c.github.io/gamepad/#remapping |
| */ |
| extern const struct wl_interface zcr_gamepad_v1_interface; |
| |
| #define ZCR_GAMING_INPUT_V1_GET_GAMEPAD 0 |
| |
| |
| /** |
| * @ingroup iface_zcr_gaming_input_v1 |
| */ |
| #define ZCR_GAMING_INPUT_V1_GET_GAMEPAD_SINCE_VERSION 1 |
| |
| /** @ingroup iface_zcr_gaming_input_v1 */ |
| static inline void |
| zcr_gaming_input_v1_set_user_data(struct zcr_gaming_input_v1 *zcr_gaming_input_v1, void *user_data) |
| { |
| wl_proxy_set_user_data((struct wl_proxy *) zcr_gaming_input_v1, user_data); |
| } |
| |
| /** @ingroup iface_zcr_gaming_input_v1 */ |
| static inline void * |
| zcr_gaming_input_v1_get_user_data(struct zcr_gaming_input_v1 *zcr_gaming_input_v1) |
| { |
| return wl_proxy_get_user_data((struct wl_proxy *) zcr_gaming_input_v1); |
| } |
| |
| static inline uint32_t |
| zcr_gaming_input_v1_get_version(struct zcr_gaming_input_v1 *zcr_gaming_input_v1) |
| { |
| return wl_proxy_get_version((struct wl_proxy *) zcr_gaming_input_v1); |
| } |
| |
| /** @ingroup iface_zcr_gaming_input_v1 */ |
| static inline void |
| zcr_gaming_input_v1_destroy(struct zcr_gaming_input_v1 *zcr_gaming_input_v1) |
| { |
| wl_proxy_destroy((struct wl_proxy *) zcr_gaming_input_v1); |
| } |
| |
| /** |
| * @ingroup iface_zcr_gaming_input_v1 |
| * |
| * Create gamepad object. See zcr_gamepad_v1 interface for details. |
| */ |
| static inline struct zcr_gamepad_v1 * |
| zcr_gaming_input_v1_get_gamepad(struct zcr_gaming_input_v1 *zcr_gaming_input_v1, struct wl_seat *seat) |
| { |
| struct wl_proxy *id; |
| |
| id = wl_proxy_marshal_constructor((struct wl_proxy *) zcr_gaming_input_v1, |
| ZCR_GAMING_INPUT_V1_GET_GAMEPAD, &zcr_gamepad_v1_interface, NULL, seat); |
| |
| return (struct zcr_gamepad_v1 *) id; |
| } |
| |
| #ifndef ZCR_GAMEPAD_V1_GAMEPAD_STATE_ENUM |
| #define ZCR_GAMEPAD_V1_GAMEPAD_STATE_ENUM |
| /** |
| * @ingroup iface_zcr_gamepad_v1 |
| * connection state |
| */ |
| enum zcr_gamepad_v1_gamepad_state { |
| /** |
| * no gamepads are connected or on. |
| */ |
| ZCR_GAMEPAD_V1_GAMEPAD_STATE_OFF = 0, |
| /** |
| * at least one gamepad is connected. |
| */ |
| ZCR_GAMEPAD_V1_GAMEPAD_STATE_ON = 1, |
| }; |
| #endif /* ZCR_GAMEPAD_V1_GAMEPAD_STATE_ENUM */ |
| |
| #ifndef ZCR_GAMEPAD_V1_BUTTON_STATE_ENUM |
| #define ZCR_GAMEPAD_V1_BUTTON_STATE_ENUM |
| /** |
| * @ingroup iface_zcr_gamepad_v1 |
| * physical button state |
| * |
| * Describes the physical state of a button that produced the button |
| * event. |
| */ |
| enum zcr_gamepad_v1_button_state { |
| /** |
| * the button is not pressed |
| */ |
| ZCR_GAMEPAD_V1_BUTTON_STATE_RELEASED = 0, |
| /** |
| * the button is pressed |
| */ |
| ZCR_GAMEPAD_V1_BUTTON_STATE_PRESSED = 1, |
| }; |
| #endif /* ZCR_GAMEPAD_V1_BUTTON_STATE_ENUM */ |
| |
| /** |
| * @ingroup iface_zcr_gamepad_v1 |
| * @struct zcr_gamepad_v1_listener |
| */ |
| struct zcr_gamepad_v1_listener { |
| /** |
| * state change event |
| * |
| * Notification that this seat's connection state has changed. |
| * @param state new state |
| */ |
| void (*state_change)(void *data, |
| struct zcr_gamepad_v1 *zcr_gamepad_v1, |
| uint32_t state); |
| /** |
| * axis change event |
| * |
| * Notification of axis change. |
| * |
| * The axis id specifies which axis has changed as defined by the |
| * W3C 'Standard Gamepad'. |
| * |
| * The value is calibrated and normalized to the -1 to 1 range. |
| * @param time timestamp with millisecond granularity |
| * @param axis axis that produced this event |
| * @param value new value of axis |
| */ |
| void (*axis)(void *data, |
| struct zcr_gamepad_v1 *zcr_gamepad_v1, |
| uint32_t time, |
| uint32_t axis, |
| wl_fixed_t value); |
| /** |
| * Gamepad button changed |
| * |
| * Notification of button change. |
| * |
| * The button id specifies which button has changed as defined by |
| * the W3C 'Standard Gamepad'. |
| * |
| * A button can have a digital and an analog value. The analog |
| * value is normalized to a 0 to 1 range. If a button does not |
| * provide an analog value, it will be derived from the digital |
| * state. |
| * @param time timestamp with millisecond granularity |
| * @param button id of button |
| * @param state digital state of the button |
| * @param analog analog value of the button |
| */ |
| void (*button)(void *data, |
| struct zcr_gamepad_v1 *zcr_gamepad_v1, |
| uint32_t time, |
| uint32_t button, |
| uint32_t state, |
| wl_fixed_t analog); |
| /** |
| * Notifies end of a series of gamepad changes. |
| * |
| * Indicates the end of a set of events that logically belong |
| * together. A client is expected to accumulate the data in all |
| * events within the frame before proceeding. |
| * @param time timestamp with millisecond granularity |
| */ |
| void (*frame)(void *data, |
| struct zcr_gamepad_v1 *zcr_gamepad_v1, |
| uint32_t time); |
| }; |
| |
| /** |
| * @ingroup iface_zcr_gamepad_v1 |
| */ |
| static inline int |
| zcr_gamepad_v1_add_listener(struct zcr_gamepad_v1 *zcr_gamepad_v1, |
| const struct zcr_gamepad_v1_listener *listener, void *data) |
| { |
| return wl_proxy_add_listener((struct wl_proxy *) zcr_gamepad_v1, |
| (void (**)(void)) listener, data); |
| } |
| |
| #define ZCR_GAMEPAD_V1_DESTROY 0 |
| |
| /** |
| * @ingroup iface_zcr_gamepad_v1 |
| */ |
| #define ZCR_GAMEPAD_V1_STATE_CHANGE_SINCE_VERSION 1 |
| /** |
| * @ingroup iface_zcr_gamepad_v1 |
| */ |
| #define ZCR_GAMEPAD_V1_AXIS_SINCE_VERSION 1 |
| /** |
| * @ingroup iface_zcr_gamepad_v1 |
| */ |
| #define ZCR_GAMEPAD_V1_BUTTON_SINCE_VERSION 1 |
| /** |
| * @ingroup iface_zcr_gamepad_v1 |
| */ |
| #define ZCR_GAMEPAD_V1_FRAME_SINCE_VERSION 1 |
| |
| /** |
| * @ingroup iface_zcr_gamepad_v1 |
| */ |
| #define ZCR_GAMEPAD_V1_DESTROY_SINCE_VERSION 1 |
| |
| /** @ingroup iface_zcr_gamepad_v1 */ |
| static inline void |
| zcr_gamepad_v1_set_user_data(struct zcr_gamepad_v1 *zcr_gamepad_v1, void *user_data) |
| { |
| wl_proxy_set_user_data((struct wl_proxy *) zcr_gamepad_v1, user_data); |
| } |
| |
| /** @ingroup iface_zcr_gamepad_v1 */ |
| static inline void * |
| zcr_gamepad_v1_get_user_data(struct zcr_gamepad_v1 *zcr_gamepad_v1) |
| { |
| return wl_proxy_get_user_data((struct wl_proxy *) zcr_gamepad_v1); |
| } |
| |
| static inline uint32_t |
| zcr_gamepad_v1_get_version(struct zcr_gamepad_v1 *zcr_gamepad_v1) |
| { |
| return wl_proxy_get_version((struct wl_proxy *) zcr_gamepad_v1); |
| } |
| |
| /** |
| * @ingroup iface_zcr_gamepad_v1 |
| */ |
| static inline void |
| zcr_gamepad_v1_destroy(struct zcr_gamepad_v1 *zcr_gamepad_v1) |
| { |
| wl_proxy_marshal((struct wl_proxy *) zcr_gamepad_v1, |
| ZCR_GAMEPAD_V1_DESTROY); |
| |
| wl_proxy_destroy((struct wl_proxy *) zcr_gamepad_v1); |
| } |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif |