Add "stylus-tools" Wayland protocol.

third_party/wayland-protocols/include/protocol/annotation-unstable-v1-server-protocol.h

+/* Generated by wayland-scanner 1.12.90 */
+
+#ifndef ANNOTATION_UNSTABLE_V1_SERVER_PROTOCOL_H
+#define ANNOTATION_UNSTABLE_V1_SERVER_PROTOCOL_H
+
+#include <stddef.h>
+#include <stdint.h>
+#include "wayland-server.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct wl_client;
+struct wl_resource;
+
+/**
+ * @page page_annotation_unstable_v1 The annotation_unstable_v1 protocol
+ * Protocol for the annotation layer
+ *
+ * @section page_desc_annotation_unstable_v1 Description
+ *
+ * This protocol specifies a set of interfaces to control the behavior
+ * or the annotation layer, a special layer allowing the user to annotate
+ * the on-screen content.
+ *
+ * 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 interface version bump. Backward
+ * incompatible changes are done by bumping the version number in the protocol
+ * and interface 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_ifaces_annotation_unstable_v1 Interfaces
+ * - @subpage page_iface_zcr_annotation_v1 - annotation
+ * - @subpage page_iface_zcr_annotation_features_v1 - annotation_features
+ * interface to a wl_surface
+ * @section page_copyright_annotation_unstable_v1 Copyright
+ * <pre>
+ *
+ * Copyright 2017 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_surface;
+struct zcr_annotation_features_v1;
+struct zcr_annotation_v1;
+
+/**
+ * @page page_iface_zcr_annotation_v1 zcr_annotation_v1
+ * @section page_iface_zcr_annotation_v1_desc Description
+ *
+ * The global interface exposing the annotation layer capabilities is
+ * used to instantiate an interface extension for a wl_surface object.
+ * This extended interface will then allow the client to specify the
+ * features of the annotation layer.
+ * @section page_iface_zcr_annotation_v1_api API
+ * See @ref iface_zcr_annotation_v1.
+ */
+/**
+ * @defgroup iface_zcr_annotation_v1 The zcr_annotation_v1 interface
+ *
+ * The global interface exposing the annotation layer capabilities is
+ * used to instantiate an interface extension for a wl_surface object.
+ * This extended interface will then allow the client to specify the
+ * features of the annotation layer.
+ */
+extern const struct wl_interface zcr_annotation_v1_interface;
+/**
+ * @page page_iface_zcr_annotation_features_v1 zcr_annotation_features_v1
+ * @section page_iface_zcr_annotation_features_v1_desc Description
+ *
+ * An additional interface to a wl_surface object, which allows the
+ * client to specify the features of the annotation layer.
+ *
+ * If the wl_surface associated with the annotation_features object is
+ * destroyed, the annotation_features object becomes inert.
+ *
+ * If the annotation_features object is destroyed, the annotation_features state
+ * is removed from the wl_surface. The change will be applied on the next
+ * wl_surface.commit.
+ * @section page_iface_zcr_annotation_features_v1_api API
+ * See @ref iface_zcr_annotation_features_v1.
+ */
+/**
+ * @defgroup iface_zcr_annotation_features_v1 The zcr_annotation_features_v1
+ * interface
+ *
+ * An additional interface to a wl_surface object, which allows the
+ * client to specify the features of the annotation layer.
+ *
+ * If the wl_surface associated with the annotation_features object is
+ * destroyed, the annotation_features object becomes inert.
+ *
+ * If the annotation_features object is destroyed, the annotation_features state
+ * is removed from the wl_surface. The change will be applied on the next
+ * wl_surface.commit.
+ */
+extern const struct wl_interface zcr_annotation_features_v1_interface;
+
+#ifndef ZCR_ANNOTATION_V1_ERROR_ENUM
+#define ZCR_ANNOTATION_V1_ERROR_ENUM
+enum zcr_annotation_v1_error {
+  /**
+   * the surface already has an annotation_features object associated
+   */
+  ZCR_ANNOTATION_V1_ERROR_ANNOTATION_FEATURES_EXISTS = 0,
+};
+#endif /* ZCR_ANNOTATION_V1_ERROR_ENUM */
+
+/**
+ * @ingroup iface_zcr_annotation_v1
+ * @struct zcr_annotation_v1_interface
+ */
+struct zcr_annotation_v1_interface {
+  /**
+   * unbind from the annotation interface
+   *
+   * Informs the server that the client will not be using this
+   * protocol object anymore. This does not affect any other objects,
+   * annotation_features objects included.
+   */
+  void (*destroy)(struct wl_client* client, struct wl_resource* resource);
+  /**
+   * extend surface interface for annotation_features
+   *
+   * Instantiate an interface extension for the given wl_surface to
+   * provide access to the annotation layer features. If the given
+   * wl_surface already has an annotation_features object associated,
+   * the annotation_features_exists protocol error is raised.
+   * @param id the new annotation_features interface id
+   * @param surface the surface
+   */
+  void (*get_annotation_features)(struct wl_client* client,
+                                  struct wl_resource* resource,
+                                  uint32_t id,
+                                  struct wl_resource* surface);
+};
+
+/**
+ * @ingroup iface_zcr_annotation_v1
+ */
+#define ZCR_ANNOTATION_V1_DESTROY_SINCE_VERSION 1
+/**
+ * @ingroup iface_zcr_annotation_v1
+ */
+#define ZCR_ANNOTATION_V1_GET_ANNOTATION_FEATURES_SINCE_VERSION 1
+
+#ifndef ZCR_ANNOTATION_FEATURES_V1_INPUT_MODE_ENUM
+#define ZCR_ANNOTATION_FEATURES_V1_INPUT_MODE_ENUM
+/**
+ * @ingroup iface_zcr_annotation_features_v1
+ * mode
+ *
+ * Input mode: which types of input events should be handled by
+ * the annotation layer.
+ */
+enum zcr_annotation_features_v1_input_mode {
+  /**
+   * Handle all input events
+   */
+  ZCR_ANNOTATION_FEATURES_V1_INPUT_MODE_DEFAULT = 0,
+  /**
+   * Handle stylus only
+   */
+  ZCR_ANNOTATION_FEATURES_V1_INPUT_MODE_STYLUS_ONLY = 1,
+};
+#endif /* ZCR_ANNOTATION_FEATURES_V1_INPUT_MODE_ENUM */
+
+/**
+ * @ingroup iface_zcr_annotation_features_v1
+ * @struct zcr_annotation_features_v1_interface
+ */
+struct zcr_annotation_features_v1_interface {
+  /**
+   * remove annotation_features from the surface
+   *
+   * The associated wl_surface's annotation_features state is
+   * removed. The change is applied on the next wl_surface.commit.
+   */
+  void (*destroy)(struct wl_client* client, struct wl_resource* resource);
+  /**
+   * set the input mode
+   *
+   * Set the input mode for the annotation layer associated with
+   * the wl_surface.
+   * @param mode the new input mode
+   */
+  void (*set_input_mode)(struct wl_client* client,
+                         struct wl_resource* resource,
+                         uint32_t mode);
+};
+
+/**
+ * @ingroup iface_zcr_annotation_features_v1
+ */
+#define ZCR_ANNOTATION_FEATURES_V1_DESTROY_SINCE_VERSION 1
+/**
+ * @ingroup iface_zcr_annotation_features_v1
+ */
+#define ZCR_ANNOTATION_FEATURES_V1_SET_INPUT_MODE_SINCE_VERSION 1
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif