src/randr.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!--
   3 Copyright (C) 2006 Jeremy Kolb, Ian Osgood
   4 All Rights Reserved.
   5
   6 Permission is hereby granted, free of charge, to any person obtaining a copy
   7 of this software and associated documentation files (the "Software"), to deal
   8 in the Software without restriction, including without limitation the rights
   9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 copies of the Software, and to permit persons to whom the Software is
  11 furnished to do so, subject to the following conditions:
  12
  13 The above copyright notice and this permission notice shall be included in all
  14 copies or substantial portions of the Software.
  15
  16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  20 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  21 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22
  23 Except as contained in this notice, the names of the authors or their
  24 institutions shall not be used in advertising or otherwise to promote the
  25 sale, use or other dealings in this Software without prior written
  26 authorization from the authors.
  27 -->
  28
  29 <xcb header="randr" extension-xname="RANDR" extension-name="RandR"
  30     major-version="1" minor-version="2">
  31
  32         <import>xproto</import>
  33
  34         <!-- Errors -->
  35
  36         <error name="BadOutput" number="0" />
  37         <error name="BadCrtc"   number="1" />
  38         <error name="BadMode"   number="2" />
  39
  40         <!-- Requests -->
  41
  42         <enum name="Rotation">
  43                 <item name="Rotate_0">  <bit>0</bit></item>
  44                 <item name="Rotate_90"> <bit>1</bit></item>
  45                 <item name="Rotate_180"><bit>2</bit></item>
  46                 <item name="Rotate_270"><bit>3</bit></item>
  47                 <item name="Reflect_X"> <bit>4</bit></item>
  48                 <item name="Reflect_Y"> <bit>5</bit></item>
  49         </enum>
  50
  51         <struct name="ScreenSize">
  52                 <field type="CARD16" name="width" />   <!-- pixels -->
  53                 <field type="CARD16" name="height" />
  54                 <field type="CARD16" name="mwidth" />  <!-- millimeters -->
  55                 <field type="CARD16" name="mheight" />
  56         </struct>
  57
  58         <struct name="RefreshRates">
  59                 <field type="CARD16" name="nRates" />
  60                 <list type="CARD16" name="rates">
  61                         <fieldref>nRates</fieldref>
  62                 </list>
  63         </struct>
  64
  65         <request name="QueryVersion" opcode="0">
  66                 <field type="CARD32" name="major_version" />
  67                 <field type="CARD32" name="minor_version" />
  68                 <reply>
  69                         <pad bytes="1" />
  70                         <field type="CARD32" name="major_version" />
  71                         <field type="CARD32" name="minor_version" />
  72                         <pad bytes="16" />
  73                 </reply>
  74         </request>
  75
  76         <!-- Skip obsolete opcode 1 so old clients fail immediately -->
  77
  78         <!-- This is for the 1.1 version request.  I don't believe we need to specify a 1.0 request
  79         as few things used randr 1.0.  The only difference is the removal of refresh and padding I think.
  80         BEWARE: the docs lie!
  81         -->
  82         <request name="SetScreenConfig" opcode="2">
  83                 <field type="WINDOW" name="window" />
  84                 <field type="TIMESTAMP" name="timestamp" />
  85                 <field type="TIMESTAMP" name="config_timestamp" />
  86                 <field type="CARD16" name="sizeID" />
  87                 <field type="CARD16" name="rotation" />         <!-- enum Rotation -->
  88                 <field type="CARD16" name="rate" />
  89                 <pad bytes="2" />
  90                 <reply>
  91                         <field type="CARD8" name="status" />    <!-- enum SetConfig -->
  92                         <field type="TIMESTAMP" name="new_timestamp" />
  93                         <field type="TIMESTAMP" name="config_timestamp" />
  94                         <field type="WINDOW" name="root" />
  95                         <field type="CARD16" name="subpixel_order" />   <!-- enum SubPixel (from Render) -->
  96                         <pad bytes="10" />
  97                 </reply>
  98         </request>
  99
 100         <!-- opcode 3 is obsolete -->
 101
 102         <enum name="SetConfig">
 103                 <item name="Success"><value>0</value></item>
 104                 <item name="InvalidConfigTime"><value>1</value></item>
 105                 <item name="InvalidTime"><value>2</value></item>
 106                 <item name="Failed"><value>3</value></item>
 107         </enum>
 108
 109         <request name="SelectInput" opcode="4">
 110                 <field type="WINDOW" name="window" />
 111                 <field type="CARD16" name="enable" />  <!-- enum SetConfig -->
 112                 <pad bytes="2" />
 113         </request>
 114
 115         <!--
 116         I think this is correct.  It works. though I believe nInfo is a bit high...
 117         -->
 118         <request name="GetScreenInfo" opcode="5">
 119                 <field type="WINDOW" name="window" />
 120                 <reply>
 121                         <field type="CARD8" name="rotations" />
 122                         <field type="WINDOW" name="root" />
 123                         <field type="TIMESTAMP" name="timestamp" />
 124                         <field type="TIMESTAMP" name="config_timestamp" />
 125                         <field type="CARD16" name="nSizes" />
 126                         <field type="CARD16" name="sizeID" />
 127                         <field type="CARD16" name="rotation" />
 128                         <field type="CARD16" name="rate" />
 129                         <field type="CARD16" name="nInfo" />
 130                         <pad bytes="2" />
 131                         <list type="ScreenSize" name="sizes">
 132                             <fieldref>nSizes</fieldref>
 133                         </list>
 134                         <list type="RefreshRates" name="rates">
 135                                 <op op="-">
 136                                         <fieldref>nInfo</fieldref>
 137                                         <fieldref>nSizes</fieldref>
 138                                 </op>
 139                         </list>
 140                 </reply>
 141         </request>
 142
 143         <!-- new in version 1.2 -->
 144
 145         <request name="GetScreenSizeRange" opcode="6">
 146                 <field type="WINDOW" name="window" />
 147                 <reply>
 148                         <pad bytes="1" />
 149                         <field type="CARD16" name="min_width" />
 150                         <field type="CARD16" name="min_height" />
 151                         <field type="CARD16" name="max_width" />
 152                         <field type="CARD16" name="max_height" />
 153                         <pad bytes="16" />
 154                 </reply>
 155         </request>
 156
 157         <request name="SetScreenSize" opcode="7">
 158                 <field type="WINDOW" name="window" />
 159                 <field type="CARD16" name="width" />    <!-- pixels -->
 160                 <field type="CARD16" name="height" />
 161                 <field type="CARD32" name="mm_width" />  <!-- millimeters -->
 162                 <field type="CARD32" name="mm_height" />
 163         </request>
 164
 165         <!-- for GetScreenResources.ModeInfo.ModeFlag -->
 166         <enum name="ModeFlag">
 167                 <item name="HsyncPositive"> <bit>0</bit></item>
 168                 <item name="HsyncNegative"> <bit>1</bit></item>
 169                 <item name="VsyncPositive"> <bit>2</bit></item>
 170                 <item name="VsyncNegative"> <bit>3</bit></item>
 171                 <item name="Interlace">     <bit>4</bit></item>
 172                 <item name="DoubleScan">    <bit>5</bit></item>
 173                 <item name="Csync">         <bit>6</bit></item>
 174                 <item name="CsyncPositive"> <bit>7</bit></item>
 175                 <item name="CsyncNegative"> <bit>8</bit></item>
 176                 <item name="HskewPresent">  <bit>9</bit></item>
 177                 <item name="Bcast">         <bit>10</bit></item>
 178                 <item name="PixelMultiplex"><bit>11</bit></item>
 179                 <item name="DoubleClock">   <bit>12</bit></item>
 180                 <item name="HalveClock">    <bit>13</bit></item>
 181         </enum>
 182
 183         <struct name="ModeInfo">
 184                 <field type="CARD32" name="id" />
 185                 <field type="CARD16" name="width" />
 186                 <field type="CARD16" name="height" />
 187                 <field type="CARD32" name="dot_clock" />
 188                 <field type="CARD16" name="hsync_start" />
 189                 <field type="CARD16" name="hsync_end" />
 190                 <field type="CARD16" name="htotal" />
 191                 <field type="CARD16" name="hskew" />
 192                 <field type="CARD16" name="vsync_start" />
 193                 <field type="CARD16" name="vsync_end" />
 194                 <field type="CARD16" name="vtotal" />
 195                 <field type="CARD16" name="name_len" />
 196                 <field type="CARD32" name="mode_flags" />       <!-- enum ModeFlag -->
 197                 <!-- the mode name itself -->
 198         </struct>
 199
 200         <request name="GetScreenResources" opcode="8">
 201                 <field type="WINDOW" name="window" />
 202                 <reply>
 203                         <pad bytes="1" />
 204                         <field type="TIMESTAMP" name="timestamp" />
 205                         <field type="TIMESTAMP" name="config_timestamp" />
 206                         <field type="CARD16" name="num_crtcs" />
 207                         <field type="CARD16" name="num_outputs" />
 208                         <field type="CARD16" name="num_modes" />
 209                         <field type="CARD16" name="names_len" />
 210                         <pad bytes="8" />
 211                         <list type="CARD32" name="crtcs">
 212                             <fieldref>num_crtcs</fieldref>
 213                         </list>
 214                         <list type="CARD32" name="outputs">
 215                             <fieldref>num_outputs</fieldref>
 216                         </list>
 217                         <list type="ModeInfo" name="modes">
 218                             <fieldref>num_modes</fieldref>
 219                         </list>
 220                         <!-- FIXME: this is *not* null separated!
 221                              One must use ModeInfo.name_len from each previous
 222                              ModeInfo to infer the position of the name. -->
 223                         <list type="BYTE" name="names">
 224                             <fieldref>names_len</fieldref>
 225                         </list>
 226                 </reply>
 227         </request>
 228
 229         <!-- for GetOutputInfo.connection -->
 230         <enum name="Connection">
 231                 <item name="Connected" />
 232                 <item name="Disconnected" />
 233                 <item name="Unknown" />
 234         </enum>
 235
 236         <request name="GetOutputInfo" opcode="9">
 237                 <field type="CARD32" name="output" />
 238                 <field type="TIMESTAMP" name="config_timestamp" />
 239                 <reply>
 240                         <field type="CARD8" name="status" />    <!-- enum SetConfig -->
 241                         <field type="TIMESTAMP" name="timestamp" />
 242                         <field type="CARD32" name="crtc" />
 243                         <field type="CARD32" name="mm_width" />  <!-- millimeters -->
 244                         <field type="CARD32" name="mm_height" />
 245                         <field type="CARD8" name="connection" /> <!-- enum Connection -->
 246                         <field type="CARD8" name="subpixel_order" /> <!-- enum SubPixel (from Render) -->
 247                         <field type="CARD16" name="num_crtcs" />
 248                         <field type="CARD16" name="num_modes" />
 249                         <field type="CARD16" name="num_preferred" />
 250                         <field type="CARD16" name="num_clones" />
 251                         <field type="CARD16" name="name_len" />
 252                         <list type="CARD32" name="crtcs">
 253                             <fieldref>num_crtcs</fieldref>
 254                         </list>
 255                         <list type="CARD32" name="modes">
 256                             <fieldref>num_modes</fieldref>
 257                         </list>
 258                         <list type="CARD32" name="clones">
 259                             <fieldref>num_clones</fieldref>
 260                         </list>
 261                         <list type="BYTE" name="name">
 262                             <fieldref>name_len</fieldref>
 263                         </list>
 264                 </reply>
 265         </request>
 266
 267         <request name="ListOutputProperties" opcode="10">
 268                 <field type="CARD32" name="output" />
 269                 <reply>
 270                         <pad bytes="1" />
 271                         <field type="CARD16" name="num_atoms" />
 272                         <pad bytes="22" />
 273                         <list type="ATOM" name="atoms">
 274                                 <fieldref>num_atoms</fieldref>
 275                         </list>
 276                 </reply>
 277         </request>
 278
 279         <request name="QueryOutputProperty" opcode="11">
 280                 <field type="CARD32" name="output" />
 281                 <field type="ATOM" name="property" />
 282                 <reply>
 283                         <pad bytes="1" />
 284                         <field type="BOOL" name="pending" />
 285                         <field type="BOOL" name="range" />
 286                         <field type="BOOL" name="immutable" />
 287                         <pad bytes="21" />
 288                         <list type="INT32" name="validValues">
 289                                 <fieldref>length</fieldref>
 290                         </list>
 291                 </reply>
 292         </request>
 293
 294         <request name="ConfigureOutputProperty" opcode="12">
 295                 <field type="CARD32" name="output" />
 296                 <field type="ATOM" name="property" />
 297                 <field type="BOOL" name="pending" />
 298                 <field type="BOOL" name="range" />
 299                 <pad bytes="2" />
 300                 <list type="INT32" name="values" />
 301         </request>
 302
 303         <request name="ChangeOutputProperty" opcode="13">
 304                 <field type="CARD32" name="output" />
 305                 <field type="ATOM" name="property" />
 306                 <field type="ATOM" name="type" />
 307                 <field type="CARD8" name="format" />
 308                 <field type="CARD8" name="mode" />
 309                 <pad bytes="2" />
 310                 <field type="CARD32" name="num_units" />
 311                 <list type="void" name="data">
 312                     <op op="/">
 313                         <op op="*">
 314                             <fieldref>num_units</fieldref>
 315                             <fieldref>format</fieldref>
 316                         </op>
 317                         <value>8</value>
 318                     </op>
 319                 </list>
 320         </request>
 321
 322         <request name="DeleteOutputProperty" opcode="14">
 323                 <field type="CARD32" name="output" />
 324                 <field type="ATOM" name="property" />
 325         </request>
 326
 327         <!-- NOTE: num_items depends on format (8/16/32) -->
 328         <request name="GetOutputProperty" opcode="15">
 329                 <field type="CARD32" name="output" />
 330                 <field type="ATOM" name="property" />
 331                 <field type="ATOM" name="type" />
 332                 <field type="CARD32" name="long_offset" />
 333                 <field type="CARD32" name="long_length" />
 334                 <field type="BOOL" name="delete" />
 335                 <field type="BOOL" name="pending" />
 336                 <pad bytes="2" />
 337                 <reply>
 338                         <field type="CARD8" name="format" />
 339                         <field type="ATOM" name="type" />
 340                         <field type="CARD32" name="bytes_after" />
 341                         <field type="CARD32" name="num_items" />
 342                         <pad bytes="12" />
 343                         <list type="BYTE" name="data">
 344                                 <!-- n * format / 8 -->
 345                                 <op op="*">
 346                                         <fieldref>num_items</fieldref>
 347                                         <op op="/">
 348                                                 <fieldref>format</fieldref>
 349                                                 <value>8</value>
 350                                         </op>
 351                                 </op>
 352                         </list>
 353                 </reply>
 354         </request>
 355
 356         <request name="CreateMode" opcode="16">
 357                 <field type="WINDOW" name="window" />
 358                 <field type="ModeInfo" name="mode_info" />
 359                 <list type="char" name="name" />
 360                 <reply>
 361                         <pad bytes="1" />
 362                         <field type="CARD32" name="mode" />
 363                         <pad bytes="20" />
 364                 </reply>
 365         </request>
 366
 367         <request name="DestroyMode" opcode="17">
 368                 <field type="CARD32" name="mode" />
 369         </request>
 370
 371         <request name="AddOutputMode" opcode="18">
 372                 <field type="CARD32" name="output" />
 373                 <field type="CARD32" name="mode" />
 374         </request>
 375
 376         <request name="DeleteOutputMode" opcode="19">
 377                 <field type="CARD32" name="output" />
 378                 <field type="CARD32" name="mode" />
 379         </request>
 380
 381         <request name="GetCrtcInfo" opcode="20">
 382                 <field type="CARD32" name="crtc" />
 383                 <field type="TIMESTAMP" name="config_timestamp" />
 384                 <reply>
 385                         <field type="CARD8" name="status" />    <!-- enum SetConfig -->
 386                         <field type="TIMESTAMP" name="timestamp" />
 387                         <field type="INT16" name="x" />
 388                         <field type="INT16" name="y" />
 389                         <field type="CARD16" name="width" />
 390                         <field type="CARD16" name="height" />
 391                         <field type="CARD32" name="mode" />
 392                         <field type="CARD16" name="rotation" />         <!-- enum Rotation -->
 393                         <field type="CARD16" name="rotations" />        <!-- mask of enum Rotation -->
 394                         <field type="CARD16" name="num_outputs" />
 395                         <field type="CARD16" name="num_possible_outputs" />
 396                         <list type="CARD32" name="outputs">
 397                                 <fieldref>num_outputs</fieldref>
 398                         </list>
 399                         <list type="CARD32" name="possible">
 400                                 <fieldref>num_possible_outputs</fieldref>
 401                         </list>
 402                 </reply>
 403         </request>
 404
 405         <request name="SetCrtcConfig" opcode="21">
 406                 <field type="CARD32" name="crtc" />
 407                 <field type="TIMESTAMP" name="timestamp" />
 408                 <field type="TIMESTAMP" name="config_timestamp" />
 409                 <field type="INT16" name="x" />
 410                 <field type="INT16" name="y" />
 411                 <field type="CARD32" name="mode" />
 412                 <field type="CARD16" name="rotation" />         <!-- enum Rotation -->
 413                 <pad bytes="2" />
 414                 <list type="CARD32" name="outputs" />
 415                 <reply>
 416                         <field type="CARD8" name="status" />    <!-- enum SetConfig -->
 417                         <field type="TIMESTAMP" name="timestamp" />
 418                         <pad bytes="20" />
 419                 </reply>
 420         </request>
 421
 422         <request name="GetCrtcGammaSize" opcode="22">
 423                 <field type="CARD32" name="crtc" />
 424                 <reply>
 425                         <pad bytes="1" />
 426                         <field type="CARD16" name="size" />
 427                         <pad bytes="22" />
 428                 </reply>
 429         </request>
 430
 431         <request name="GetCrtcGamma" opcode="23">
 432                 <field type="CARD32" name="crtc" />
 433                 <reply>
 434                         <pad bytes="1" />
 435                         <field type="CARD16" name="size" />
 436                         <pad bytes="22" />
 437                         <list type="CARD16" name="red">
 438                                 <fieldref>size</fieldref>
 439                         </list>
 440                         <list type="CARD16" name="green">
 441                                 <fieldref>size</fieldref>
 442                         </list>
 443                         <list type="CARD16" name="blue">
 444                                 <fieldref>size</fieldref>
 445                         </list>
 446                 </reply>
 447         </request>
 448
 449         <request name="SetCrtcGamma" opcode="24">
 450                 <field type="CARD32" name="crtc" />
 451                 <field type="CARD16" name="size" />
 452                 <pad bytes="2"/>
 453                 <list type="CARD16" name="red">
 454                         <fieldref>size</fieldref>
 455                 </list>
 456                 <list type="CARD16" name="green">
 457                         <fieldref>size</fieldref>
 458                 </list>
 459                 <list type="CARD16" name="blue">
 460                         <fieldref>size</fieldref>
 461                 </list>
 462         </request>
 463
 464         <!-- Events -->
 465
 466         <enum name="NotifyMask" >
 467                 <item name="ScreenChange">  <bit>0</bit></item>
 468                 <!-- new in 1.2 -->
 469                 <item name="CrtcChange">    <bit>1</bit></item>
 470                 <item name="OutputChange">  <bit>2</bit></item>
 471                 <item name="OutputProperty"><bit>3</bit></item>
 472         </enum>
 473
 474         <event name="ScreenChangeNotify" number="0">
 475                 <field type="CARD8" name="rotation" />
 476                 <field type="TIMESTAMP" name="timestamp" />
 477                 <field type="TIMESTAMP" name="config_timestamp" />
 478                 <field type="WINDOW" name="root" />
 479                 <field type="WINDOW" name="request_window" />
 480                 <field type="CARD16" name="sizeID" />
 481                 <field type="CARD16" name="subpixel_order" />   <!-- enum SubPixel (from Render) -->
 482                 <field type="CARD16" name="width" />
 483                 <field type="CARD16" name="height" />
 484                 <field type="CARD16" name="mwidth" />
 485                 <field type="CARD16" name="mheight" />
 486         </event>
 487
 488         <!-- New in version 1.2 -->
 489
 490         <!-- subcode -->
 491         <enum name="Notify" >
 492                 <item name="CrtcChange">    <value>0</value></item>
 493                 <item name="OutputChange">  <value>1</value></item>
 494                 <item name="OutputProperty"><value>2</value></item>
 495         </enum>
 496
 497         <struct name="CrtcChange">
 498                 <field type="TIMESTAMP" name="timestamp" />
 499                 <field type="WINDOW" name="window" />
 500                 <field type="CARD32" name="crtc" />
 501                 <field type="CARD32" name="mode" />
 502                 <field type="CARD16" name="rotation" />         <!-- enum Rotation -->
 503                 <pad bytes="2" />
 504                 <field type="INT16" name="x" />
 505                 <field type="INT16" name="y" />
 506                 <field type="CARD16" name="width" />
 507                 <field type="CARD16" name="height" />
 508         </struct>
 509
 510         <struct name="OutputChange">
 511                 <field type="TIMESTAMP" name="timestamp" />
 512                 <field type="TIMESTAMP" name="config_timestamp" />
 513                 <field type="WINDOW" name="window" />
 514                 <field type="CARD32" name="output" />
 515                 <field type="CARD32" name="crtc" />
 516                 <field type="CARD32" name="mode" />
 517                 <field type="CARD16" name="rotation" />         <!-- enum Rotation -->
 518                 <field type="CARD8" name="connection" />        <!-- enum Connection -->
 519                 <field type="CARD8" name="subpixel_order" />    <!-- enum SubPixel (from Render) -->
 520         </struct>
 521
 522         <struct name="OutputProperty">
 523                 <field type="WINDOW" name="window" />
 524                 <field type="CARD32" name="output" />
 525                 <field type="ATOM" name="atom" />
 526                 <field type="TIMESTAMP" name="timestamp" />
 527                 <field type="CARD8" name="status" />            <!-- core enum Property -->
 528                 <pad bytes="11" />
 529         </struct>
 530
 531         <union name="NotifyData">
 532                 <field type="CrtcChange"     name="cc" />
 533                 <field type="OutputChange"   name="oc" />
 534                 <field type="OutputProperty" name="op" />
 535         </union>
 536
 537         <event name="Notify" number="1">
 538                 <field type="CARD8" name="subCode" />           <!-- enum Notify -->
 539                 <field type="NotifyData" name="u" />
 540         </event>
 541 </xcb>