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