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         <!-- 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="INT16" name="width" />   <!-- pixels -->
  53                 <field type="INT16" name="height" />
  54                 <field type="INT16" name="mwidth" />  <!-- millimeters -->
  55                 <field type="INT16" 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="DRAWABLE" name="drawable" />
  84                 <field type="TIMESTAMP" name="timestamp" />
  85                 <field type="TIMESTAMP" name="config_timestamp" />
  86                 <field type="CARD16" name="sizeID" />
  87                 <field type="INT16" name="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" />
  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="INT16" 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="minWidth" />
 150                         <field type="CARD16" name="minHeight" />
 151                         <field type="CARD16" name="maxWidth" />
 152                         <field type="CARD16" name="maxHeight" />
 153                 </reply>
 154         </request>
 155
 156         <request name="SetScreenSize" opcode="7">
 157                 <field type="WINDOW" name="window" />
 158                 <field type="CARD16" name="width" />    <!-- pixels -->
 159                 <field type="CARD16" name="height" />
 160                 <field type="CARD32" name="mmWidth" />  <!-- millimeters -->
 161                 <field type="CARD32" name="mmHeight" />
 162         </request>
 163
 164         <!-- for GetScreenResources.ModeInfo.ModeFlag -->
 165         <enum name="ModeFlag">
 166                 <item name="HsyncPositive"> <bit>0</bit></item>
 167                 <item name="HsyncNegative"> <bit>1</bit></item>
 168                 <item name="VsyncPositive"> <bit>2</bit></item>
 169                 <item name="VsyncNegative"> <bit>3</bit></item>
 170                 <item name="Interlace">     <bit>4</bit></item>
 171                 <item name="DoubleScan">    <bit>5</bit></item>
 172                 <item name="Csync">         <bit>6</bit></item>
 173                 <item name="CsyncPositive"> <bit>7</bit></item>
 174                 <item name="CsyncNegative"> <bit>8</bit></item>
 175                 <item name="HskewPresent">  <bit>9</bit></item>
 176                 <item name="Bcast">         <bit>10</bit></item>
 177                 <item name="PixelMultiplex"><bit>11</bit></item>
 178                 <item name="DoubleClock">   <bit>12</bit></item>
 179                 <item name="HalveClock">    <bit>13</bit></item>
 180         </enum>
 181
 182         <struct name="ModeInfo">
 183                 <field type="CARD32" name="id" />
 184                 <field type="CARD16" name="width" />
 185                 <field type="CARD16" name="height" />
 186                 <field type="CARD32" name="dotClock" />
 187                 <field type="CARD16" name="hsyncStart" />
 188                 <field type="CARD16" name="hsyncEnd" />
 189                 <field type="CARD16" name="htotal" />
 190                 <field type="CARD16" name="hskew" />
 191                 <field type="CARD16" name="vsyncStart" />
 192                 <field type="CARD16" name="vsyncEnd" />
 193                 <field type="CARD16" name="vtotal" />
 194                 <field type="CARD16" name="name_len" />
 195                 <field type="CARD32" name="modeFlags" />        <!-- enum ModeFlag -->
 196                 <!-- the mode name itself -->
 197         </struct>
 198
 199         <request name="GetScreenResources" opcode="8">
 200                 <field type="WINDOW" name="window" />
 201                 <reply>
 202                         <pad bytes="1" />
 203                         <field type="TIMESTAMP" name="timestamp" />
 204                         <field type="TIMESTAMP" name="config_timestamp" />
 205                         <field type="CARD16" name="num_crtcs" />
 206                         <field type="CARD16" name="num_outputs" />
 207                         <field type="CARD16" name="num_modes" />
 208                         <field type="CARD16" name="names_len" />
 209                         <pad bytes="8" />
 210                         <list type="CARD32" name="crtcs">
 211                             <fieldref>num_crtcs</fieldref>
 212                         </list>
 213                         <list type="CARD32" name="outputs">
 214                             <fieldref>num_outputs</fieldref>
 215                         </list>
 216                         <list type="ModeInfo" name="modes">
 217                             <fieldref>num_modes</fieldref>
 218                         </list>
 219                         <!-- FIXME: this is *not* null separated!
 220                              One must use ModeInfo.name_len from each previous
 221                              ModeInfo to infer the position of the name. -->
 222                         <list type="BYTE" name="names">
 223                             <fieldref>names_len</fieldref>
 224                         </list>
 225                 </reply>
 226         </request>
 227
 228         <!-- for GetOutputInfo.connection -->
 229         <enum name="Connection">
 230                 <item name="Connected" />
 231                 <item name="Disconnected" />
 232                 <item name="Unknown" />
 233         </enum>
 234
 235         <request name="GetOutputInfo" opcode="9">
 236                 <field type="CARD32" name="output" />
 237                 <field type="TIMESTAMP" name="configTimestamp" />
 238                 <reply>
 239                         <field type="CARD8" name="status" />    <!-- enum SetConfig -->
 240                         <field type="TIMESTAMP" name="timestamp" />
 241                         <field type="CARD32" name="crtc" />
 242                         <field type="CARD32" name="mmWidth" />  <!-- millimeters -->
 243                         <field type="CARD32" name="mmHeight" />
 244                         <field type="CARD8" name="connection" /> <!-- enum Connection -->
 245                         <field type="CARD8" name="subpixelOrder" />
 246                         <field type="CARD16" name="num_crtcs" />
 247                         <field type="CARD16" name="num_modes" />
 248                         <field type="CARD16" name="num_preferred" />
 249                         <field type="CARD16" name="num_clones" />
 250                         <field type="CARD16" name="name_len" />
 251                         <list type="CARD32" name="crtcs">
 252                             <fieldref>num_crtcs</fieldref>
 253                         </list>
 254                         <list type="CARD32" name="modes">
 255                             <fieldref>num_modes</fieldref>
 256                         </list>
 257                         <list type="CARD32" name="clones">
 258                             <fieldref>num_clones</fieldref>
 259                         </list>
 260                         <list type="BYTE" name="name">
 261                             <fieldref>name_len</fieldref>
 262                         </list>
 263                 </reply>
 264         </request>
 265
 266         <!-- NOTE: num_atoms is currently unused. -->
 267         <request name="ListOutputProperties" opcode="10">
 268                 <field type="CARD32" name="output" />
 269                 <reply>
 270                         <field type="CARD8" name="num_properties" />
 271                         <field type="CARD16" name="num_atoms" />
 272                         <pad bytes="22" />
 273                         <list type="ATOM" name="properties">
 274                                 <fieldref>num_properties</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                 </reply>
 290         </request>
 291
 292         <request name="ConfigureOutputProperty" opcode="12">
 293                 <field type="CARD32" name="output" />
 294                 <field type="ATOM" name="property" />
 295                 <field type="BOOL" name="pending" />
 296                 <field type="BOOL" name="range" />
 297                 <pad bytes="2" />
 298         </request>
 299
 300         <request name="ChangeOutputProperty" opcode="13">
 301                 <field type="CARD32" name="output" />
 302                 <field type="ATOM" name="property" />
 303                 <field type="ATOM" name="type" />
 304                 <field type="CARD8" name="format" />
 305                 <field type="CARD8" name="mode" />
 306                 <pad bytes="2" />
 307                 <field type="CARD32" name="num_units" />
 308         </request>
 309
 310         <request name="DeleteOutputProperty" opcode="14">
 311                 <field type="CARD32" name="output" />
 312                 <field type="ATOM" name="property" />
 313         </request>
 314
 315         <!-- NOTE: num_items depends on format (8/16/32) -->
 316         <request name="GetOutputProperty" opcode="15">
 317                 <field type="CARD32" name="output" />
 318                 <field type="ATOM" name="property" />
 319                 <field type="ATOM" name="type" />
 320                 <field type="CARD32" name="longOffset" />
 321                 <field type="CARD32" name="longLength" />
 322                 <field type="BOOL" name="delete" />
 323                 <field type="BOOL" name="pending" />
 324                 <reply>
 325                         <field type="CARD8" name="format" />
 326                         <field type="ATOM" name="type" />
 327                         <field type="CARD32" name="bytesAfter" />
 328                         <field type="CARD32" name="num_items" />
 329                         <pad bytes="12" />
 330                         <list type="BYTE" name="data">
 331                                 <!-- n * format / 8 -->
 332                                 <op op="*">
 333                                         <fieldref>num_items</fieldref>
 334                                         <op op="/">
 335                                                 <fieldref>format</fieldref>
 336                                                 <value>8</value>
 337                                         </op>
 338                                 </op>
 339                         </list>
 340                 </reply>
 341         </request>
 342
 343         <request name="CreateMode" opcode="16">
 344                 <field type="WINDOW" name="window" />
 345                 <field type="ModeInfo" name="modeInfo" />
 346                 <reply>
 347                         <field type="CARD8" name="status" />    <!-- enum SetConfig -->
 348                         <field type="CARD32" name="mode" />
 349                 </reply>
 350         </request>
 351
 352         <request name="DestroyMode" opcode="17">
 353                 <field type="CARD32" name="mode" />
 354         </request>
 355
 356         <request name="AddOutputMode" opcode="18">
 357                 <field type="CARD32" name="output" />
 358                 <field type="CARD32" name="mode" />
 359         </request>
 360
 361         <request name="DeleteOutputMode" opcode="19">
 362                 <field type="CARD32" name="output" />
 363                 <field type="CARD32" name="mode" />
 364         </request>
 365
 366         <request name="GetCrtcInfo" opcode="20">
 367                 <field type="CARD32" name="crtc" />
 368                 <field type="TIMESTAMP" name="configTimestamp" />
 369                 <reply>
 370                         <field type="CARD8" name="status" />    <!-- enum SetConfig -->
 371                         <field type="TIMESTAMP" name="timestamp" />
 372                         <field type="CARD32" name="crtc" />
 373                         <field type="INT16" name="x" />
 374                         <field type="INT16" name="y" />
 375                         <field type="CARD16" name="width" />
 376                         <field type="CARD16" name="height" />
 377                         <field type="CARD32" name="mode" />
 378                         <field type="CARD16" name="rotation" />         <!-- enum Rotation -->
 379                         <field type="CARD16" name="rotations" />        <!-- mask of enum Rotation -->
 380                         <field type="CARD16" name="num_outputs" />
 381                         <field type="CARD16" name="num_possible_outputs" />
 382                         <list type="CARD32" name="outputs">
 383                                 <fieldref>num_outputs</fieldref>
 384                         </list>
 385                 </reply>
 386         </request>
 387
 388         <request name="SetCrtcConfig" opcode="21">
 389                 <field type="CARD32" name="crtc" />
 390                 <field type="TIMESTAMP" name="timestamp" />
 391                 <field type="TIMESTAMP" name="configTimestamp" />
 392                 <field type="INT16" name="x" />
 393                 <field type="INT16" name="y" />
 394                 <field type="CARD32" name="mode" />
 395                 <field type="CARD16" name="rotation" />         <!-- enum Rotation -->
 396                 <reply>
 397                         <field type="CARD8" name="status" />    <!-- enum SetConfig -->
 398                         <field type="TIMESTAMP" name="timestamp" />
 399                 </reply>
 400         </request>
 401
 402         <request name="GetCrtcGammaSize" opcode="22">
 403                 <field type="CARD32" name="crtc" />
 404                 <reply>
 405                         <field type="CARD8" name="status" />    <!-- enum SetConfig -->
 406                         <field type="CARD16" name="size" />
 407                 </reply>
 408         </request>
 409
 410         <request name="GetCrtcGamma" opcode="23">
 411                 <field type="CARD32" name="crtc" />
 412                 <reply>
 413                         <field type="CARD8" name="status" />    <!-- enum SetConfig -->
 414                         <field type="CARD16" name="size" />
 415                         <pad bytes="22" />
 416                         <list type="CARD16" name="red">
 417                                 <fieldref>size</fieldref>
 418                         </list>
 419                         <list type="CARD16" name="green">
 420                                 <fieldref>size</fieldref>
 421                         </list>
 422                         <list type="CARD16" name="blue">
 423                                 <fieldref>size</fieldref>
 424                         </list>
 425                 </reply>
 426         </request>
 427
 428         <request name="SetCrtcGamma" opcode="24">
 429                 <field type="CARD32" name="crtc" />
 430                 <field type="CARD16" name="size" />
 431                 <pad bytes="2"/>
 432                 <list type="CARD16" name="red">
 433                         <fieldref>size</fieldref>
 434                 </list>
 435                 <list type="CARD16" name="green">
 436                         <fieldref>size</fieldref>
 437                 </list>
 438                 <list type="CARD16" name="blue">
 439                         <fieldref>size</fieldref>
 440                 </list>
 441         </request>
 442
 443         <!-- Events -->
 444
 445         <enum name="NotifyMask" >
 446                 <item name="ScreenChange">  <bit>0</bit></item>
 447                 <!-- new in 1.2 -->
 448                 <item name="CrtcChange">    <bit>1</bit></item>
 449                 <item name="OutputChange">  <bit>2</bit></item>
 450                 <item name="OutputProperty"><bit>3</bit></item>
 451         </enum>
 452
 453         <event name="ScreenChangeNotify" number="0">
 454                 <field type="CARD8" name="rotation" />
 455                 <field type="TIMESTAMP" name="timestamp" />
 456                 <field type="TIMESTAMP" name="config_timestamp" />
 457                 <field type="WINDOW" name="root" />
 458                 <field type="WINDOW" name="request_window" />
 459                 <field type="CARD16" name="sizeID" />
 460                 <field type="CARD16" name="subpixel_order" />
 461                 <field type="CARD16" name="width" />
 462                 <field type="CARD16" name="height" />
 463                 <field type="CARD16" name="mmWidth" />
 464                 <field type="CARD16" name="mmHeight" />
 465         </event>
 466
 467         <!-- New in version 1.2 -->
 468
 469         <!-- subcode -->
 470         <enum name="Notify" >
 471                 <item name="CrtcChange">    <value>0</value></item>
 472                 <item name="OutputChange">  <value>1</value></item>
 473                 <item name="OutputProperty"><value>2</value></item>
 474         </enum>
 475
 476         <struct name="CrtcChange">
 477                 <field type="TIMESTAMP" name="timestamp" />
 478                 <field type="WINDOW" name="window" />
 479                 <field type="CARD32" name="crtc" />
 480                 <field type="CARD32" name="mode" />
 481                 <field type="CARD16" name="rotation" />         <!-- enum Rotation -->
 482                 <pad bytes="2" />
 483                 <field type="INT16" name="x" />
 484                 <field type="INT16" name="y" />
 485                 <field type="CARD16" name="width" />
 486                 <field type="CARD16" name="height" />
 487         </struct>
 488
 489         <struct name="OutputChange">
 490                 <field type="TIMESTAMP" name="timestamp" />
 491                 <field type="TIMESTAMP" name="configTimestamp" />
 492                 <field type="WINDOW" name="window" />
 493                 <field type="CARD32" name="output" />
 494                 <field type="CARD32" name="crtc" />
 495                 <field type="CARD32" name="mode" />
 496                 <field type="CARD16" name="rotation" />         <!-- enum Rotation -->
 497                 <field type="CARD8" name="connection" />        <!-- enum Connection -->
 498                 <field type="CARD8" name="subpixelOrder" />
 499         </struct>
 500
 501         <struct name="OutputProperty">
 502                 <field type="WINDOW" name="window" />
 503                 <field type="CARD32" name="output" />
 504                 <field type="ATOM" name="atom" />
 505                 <field type="TIMESTAMP" name="timestamp" />
 506                 <field type="CARD8" name="status" />            <!-- core enum Property -->
 507                 <pad bytes="11" />
 508         </struct>
 509
 510         <union name="NotifyData">
 511                 <field type="CrtcChange"     name="cc" />
 512                 <field type="OutputChange"   name="oc" />
 513                 <field type="OutputProperty" name="op" />
 514         </union>
 515
 516         <event name="Notify" number="1">
 517                 <field type="CARD8" name="subCode" />           <!-- enum Notify -->
 518                 <field type="NotifyData" name="u" />
 519         </event>
 520 </xcb>