1<?xml version="1.0" encoding="UTF-8"?> 2<protocol name="aura_shell"> 3 4 <copyright> 5 Copyright 2017 The Chromium Authors 6 7 Permission is hereby granted, free of charge, to any person obtaining a 8 copy of this software and associated documentation files (the "Software"), 9 to deal in the Software without restriction, including without limitation 10 the rights to use, copy, modify, merge, publish, distribute, sublicense, 11 and/or sell copies of the Software, and to permit persons to whom the 12 Software is furnished to do so, subject to the following conditions: 13 14 The above copyright notice and this permission notice (including the next 15 paragraph) shall be included in all copies or substantial portions of the 16 Software. 17 18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 21 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 23 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 24 DEALINGS IN THE SOFTWARE. 25 </copyright> 26 27 <interface name="zaura_shell" version="63"> 28 <description summary="aura_shell"> 29 The global interface exposing aura shell capabilities is used to 30 instantiate an interface extension for a wl_surface object. 31 This extended interface will then allow the client to use aura shell 32 specific functionality. 33 </description> 34 35 <enum name="error"> 36 <entry name="aura_surface_exists" value="0" 37 summary="the surface already has an aura surface object associated"/> 38 <entry name="aura_output_exists" value="1" 39 summary="the output already has an aura output object associated"/> 40 </enum> 41 42 <request name="get_aura_surface"> 43 <description summary="extend surface interface for aura shell"> 44 Instantiate an interface extension for the given wl_surface to 45 provide aura shell functionality. If the given wl_surface is not 46 associated with a shell surface, the shell_surface_missing protocol 47 error is raised. 48 </description> 49 50 <arg name="id" type="new_id" interface="zaura_surface" 51 summary="the new aura surface interface id"/> 52 <arg name="surface" type="object" interface="wl_surface" 53 summary="the surface"/> 54 </request> 55 56 <!-- Version 2 additions --> 57 58 <request name="get_aura_output" since="2"> 59 <description summary="extend output interface for aura shell"> 60 Instantiate an interface extension for the given wl_output to 61 provide aura shell functionality. 62 </description> 63 64 <arg name="id" type="new_id" interface="zaura_output" 65 summary="the new aura output interface id"/> 66 <arg name="output" type="object" interface="wl_output" 67 summary="the output"/> 68 </request> 69 70 <!-- Version 11 additions --> 71 72 <enum name="layout_mode"> 73 <description summary="the layout mode"> 74 Specifies the server's window layout mode. 75 </description> 76 <entry name="windowed" value="1" summary="multiple windows"/> 77 <entry name="tablet" value="2" summary="restricted mode for tablet"/> 78 </enum> 79 80 <event name="layout_mode" since="11"> 81 <description summary="sends the layout_mode"> 82 Sends the layout_mode used by the server. 83 </description> 84 <arg name="layout_mode" type="uint" summary="layout_mode enum"/> 85 </event> 86 87 <!-- Version 14 additions --> 88 89 <event name="bug_fix" since="14"> 90 <description summary="sends a bug fix ID"> 91 Sends a monorail ID of a bug fixed on the exo server that clients can 92 use to gate functionality. 93 </description> 94 <arg name="id" type="uint" summary="ID of a single bug fix"/> 95 </event> 96 97 <event name="desks_changed" since="22"> 98 <description summary="sends names of desks"> 99 Notifies when there is a change in global desks state. This is emitted on 100 desk name changes, desk addition/removal or desks are reordered. 101 "desk_names" argument contains the set of null terminated strings as names of desks. 102 </description> 103 <arg name="desk_names" type="array" summary="an array of existing desks' names"/> 104 </event> 105 <event name="desk_activation_changed" since="22"> 106 <description summary="sends the index of the active desk"> 107 Notifies when there is a change of the active desk. 108 </description> 109 <arg name="active_desk_index" type="int" summary="index of the active desk"/> 110 </event> 111 112 <!-- Version 24 additions --> 113 <event name="activated" since="24"> 114 <description summary="activated surface changed"> 115 Notifies client that the activated surface changed. 116 </description> 117 <arg name="gained_active" type="object" interface="wl_surface" allow-null="true"/> 118 <arg name="lost_active" type="object" interface="wl_surface" allow-null="true"/> 119 </event> 120 121 <!-- Version 26 additions --> 122 <request name="surface_submission_in_pixel_coordinates" since="26"> 123 <description summary="surfaces will be submitted in pixel coordinates"> 124 [Deprecated] Informs the server that when submitting surfaces, this 125 client will not use wl_surface_set_buffer_scale to report the scales, 126 nor will it apply scale via vp_viewporter. Instead the server should 127 apply an appropriate scale transform to have the submitted buffers 128 composited correctly. 129 </description> 130 </request> 131 132 <request name="get_aura_toplevel_for_xdg_toplevel" since="27"> 133 <description summary="get aura toplevel"> 134 Retrieve the aura toplevel interface for a given xdg toplevel interface 135 </description> 136 <arg name="id" type="new_id" interface="zaura_toplevel" 137 summary="the new aura toplevel interface id"/> 138 <arg name="toplevel" type="object" interface="xdg_toplevel"/> 139 </request> 140 141 <request name="get_aura_popup_for_xdg_popup" since="28"> 142 <description summary="get aura popup"> 143 Retrieve the aura popup interface for the given xdg popup interface 144 </description> 145 <arg name="id" type="new_id" interface="zaura_popup" 146 summary="the aura popup interface id"/> 147 <arg name="popup" type="object" interface="xdg_popup"/> 148 </request> 149 150 <request name="release" type="destructor" since="38"> 151 <description summary="release zaura_shell object"> 152 Using this request a client can tell the server that it is not going to 153 use the zaura_shell object anymore. This does not affect any other objects. 154 155 This is named "release" because "destroy" is a special named function used for 156 freeing wl_proxy objects. Naming it "destroy" will cause marshalling errors 157 when running on lower versioned hosts. All "release" requests here should be 158 renamed to "destroy" if we move to aura-shell v2. 159 </description> 160 </request> 161 162 <!-- Version 57 additions --> 163 <event name="set_overview_mode" since="57"> 164 <description summary="entered overview mode"> 165 Notifies client that the server has entered overview mode. Overview mode 166 displays all app windows associated with the current desk for the user. 167 </description> 168 </event> 169 <event name="unset_overview_mode" since="57"> 170 <description summary="exited overview mode"> 171 Notifies client that the server has exited overview mode. 172 </description> 173 </event> 174 175 <!-- Version 58 additions --> 176 <event name="compositor_version" since="58"> 177 <description summary="sends the server version"> 178 Sends the Exo compositor version information. 179 </description> 180 <arg name="version_label" type="string" summary="version string label"/> 181 </event> 182 183 <!-- Version 60 additions --> 184 <event name="all_bug_fixes_sent" since="60"> 185 <description summary="completed sending all bug fix ids"> 186 Notifies client that all the IDs of a bug fixed on the exo server is 187 sent. Bug fix ids are sent via `bug_fix` events which sends ids one by 188 one, not an array. This event is used to confirm all ids are sent. 189 </description> 190 </event> 191 192 <!-- Version 61 additions --> 193 <event name="window_corners_radii" since="61"> 194 <description summary="sends the radius of each corner the window"> 195 Sends the radius of each corner of the window to the clients in dips. 196 </description> 197 <arg name="upper_left_radius" type="uint"/> 198 <arg name="upper_right_radius" type="uint"/> 199 <arg name="lower_right_radius" type="uint"/> 200 <arg name="lower_left_radius" type="uint"/> 201 </event> 202 </interface> 203 204 <interface name="zaura_surface" version="51"> 205 <description summary="aura shell interface to a wl_surface"> 206 An additional interface to a wl_surface object, which allows the 207 client to access aura shell specific functionality for surface. 208 </description> 209 210 <enum name="frame_type"> 211 <description summary="different frame types"> 212 Frame types that can be used to decorate a surface. 213 </description> 214 <entry name="none" value="0" summary="no frame"/> 215 <entry name="normal" value="1" summary="caption with shadow" /> 216 <entry name="shadow" value="2" summary="shadow only"/> 217 </enum> 218 219 <request name="set_frame"> 220 <description summary="request a frame for surface"> 221 [Deprecated] Suggests a surface should use a specific frame. Deprecated 222 since M105. See the set_decoration method on zaura_toplevel and 223 zaura_popup. 224 </description> 225 <arg name="type" type="uint" summary="the new frame type"/> 226 </request> 227 228 <!-- Version 2 additions --> 229 230 <request name="set_parent" since="2"> 231 <description summary="set the parent of this surface"> 232 Set the "parent" of this surface. "x" and "y" arguments specify the 233 initial position for surface relative to parent. 234 </description> 235 <arg name="parent" type="object" interface="zaura_surface" allow-null="true"/> 236 <arg name="x" type="int"/> 237 <arg name="y" type="int"/> 238 </request> 239 240 <!-- Version 3 additions --> 241 242 <request name="set_frame_colors" since="3"> 243 <description summary="set the frame colors of this surface"> 244 Set the frame colors. 245 </description> 246 <arg name="active_color" type="uint" summary="32 bit ARGB color value, not premultiplied"/> 247 <arg name="inactive_color" type="uint" summary="32 bit ARGB color value, not premultiplied"/> 248 </request> 249 250 <!-- Version 4 additions --> 251 252 <request name="set_startup_id" since="4"> 253 <description summary="set the startup ID of this surface"> 254 Set the startup ID. 255 </description> 256 <arg name="startup_id" type="string" allow-null="true"/> 257 </request> 258 259 <!-- Version 5 additions --> 260 261 <request name="set_application_id" since="5"> 262 <description summary="set the application ID of this surface"> 263 Set the application ID. 264 </description> 265 <arg name="application_id" type="string" allow-null="true"/> 266 </request> 267 268 <!-- Version 7 additions --> 269 270 <request name="set_client_surface_id" since="7"> 271 <description summary="set the client surface ID of this surface"> 272 Deprecated. Please use set_client_surface_str_id instead. 273 Set the identifier of the surface assigned by the client. 274 </description> 275 <arg name="client_surface_id" type="int" /> 276 </request> 277 278 <!-- Version 8 additions --> 279 280 <enum name="occlusion_change_reason"> 281 <description summary="occlusion change reason"> 282 Enum describing why an occlusion change happened. An occlusion change as a 283 result of a user action could include things like the user moving a window, 284 changing occlusion, or opening/closing a window, changing the occlusion. 285 </description> 286 <entry name="user_action" value="1" summary="occlusion changed as a result of a user action"/> 287 </enum> 288 289 <request name="set_occlusion_tracking" since="8"> 290 <description summary="set tracked occlusion region"> 291 Sets occlusion tracking on this surface. The client will be updated with a 292 new occlusion fraction when the amount of occlusion of this surface changes. 293 </description> 294 </request> 295 296 <request name="unset_occlusion_tracking" since="8"> 297 <description summary="unset tracked occlusion region"> 298 Unsets occlusion tracking for this surface. 299 </description> 300 </request> 301 302 <event name="occlusion_changed" since="8"> 303 <description summary="Notifies on an occlusion change"> 304 Notifies when there is a change in the amount this surface is occluded. 305 The occlusion update is sent as a fixed point number from 0 to 1, representing 306 the proportion of occlusion. 307 </description> 308 <arg name="occlusion_fraction" type="fixed"/> 309 <arg name="occlusion_reason" type="uint"/> 310 </event> 311 312 <!-- Version 9 additions --> 313 314 <request name="activate" since="9"> 315 <description summary="Indicate that this window wants to be the active window"> 316 [Deprecated] Make this the active window. This usually implies something 317 like restacking this surface to the foreground. The compositor is free 318 to ignore this request if it deems the client to be misbehaving. 319 Typically this request will only be honoured in response to some user 320 driven event, such as executing an application or opening a file in a 321 window that already exists. 322 </description> 323 </request> 324 325 <request name="draw_attention" since="9"> 326 <description summary="Indicate that this window wants some of the user's attention"> 327 Draw attention to this surface in a way that does not change the user's 328 focus. This usually means animating window decorations or taskbar icons. 329 The compositor can still ignore this request if it deems fit, but unlike 330 draw_focus, these requests are expected to come from background tasks, 331 and are more likely to be honoured. 332 </description> 333 </request> 334 335 <!-- Version 10 additions --> 336 337 <enum name="fullscreen_mode"> 338 <description 339 summary="Specifies the behavior of the surface in fullscreen."> 340 [Deprecated] Possible windowing system behaviors if this surface were to go 341 fullscreen. 342 </description> 343 <entry 344 name="immersive" 345 value="0" 346 summary="user can access system UIs such as the shelf and window frame 347 by pointing to, or swiping over, the screen edge"/> 348 <entry 349 name="plain" 350 value="1" 351 summary="user cannot access system UIs using mouse/touches"/> 352 </enum> 353 354 <request name="set_fullscreen_mode" since="10"> 355 <description summary="Sets the behavior of the surface in fullscreen."> 356 [Deprecated] Use the set_fullscreen_mode in the toplevel interface. 357 Suggests how the windowing system should behave if this surface were 358 to go fullscreen. Does not make the surface fullscreen. 359 360 Typically the default mode is "immersive". 361 </description> 362 <arg name="mode" type="uint" enum="fullscreen_mode"/> 363 </request> 364 365 <!-- Version 12 additions --> 366 367 <request name="set_client_surface_str_id" since="12"> 368 <description summary="set the client surface ID of this surface"> 369 Set the identifier of the surface assigned by the client. 370 </description> 371 <arg name="client_surface_id" type="string" /> 372 </request> 373 374 <!-- Version 15 additions --> 375 376 <request name="set_server_start_resize" since="15"> 377 <description summary="request a server-side shadow for surface"> 378 Suggests a surface to have client-side decoration, but 379 server-side decides when and where to start the resize. The server may also 380 apply visual effects to indicate that the resize operation is ongoing. 381 </description> 382 </request> 383 384 <!-- Version 16 additions --> 385 386 <enum name="snap_direction"> 387 <description summary="surface snap directions"> 388 Surface snap directions. 389 </description> 390 <entry name="none" value="0" summary=""/> 391 <entry name="left" value="1" summary=""/> 392 <entry name="right" value="2" summary=""/> 393 </enum> 394 395 <request name="intent_to_snap" since="16"> 396 <description summary="client intents to snap the surface."> 397 [Deprecated] Use intent_to_snap on zaura_toplevel. 398 Notify (or inform) the server the client's intent to snap the window. 399 To inform it's no longer willing to snap, send 'none'. 400 </description> 401 <arg name="direction" type="uint" enum="snap_direction"/> 402 </request> 403 404 <request name="set_snap_left" since="16"> 405 <description summary="snap the surface to the left."> 406 [Deprecated] Use set_snap_primary on zaura_toplevel. 407 Request that surface is snapped to the left. 408 </description> 409 </request> 410 411 <request name="set_snap_right" since="16"> 412 <description summary="snap the surface to the right."> 413 [Deprecated] Use set_snap_secondary on zaura_toplevel. 414 Request that surface is snapped to the right. 415 </description> 416 </request> 417 418 <request name="unset_snap" since="16"> 419 <description summary="Unset the surface snap."> 420 [Deprecated] Use unset_snap on zaura_toplevel. 421 Request that surface resets snapping. 422 </description> 423 </request> 424 425 <!-- Version 17 additions --> 426 427 <event name="lock_frame_normal" since="17"> 428 <description summary="Notify the client that server intent to lock window in normal or restore state"> 429 Notifies the client to lock window in normal or restore state. When 430 window is locked, the window frame should look like it is in restored 431 state, but actually isn't. Locking happends while dragging a maximized 432 window. 433 </description> 434 </event> 435 436 <event name="unlock_frame_normal" since="17"> 437 <description summary="Notify the client that server intent to unlock window's normal or restore state"> 438 Notifies the client to unlock window if it is previously locked. 439 Unlocking happends while dragging a maximized window. 440 </description> 441 </event> 442 443 <!-- Version 18 additions --> 444 <request name="set_window_session_id" since="18"> 445 <description summary="set surface window session id"> 446 Set window session id to the surface. 447 </description> 448 <arg name="id" type="int" summary="window session id"/> 449 </request> 450 451 <!-- Version 19 additions --> 452 <request name="set_can_go_back" since="19"> 453 <description summary="Set the minimize-on-back-gesture behavior."> 454 Sets that the surface can go back as per its navigation list. 455 This allows the server to react to by minimizing the window upon a 456 system wide back gesture. 457 </description> 458 </request> 459 460 <request name="unset_can_go_back" since="19"> 461 <description summary="Unset the minimize-on-back-gesture behavior."> 462 Unsets that the surface can go back as per its navigation list. 463 See above. 464 </description> 465 </request> 466 467 <!-- Version 20 additions --> 468 <request name="set_pip" since="20"> 469 <description summary="Set pip for the surface."> 470 Requests that the surface is set to Picture-in-Picture (PIP). 471 </description> 472 </request> 473 474 <request name="unset_pip" since="20"> 475 <description summary="Unset pip for the surface."> 476 Requests that the surface is unset from Picture-in-Picture (PIP). 477 </description> 478 </request> 479 480 <request name="set_aspect_ratio" since="20"> 481 <description summary="Set aspect ratio for the surface."> 482 Sets the aspect ratio of the surface. 483 </description> 484 <arg name="width" type="int"/> 485 <arg name="height" type="int"/> 486 </request> 487 488 <!-- Version 21 additions --> 489 <enum name="occlusion_state"> 490 <description summary="surface occlusion state"> 491 Describes the occlusion state of a surface. 492 </description> 493 <entry name="unknown" value="0" summary="The surface's occlusion state isn't tracked"/> 494 <entry name="visible" value="1" summary="The surface is visible"/> 495 <entry name="occluded" value="2" summary="The surface is occluded"/> 496 <entry name="hidden" value="3" summary="The surface is not visible"/> 497 </enum> 498 499 <event name="occlusion_state_changed" since="21"> 500 <description summary="Notify the client that the occlusion state changed"> 501 Notifies the client that the occlusion state of a window has changed. Clients 502 will only receive these messages if they previously request occlusion tracking 503 via set_occlusion_tracking for a particular surface. 504 </description> 505 <arg name="mode" type="uint" enum="occlusion_state"/> 506 </event> 507 508 <!-- Version 22 additions --> 509 <request name="move_to_desk" since="22"> 510 <description summary="move to desk"> 511 If |index| equals -1, requests that the server toggles whether client 512 is visible on all workspaces. 513 If |index| is not -1, requests that the server moves the client to the desk at 514 |index|. 515 </description> 516 <arg name="index" type="int"/> 517 </request> 518 519 <event name="desk_changed" since="22"> 520 <description summary="window desk state changed"> 521 Notifies when there is a change in the desk state of a window. 522 This is emitted when a window is moved to another desk or 523 when its assigned-to-all-desks state changes. 524 </description> 525 <arg name="state" type="int" summary="index of desk or -1 for a window assigned to all desks"/> 526 </event> 527 528 <!-- Version 23 additions --> 529 <request name="set_initial_workspace" since="23"> 530 <description summary="initial workspace for restore"> 531 If |initial_workspace| equals '-1', a window is restored and visible on all workspaces, 532 Otherwise, set the initial workspace to restore the window to the corresponding workspace. 533 This is not double buffered and must be set before attaching a buffer. 534 </description> 535 <arg name="initial_workspace" type="string" summary="intial workspace for restoring or '-1' for visible on all workspaces"/> 536 </request> 537 538 <!-- Version 25 additions --> 539 <request name="set_pin" since="25"> 540 <description summary="pin a window (trusted or not)"> 541 Requests that a window is pinned which means that the system does not allow 542 the user to leave the window until an exit criteria is met. 543 544 This is a request to get the window pinned so that the user cannot get to any 545 other window / application. There are two modes: 546 A. trusted is 0 - which is slightly less restrictive and allows the user to 547 get out of the window by a predefined way of authentication. 548 B. trusted is not 0 in which case a trusted application was locking down the 549 system and needs to unlock. This is used for e.g. School tests. 550 </description> 551 <arg name="trusted" type="int" summary="0 for non trusted"/> 552 </request> 553 554 <request name="unset_pin" since="25"> 555 <description summary="unpin a window"> 556 Requests that the user can leave a previously pinned window. 557 558 This is a request to unpin a previously pinned window. It does not matter if 559 the window was locked with the trusted state or not. 560 </description> 561 </request> 562 563 <event name="start_throttle" since="29"> 564 <description summary="start throttling on the surface"> 565 Informs the client to start throttling on the surface. 566 </description> 567 </event> 568 <event name="end_throttle" since="29"> 569 <description summary="end throttling on the surface"> 570 Informs the client to end throttling on the surface. 571 </description> 572 </event> 573 574 <!-- Version 38 additions --> 575 <request name="release" type="destructor" since="38"> 576 <description summary="destroy zaura_surface"> 577 Destroy the zaura_surface object. A client should destroy this object when the 578 role is unmapped from a wl_surface. 579 580 See zaura_shell.release for destructor naming. 581 </description> 582 </request> 583 584 <!-- Version 47 additions --> 585 <request name="show_tooltip" since="47"> 586 <description summary="show tooltip window"> 587 Show tooltip on server side. 588 `x` and `y` specifies the location of tooltip in surface local coordinates. 589 `hide_delay` and `show_delay` specify the time to wait until showing/hiding tooltip. 590 The unit is millisecond. 591 </description> 592 <arg name="text" type="string"/> 593 <arg name="x" type="int"/> 594 <arg name="y" type="int"/> 595 <arg name="tooltip_trigger" type="uint" summary="tooltip_trigger enum"/> 596 <arg name="show_delay" type="uint" summary="delay to show tooltip in millisecond"/> 597 <arg name="hide_delay" type="uint" summary="delay to hide tooltip in millisecond"/> 598 </request> 599 600 <enum name="tooltip_trigger"> 601 <description summary="type of tooltip trigger"> 602 Describes what triggered tooltip 603 </description> 604 <entry name="cursor" value="0" summary="triggered by cursor"/> 605 <entry name="keyboard" value="1" summary="triggered by keyboard"/> 606 </enum> 607 608 <request name="hide_tooltip" since="47"> 609 <description summary="hide tooltip window"> 610 Hide tooltip created by the same client on server side. 611 This may be called even when there is no tooltip window to hide. 612 </description> 613 </request> 614 615 <event name="tooltip_shown" since="47"> 616 <description summary="tooltip is shown by server side"> 617 Informs the client that the tooltip is shown with states. 618 `x` and `y` specifies the location of tooltip in surface local coordinates. 619 </description> 620 <arg name="text" type="string"/> 621 <arg name="x" type="int"/> 622 <arg name="y" type="int"/> 623 <arg name="width" type="int"/> 624 <arg name="height" type="int"/> 625 </event> 626 627 <event name="tooltip_hidden" since="47"> 628 <description summary="tooltip is hidden by server side"> 629 Informs the client that the tooltip is hidden. 630 </description> 631 </event> 632 633 <!-- Version 51 additions --> 634 <request name="set_accessibility_id" since="51"> 635 <description summary="set accessibility ID to the surface"> 636 Set accessibility window ID to the surface. A negative number removes 637 the existing accessibility ID from the surface. 638 </description> 639 <arg name="id" type="int" summary="Accessibility ID. Negative number removes existing accessibility ID from the surface."/> 640 </request> 641 </interface> 642 643 <interface name="zaura_output" version="45"> 644 <description summary="aura shell interface to a wl_output"> 645 An additional interface to a wl_output object, which allows the 646 client to access aura shell specific functionality for output. 647 </description> 648 649 <!-- Version 2 additions --> 650 651 <enum name="scale_property" bitfield="true"> 652 <description summary="scale information"> 653 These flags describe properties of an output scale. 654 They are used in the flags bitfield of the scale event. 655 </description> 656 <entry name="current" value="0x1" 657 summary="indicates this is the current scale"/> 658 <entry name="preferred" value="0x2" 659 summary="indicates this is the preferred scale"/> 660 </enum> 661 662 <enum name="scale_factor"> 663 <entry name="0400" value="400"/> 664 <entry name="0500" value="500"/> 665 <entry name="0550" value="550"/> 666 <entry name="0600" value="600"/> 667 <entry name="0625" value="625"/> 668 <entry name="0650" value="650"/> 669 <entry name="0700" value="700"/> 670 <entry name="0750" value="750"/> 671 <entry name="0800" value="800"/> 672 <entry name="0850" value="850"/> 673 <entry name="0900" value="900"/> 674 <entry name="0950" value="950"/> 675 <entry name="1000" value="1000"/> 676 <entry name="1050" value="1050"/> 677 <entry name="1100" value="1100"/> 678 <entry name="1150" value="1150"/> 679 <entry name="1125" value="1125"/> 680 <entry name="1200" value="1200"/> 681 <entry name="1250" value="1250"/> 682 <entry name="1300" value="1300"/> 683 <entry name="1400" value="1400"/> 684 <entry name="1450" value="1450"/> 685 <entry name="1500" value="1500"/> 686 <entry name="1600" value="1600"/> 687 <entry name="1750" value="1750"/> 688 <entry name="1800" value="1800"/> 689 <entry name="2000" value="2000"/> 690 <entry name="2200" value="2200"/> 691 <entry name="2250" value="2250"/> 692 <entry name="2500" value="2500"/> 693 <entry name="2750" value="2750"/> 694 <entry name="3000" value="3000"/> 695 <entry name="3500" value="3500"/> 696 <entry name="4000" value="4000"/> 697 <entry name="4500" value="4500"/> 698 <entry name="5000" value="5000"/> 699 </enum> 700 701 <event name="scale" since="2"> 702 <description summary="advertise available scales for the output"> 703 The scale event describes an available scale for the output. 704 705 The event is sent when binding to the output object and there 706 will always be one scale, the current scale. The event is sent 707 again if an output changes scale, for the scale that is now 708 current. In other words, the current scale is always the last 709 scale that was received with the current flag set. 710 </description> 711 <arg name="flags" type="uint" enum="scale_property" summary="bitfield of scale flags"/> 712 <arg name="scale" type="uint" enum="scale_factor" summary="output scale"/> 713 </event> 714 715 <!-- Version 5 additions --> 716 717 <enum name="connection_type"> 718 <entry name="unknown" value="0"/> 719 <entry name="internal" value="1"/> 720 </enum> 721 722 <event name="connection" since="5"> 723 <description summary="advertise connection for the output"> 724 The connection event describes how the output is connected. 725 726 The event is sent when binding to the output object. 727 </description> 728 <arg name="connection" type="uint" enum="connection_type" summary="output connection"/> 729 </event> 730 731 <event name="device_scale_factor" since="5"> 732 <description summary="advertise device scale factor for the output"> 733 This event describes the device specific scale factor for the output. 734 735 The device specific scale factor is not expected the change during 736 the lifetime of the output. And it is not limited to an integer value 737 like the scale factor provided by wl_output interface. The exact 738 contents scale used by the compositor can be determined by combining 739 this device scale factor with the current output scale. 740 741 The event is sent when binding to the output object. 742 </description> 743 <arg name="scale" type="uint" enum="scale_factor" summary="output device scale factor"/> 744 </event> 745 746 <!-- Version 33 additions --> 747 748 <event name="insets" since="33"> 749 <description summary="advertise the work area insets for the output"> 750 This event describes the insets for the output in logical screen 751 coordinates, from which the work area can be calculated. 752 753 This event is sent before wl_output.done, after which the client would 754 apply the change. 755 </description> 756 <arg name="top" type="int"/> 757 <arg name="left" type="int"/> 758 <arg name="bottom" type="int"/> 759 <arg name="right" type="int"/> 760 </event> 761 762 <!-- Version 34 additions --> 763 764 <event name="logical_transform" since="34"> 765 <description summary="advertise the output's logical transform"> 766 This event describes the logical transform for the output. Whereas 767 wl_output.geometry's transform corresponds to the display's panel 768 rotation, the logical transform corresponds to the display's logical 769 rotation. 770 771 This event is sent before wl_output.done, after which the client would 772 apply the change. 773 </description> 774 <arg name="transform" type="int" enum="wl_output.transform"/> 775 </event> 776 777 <!-- Version 38 additions --> 778 <request name="release" type="destructor" since="38"> 779 <description summary="destroy zaura_output"> 780 Destroy this zaura_shell object. 781 782 Destroying a bound zaura_shell object while there are zaura_surfaces 783 still alive created by this zaura_shell object instance is illegal 784 and will result in a protocol error. 785 786 See zaura_shell.release for destructor naming. 787 </description> 788 </request> 789 790 <event name="display_id" since="43"> 791 <description summary="advertise the output's display id"> 792 This event describes the 64bit display id assigned to each display by ChromeOS. 793 The value is opaque and should not be interpreted. 794 </description> 795 <arg name="display_id_hi" type="uint"/> 796 <arg name="display_id_lo" type="uint"/> 797 </event> 798 799 <!-- Version 45 additions --> 800 <event name="activated" since="45"> 801 <description summary="target display for new windows"> 802 Notifies that this output is now active output. It is typically used as a 803 target when a new window is created without specific bounds. 804 </description> 805 </event> 806 </interface> 807 808 <interface name="zaura_toplevel" version="63"> 809 <description summary="aura shell interface to the toplevel shell"> 810 An interface to the toplevel shell, which allows the 811 client to access shell specific functionality. 812 </description> 813 814 <enum name="orientation_lock"> 815 <description summary="orientation lock request"> 816 Defines orientation request when a surface is in fullscreen. 817 </description> 818 <entry name="none" value="1" summary="no orientation lock"/> 819 <entry name="portrait" value="2" summary="primary or secondary portrait"/> 820 <entry name="landscape" value="3" summary="primary or secondary landscape"/> 821 <entry name="current" value="4" summary="keep current orientation"/> 822 <entry name="portrait_primary" value="5" summary="primary portrait"/> 823 <entry name="landscape_primary" value="6" summary="primary landscape"/> 824 <entry name="portrait_secondary" value="7" summary="secondary portrait"/> 825 <entry name="landscape_secondary" value="8" summary="secondary landscape"/> 826 </enum> 827 828 <request name="set_orientation_lock" since="26"> 829 <description summary="set orientation lock for a remote surface"> 830 Request a specific orientation behavior when this surface is in fullscreen. 831 </description> 832 <arg name="orientation_lock" type="uint" enum="orientation_lock"/> 833 </request> 834 <request name="surface_submission_in_pixel_coordinates" since="28"> 835 <description summary="surface will be submitted in pixel coordinates"> 836 Informs the server that when submitting this surface, this client will not 837 use wl_surface_set_buffer_scale to report the scales, nor will it apply 838 scale via vp_viewporter. Instead the server should apply an appropriate 839 scale transform for the submitted buffers to be composited correctly. 840 </description> 841 </request> 842 843 <request name="set_supports_screen_coordinates" since="29"> 844 <description summary="enables screen coordinates in window bounds"> 845 Requesting this will enable screen coordinates in surfaces 846 associated with aura_toplevel including sub surfaces and popup 847 windows who added this toplevel as a parent. This should be 848 set before first commit. 849 </description> 850 </request> 851 852 <request name="set_window_bounds" since="29"> 853 <description summary="set window size and position"> 854 Request a new location and bounds of the surface in DP screen 855 coordinates. The size will be applied to visible bounds used 856 in set_geometry. The output is a hint for the compositor to 857 determine which output the window should move to. If the 858 output is null, the compositor should make decision solely by 859 the given bounds. These parameters are just a request and the 860 compositor may ignore, adjust the size and position based on 861 the rule imposed by the window manager, or may preserve it for 862 future operations. For example, the compositor will not allow 863 a position outside of the output, or the compositor may just 864 store it if the toplevel surface is in maximiezd state, and 865 may use it upon unmaximized. 866 </description> 867 <arg name="x" type="int"/> 868 <arg name="y" type="int"/> 869 <arg name="width" type="int"/> 870 <arg name="height" type="int"/> 871 <arg name="output" type="object" interface="wl_output" summary="the output" allow-null="true"/> 872 </request> 873 874 <event name="configure" since="29"> 875 <description summary="suggest a surface change"> 876 A configuration change that also includes the window origin in screen coordinates. 877 </description> 878 <arg name="x" type="int"/> 879 <arg name="y" type="int"/> 880 <arg name="width" type="int"/> 881 <arg name="height" type="int"/> 882 <arg name="states" type="array"/> 883 </event> 884 885 <enum name="state"> 886 <description summary="supplemental aura states to xdg states"> 887 The states that are contained here are supplemental to the states 888 defined in the XDG shell and specific aura windows. 889 </description> 890 891 <!-- Offset by 100 to prevent collision with new XDG states. --> 892 <entry name="immersive" value="100" since="36"> 893 <description summary="immersive mode with hidden title bar and shelf"> 894 User can access system UIs such as the shelf and window frame 895 by pointing to, or swiping over, the screen edge. 896 </description> 897 </entry> 898 <entry name="minimized" value="101" since="36"> 899 <description summary="surface is minimized"> 900 The window has been minimized. 901 </description> 902 </entry> 903 <entry name="snapped_primary" value="102" since="38"> 904 <description summary="window is snapped in primary position"> 905 The window is snapped to the left if the display is in landscape mode 906 and at the top in portrait mode. 907 </description> 908 </entry> 909 <entry name="snapped_secondary" value="103" since="38"> 910 <description summary="window is snapped in secondary position"> 911 The window is snapped to the right if the display is in landscape mode 912 and at the bottom in portrait mode. 913 </description> 914 </entry> 915 <entry name="floated" value="104" since="38"> 916 <description summary="window is floated on top"> 917 The window is floated on top of other windows. One floated window is 918 allowed per desk. Floating a window when there is already a floated 919 window on the same desk will unfloat the floated window. 920 </description> 921 </entry> 922 <entry name="pip" value="105" since="54"> 923 <description summary="window is PiP"> 924 The window is in PiP mode. 925 </description> 926 </entry> 927 </enum> 928 929 <event name="origin_change" since="29"> 930 <description summary="window origin change"> 931 A notification sent when the window origin has changed. Unlike a configure, 932 this does not imply the client needs to resize. The values are in screen 933 coordinates. 934 </description> 935 <arg name="x" type="int" /> 936 <arg name="y" type="int" /> 937 </event> 938 939 <request name="set_restore_info" since="30"> 940 <description summary="set session id and restore id"> 941 Request session id and restore id of a newly created browser window. 942 Set the information used by compositor to restore the toplevel 943 surface state, such as window position, window state, upon creation. 944 This is not double buffered and must be set before sending first commit. 945 </description> 946 <arg name="restore_session_id" type="int" summary="unique browser session id"/> 947 <arg name="restore_window_id" type="int" summary="restore browser window id"/> 948 </request> 949 950 <!-- Version 31 additions --> 951 <request name="set_system_modal" since="31"> 952 <description summary="make window a system modal"> 953 Requests that the toplevel surface should become a system modal. The 954 compositor will prevent other windows from receiving events. If there 955 are multiple system modal surfaces, the compositor will decide which 956 one to receive events. 957 </description> 958 </request> 959 960 <request name="unset_system_modal" since="31"> 961 <description summary="unset window system modal state"> 962 Requests that the system modal state of the toplevel surface will be 963 unset. The compositor will then allow other windows to recieve events. 964 </description> 965 </request> 966 967 <request name="set_restore_info_with_window_id_source" since="32"> 968 <description summary="set session id and restore window id source"> 969 Request session id and restore id of the window. Set the information used by compositor to restore the toplevel surface state, such as window position, window state, upon creation. This is not double buffered and must be set before sending first commit. This is different from set_restore_info, used for clients that create multiple windows associated with restore_id_source. 970 </description> 971 <arg name="restore_session_id" type="int" summary="unique browser session id"/> 972 <arg name="restore_window_id_source" type="string" summary="restore window id source"/> 973 </request> 974 975 <request name="set_decoration" since="35"> 976 <description summary="request a decoration for surface"> 977 Clients are allowed to request a particular decoration for a 978 zaura_toplevel. The server is not required to honor this request. See 979 decoration_type for available options. Available since M105. 980 </description> 981 <arg name="type" type="uint" summary="the new frame type"/> 982 </request> 983 984 <enum name="decoration_type"> 985 <description summary="different decoration types"> 986 Decoration types are used to modify the surface (e.g. drop shadow). 987 </description> 988 <entry name="none" value="0" summary="no frame"/> 989 <entry name="normal" value="1" summary="caption with shadow"/> 990 <entry name="shadow" value="2" summary="shadow only"/> 991 </enum> 992 993 <!-- Version 38 additions --> 994 <request name="release" type="destructor" since="38"> 995 <description summary="destroy zaura_toplevel"> 996 Destroy this zaura_toplevel object. A client should call destroy when the role 997 is unmapped from a wl_surface. 998 999 See zaura_shell.release for destructor naming. 1000 </description> 1001 </request> 1002 1003 <!-- Version 39 additions --> 1004 <request name="set_float" since="39"> 1005 <description summary="float the surface on top"> 1006 [Deprecated] Use set_float_to_location. 1007 This is a request to place the surface above others. 1008 </description> 1009 </request> 1010 <request name="unset_float" since="39"> 1011 <description summary="unset the surface float"> 1012 Request that the surface resets floating. 1013 </description> 1014 </request> 1015 1016 <!-- version 40 additions --> 1017 <request name="set_z_order" since="40"> 1018 <description summary="set z order for window"> 1019 Sets the z order for a toplevel surface. See z_order_level for available options. 1020 </description> 1021 <arg name="z_order" type="uint" summary="z order value for the window"/> 1022 </request> 1023 1024 <enum name="z_order_level"> 1025 <description summary="z order levels for windows"> 1026 Different z order levels that are used to set the z order for a toplevel surface. 1027 </description> 1028 <entry name="normal" value="0" summary="the default level for windows"/> 1029 <entry name="floating_window" value="1" summary="a floating window z-ordered above other normal windows"/> 1030 <entry name="floating_ui_element" value="2" summary="used to show non-window style UIs that are shown above floating windows"/> 1031 <entry name="security_surface" value="3" summary="cannot be interfered with or covered up"/> 1032 </enum> 1033 1034 <!-- version 41 additions --> 1035 <request name="set_origin" since="41"> 1036 <description summary="set window position in DPs"> 1037 Request a new location for the surface in device-independent pixels 1038 (DPs), relative to the top-left corner of the given output. 1039 1040 A null output means whichever output currently contains the surface. 1041 1042 These parameters are just a request and the compositor may ignore 1043 them, adjust them due to rules imposed by the window manager, or 1044 preserve them for future operations. For example, the compositor will 1045 not allow a position outside of the output; or the compositor may just 1046 store it if the toplevel surface is in maximized state, and may use it 1047 upon unmaximize. 1048 </description> 1049 <arg name="x" type="int"/> 1050 <arg name="y" type="int"/> 1051 <arg name="output" type="object" interface="wl_output" allow-null="true" 1052 summary="output to contain the surface"/> 1053 </request> 1054 1055 <request name="activate" since="42"> 1056 <description summary="activates the window"> 1057 Activates this window. This is equivalent to bringing the window to the 1058 foreground. The compositor is free to ignore this request if it deems 1059 the client to be misbehaving. 1060 </description> 1061 </request> 1062 1063 <request name="deactivate" since="42"> 1064 <description summary="deactivates the window"> 1065 Deactivates this window. This is equivalent to requesting that the 1066 window not be the foreground window. The exact behavior is 1067 compositor-defined. The compositor is free to ignore this request 1068 if it deems the client to be misbehaving. 1069 </description> 1070 </request> 1071 1072 <!-- Version 44 additions --> 1073 <enum name="fullscreen_mode"> 1074 <description 1075 summary="Specifies the behavior of the surface in fullscreen."> 1076 Possible windowing system behaviors if this surface were to go 1077 fullscreen. 1078 </description> 1079 <entry 1080 name="plain" 1081 value="0" 1082 summary="user cannot access system UIs using mouse/touches"/> 1083 <entry 1084 name="immersive" 1085 value="1" 1086 summary="user can access system UIs such as the shelf and window frame 1087 by pointing to, or swiping over, the screen edge"/> 1088 </enum> 1089 1090 <request name="set_fullscreen_mode" since="44"> 1091 <description summary="Sets the behavior of the surface in fullscreen."> 1092 Suggests how the windowing manager should behave if this surface were 1093 to go fullscreen. Does not make the surface fullscreen. 1094 </description> 1095 <arg name="mode" type="uint" enum="fullscreen_mode"/> 1096 </request> 1097 1098 <!-- Version 46 additions --> 1099 <request name="set_scale_factor" since="46"> 1100 <description summary="Allows the client to set the scale factor for the future buffer commits."> 1101 The client has a 32-bit float scale factor that is associated with each 1102 zaura toplevel. This scale factor must be propagated exactly to exo. To 1103 do so we reinterpret_cast into a 32-bit uint and later cast back into a 1104 float. This is because wayland does not support native transport of 1105 floats. As different CPU architectures may use different endian 1106 representations for IEEE 754 floats, this protocol implicitly assumes 1107 that the caller and receiver are the same machine. To avoid redundant 1108 messages, this request needs to only be called once when the zaura 1109 toplevel scale factor changes. This is double buffered state and will be 1110 applied in the next commit. 1111 </description> 1112 <arg name="scale_factor_as_uint" type="uint"/> 1113 </request> 1114 1115 <!-- Version 48 additions--> 1116 <request name="set_snap_primary" since="48"> 1117 <description summary="snap the surface to the primary snap position."> 1118 Request that surface is snapped to the left or top if primary layout, 1119 right or bottom otherwise. 1120 </description>/> 1121 <arg name="snap_ratio_as_uint" type="uint"/> 1122 </request> 1123 1124 <request name="set_snap_secondary" since="48"> 1125 <description summary="snap the surface to the secondary snap position."> 1126 Request that surface is snapped to the right or bottom if primary 1127 layout, left or top otherwise. 1128 </description> 1129 <arg name="snap_ratio_as_uint" type="uint"/> 1130 </request> 1131 1132 <!-- Version 49 additions--> 1133 <enum name="snap_direction"> 1134 <description summary="window snap directions"> 1135 Window snap directions. 1136 </description> 1137 <entry name="none" value="0" summary="unsnap the window"/> 1138 <entry name="primary" value="1" summary="snap the window to the left or 1139 top in primary layout, right or bottom in secondary layout"/> 1140 <entry name="secondary" value="2" summary="snap the window to the right 1141 or bottom in primary layout, top or left in secondary layout"/> 1142 </enum> 1143 1144 <request name="intent_to_snap" since="49"> 1145 <description summary="client intents to snap the surface."> 1146 Notify (or inform) the server the client's intent to snap the window. 1147 To inform it's no longer willing to snap, send 'none'. 1148 </description> 1149 <arg name="direction" type="uint" enum="snap_direction"/> 1150 </request> 1151 1152 <request name="unset_snap" since="49"> 1153 <description summary="Unset the window snap."> 1154 Request that window unsets snapping. 1155 </description> 1156 </request> 1157 1158 <!-- Version 50 additions --> 1159 <event name="configure_raster_scale" since="50"> 1160 <description summary="set the raster scale during a configure"> 1161 Sets the raster scale of this window. This should be called during a 1162 configure event sequence. To do so we reinterpret_cast into a 32-bit 1163 uint and later cast back into a float. This is because wayland does not 1164 support native transport of floats. As different CPU architectures may 1165 use different endian representations for IEEE 754 floats, this protocol 1166 implicitly assumes that the caller and receiver are the same machine. 1167 </description> 1168 <arg name="scale" type="uint" summary="Raster scale, in float format"/> 1169 </event> 1170 1171 <!-- Version 52 additions --> 1172 <enum name="persistable"> 1173 <description summary="Describes whether or not the value is persistable"> 1174 Binary enum maps to boolean, describes whether or not a value is 1175 persistable. 1176 </description> 1177 <entry name="not_persistable" value="0" summary="the value is not persistable"/> 1178 <entry name="persistable" value="1" summary="the value is persistable"/> 1179 </enum> 1180 1181 <request name="set_persistable" since="52"> 1182 <description summary="Describes if the window is persistable"> 1183 Request the persistable status of a window. Sets the persistable status 1184 of the window in its window properties. Should be called before first 1185 commit. 1186 </description> 1187 <arg name="persistable" type="uint" enum="persistable" summary="is the argument persistable"/> 1188 </request> 1189 1190 <!-- Version 53 additions --> 1191 <request name="set_shape" since="53"> 1192 <description summary="set the shape of the surface in DP"> 1193 Sets the shape of the toplevel window in DP. Passing NULL will reset the 1194 shape of the window. 1195 1196 This should be used only in support of the existing (deprecated) Chrome 1197 Apps SetShape API and not for any other purpose. 1198 </description> 1199 <arg name="region" type="object" interface="wl_region" allow-null="true"/> 1200 </request> 1201 1202 <request name="set_top_inset" since="55"> 1203 <description summary="set top inset to the surface"> 1204 Sets the top inset to the surface. This represents the header height 1205 and should be non negative. 1206 </description> 1207 <arg name="height" type="int" summary="Top inset of client window. Should be non negative."/> 1208 </request> 1209 1210 <!-- Version 56 additions --> 1211 <enum name="rotate_direction"> 1212 <entry name="backward" value="0" /> 1213 <entry name="forward" value="1" /> 1214 </enum> 1215 1216 <enum name="rotate_restart_state"> 1217 <entry name="no_restart" value="0" /> 1218 <entry name="restart" value="1" /> 1219 </enum> 1220 1221 <event name="rotate_focus" since="56"> 1222 <description summary="rotate focus within window"> 1223 Rotates focus within the toplevel window. The window must sort its 1224 focusable view into a stable and linearly traversable order. Prior to 1225 rotating focus, the surface should already be activated and have 1226 keyboard focus. If the surface has not been activated or does not have 1227 keyboard focus, the server should first activate and enter keyboard 1228 focus for the window. An example of event order could be: 1229 1230 1. activate surface 1231 2. enter keyboard focus 1232 3. rotate focus 1233 1234 If the window is not activated or does not have keyboard focus, the 1235 client should respond with a "not handled" and not perform any 1236 operation. 1237 1238 To start a new series rotation, the server will set the "restart" arg 1239 to true. If the "restart" arg is set to true, the window should set the 1240 focus on the first UI element for the given direction and not perform 1241 any rotation. 1242 1243 The client should respond with whether the rotation was successful via 1244 the "handled" field in the "ack_rotate_focus" request. The client should 1245 pass on the event serial and direction within the ack message. 1246 </description> 1247 <arg name="serial" type="uint" summary="serial for the rotation event" /> 1248 <arg name="direction" type="uint" enum="rotate_direction" summary="the direction for linear traversal" /> 1249 <arg name="restart" type="uint" enum="rotate_restart_state" summary="whether or not to restart traversal" /> 1250 </event> 1251 1252 <enum name="rotate_handled_state"> 1253 <entry name="not_handled" value="0" /> 1254 <entry name="handled" value="1" /> 1255 </enum> 1256 1257 <request name="ack_rotate_focus" since="56"> 1258 <description summary="status of rotate focus event"> 1259 If the focus has been successfully rotated between UI elements inside 1260 surface, client replies with 'handled'. If the focus didn't rotate, the 1261 client reply with 'not_handled'. A server may use this to move the focus 1262 to next focusable surface. 1263 1264 Note that a delay in processing in the client could result in stale acks 1265 received by the server. 1266 </description> 1267 <arg name="serial" type="uint" summary="serial for the original; rotation event" /> 1268 <arg name="handled" type="uint" enum="rotate_handled_state" summary="whether or not the rotation was successful" /> 1269 </request> 1270 1271 <request name="set_can_maximize" since="58"> 1272 <description summary="Hint that the toplevel surface can be maximized"> 1273 Hints to the window manager that the toplevel surface can be maximized. 1274 </description> 1275 </request> 1276 1277 <request name="unset_can_maximize" since="58"> 1278 <description summary="Hint that the toplevel surface should not be maximized"> 1279 Hints to the window manager that the toplevel surface should not be 1280 maximized. Note that the window manager might still request the client 1281 to be maximized. In such an event, the client should respect the 1282 window manager's request and maximize. It may unset the maximized state 1283 afterwards. 1284 </description> 1285 </request> 1286 1287 <request name="set_can_fullscreen" since="58"> 1288 <description summary="Hint that the toplevel surface can enter fullscreen"> 1289 Hints to the window manager that the toplevel surface can enter 1290 fullscreen. 1291 </description> 1292 </request> 1293 1294 <request name="unset_can_fullscreen" since="58"> 1295 <description summary="Hint that the toplevel surface should not enter fullscreen"> 1296 Hints to the window manager that the toplevel surface should not be 1297 enter fullscreen. Note that the window manager might still request the 1298 client enter fullscreen. In such an event, the client should respect the 1299 window manager's request and enter fullscreen. It may exit fullscreen 1300 afterwards. 1301 </description> 1302 </request> 1303 1304 <!-- Version 59 additions --> 1305 <enum name="float_start_location"> 1306 <description 1307 summary="Specifies the location of a surface that just got floated."> 1308 Possible start locations if a surface gets floated. 1309 </description> 1310 <entry 1311 name="bottom_right" 1312 value="0" 1313 summary="On float, surface goes to the bottom right of the work area. This is the default."/> 1314 <entry 1315 name="bottom_left" 1316 value="1" 1317 summary="On float, surface goes to the bottom left of the work area."/> 1318 </enum> 1319 <request name="set_float_to_location" since="59"> 1320 <description summary="float the surface on top"> 1321 This is a request to place the surface above others. 1322 </description> 1323 <arg name="mode" type="uint" enum="float_start_location"/> 1324 </request> 1325 1326 <!-- Version 60 additions --> 1327 <request name="set_window_corner_radii" since="60"> 1328 <description summary="Request to apply rounded corners to the window of the surface."> 1329 The client specifies the radius of each corner to be applied to the 1330 window in DPs (device independent pixels). 1331 1332 The window radius is double buffered, and will be applied at the 1333 time wl_surface.commit of the corresponding wl_surface is called. 1334 1335 Note: Rounded corner radii affects the wl_surface tree, including 1336 subsurfaces. Once this protocol is called, surfaces cannot set 1337 their own rounded corner bounds because rounded window bounds will be 1338 applied to the whole surface tree. 1339 </description> 1340 <arg name="upper_left_radius" type="uint"/> 1341 <arg name="upper_right_radius" type="uint"/> 1342 <arg name="lower_right_radius" type="uint"/> 1343 <arg name="lower_left_radius" type="uint"/> 1344 </request> 1345 1346 <!-- Version 62 additions --> 1347 <enum name="in_overview"> 1348 <description summary="Describes whether or not the value is in overview"> 1349 Binary enum maps to boolean, describes whether or not a value is in 1350 overview. 1351 </description> 1352 <entry name="not_in_overview" value="0" summary="the value is not in overview"/> 1353 <entry name="in_overview" value="1" summary="the value is in overview"/> 1354 </enum> 1355 1356 <event name="overview_change" since="62"> 1357 <description summary="window is in overview"> 1358 The window is being shown in overview mode. Note that this is 1359 different than shell overview state, as not all windows will be 1360 part of the overview grid. 1361 </description> 1362 <arg name="in_overview" type="uint" enum="in_overview" summary="in overview or not"/> 1363 </event> 1364 1365 <!-- Version 63 additions --> 1366 <request name="set_shadow_corner_radii" since="63"> 1367 <description summary="Request to apply rounded corners to the shadow of the surface."> 1368 The client specifies the radius of each corner to be applied to the shadow 1369 associated with the aura toplevel surface in device independent pixels (DPs). 1370 1371 The shadow radius is double buffered, and will be applied at the 1372 time wl_surface.commit of the corresponding wl_surface is called. 1373 </description> 1374 <arg name="upper_left_radius" type="uint"/> 1375 <arg name="upper_right_radius" type="uint"/> 1376 <arg name="lower_right_radius" type="uint"/> 1377 <arg name="lower_left_radius" type="uint"/> 1378 </request> 1379 </interface> 1380 1381 <interface name="zaura_popup" version="46"> 1382 <description summary="aura shell interface to the popup shell"> 1383 An interface to the popup shell, which allows the 1384 client to access shell specific functionality. 1385 </description> 1386 1387 <request name="surface_submission_in_pixel_coordinates" since="28"> 1388 <description summary="surface will be submitted in pixel coordinates"> 1389 Informs the server that when submitting this surface, this client will not 1390 use wl_surface_set_buffer_scale to report the scales, nor will it apply 1391 scale via vp_viewporter. Instead the server should apply an appropriate 1392 scale transform for the submitted buffers to be composited correctly. 1393 </description> 1394 </request> 1395 1396 <request name="set_decoration" since="35"> 1397 <description summary="request a decoration for surface"> 1398 Clients are allowed to request a particular decoration for a 1399 zaura_toplevel. The server is not required to honor this request. See 1400 decoration_type for available options. Available since M105. 1401 </description> 1402 <arg name="type" type="uint" summary="the new frame type"/> 1403 </request> 1404 1405 <enum name="decoration_type"> 1406 <description summary="different decoration types"> 1407 Decoration types are used to modify the surface (e.g. drop shadow). 1408 </description> 1409 <entry name="none" value="0" summary="no frame"/> 1410 <entry name="normal" value="1" summary="caption with shadow"/> 1411 <entry name="shadow" value="2" summary="shadow only"/> 1412 </enum> 1413 1414 <request name="set_menu" since="37"> 1415 <description summary="set popup type to menu"> 1416 Set popup type to menu 1417 </description> 1418 </request> 1419 1420 <!-- Version 38 additions --> 1421 <request name="release" type="destructor" since="38"> 1422 <description summary="destroy zaura_popup"> 1423 This request destroys the zaura_popup. A client should call destroy when the 1424 role is unmapped from a wl_surface. 1425 1426 See zaura_shell.release for destructor naming. 1427 </description> 1428 </request> 1429 1430 <!-- Version 46 additions --> 1431 <request name="set_scale_factor" since="46"> 1432 <description summary="Allows the client to set the scale factor for the future buffer commits."> 1433 The client has a 32-bit float scale factor that is associated with each 1434 zaura popup. This scale factor must be propagated exactly to exo. To 1435 do so we reinterpret_cast into a 32-bit uint and later cast back into a 1436 float. This is because wayland does not support native transport of 1437 floats. As different CPU architectures may use different endian 1438 representations for IEEE 754 floats, this protocol implicitly assumes 1439 that the caller and receiver are the same machine. To avoid redundant 1440 messages, this request needs to only be called once when the zaura 1441 popup's scale factor changes. 1442 </description> 1443 <arg name="scale_factor_as_uint" type="uint"/> 1444 </request> 1445 </interface> 1446 1447 <interface name="zaura_output_manager" version="3"> 1448 <description summary="aura shell interface to the output manager"> 1449 A global responsible for ensuring clients have a complete view of a given 1450 output's state immediately following the bind of wl_output, and 1451 subsequently as needed. 1452 1453 Clients can expect that all the manager's events for a given wl_output 1454 arrive before the associated wl_output.done event. Clients must bind to 1455 the manager global before any output globals. 1456 </description> 1457 1458 <event name="done" since="1"> 1459 <description summary="sent all information about output"> 1460 This event is sent after all relevant properties of a 1461 zaura_output_manager for a given wl_output have been sent. 1462 </description> 1463 <arg name="output" type="object" interface="wl_output" /> 1464 </event> 1465 1466 <event name="display_id" since="1"> 1467 <description summary="advertise the output's display id"> 1468 This event describes the 64bit display id assigned to each display by 1469 ChromeOS. The value is opaque and should not be interpreted. 1470 1471 The event is sent when binding to the output object and subsequently as 1472 output state changes. 1473 </description> 1474 <arg name="output" type="object" interface="wl_output" /> 1475 <arg name="display_id_hi" type="uint" /> 1476 <arg name="display_id_lo" type="uint" /> 1477 </event> 1478 1479 <event name="logical_position" since="1"> 1480 <description 1481 summary="position of the output within the global compositor space"> 1482 The position event describes the location of the wl_output within the 1483 global compositor space. 1484 1485 The event is sent when binding to the output object and subsequently as 1486 output state changes. 1487 </description> 1488 <arg name="output" type="object" interface="wl_output" /> 1489 <arg name="x" type="int" 1490 summary="x position within the global compositor space" /> 1491 <arg name="y" type="int" 1492 summary="y position within the global compositor space" /> 1493 </event> 1494 1495 <event name="logical_size" since="1"> 1496 <description summary="size of the output in the global compositor space"> 1497 The logical_size event describes the logical size of the output in the 1498 global compositor space. 1499 1500 The event is sent when binding to the output object and subsequently as 1501 output state changes. 1502 </description> 1503 <arg name="output" type="object" interface="wl_output" /> 1504 <arg name="width" type="int" summary="width in global compositor space" /> 1505 <arg name="height" type="int" 1506 summary="height in global compositor space" /> 1507 </event> 1508 1509 <event name="physical_size" since="1"> 1510 <description summary="size of the output in pixels"> 1511 The physical resolution of the display in pixels. The value should not 1512 include any overscan insets or display rotation, except for any panel 1513 orientation adjustment. 1514 1515 The event is sent when binding to the output object and subsequently as 1516 output state changes. 1517 </description> 1518 <arg name="output" type="object" interface="wl_output" /> 1519 <arg name="width" type="int" 1520 summary="width in global compositor space" /> 1521 <arg name="height" type="int" 1522 summary="height in global compositor space" /> 1523 </event> 1524 1525 <event name="insets" since="1"> 1526 <description summary="advertise the work area insets for the output"> 1527 This event describes the insets for the output in logical screen 1528 coordinates, from which the work area can be calculated. 1529 1530 The event is sent when binding to the output object and subsequently as 1531 output state changes. 1532 </description> 1533 <arg name="output" type="object" interface="wl_output" /> 1534 <arg name="top" type="int" /> 1535 <arg name="left" type="int" /> 1536 <arg name="bottom" type="int" /> 1537 <arg name="right" type="int" /> 1538 </event> 1539 1540 <event name="device_scale_factor" since="1"> 1541 <description summary="advertise device scale factor for the output"> 1542 The scale factor of the output device. We reinterpret_cast the float 1543 scale factor into a 32-bit uint and later cast back into a float. This 1544 is because wayland does not support native transport of floats. As 1545 different CPU architectures may use different endian representations for 1546 IEEE 754 floats, this protocol implicitly assumes that the caller and 1547 receiver are the same machine. 1548 1549 The event is sent when binding to the output object and subsequently as 1550 output state changes. 1551 </description> 1552 <arg name="output" type="object" interface="wl_output" /> 1553 <arg name="device_scale_factor" type="uint" 1554 summary="display scale factor, in float format" /> 1555 </event> 1556 1557 <event name="logical_transform" since="1"> 1558 <description summary="logical transform of the output"> 1559 This event describes the logical transform for the output. Whereas 1560 panel transform corresponds to the display's panel rotation, the logical 1561 transform corresponds to the display's logical rotation. 1562 1563 The event is sent when binding to the output object and subsequently as 1564 output state changes. 1565 </description> 1566 <arg name="output" type="object" interface="wl_output" /> 1567 <arg name="transform" type="int" enum="wl_output.transform" 1568 summary="transform that maps framebuffer to output" /> 1569 </event> 1570 1571 <event name="panel_transform" since="1"> 1572 <description summary="panel transform of the output"> 1573 This event describes the panel transform for the output, which is the 1574 associated display's panel rotation. 1575 1576 The event is sent when binding to the output object and subsequently as 1577 output state changes. 1578 </description> 1579 <arg name="output" type="object" interface="wl_output" /> 1580 <arg name="transform" type="int" enum="wl_output.transform" 1581 summary="transform that maps framebuffer to output" /> 1582 </event> 1583 1584 <event name="name" since="1"> 1585 <description summary="human-readable name of this output"> 1586 The name is a UTF-8 string with no convention defined for its contents. 1587 1588 The event is sent when binding to the output object and subsequently as 1589 output state changes. 1590 </description> 1591 <arg name="output" type="object" interface="wl_output" /> 1592 <arg name="name" type="string" summary="output name" /> 1593 </event> 1594 1595 <event name="description" since="1"> 1596 <description summary="human-readable description of this output"> 1597 The description is a UTF-8 string with no convention defined for its 1598 contents. 1599 1600 The event is sent when binding to the output object and subsequently as 1601 output state changes. 1602 </description> 1603 <arg name="output" type="object" interface="wl_output" /> 1604 <arg name="description" type="string" summary="output description" /> 1605 </event> 1606 1607 <!-- Version 2 additions --> 1608 <event name="activated" since="2"> 1609 <description summary="target display for new windows"> 1610 Notifies that this output is now active output. It is typically used as 1611 a target when a new window is created without specific bounds. 1612 </description> 1613 <arg name="output" type="object" interface="wl_output" /> 1614 </event> 1615 1616 <!-- Version 3 additions --> 1617 <event name="overscan_insets" since="3"> 1618 <description summary="advertise the overscan insets for the output"> 1619 This event describes the overscan insets for the output in physical 1620 pixels. 1621 1622 The event is sent when binding to the output object and subsequently as 1623 output state changes. 1624 </description> 1625 <arg name="output" type="object" interface="wl_output" /> 1626 <arg name="top" type="int" /> 1627 <arg name="left" type="int" /> 1628 <arg name="bottom" type="int" /> 1629 <arg name="right" type="int" /> 1630 </event> 1631 </interface> 1632</protocol> 1633