package wayland
Pure OCaml Wayland protocol library
Install
Dune Dependency
Authors
Maintainers
Sources
wayland-2.1.tbz
sha256=0ffb53958954f1ed4ef874a122c071a9cf3de77ae341b963eb7b513d8028f3c1
sha512=e391b91b4161ada44339bb97b0acf40a0ef3d3c8f62a114333a61155b70288b31b5904492ebbf187bad957849ff6e1df172d014f46ffc33db7140fa833449f5c
doc/src/wayland.protocols/pointer_constraints_unstable_v1_client.ml.html
Source file pointer_constraints_unstable_v1_client.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
(* This file was generated automatically by wayland-scanner-ocaml *) [@@@ocaml.warning "-27"] open struct module Imports = struct include Pointer_constraints_unstable_v1_proto include Wayland.Wayland_proto end module Proxy = Wayland.Proxy module Msg = Wayland.Msg module Fixed = Wayland.Fixed module Iface_reg = Wayland.Iface_reg module S = Wayland.S end (** Constrain the movement of a pointer. The global interface exposing pointer constraining functionality. It exposes two requests: lock_pointer for locking the pointer to its position, and confine_pointer for locking the pointer to a region. The lock_pointer and confine_pointer requests create the objects wp_locked_pointer and wp_confined_pointer respectively, and the client can use these objects to interact with the lock. For any surface, only one lock or confinement may be active across all wl_pointer objects of the same seat. If a lock or confinement is requested when another lock or confinement is active or requested on the same surface and with any of the wl_pointer objects of the same seat, an 'already_constrained' error will be raised. *) module Zwp_pointer_constraints_v1 = struct type 'v t = ([`Zwp_pointer_constraints_v1], 'v, [`Client]) Proxy.t module Error = Pointer_constraints_unstable_v1_proto.Zwp_pointer_constraints_v1.Error module Lifetime = Pointer_constraints_unstable_v1_proto.Zwp_pointer_constraints_v1.Lifetime (** {2 Version 1} *) (** Confine pointer to a region. The confine_pointer request lets the client request to confine the pointer cursor to a given region. This request may not take effect immediately; in the future, when the compositor deems implementation- specific constraints are satisfied, the pointer confinement will be activated and the compositor sends a confined event. The intersection of the region passed with this request and the input region of the surface is used to determine where the pointer must be in order for the confinement to activate. It is up to the compositor whether to warp the pointer or require some kind of user interaction for the confinement to activate. If the region is null the surface input region is used. The request will create a new object wp_confined_pointer which is used to interact with the confinement as well as receive updates about its state. See the the description of wp_confined_pointer for further information. *) let confine_pointer (_t:([< `V1] as 'v) t) (id:([`Zwp_confined_pointer_v1], 'v, [`Client]) #Proxy.Handler.t) ~(surface:([`Wl_surface], _, [`Client]) Proxy.t) ~(pointer:([`Wl_pointer], _, [`Client]) Proxy.t) ~(region:([`Wl_region], _, [`Client]) Proxy.t option) ~lifetime = let __id = Proxy.spawn _t id in let _msg = Proxy.alloc _t ~op:2 ~ints:5 ~strings:[] ~arrays:[] in Msg.add_int _msg (Proxy.id __id); Msg.add_int _msg (Proxy.id surface); Msg.add_int _msg (Proxy.id pointer); Msg.add_int _msg (Proxy.id_opt region); Msg.add_int _msg (Imports.Zwp_pointer_constraints_v1.Lifetime.to_int32 lifetime); Proxy.send _t _msg; __id (** Lock pointer to a position. The lock_pointer request lets the client request to disable movements of the virtual pointer (i.e. the cursor), effectively locking the pointer to a position. This request may not take effect immediately; in the future, when the compositor deems implementation-specific constraints are satisfied, the pointer lock will be activated and the compositor sends a locked event. The protocol provides no guarantee that the constraints are ever satisfied, and does not require the compositor to send an error if the constraints cannot ever be satisfied. It is thus possible to request a lock that will never activate. There may not be another pointer constraint of any kind requested or active on the surface for any of the wl_pointer objects of the seat of the passed pointer when requesting a lock. If there is, an error will be raised. See general pointer lock documentation for more details. The intersection of the region passed with this request and the input region of the surface is used to determine where the pointer must be in order for the lock to activate. It is up to the compositor whether to warp the pointer or require some kind of user interaction for the lock to activate. If the region is null the surface input region is used. A surface may receive pointer focus without the lock being activated. The request creates a new object wp_locked_pointer which is used to interact with the lock as well as receive updates about its state. See the the description of wp_locked_pointer for further information. Note that while a pointer is locked, the wl_pointer objects of the corresponding seat will not emit any wl_pointer.motion events, but relative motion events will still be emitted via wp_relative_pointer objects of the same seat. wl_pointer.axis and wl_pointer.button events are unaffected. *) let lock_pointer (_t:([< `V1] as 'v) t) (id:([`Zwp_locked_pointer_v1], 'v, [`Client]) #Proxy.Handler.t) ~(surface:([`Wl_surface], _, [`Client]) Proxy.t) ~(pointer:([`Wl_pointer], _, [`Client]) Proxy.t) ~(region:([`Wl_region], _, [`Client]) Proxy.t option) ~lifetime = let __id = Proxy.spawn _t id in let _msg = Proxy.alloc _t ~op:1 ~ints:5 ~strings:[] ~arrays:[] in Msg.add_int _msg (Proxy.id __id); Msg.add_int _msg (Proxy.id surface); Msg.add_int _msg (Proxy.id pointer); Msg.add_int _msg (Proxy.id_opt region); Msg.add_int _msg (Imports.Zwp_pointer_constraints_v1.Lifetime.to_int32 lifetime); Proxy.send _t _msg; __id (** Destroy the pointer constraints manager object. Used by the client to notify the server that it will no longer use this pointer constraints object. *) let destroy (_t:([< `V1] as 'v) t) = let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in Proxy.send _t _msg; Proxy.shutdown_send _t (**/**) class ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t) method user_data = S.No_data method metadata = (module Pointer_constraints_unstable_v1_proto.Zwp_pointer_constraints_v1) method max_version = 1l method dispatch (_proxy : 'v t) _msg = let _proxy = Proxy.cast_version _proxy in match Msg.op _msg with | _ -> assert false end (**/**) (** {2 Handlers} Note: Servers will always want to use [v1]. *) (** Handler for a proxy with version >= 1. *) class ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t) (**/**) inherit [[< `V1] as 'v] _handlers_unsafe (**/**) method min_version = 1l method bind_version : [`V1] = `V1 end end (** Receive relative pointer motion events. The wp_locked_pointer interface represents a locked pointer state. While the lock of this object is active, the wl_pointer objects of the associated seat will not emit any wl_pointer.motion events. This object will send the event 'locked' when the lock is activated. Whenever the lock is activated, it is guaranteed that the locked surface will already have received pointer focus and that the pointer will be within the region passed to the request creating this object. To unlock the pointer, send the destroy request. This will also destroy the wp_locked_pointer object. If the compositor decides to unlock the pointer the unlocked event is sent. See wp_locked_pointer.unlock for details. When unlocking, the compositor may warp the cursor position to the set cursor position hint. If it does, it will not result in any relative motion events emitted via wp_relative_pointer. If the surface the lock was requested on is destroyed and the lock is not yet activated, the wp_locked_pointer object is now defunct and must be destroyed. *) module Zwp_locked_pointer_v1 = struct type 'v t = ([`Zwp_locked_pointer_v1], 'v, [`Client]) Proxy.t (** {2 Version 1} *) (** Set a new lock region. Set a new region used to lock the pointer. The new lock region is double-buffered. The new lock region will only take effect when the associated surface gets its pending state applied. See wl_surface.commit for details. For details about the lock region, see wp_locked_pointer. *) let set_region (_t:([< `V1] as 'v) t) ~(region:([`Wl_region], _, [`Client]) Proxy.t option) = let _msg = Proxy.alloc _t ~op:2 ~ints:1 ~strings:[] ~arrays:[] in Msg.add_int _msg (Proxy.id_opt region); Proxy.send _t _msg (** Set the pointer cursor position hint. Set the cursor position hint relative to the top left corner of the surface. If the client is drawing its own cursor, it should update the position hint to the position of its own cursor. A compositor may use this information to warp the pointer upon unlock in order to avoid pointer jumps. The cursor position hint is double buffered. The new hint will only take effect when the associated surface gets it pending state applied. See wl_surface.commit for details. *) let set_cursor_position_hint (_t:([< `V1] as 'v) t) ~surface_x ~surface_y = let _msg = Proxy.alloc _t ~op:1 ~ints:2 ~strings:[] ~arrays:[] in Msg.add_fixed _msg surface_x; Msg.add_fixed _msg surface_y; Proxy.send _t _msg (** Destroy the locked pointer object. Destroy the locked pointer object. If applicable, the compositor will unlock the pointer. *) let destroy (_t:([< `V1] as 'v) t) = let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in Proxy.send _t _msg; Proxy.shutdown_send _t (**/**) class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t) method user_data = S.No_data method metadata = (module Pointer_constraints_unstable_v1_proto.Zwp_locked_pointer_v1) method max_version = 1l method private virtual on_locked : [> ] t -> unit method private virtual on_unlocked : [> ] t -> unit method dispatch (_proxy : 'v t) _msg = let _proxy = Proxy.cast_version _proxy in match Msg.op _msg with | 0 -> _self#on_locked _proxy | 1 -> _self#on_unlocked _proxy | _ -> assert false end (**/**) (** {2 Handlers} Note: Servers will always want to use [v1]. *) (** Handler for a proxy with version >= 1. *) class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t) (**/**) inherit [[< `V1] as 'v] _handlers_unsafe (**/**) method private virtual on_locked : [> `V1] t -> unit (** Lock activation event. Notification that the pointer lock of the seat's pointer is activated. *) method private virtual on_unlocked : [> `V1] t -> unit (** Lock deactivation event. Notification that the pointer lock of the seat's pointer is no longer active. If this is a oneshot pointer lock (see wp_pointer_constraints.lifetime) this object is now defunct and should be destroyed. If this is a persistent pointer lock (see wp_pointer_constraints.lifetime) this pointer lock may again reactivate in the future. *) method min_version = 1l end end (** Confined pointer object. The wp_confined_pointer interface represents a confined pointer state. This object will send the event 'confined' when the confinement is activated. Whenever the confinement is activated, it is guaranteed that the surface the pointer is confined to will already have received pointer focus and that the pointer will be within the region passed to the request creating this object. It is up to the compositor to decide whether this requires some user interaction and if the pointer will warp to within the passed region if outside. To unconfine the pointer, send the destroy request. This will also destroy the wp_confined_pointer object. If the compositor decides to unconfine the pointer the unconfined event is sent. The wp_confined_pointer object is at this point defunct and should be destroyed. *) module Zwp_confined_pointer_v1 = struct type 'v t = ([`Zwp_confined_pointer_v1], 'v, [`Client]) Proxy.t (** {2 Version 1} *) (** Set a new confine region. Set a new region used to confine the pointer. The new confine region is double-buffered. The new confine region will only take effect when the associated surface gets its pending state applied. See wl_surface.commit for details. If the confinement is active when the new confinement region is applied and the pointer ends up outside of newly applied region, the pointer may warped to a position within the new confinement region. If warped, a wl_pointer.motion event will be emitted, but no wp_relative_pointer.relative_motion event. The compositor may also, instead of using the new region, unconfine the pointer. For details about the confine region, see wp_confined_pointer. *) let set_region (_t:([< `V1] as 'v) t) ~(region:([`Wl_region], _, [`Client]) Proxy.t option) = let _msg = Proxy.alloc _t ~op:1 ~ints:1 ~strings:[] ~arrays:[] in Msg.add_int _msg (Proxy.id_opt region); Proxy.send _t _msg (** Destroy the confined pointer object. Destroy the confined pointer object. If applicable, the compositor will unconfine the pointer. *) let destroy (_t:([< `V1] as 'v) t) = let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in Proxy.send _t _msg; Proxy.shutdown_send _t (**/**) class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t) method user_data = S.No_data method metadata = (module Pointer_constraints_unstable_v1_proto.Zwp_confined_pointer_v1) method max_version = 1l method private virtual on_confined : [> ] t -> unit method private virtual on_unconfined : [> ] t -> unit method dispatch (_proxy : 'v t) _msg = let _proxy = Proxy.cast_version _proxy in match Msg.op _msg with | 0 -> _self#on_confined _proxy | 1 -> _self#on_unconfined _proxy | _ -> assert false end (**/**) (** {2 Handlers} Note: Servers will always want to use [v1]. *) (** Handler for a proxy with version >= 1. *) class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t) (**/**) inherit [[< `V1] as 'v] _handlers_unsafe (**/**) method private virtual on_confined : [> `V1] t -> unit (** Pointer confined. Notification that the pointer confinement of the seat's pointer is activated. *) method private virtual on_unconfined : [> `V1] t -> unit (** Pointer unconfined. Notification that the pointer confinement of the seat's pointer is no longer active. If this is a oneshot pointer confinement (see wp_pointer_constraints.lifetime) this object is now defunct and should be destroyed. If this is a persistent pointer confinement (see wp_pointer_constraints.lifetime) this pointer confinement may again reactivate in the future. *) method min_version = 1l end end
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>