Index: third_party/wayland-protocols/include/protocol/gaming-input-unstable-v1-server-protocol.h |
diff --git a/third_party/wayland-protocols/include/protocol/gaming-input-unstable-v1-server-protocol.h b/third_party/wayland-protocols/include/protocol/gaming-input-unstable-v1-server-protocol.h |
index 6b2fefbba918483ac5a55fa8c434be67ca67a808..f8ec850a5951075bef1ee7d18cd0f58eb017b41b 100644 |
--- a/third_party/wayland-protocols/include/protocol/gaming-input-unstable-v1-server-protocol.h |
+++ b/third_party/wayland-protocols/include/protocol/gaming-input-unstable-v1-server-protocol.h |
@@ -1,17 +1,40 @@ |
-/* |
+/* Generated by wayland-scanner 1.11.0 */ |
+ |
+#ifndef GAMING_INPUT_UNSTABLE_V1_SERVER_PROTOCOL_H |
+#define GAMING_INPUT_UNSTABLE_V1_SERVER_PROTOCOL_H |
+ |
+#include <stdint.h> |
+#include <stddef.h> |
+#include "wayland-server.h" |
+ |
+#ifdef __cplusplus |
+extern "C" { |
+#endif |
+ |
+struct wl_client; |
+struct wl_resource; |
+ |
+/** |
+ * @page page_gaming_input_unstable_v1 The gaming_input_unstable_v1 protocol |
+ * @section page_ifaces_gaming_input_unstable_v1 Interfaces |
+ * - @subpage page_iface_zwp_gaming_input_v1 - extends wl_seat with gaming input devices |
+ * - @subpage page_iface_zwp_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 |
@@ -19,31 +42,33 @@ |
* 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> |
*/ |
- |
-#ifndef GAMING_INPUT_UNSTABLE_V1_SERVER_PROTOCOL_H |
-#define GAMING_INPUT_UNSTABLE_V1_SERVER_PROTOCOL_H |
- |
-#ifdef __cplusplus |
-extern "C" { |
-#endif |
- |
-#include <stdint.h> |
-#include <stddef.h> |
-#include "wayland-util.h" |
- |
-struct wl_client; |
-struct wl_resource; |
- |
-struct zwp_gaming_input_v1; |
+struct wl_seat; |
struct zwp_gamepad_v1; |
+struct zwp_gaming_input_v1; |
-extern const struct wl_interface zwp_gaming_input_v1_interface; |
-extern const struct wl_interface zwp_gamepad_v1_interface; |
- |
/** |
- * zwp_gaming_input_v1 - extends wl_seat with gaming input devices |
- * @get_gamepad: get gamepad device assigned to seat |
+ * @page page_iface_zwp_gaming_input_v1 zwp_gaming_input_v1 |
+ * @section page_iface_zwp_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_zwp_gaming_input_v1_api API |
+ * See @ref iface_zwp_gaming_input_v1. |
+ */ |
+/** |
+ * @defgroup iface_zwp_gaming_input_v1 The zwp_gaming_input_v1 interface |
* |
* A global interface to provide gaming input devices for a given seat. |
* |
@@ -58,11 +83,33 @@ extern const struct wl_interface zwp_gamepad_v1_interface; |
* version number in the protocol and interface names are removed and the |
* interface version number is reset. |
*/ |
+extern const struct wl_interface zwp_gaming_input_v1_interface; |
+/** |
+ * @page page_iface_zwp_gamepad_v1 zwp_gamepad_v1 |
+ * @section page_iface_zwp_gamepad_v1_desc Description |
+ * |
+ * The zwp_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_zwp_gamepad_v1_api API |
+ * See @ref iface_zwp_gamepad_v1. |
+ */ |
+/** |
+ * @defgroup iface_zwp_gamepad_v1 The zwp_gamepad_v1 interface |
+ * |
+ * The zwp_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 zwp_gamepad_v1_interface; |
+ |
+/** |
+ * @ingroup iface_zwp_gaming_input_v1 |
+ * @struct zwp_gaming_input_v1_interface |
+ */ |
struct zwp_gaming_input_v1_interface { |
/** |
- * get_gamepad - get gamepad device assigned to seat |
- * @id: (none) |
- * @seat: (none) |
+ * get gamepad device assigned to seat |
* |
* Create gamepad object. See zwp_gamepad_v1 interface for |
* details. |
@@ -73,17 +120,21 @@ struct zwp_gaming_input_v1_interface { |
struct wl_resource *seat); |
}; |
+ |
#ifndef ZWP_GAMEPAD_V1_GAMEPAD_STATE_ENUM |
#define ZWP_GAMEPAD_V1_GAMEPAD_STATE_ENUM |
/** |
- * zwp_gamepad_v1_gamepad_state - connection state |
- * @ZWP_GAMEPAD_V1_GAMEPAD_STATE_OFF: no gamepads are connected or on. |
- * @ZWP_GAMEPAD_V1_GAMEPAD_STATE_ON: at least one gamepad is connected. |
- * |
- * |
+ * @ingroup iface_zwp_gamepad_v1 |
+ * connection state |
*/ |
enum zwp_gamepad_v1_gamepad_state { |
+ /** |
+ * no gamepads are connected or on. |
+ */ |
ZWP_GAMEPAD_V1_GAMEPAD_STATE_OFF = 0, |
+ /** |
+ * at least one gamepad is connected. |
+ */ |
ZWP_GAMEPAD_V1_GAMEPAD_STATE_ON = 1, |
}; |
#endif /* ZWP_GAMEPAD_V1_GAMEPAD_STATE_ENUM */ |
@@ -91,31 +142,31 @@ enum zwp_gamepad_v1_gamepad_state { |
#ifndef ZWP_GAMEPAD_V1_BUTTON_STATE_ENUM |
#define ZWP_GAMEPAD_V1_BUTTON_STATE_ENUM |
/** |
- * zwp_gamepad_v1_button_state - physical button state |
- * @ZWP_GAMEPAD_V1_BUTTON_STATE_RELEASED: the button is not pressed |
- * @ZWP_GAMEPAD_V1_BUTTON_STATE_PRESSED: the button is pressed |
+ * @ingroup iface_zwp_gamepad_v1 |
+ * physical button state |
* |
* Describes the physical state of a button that produced the button |
* event. |
*/ |
enum zwp_gamepad_v1_button_state { |
+ /** |
+ * the button is not pressed |
+ */ |
ZWP_GAMEPAD_V1_BUTTON_STATE_RELEASED = 0, |
+ /** |
+ * the button is pressed |
+ */ |
ZWP_GAMEPAD_V1_BUTTON_STATE_PRESSED = 1, |
}; |
#endif /* ZWP_GAMEPAD_V1_BUTTON_STATE_ENUM */ |
/** |
- * zwp_gamepad_v1 - gamepad input device |
- * @destroy: destroy gamepad object |
- * |
- * The zwp_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 |
+ * @ingroup iface_zwp_gamepad_v1 |
+ * @struct zwp_gamepad_v1_interface |
*/ |
struct zwp_gamepad_v1_interface { |
/** |
- * destroy - destroy gamepad object |
+ * destroy gamepad object |
* |
* |
*/ |
@@ -128,24 +179,70 @@ struct zwp_gamepad_v1_interface { |
#define ZWP_GAMEPAD_V1_BUTTON 2 |
#define ZWP_GAMEPAD_V1_FRAME 3 |
+/** |
+ * @ingroup iface_zwp_gamepad_v1 |
+ */ |
+#define ZWP_GAMEPAD_V1_STATE_CHANGE_SINCE_VERSION 1 |
+/** |
+ * @ingroup iface_zwp_gamepad_v1 |
+ */ |
+#define ZWP_GAMEPAD_V1_AXIS_SINCE_VERSION 1 |
+/** |
+ * @ingroup iface_zwp_gamepad_v1 |
+ */ |
+#define ZWP_GAMEPAD_V1_BUTTON_SINCE_VERSION 1 |
+/** |
+ * @ingroup iface_zwp_gamepad_v1 |
+ */ |
+#define ZWP_GAMEPAD_V1_FRAME_SINCE_VERSION 1 |
+ |
+/** |
+ * @ingroup iface_zwp_gamepad_v1 |
+ * Sends an state_change event to the client owning the resource. |
+ * @param resource_ The client's resource |
+ * @param state new state |
+ */ |
static inline void |
zwp_gamepad_v1_send_state_change(struct wl_resource *resource_, uint32_t state) |
{ |
wl_resource_post_event(resource_, ZWP_GAMEPAD_V1_STATE_CHANGE, state); |
} |
+/** |
+ * @ingroup iface_zwp_gamepad_v1 |
+ * Sends an axis event to the client owning the resource. |
+ * @param resource_ The client's resource |
+ * @param time timestamp with millisecond granularity |
+ * @param axis axis that produced this event |
+ * @param value new value of axis |
+ */ |
static inline void |
zwp_gamepad_v1_send_axis(struct wl_resource *resource_, uint32_t time, uint32_t axis, wl_fixed_t value) |
{ |
wl_resource_post_event(resource_, ZWP_GAMEPAD_V1_AXIS, time, axis, value); |
} |
+/** |
+ * @ingroup iface_zwp_gamepad_v1 |
+ * Sends an button event to the client owning the resource. |
+ * @param resource_ The client's resource |
+ * @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 |
+ */ |
static inline void |
zwp_gamepad_v1_send_button(struct wl_resource *resource_, uint32_t time, uint32_t button, uint32_t state, wl_fixed_t analog) |
{ |
wl_resource_post_event(resource_, ZWP_GAMEPAD_V1_BUTTON, time, button, state, analog); |
} |
+/** |
+ * @ingroup iface_zwp_gamepad_v1 |
+ * Sends an frame event to the client owning the resource. |
+ * @param resource_ The client's resource |
+ * @param time timestamp with millisecond granularity |
+ */ |
static inline void |
zwp_gamepad_v1_send_frame(struct wl_resource *resource_, uint32_t time) |
{ |