include/GL/internal/dri_interface.h

   1 /*
   2  * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
   3  * Copyright 2007-2008 Red Hat, Inc.
   4  * (C) Copyright IBM Corporation 2004
   5  * All Rights Reserved.
   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  * on the rights to use, copy, modify, merge, publish, distribute, sub
  11  * license, and/or sell copies of the Software, and to permit persons to whom
  12  * the 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 NON-INFRINGEMENT.  IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27 /**
  28  * \file dri_interface.h
  29  *
  30  * This file contains all the types and functions that define the interface
  31  * between a DRI driver and driver loader.  Currently, the most common driver
  32  * loader is the XFree86 libGL.so.  However, other loaders do exist, and in
  33  * the future the server-side libglx.a will also be a loader.
  34  *
  35  * \author Kevin E. Martin <kevin@precisioninsight.com>
  36  * \author Ian Romanick <idr@us.ibm.com>
  37  * \author Kristian Høgsberg <krh@redhat.com>
  38  */
  39
  40 #ifndef DRI_INTERFACE_H
  41 #define DRI_INTERFACE_H
  42
  43 /* For archs with no drm.h */
  44 #if defined(__APPLE__) || defined(__CYGWIN__) || defined(__GNU__)
  45 #ifndef __NOT_HAVE_DRM_H
  46 #define __NOT_HAVE_DRM_H
  47 #endif
  48 #endif
  49
  50 #ifndef __NOT_HAVE_DRM_H
  51 #include <drm.h>
  52 #else
  53 typedef unsigned int drm_context_t;
  54 typedef unsigned int drm_drawable_t;
  55 typedef struct drm_clip_rect drm_clip_rect_t;
  56 #endif
  57
  58 /**
  59  * \name DRI interface structures
  60  *
  61  * The following structures define the interface between the GLX client
  62  * side library and the DRI (direct rendering infrastructure).
  63  */
  64 /*@{*/
  65 typedef struct __DRIdisplayRec          __DRIdisplay;
  66 typedef struct __DRIscreenRec           __DRIscreen;
  67 typedef struct __DRIcontextRec          __DRIcontext;
  68 typedef struct __DRIdrawableRec         __DRIdrawable;
  69 typedef struct __DRIconfigRec           __DRIconfig;
  70 typedef struct __DRIframebufferRec      __DRIframebuffer;
  71 typedef struct __DRIversionRec          __DRIversion;
  72
  73 typedef struct __DRIcoreExtensionRec            __DRIcoreExtension;
  74 typedef struct __DRIextensionRec                __DRIextension;
  75 typedef struct __DRIcopySubBufferExtensionRec   __DRIcopySubBufferExtension;
  76 typedef struct __DRIswapControlExtensionRec     __DRIswapControlExtension;
  77 typedef struct __DRIframeTrackingExtensionRec   __DRIframeTrackingExtension;
  78 typedef struct __DRImediaStreamCounterExtensionRec      __DRImediaStreamCounterExtension;
  79 typedef struct __DRItexOffsetExtensionRec       __DRItexOffsetExtension;
  80 typedef struct __DRItexBufferExtensionRec       __DRItexBufferExtension;
  81 typedef struct __DRIlegacyExtensionRec          __DRIlegacyExtension;
  82 typedef struct __DRIswrastExtensionRec          __DRIswrastExtension;
  83 typedef struct __DRIbufferRec                   __DRIbuffer;
  84 typedef struct __DRIdri2ExtensionRec            __DRIdri2Extension;
  85 typedef struct __DRIdri2LoaderExtensionRec      __DRIdri2LoaderExtension;
  86 typedef struct __DRI2flushExtensionRec  __DRI2flushExtension;
  87 typedef struct __DRI2throttleExtensionRec       __DRI2throttleExtension;
  88
  89
  90 typedef struct __DRIimageLoaderExtensionRec     __DRIimageLoaderExtension;
  91 typedef struct __DRIimageDriverExtensionRec     __DRIimageDriverExtension;
  92
  93 /*@}*/
  94
  95
  96 /**
  97  * Extension struct.  Drivers 'inherit' from this struct by embedding
  98  * it as the first element in the extension struct.
  99  *
 100  * We never break API in for a DRI extension.  If we need to change
 101  * the way things work in a non-backwards compatible manner, we
 102  * introduce a new extension.  During a transition period, we can
 103  * leave both the old and the new extension in the driver, which
 104  * allows us to move to the new interface without having to update the
 105  * loader(s) in lock step.
 106  *
 107  * However, we can add entry points to an extension over time as long
 108  * as we don't break the old ones.  As we add entry points to an
 109  * extension, we increase the version number.  The corresponding
 110  * #define can be used to guard code that accesses the new entry
 111  * points at compile time and the version field in the extension
 112  * struct can be used at run-time to determine how to use the
 113  * extension.
 114  */
 115 struct __DRIextensionRec {
 116     const char *name;
 117     int version;
 118 };
 119
 120 /**
 121  * The first set of extension are the screen extensions, returned by
 122  * __DRIcore::getExtensions().  This entry point will return a list of
 123  * extensions and the loader can use the ones it knows about by
 124  * casting them to more specific extensions and advertising any GLX
 125  * extensions the DRI extensions enables.
 126  */
 127
 128 /**
 129  * Used by drivers to indicate support for setting the read drawable.
 130  */
 131 #define __DRI_READ_DRAWABLE "DRI_ReadDrawable"
 132 #define __DRI_READ_DRAWABLE_VERSION 1
 133
 134 /**
 135  * Used by drivers that implement the GLX_MESA_copy_sub_buffer extension.
 136  */
 137 #define __DRI_COPY_SUB_BUFFER "DRI_CopySubBuffer"
 138 #define __DRI_COPY_SUB_BUFFER_VERSION 1
 139 struct __DRIcopySubBufferExtensionRec {
 140     __DRIextension base;
 141     void (*copySubBuffer)(__DRIdrawable *drawable, int x, int y, int w, int h);
 142 };
 143
 144 /**
 145  * Used by drivers that implement the GLX_SGI_swap_control or
 146  * GLX_MESA_swap_control extension.
 147  */
 148 #define __DRI_SWAP_CONTROL "DRI_SwapControl"
 149 #define __DRI_SWAP_CONTROL_VERSION 1
 150 struct __DRIswapControlExtensionRec {
 151     __DRIextension base;
 152     void (*setSwapInterval)(__DRIdrawable *drawable, unsigned int inteval);
 153     unsigned int (*getSwapInterval)(__DRIdrawable *drawable);
 154 };
 155
 156 /**
 157  * Used by drivers that implement the GLX_MESA_swap_frame_usage extension.
 158  */
 159 #define __DRI_FRAME_TRACKING "DRI_FrameTracking"
 160 #define __DRI_FRAME_TRACKING_VERSION 1
 161 struct __DRIframeTrackingExtensionRec {
 162     __DRIextension base;
 163
 164     /**
 165      * Enable or disable frame usage tracking.
 166      *
 167      * \since Internal API version 20030317.
 168      */
 169     int (*frameTracking)(__DRIdrawable *drawable, GLboolean enable);
 170
 171     /**
 172      * Retrieve frame usage information.
 173      *
 174      * \since Internal API version 20030317.
 175      */
 176     int (*queryFrameTracking)(__DRIdrawable *drawable,
 177                               int64_t * sbc, int64_t * missedFrames,
 178                               float * lastMissedUsage, float * usage);
 179 };
 180
 181
 182 /**
 183  * Used by drivers that implement the GLX_SGI_video_sync extension.
 184  */
 185 #define __DRI_MEDIA_STREAM_COUNTER "DRI_MediaStreamCounter"
 186 #define __DRI_MEDIA_STREAM_COUNTER_VERSION 1
 187 struct __DRImediaStreamCounterExtensionRec {
 188     __DRIextension base;
 189
 190     /**
 191      * Wait for the MSC to equal target_msc, or, if that has already passed,
 192      * the next time (MSC % divisor) is equal to remainder.  If divisor is
 193      * zero, the function will return as soon as MSC is greater than or equal
 194      * to target_msc.
 195      */
 196     int (*waitForMSC)(__DRIdrawable *drawable,
 197                       int64_t target_msc, int64_t divisor, int64_t remainder,
 198                       int64_t * msc, int64_t * sbc);
 199
 200     /**
 201      * Get the number of vertical refreshes since some point in time before
 202      * this function was first called (i.e., system start up).
 203      */
 204     int (*getDrawableMSC)(__DRIscreen *screen, __DRIdrawable *drawable,
 205                           int64_t *msc);
 206 };
 207
 208
 209 #define __DRI_TEX_OFFSET "DRI_TexOffset"
 210 #define __DRI_TEX_OFFSET_VERSION 1
 211 struct __DRItexOffsetExtensionRec {
 212     __DRIextension base;
 213
 214     /**
 215      * Method to override base texture image with a driver specific 'offset'.
 216      * The depth passed in allows e.g. to ignore the alpha channel of texture
 217      * images where the non-alpha components don't occupy a whole texel.
 218      *
 219      * For GLX_EXT_texture_from_pixmap with AIGLX.
 220      */
 221     void (*setTexOffset)(__DRIcontext *pDRICtx, GLint texname,
 222                          unsigned long long offset, GLint depth, GLuint pitch);
 223 };
 224
 225
 226 /* Valid values for format in the setTexBuffer2 function below.  These
 227  * values match the GLX tokens for compatibility reasons, but we
 228  * define them here since the DRI interface can't depend on GLX. */
 229 #define __DRI_TEXTURE_FORMAT_NONE        0x20D8
 230 #define __DRI_TEXTURE_FORMAT_RGB         0x20D9
 231 #define __DRI_TEXTURE_FORMAT_RGBA        0x20DA
 232
 233 #define __DRI_TEX_BUFFER "DRI_TexBuffer"
 234 #define __DRI_TEX_BUFFER_VERSION 2
 235 struct __DRItexBufferExtensionRec {
 236     __DRIextension base;
 237
 238     /**
 239      * Method to override base texture image with the contents of a
 240      * __DRIdrawable.
 241      *
 242      * For GLX_EXT_texture_from_pixmap with AIGLX.  Deprecated in favor of
 243      * setTexBuffer2 in version 2 of this interface
 244      */
 245     void (*setTexBuffer)(__DRIcontext *pDRICtx,
 246                          GLint target,
 247                          __DRIdrawable *pDraw);
 248
 249     /**
 250      * Method to override base texture image with the contents of a
 251      * __DRIdrawable, including the required texture format attribute.
 252      *
 253      * For GLX_EXT_texture_from_pixmap with AIGLX.
 254      */
 255     void (*setTexBuffer2)(__DRIcontext *pDRICtx,
 256                           GLint target,
 257                           GLint format,
 258                           __DRIdrawable *pDraw);
 259     /**
 260      * Method to release texture buffer in case some special platform
 261      * need this.
 262      *
 263      * For GLX_EXT_texture_from_pixmap with AIGLX.
 264      */
 265     void (*releaseTexBuffer)(__DRIcontext *pDRICtx,
 266                         GLint target,
 267                         __DRIdrawable *pDraw);
 268 };
 269
 270 /**
 271  * Used by drivers that implement DRI2
 272  */
 273 #define __DRI2_FLUSH "DRI2_Flush"
 274 #define __DRI2_FLUSH_VERSION 4
 275
 276 #define __DRI2_FLUSH_DRAWABLE (1 << 0) /* the drawable should be flushed. */
 277 #define __DRI2_FLUSH_CONTEXT  (1 << 1) /* glFlush should be called */
 278
 279 enum __DRI2throttleReason {
 280    __DRI2_THROTTLE_SWAPBUFFER,
 281    __DRI2_THROTTLE_COPYSUBBUFFER,
 282    __DRI2_THROTTLE_FLUSHFRONT
 283 };
 284
 285 struct __DRI2flushExtensionRec {
 286     __DRIextension base;
 287     void (*flush)(__DRIdrawable *drawable);
 288
 289     /**
 290      * Ask the driver to call getBuffers/getBuffersWithFormat before
 291      * it starts rendering again.
 292      *
 293      * \param drawable the drawable to invalidate
 294      *
 295      * \since 3
 296      */
 297     void (*invalidate)(__DRIdrawable *drawable);
 298
 299     /**
 300      * This function reduces the number of flushes in the driver by combining
 301      * several operations into one call.
 302      *
 303      * It can:
 304      * - throttle
 305      * - flush a drawable
 306      * - flush a context
 307      *
 308      * \param context           the context
 309      * \param drawable          the drawable to flush
 310      * \param flags             a combination of _DRI2_FLUSH_xxx flags
 311      * \param throttle_reason   the reason for throttling, 0 = no throttling
 312      *
 313      * \since 4
 314      */
 315     void (*flush_with_flags)(__DRIcontext *ctx,
 316                              __DRIdrawable *drawable,
 317                              unsigned flags,
 318                              enum __DRI2throttleReason throttle_reason);
 319 };
 320
 321
 322 /**
 323  * Extension that the driver uses to request
 324  * throttle callbacks.
 325  */
 326
 327 #define __DRI2_THROTTLE "DRI2_Throttle"
 328 #define __DRI2_THROTTLE_VERSION 1
 329
 330 struct __DRI2throttleExtensionRec {
 331    __DRIextension base;
 332    void (*throttle)(__DRIcontext *ctx,
 333                     __DRIdrawable *drawable,
 334                     enum __DRI2throttleReason reason);
 335 };
 336
 337 /*@}*/
 338
 339 /**
 340  * The following extensions describe loader features that the DRI
 341  * driver can make use of.  Some of these are mandatory, such as the
 342  * getDrawableInfo extension for DRI and the DRI Loader extensions for
 343  * DRI2, while others are optional, and if present allow the driver to
 344  * expose certain features.  The loader pass in a NULL terminated
 345  * array of these extensions to the driver in the createNewScreen
 346  * constructor.
 347  */
 348
 349 typedef struct __DRIgetDrawableInfoExtensionRec __DRIgetDrawableInfoExtension;
 350 typedef struct __DRIsystemTimeExtensionRec __DRIsystemTimeExtension;
 351 typedef struct __DRIdamageExtensionRec __DRIdamageExtension;
 352 typedef struct __DRIloaderExtensionRec __DRIloaderExtension;
 353 typedef struct __DRIswrastLoaderExtensionRec __DRIswrastLoaderExtension;
 354
 355
 356 /**
 357  * Callback to getDrawableInfo protocol
 358  */
 359 #define __DRI_GET_DRAWABLE_INFO "DRI_GetDrawableInfo"
 360 #define __DRI_GET_DRAWABLE_INFO_VERSION 1
 361 struct __DRIgetDrawableInfoExtensionRec {
 362     __DRIextension base;
 363
 364     /**
 365      * This function is used to get information about the position, size, and
 366      * clip rects of a drawable.
 367      */
 368     GLboolean (* getDrawableInfo) ( __DRIdrawable *drawable,
 369         unsigned int * index, unsigned int * stamp,
 370         int * x, int * y, int * width, int * height,
 371         int * numClipRects, drm_clip_rect_t ** pClipRects,
 372         int * backX, int * backY,
 373         int * numBackClipRects, drm_clip_rect_t ** pBackClipRects,
 374         void *loaderPrivate);
 375 };
 376
 377 /**
 378  * Callback to get system time for media stream counter extensions.
 379  */
 380 #define __DRI_SYSTEM_TIME "DRI_SystemTime"
 381 #define __DRI_SYSTEM_TIME_VERSION 1
 382 struct __DRIsystemTimeExtensionRec {
 383     __DRIextension base;
 384
 385     /**
 386      * Get the 64-bit unadjusted system time (UST).
 387      */
 388     int (*getUST)(int64_t * ust);
 389
 390     /**
 391      * Get the media stream counter (MSC) rate.
 392      *
 393      * Matching the definition in GLX_OML_sync_control, this function returns
 394      * the rate of the "media stream counter".  In practical terms, this is
 395      * the frame refresh rate of the display.
 396      */
 397     GLboolean (*getMSCRate)(__DRIdrawable *draw,
 398                             int32_t * numerator, int32_t * denominator,
 399                             void *loaderPrivate);
 400 };
 401
 402 /**
 403  * Damage reporting
 404  */
 405 #define __DRI_DAMAGE "DRI_Damage"
 406 #define __DRI_DAMAGE_VERSION 1
 407 struct __DRIdamageExtensionRec {
 408     __DRIextension base;
 409
 410     /**
 411      * Reports areas of the given drawable which have been modified by the
 412      * driver.
 413      *
 414      * \param drawable which the drawing was done to.
 415      * \param rects rectangles affected, with the drawable origin as the
 416      *        origin.
 417      * \param x X offset of the drawable within the screen (used in the
 418      *        front_buffer case)
 419      * \param y Y offset of the drawable within the screen.
 420      * \param front_buffer boolean flag for whether the drawing to the
 421      *        drawable was actually done directly to the front buffer (instead
 422      *        of backing storage, for example)
 423      * \param loaderPrivate the data passed in at createNewDrawable time
 424      */
 425     void (*reportDamage)(__DRIdrawable *draw,
 426                          int x, int y,
 427                          drm_clip_rect_t *rects, int num_rects,
 428                          GLboolean front_buffer,
 429                          void *loaderPrivate);
 430 };
 431
 432 #define __DRI_SWRAST_IMAGE_OP_DRAW      1
 433 #define __DRI_SWRAST_IMAGE_OP_CLEAR     2
 434 #define __DRI_SWRAST_IMAGE_OP_SWAP      3
 435
 436 /**
 437  * SWRast Loader extension.
 438  */
 439 #define __DRI_SWRAST_LOADER "DRI_SWRastLoader"
 440 #define __DRI_SWRAST_LOADER_VERSION 2
 441 struct __DRIswrastLoaderExtensionRec {
 442     __DRIextension base;
 443
 444     /*
 445      * Drawable position and size
 446      */
 447     void (*getDrawableInfo)(__DRIdrawable *drawable,
 448                             int *x, int *y, int *width, int *height,
 449                             void *loaderPrivate);
 450
 451     /**
 452      * Put image to drawable
 453      */
 454     void (*putImage)(__DRIdrawable *drawable, int op,
 455                      int x, int y, int width, int height,
 456                      char *data, void *loaderPrivate);
 457
 458     /**
 459      * Get image from readable
 460      */
 461     void (*getImage)(__DRIdrawable *readable,
 462                      int x, int y, int width, int height,
 463                      char *data, void *loaderPrivate);
 464
 465     /**
 466      * Put image to drawable
 467      *
 468      * \since 2
 469      */
 470     void (*putImage2)(__DRIdrawable *drawable, int op,
 471                       int x, int y, int width, int height, int stride,
 472                       char *data, void *loaderPrivate);
 473 };
 474
 475 /**
 476  * Invalidate loader extension.  The presence of this extension
 477  * indicates to the DRI driver that the loader will call invalidate in
 478  * the __DRI2_FLUSH extension, whenever the needs to query for new
 479  * buffers.  This means that the DRI driver can drop the polling in
 480  * glViewport().
 481  *
 482  * The extension doesn't provide any functionality, it's only use to
 483  * indicate to the driver that it can use the new semantics.  A DRI
 484  * driver can use this to switch between the different semantics or
 485  * just refuse to initialize if this extension isn't present.
 486  */
 487 #define __DRI_USE_INVALIDATE "DRI_UseInvalidate"
 488 #define __DRI_USE_INVALIDATE_VERSION 1
 489
 490 typedef struct __DRIuseInvalidateExtensionRec __DRIuseInvalidateExtension;
 491 struct __DRIuseInvalidateExtensionRec {
 492    __DRIextension base;
 493 };
 494
 495 /**
 496  * The remaining extensions describe driver extensions, immediately
 497  * available interfaces provided by the driver.  To start using the
 498  * driver, dlsym() for the __DRI_DRIVER_EXTENSIONS symbol and look for
 499  * the extension you need in the array.
 500  */
 501 #define __DRI_DRIVER_EXTENSIONS "__driDriverExtensions"
 502
 503 /**
 504  * This symbol replaces the __DRI_DRIVER_EXTENSIONS symbol, and will be
 505  * suffixed by "_drivername", allowing multiple drivers to be built into one
 506  * library, and also giving the driver the chance to return a variable driver
 507  * extensions struct depending on the driver name being loaded or any other
 508  * system state.
 509  *
 510  * The function prototype is:
 511  *
 512  * const __DRIextension **__driDriverGetExtensions_drivername(void);
 513  */
 514 #define __DRI_DRIVER_GET_EXTENSIONS "__driDriverGetExtensions"
 515
 516 /**
 517  * Tokens for __DRIconfig attribs.  A number of attributes defined by
 518  * GLX or EGL standards are not in the table, as they must be provided
 519  * by the loader.  For example, FBConfig ID or visual ID, drawable type.
 520  */
 521
 522 #define __DRI_ATTRIB_BUFFER_SIZE                 1
 523 #define __DRI_ATTRIB_LEVEL                       2
 524 #define __DRI_ATTRIB_RED_SIZE                    3
 525 #define __DRI_ATTRIB_GREEN_SIZE                  4
 526 #define __DRI_ATTRIB_BLUE_SIZE                   5
 527 #define __DRI_ATTRIB_LUMINANCE_SIZE              6
 528 #define __DRI_ATTRIB_ALPHA_SIZE                  7
 529 #define __DRI_ATTRIB_ALPHA_MASK_SIZE             8
 530 #define __DRI_ATTRIB_DEPTH_SIZE                  9
 531 #define __DRI_ATTRIB_STENCIL_SIZE               10
 532 #define __DRI_ATTRIB_ACCUM_RED_SIZE             11
 533 #define __DRI_ATTRIB_ACCUM_GREEN_SIZE           12
 534 #define __DRI_ATTRIB_ACCUM_BLUE_SIZE            13
 535 #define __DRI_ATTRIB_ACCUM_ALPHA_SIZE           14
 536 #define __DRI_ATTRIB_SAMPLE_BUFFERS             15
 537 #define __DRI_ATTRIB_SAMPLES                    16
 538 #define __DRI_ATTRIB_RENDER_TYPE                17
 539 #define __DRI_ATTRIB_CONFIG_CAVEAT              18
 540 #define __DRI_ATTRIB_CONFORMANT                 19
 541 #define __DRI_ATTRIB_DOUBLE_BUFFER              20
 542 #define __DRI_ATTRIB_STEREO                     21
 543 #define __DRI_ATTRIB_AUX_BUFFERS                22
 544 #define __DRI_ATTRIB_TRANSPARENT_TYPE           23
 545 #define __DRI_ATTRIB_TRANSPARENT_INDEX_VALUE    24
 546 #define __DRI_ATTRIB_TRANSPARENT_RED_VALUE      25
 547 #define __DRI_ATTRIB_TRANSPARENT_GREEN_VALUE    26
 548 #define __DRI_ATTRIB_TRANSPARENT_BLUE_VALUE     27
 549 #define __DRI_ATTRIB_TRANSPARENT_ALPHA_VALUE    28
 550 #define __DRI_ATTRIB_FLOAT_MODE                 29
 551 #define __DRI_ATTRIB_RED_MASK                   30
 552 #define __DRI_ATTRIB_GREEN_MASK                 31
 553 #define __DRI_ATTRIB_BLUE_MASK                  32
 554 #define __DRI_ATTRIB_ALPHA_MASK                 33
 555 #define __DRI_ATTRIB_MAX_PBUFFER_WIDTH          34
 556 #define __DRI_ATTRIB_MAX_PBUFFER_HEIGHT         35
 557 #define __DRI_ATTRIB_MAX_PBUFFER_PIXELS         36
 558 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_WIDTH      37
 559 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_HEIGHT     38
 560 #define __DRI_ATTRIB_VISUAL_SELECT_GROUP        39
 561 #define __DRI_ATTRIB_SWAP_METHOD                40
 562 #define __DRI_ATTRIB_MAX_SWAP_INTERVAL          41
 563 #define __DRI_ATTRIB_MIN_SWAP_INTERVAL          42
 564 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGB        43
 565 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGBA       44
 566 #define __DRI_ATTRIB_BIND_TO_MIPMAP_TEXTURE     45
 567 #define __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS    46
 568 #define __DRI_ATTRIB_YINVERTED                  47
 569 #define __DRI_ATTRIB_FRAMEBUFFER_SRGB_CAPABLE   48
 570
 571 /* __DRI_ATTRIB_RENDER_TYPE */
 572 #define __DRI_ATTRIB_RGBA_BIT                   0x01
 573 #define __DRI_ATTRIB_COLOR_INDEX_BIT            0x02
 574 #define __DRI_ATTRIB_LUMINANCE_BIT              0x04
 575 #define __DRI_ATTRIB_FLOAT_BIT                  0x08
 576 #define __DRI_ATTRIB_UNSIGNED_FLOAT_BIT         0x10
 577
 578 /* __DRI_ATTRIB_CONFIG_CAVEAT */
 579 #define __DRI_ATTRIB_SLOW_BIT                   0x01
 580 #define __DRI_ATTRIB_NON_CONFORMANT_CONFIG      0x02
 581
 582 /* __DRI_ATTRIB_TRANSPARENT_TYPE */
 583 #define __DRI_ATTRIB_TRANSPARENT_RGB            0x00
 584 #define __DRI_ATTRIB_TRANSPARENT_INDEX          0x01
 585
 586 /* __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS  */
 587 #define __DRI_ATTRIB_TEXTURE_1D_BIT             0x01
 588 #define __DRI_ATTRIB_TEXTURE_2D_BIT             0x02
 589 #define __DRI_ATTRIB_TEXTURE_RECTANGLE_BIT      0x04
 590
 591 /**
 592  * This extension defines the core DRI functionality.
 593  */
 594 #define __DRI_CORE "DRI_Core"
 595 #define __DRI_CORE_VERSION 1
 596
 597 struct __DRIcoreExtensionRec {
 598     __DRIextension base;
 599
 600     __DRIscreen *(*createNewScreen)(int screen, int fd,
 601                                     unsigned int sarea_handle,
 602                                     const __DRIextension **extensions,
 603                                     const __DRIconfig ***driverConfigs,
 604                                     void *loaderPrivate);
 605
 606     void (*destroyScreen)(__DRIscreen *screen);
 607
 608     const __DRIextension **(*getExtensions)(__DRIscreen *screen);
 609
 610     int (*getConfigAttrib)(const __DRIconfig *config,
 611                            unsigned int attrib,
 612                            unsigned int *value);
 613
 614     int (*indexConfigAttrib)(const __DRIconfig *config, int index,
 615                              unsigned int *attrib, unsigned int *value);
 616
 617     __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
 618                                         const __DRIconfig *config,
 619                                         unsigned int drawable_id,
 620                                         unsigned int head,
 621                                         void *loaderPrivate);
 622
 623     void (*destroyDrawable)(__DRIdrawable *drawable);
 624
 625     void (*swapBuffers)(__DRIdrawable *drawable);
 626
 627     __DRIcontext *(*createNewContext)(__DRIscreen *screen,
 628                                       const __DRIconfig *config,
 629                                       __DRIcontext *shared,
 630                                       void *loaderPrivate);
 631
 632     int (*copyContext)(__DRIcontext *dest,
 633                        __DRIcontext *src,
 634                        unsigned long mask);
 635
 636     void (*destroyContext)(__DRIcontext *context);
 637
 638     int (*bindContext)(__DRIcontext *ctx,
 639                        __DRIdrawable *pdraw,
 640                        __DRIdrawable *pread);
 641
 642     int (*unbindContext)(__DRIcontext *ctx);
 643 };
 644
 645 /**
 646  * Stored version of some component (i.e., server-side DRI module, kernel-side
 647  * DRM, etc.).
 648  *
 649  * \todo
 650  * There are several data structures that explicitly store a major version,
 651  * minor version, and patch level.  These structures should be modified to
 652  * have a \c __DRIversionRec instead.
 653  */
 654 struct __DRIversionRec {
 655     int    major;        /**< Major version number. */
 656     int    minor;        /**< Minor version number. */
 657     int    patch;        /**< Patch-level. */
 658 };
 659
 660 /**
 661  * Framebuffer information record.  Used by libGL to communicate information
 662  * about the framebuffer to the driver's \c __driCreateNewScreen function.
 663  *
 664  * In XFree86, most of this information is derrived from data returned by
 665  * calling \c XF86DRIGetDeviceInfo.
 666  *
 667  * \sa XF86DRIGetDeviceInfo __DRIdisplayRec::createNewScreen
 668  *     __driUtilCreateNewScreen CallCreateNewScreen
 669  *
 670  * \bug This structure could be better named.
 671  */
 672 struct __DRIframebufferRec {
 673     unsigned char *base;    /**< Framebuffer base address in the CPU's
 674                              * address space.  This value is calculated by
 675                              * calling \c drmMap on the framebuffer handle
 676                              * returned by \c XF86DRIGetDeviceInfo (or a
 677                              * similar function).
 678                              */
 679     int size;               /**< Framebuffer size, in bytes. */
 680     int stride;             /**< Number of bytes from one line to the next. */
 681     int width;              /**< Pixel width of the framebuffer. */
 682     int height;             /**< Pixel height of the framebuffer. */
 683     int dev_priv_size;      /**< Size of the driver's dev-priv structure. */
 684     void *dev_priv;         /**< Pointer to the driver's dev-priv structure. */
 685 };
 686
 687
 688 /**
 689  * This extension provides alternative screen, drawable and context
 690  * constructors for legacy DRI functionality.  This is used in
 691  * conjunction with the core extension.
 692  */
 693 #define __DRI_LEGACY "DRI_Legacy"
 694 #define __DRI_LEGACY_VERSION 1
 695
 696 struct __DRIlegacyExtensionRec {
 697     __DRIextension base;
 698
 699     __DRIscreen *(*createNewScreen)(int screen,
 700                                     const __DRIversion *ddx_version,
 701                                     const __DRIversion *dri_version,
 702                                     const __DRIversion *drm_version,
 703                                     const __DRIframebuffer *frame_buffer,
 704                                     void *pSAREA, int fd,
 705                                     const __DRIextension **extensions,
 706                                     const __DRIconfig ***driver_configs,
 707                                     void *loaderPrivate);
 708
 709     __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
 710                                         const __DRIconfig *config,
 711                                         drm_drawable_t hwDrawable,
 712                                         int renderType, const int *attrs,
 713                                         void *loaderPrivate);
 714
 715     __DRIcontext *(*createNewContext)(__DRIscreen *screen,
 716                                       const __DRIconfig *config,
 717                                       int render_type,
 718                                       __DRIcontext *shared,
 719                                       drm_context_t hwContext,
 720                                       void *loaderPrivate);
 721 };
 722
 723 /**
 724  * This extension provides alternative screen, drawable and context
 725  * constructors for swrast DRI functionality.  This is used in
 726  * conjunction with the core extension.
 727  */
 728 #define __DRI_SWRAST "DRI_SWRast"
 729 #define __DRI_SWRAST_VERSION 4
 730
 731 struct __DRIswrastExtensionRec {
 732     __DRIextension base;
 733
 734     __DRIscreen *(*createNewScreen)(int screen,
 735                                     const __DRIextension **extensions,
 736                                     const __DRIconfig ***driver_configs,
 737                                     void *loaderPrivate);
 738
 739     __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
 740                                         const __DRIconfig *config,
 741                                         void *loaderPrivate);
 742
 743    /* Since version 2 */
 744    __DRIcontext *(*createNewContextForAPI)(__DRIscreen *screen,
 745                                            int api,
 746                                            const __DRIconfig *config,
 747                                            __DRIcontext *shared,
 748                                            void *data);
 749
 750    /**
 751     * Create a context for a particular API with a set of attributes
 752     *
 753     * \since version 3
 754     *
 755     * \sa __DRIdri2ExtensionRec::createContextAttribs
 756     */
 757    __DRIcontext *(*createContextAttribs)(__DRIscreen *screen,
 758                                          int api,
 759                                          const __DRIconfig *config,
 760                                          __DRIcontext *shared,
 761                                          unsigned num_attribs,
 762                                          const uint32_t *attribs,
 763                                          unsigned *error,
 764                                          void *loaderPrivate);
 765
 766    /**
 767     * createNewScreen() with the driver extensions passed in.
 768     *
 769     * \since version 4
 770     */
 771    __DRIscreen *(*createNewScreen2)(int screen,
 772                                     const __DRIextension **loader_extensions,
 773                                     const __DRIextension **driver_extensions,
 774                                     const __DRIconfig ***driver_configs,
 775                                     void *loaderPrivate);
 776
 777 };
 778
 779 /** Common DRI function definitions, shared among DRI2 and Image extensions
 780  */
 781
 782 typedef __DRIscreen *
 783 (*__DRIcreateNewScreen2Func)(int screen, int fd,
 784                              const __DRIextension **extensions,
 785                              const __DRIextension **driver_extensions,
 786                              const __DRIconfig ***driver_configs,
 787                              void *loaderPrivate);
 788
 789 typedef __DRIdrawable *
 790 (*__DRIcreateNewDrawableFunc)(__DRIscreen *screen,
 791                               const __DRIconfig *config,
 792                               void *loaderPrivate);
 793
 794 typedef __DRIcontext *
 795 (*__DRIcreateContextAttribsFunc)(__DRIscreen *screen,
 796                                  int api,
 797                                  const __DRIconfig *config,
 798                                  __DRIcontext *shared,
 799                                  unsigned num_attribs,
 800                                  const uint32_t *attribs,
 801                                  unsigned *error,
 802                                  void *loaderPrivate);
 803
 804 typedef unsigned int
 805 (*__DRIgetAPIMaskFunc)(__DRIscreen *screen);
 806
 807 /**
 808  * DRI2 Loader extension.
 809  */
 810 #define __DRI_BUFFER_FRONT_LEFT         0
 811 #define __DRI_BUFFER_BACK_LEFT          1
 812 #define __DRI_BUFFER_FRONT_RIGHT        2
 813 #define __DRI_BUFFER_BACK_RIGHT         3
 814 #define __DRI_BUFFER_DEPTH              4
 815 #define __DRI_BUFFER_STENCIL            5
 816 #define __DRI_BUFFER_ACCUM              6
 817 #define __DRI_BUFFER_FAKE_FRONT_LEFT    7
 818 #define __DRI_BUFFER_FAKE_FRONT_RIGHT   8
 819 #define __DRI_BUFFER_DEPTH_STENCIL      9  /**< Only available with DRI2 1.1 */
 820 #define __DRI_BUFFER_HIZ                10
 821
 822 /* Inofficial and for internal use. Increase when adding a new buffer token. */
 823 #define __DRI_BUFFER_COUNT              11
 824
 825 struct __DRIbufferRec {
 826     unsigned int attachment;
 827     unsigned int name;
 828     unsigned int pitch;
 829     unsigned int cpp;
 830     unsigned int flags;
 831 };
 832
 833 #define __DRI_DRI2_LOADER "DRI_DRI2Loader"
 834 #define __DRI_DRI2_LOADER_VERSION 3
 835 struct __DRIdri2LoaderExtensionRec {
 836     __DRIextension base;
 837
 838     __DRIbuffer *(*getBuffers)(__DRIdrawable *driDrawable,
 839                                int *width, int *height,
 840                                unsigned int *attachments, int count,
 841                                int *out_count, void *loaderPrivate);
 842
 843     /**
 844      * Flush pending front-buffer rendering
 845      *
 846      * Any rendering that has been performed to the
 847      * \c __DRI_BUFFER_FAKE_FRONT_LEFT will be flushed to the
 848      * \c __DRI_BUFFER_FRONT_LEFT.
 849      *
 850      * \param driDrawable    Drawable whose front-buffer is to be flushed
 851      * \param loaderPrivate  Loader's private data that was previously passed
 852      *                       into __DRIdri2ExtensionRec::createNewDrawable
 853      */
 854     void (*flushFrontBuffer)(__DRIdrawable *driDrawable, void *loaderPrivate);
 855
 856
 857     /**
 858      * Get list of buffers from the server
 859      *
 860      * Gets a list of buffer for the specified set of attachments.  Unlike
 861      * \c ::getBuffers, this function takes a list of attachments paired with
 862      * opaque \c unsigned \c int value describing the format of the buffer.
 863      * It is the responsibility of the caller to know what the service that
 864      * allocates the buffers will expect to receive for the format.
 865      *
 866      * \param driDrawable    Drawable whose buffers are being queried.
 867      * \param width          Output where the width of the buffers is stored.
 868      * \param height         Output where the height of the buffers is stored.
 869      * \param attachments    List of pairs of attachment ID and opaque format
 870      *                       requested for the drawable.
 871      * \param count          Number of attachment / format pairs stored in
 872      *                       \c attachments.
 873      * \param loaderPrivate  Loader's private data that was previously passed
 874      *                       into __DRIdri2ExtensionRec::createNewDrawable.
 875      */
 876     __DRIbuffer *(*getBuffersWithFormat)(__DRIdrawable *driDrawable,
 877                                          int *width, int *height,
 878                                          unsigned int *attachments, int count,
 879                                          int *out_count, void *loaderPrivate);
 880 };
 881
 882 /**
 883  * This extension provides alternative screen, drawable and context
 884  * constructors for DRI2.
 885  */
 886 #define __DRI_DRI2 "DRI_DRI2"
 887 #define __DRI_DRI2_VERSION 4
 888
 889 #define __DRI_API_OPENGL        0       /**< OpenGL compatibility profile */
 890 #define __DRI_API_GLES          1       /**< OpenGL ES 1.x */
 891 #define __DRI_API_GLES2         2       /**< OpenGL ES 2.x */
 892 #define __DRI_API_OPENGL_CORE   3       /**< OpenGL 3.2+ core profile */
 893 #define __DRI_API_GLES3         4       /**< OpenGL ES 3.x */
 894
 895 #define __DRI_CTX_ATTRIB_MAJOR_VERSION          0
 896 #define __DRI_CTX_ATTRIB_MINOR_VERSION          1
 897 #define __DRI_CTX_ATTRIB_FLAGS                  2
 898
 899 /**
 900  * \requires __DRI2_ROBUSTNESS.
 901  */
 902 #define __DRI_CTX_ATTRIB_RESET_STRATEGY         3
 903
 904 #define __DRI_CTX_FLAG_DEBUG                    0x00000001
 905 #define __DRI_CTX_FLAG_FORWARD_COMPATIBLE       0x00000002
 906
 907 /**
 908  * \requires __DRI2_ROBUSTNESS.
 909  */
 910 #define __DRI_CTX_FLAG_ROBUST_BUFFER_ACCESS     0x00000004
 911
 912 /**
 913  * \name Context reset strategies.
 914  */
 915 /*@{*/
 916 #define __DRI_CTX_RESET_NO_NOTIFICATION         0
 917 #define __DRI_CTX_RESET_LOSE_CONTEXT            1
 918 /*@}*/
 919
 920 /**
 921  * \name Reasons that __DRIdri2Extension::createContextAttribs might fail
 922  */
 923 /*@{*/
 924 /** Success! */
 925 #define __DRI_CTX_ERROR_SUCCESS                 0
 926
 927 /** Memory allocation failure */
 928 #define __DRI_CTX_ERROR_NO_MEMORY               1
 929
 930 /** Client requested an API (e.g., OpenGL ES 2.0) that the driver can't do. */
 931 #define __DRI_CTX_ERROR_BAD_API                 2
 932
 933 /** Client requested an API version that the driver can't do. */
 934 #define __DRI_CTX_ERROR_BAD_VERSION             3
 935
 936 /** Client requested a flag or combination of flags the driver can't do. */
 937 #define __DRI_CTX_ERROR_BAD_FLAG                4
 938
 939 /** Client requested an attribute the driver doesn't understand. */
 940 #define __DRI_CTX_ERROR_UNKNOWN_ATTRIBUTE       5
 941
 942 /** Client requested a flag the driver doesn't understand. */
 943 #define __DRI_CTX_ERROR_UNKNOWN_FLAG            6
 944 /*@}*/
 945
 946 struct __DRIdri2ExtensionRec {
 947     __DRIextension base;
 948
 949     __DRIscreen *(*createNewScreen)(int screen, int fd,
 950                                     const __DRIextension **extensions,
 951                                     const __DRIconfig ***driver_configs,
 952                                     void *loaderPrivate);
 953
 954    __DRIcreateNewDrawableFunc   createNewDrawable;
 955    __DRIcontext *(*createNewContext)(__DRIscreen *screen,
 956                                      const __DRIconfig *config,
 957                                      __DRIcontext *shared,
 958                                      void *loaderPrivate);
 959
 960    /* Since version 2 */
 961    __DRIgetAPIMaskFunc          getAPIMask;
 962
 963    __DRIcontext *(*createNewContextForAPI)(__DRIscreen *screen,
 964                                            int api,
 965                                            const __DRIconfig *config,
 966                                            __DRIcontext *shared,
 967                                            void *data);
 968
 969    __DRIbuffer *(*allocateBuffer)(__DRIscreen *screen,
 970                                   unsigned int attachment,
 971                                   unsigned int format,
 972                                   int width,
 973                                   int height);
 974    void (*releaseBuffer)(__DRIscreen *screen,
 975                          __DRIbuffer *buffer);
 976
 977    /**
 978     * Create a context for a particular API with a set of attributes
 979     *
 980     * \since version 3
 981     *
 982     * \sa __DRIswrastExtensionRec::createContextAttribs
 983     */
 984    __DRIcreateContextAttribsFunc        createContextAttribs;
 985
 986    /**
 987     * createNewScreen with the driver's extension list passed in.
 988     *
 989     * \since version 4
 990     */
 991    __DRIcreateNewScreen2Func            createNewScreen2;
 992 };
 993
 994
 995 /**
 996  * This extension provides functionality to enable various EGLImage
 997  * extensions.
 998  */
 999 #define __DRI_IMAGE "DRI_IMAGE"
1000 #define __DRI_IMAGE_VERSION 8
1001
1002 /**
1003  * These formats correspond to the similarly named MESA_FORMAT_*
1004  * tokens, except in the native endian of the CPU.  For example, on
1005  * little endian __DRI_IMAGE_FORMAT_XRGB8888 corresponds to
1006  * MESA_FORMAT_XRGB8888, but MESA_FORMAT_XRGB8888_REV on big endian.
1007  *
1008  * __DRI_IMAGE_FORMAT_NONE is for images that aren't directly usable
1009  * by the driver (YUV planar formats) but serve as a base image for
1010  * creating sub-images for the different planes within the image.
1011  *
1012  * R8, GR88 and NONE should not be used with createImageFormName or
1013  * createImage, and are returned by query from sub images created with
1014  * createImageFromNames (NONE, see above) and fromPlane (R8 & GR88).
1015  */
1016 #define __DRI_IMAGE_FORMAT_RGB565       0x1001
1017 #define __DRI_IMAGE_FORMAT_XRGB8888     0x1002
1018 #define __DRI_IMAGE_FORMAT_ARGB8888     0x1003
1019 #define __DRI_IMAGE_FORMAT_ABGR8888     0x1004
1020 #define __DRI_IMAGE_FORMAT_XBGR8888     0x1005
1021 #define __DRI_IMAGE_FORMAT_R8           0x1006 /* Since version 5 */
1022 #define __DRI_IMAGE_FORMAT_GR88         0x1007
1023 #define __DRI_IMAGE_FORMAT_NONE         0x1008
1024 #define __DRI_IMAGE_FORMAT_XRGB2101010  0x1009
1025 #define __DRI_IMAGE_FORMAT_ARGB2101010  0x100a
1026 #define __DRI_IMAGE_FORMAT_SARGB8       0x100b
1027
1028 #define __DRI_IMAGE_USE_SHARE           0x0001
1029 #define __DRI_IMAGE_USE_SCANOUT         0x0002
1030 #define __DRI_IMAGE_USE_CURSOR          0x0004 /* Depricated */
1031 #define __DRI_IMAGE_USE_LINEAR          0x0008
1032
1033
1034 /**
1035  * Four CC formats that matches with WL_DRM_FORMAT_* from wayland_drm.h
1036  * and GBM_FORMAT_* from gbm.h, used with createImageFromNames.
1037  *
1038  * \since 5
1039  */
1040
1041 #define __DRI_IMAGE_FOURCC_RGB565       0x36314752
1042 #define __DRI_IMAGE_FOURCC_ARGB8888     0x34325241
1043 #define __DRI_IMAGE_FOURCC_XRGB8888     0x34325258
1044 #define __DRI_IMAGE_FOURCC_ABGR8888     0x34324241
1045 #define __DRI_IMAGE_FOURCC_XBGR8888     0x34324258
1046 #define __DRI_IMAGE_FOURCC_SARGB8888    0x83324258
1047 #define __DRI_IMAGE_FOURCC_YUV410       0x39565559
1048 #define __DRI_IMAGE_FOURCC_YUV411       0x31315559
1049 #define __DRI_IMAGE_FOURCC_YUV420       0x32315559
1050 #define __DRI_IMAGE_FOURCC_YUV422       0x36315559
1051 #define __DRI_IMAGE_FOURCC_YUV444       0x34325559
1052 #define __DRI_IMAGE_FOURCC_NV12         0x3231564e
1053 #define __DRI_IMAGE_FOURCC_NV16         0x3631564e
1054 #define __DRI_IMAGE_FOURCC_YUYV         0x56595559
1055
1056
1057 /**
1058  * Queryable on images created by createImageFromNames.
1059  *
1060  * RGB and RGBA are may be usable directly as images but its still
1061  * recommended to call fromPlanar with plane == 0.
1062  *
1063  * Y_U_V, Y_UV and Y_XUXV all requires call to fromPlanar to create
1064  * usable sub-images, sampling from images return raw YUV data and
1065  * color conversion needs to be done in the shader.
1066  *
1067  * \since 5
1068  */
1069
1070 #define __DRI_IMAGE_COMPONENTS_RGB      0x3001
1071 #define __DRI_IMAGE_COMPONENTS_RGBA     0x3002
1072 #define __DRI_IMAGE_COMPONENTS_Y_U_V    0x3003
1073 #define __DRI_IMAGE_COMPONENTS_Y_UV     0x3004
1074 #define __DRI_IMAGE_COMPONENTS_Y_XUXV   0x3005
1075
1076
1077 /**
1078  * queryImage attributes
1079  */
1080
1081 #define __DRI_IMAGE_ATTRIB_STRIDE       0x2000
1082 #define __DRI_IMAGE_ATTRIB_HANDLE       0x2001
1083 #define __DRI_IMAGE_ATTRIB_NAME         0x2002
1084 #define __DRI_IMAGE_ATTRIB_FORMAT       0x2003 /* available in versions 3+ */
1085 #define __DRI_IMAGE_ATTRIB_WIDTH        0x2004 /* available in versions 4+ */
1086 #define __DRI_IMAGE_ATTRIB_HEIGHT       0x2005
1087 #define __DRI_IMAGE_ATTRIB_COMPONENTS   0x2006 /* available in versions 5+ */
1088 #define __DRI_IMAGE_ATTRIB_FD           0x2007 /* available in versions
1089                                                 * 7+. Each query will return a
1090                                                 * new fd. */
1091
1092 enum __DRIYUVColorSpace {
1093    __DRI_YUV_COLOR_SPACE_UNDEFINED = 0,
1094    __DRI_YUV_COLOR_SPACE_ITU_REC601 = 0x327F,
1095    __DRI_YUV_COLOR_SPACE_ITU_REC709 = 0x3280,
1096    __DRI_YUV_COLOR_SPACE_ITU_REC2020 = 0x3281
1097 };
1098
1099 enum __DRISampleRange {
1100    __DRI_YUV_RANGE_UNDEFINED = 0,
1101    __DRI_YUV_FULL_RANGE = 0x3282,
1102    __DRI_YUV_NARROW_RANGE = 0x3283
1103 };
1104
1105 enum __DRIChromaSiting {
1106    __DRI_YUV_CHROMA_SITING_UNDEFINED = 0,
1107    __DRI_YUV_CHROMA_SITING_0 = 0x3284,
1108    __DRI_YUV_CHROMA_SITING_0_5 = 0x3285
1109 };
1110
1111 /**
1112  * \name Reasons that __DRIimageExtensionRec::createImageFromTexture might fail
1113  */
1114 /*@{*/
1115 /** Success! */
1116 #define __DRI_IMAGE_ERROR_SUCCESS       0
1117
1118 /** Memory allocation failure */
1119 #define __DRI_IMAGE_ERROR_BAD_ALLOC     1
1120
1121 /** Client requested an invalid attribute for a texture object  */
1122 #define __DRI_IMAGE_ERROR_BAD_MATCH     2
1123
1124 /** Client requested an invalid texture object */
1125 #define __DRI_IMAGE_ERROR_BAD_PARAMETER 3
1126 /*@}*/
1127
1128 typedef struct __DRIimageRec          __DRIimage;
1129 typedef struct __DRIimageExtensionRec __DRIimageExtension;
1130 struct __DRIimageExtensionRec {
1131     __DRIextension base;
1132
1133     __DRIimage *(*createImageFromName)(__DRIscreen *screen,
1134                                        int width, int height, int format,
1135                                        int name, int pitch,
1136                                        void *loaderPrivate);
1137
1138     __DRIimage *(*createImageFromRenderbuffer)(__DRIcontext *context,
1139                                                int renderbuffer,
1140                                                void *loaderPrivate);
1141
1142     void (*destroyImage)(__DRIimage *image);
1143
1144     __DRIimage *(*createImage)(__DRIscreen *screen,
1145                                int width, int height, int format,
1146                                unsigned int use,
1147                                void *loaderPrivate);
1148
1149    GLboolean (*queryImage)(__DRIimage *image, int attrib, int *value);
1150
1151    /**
1152     * The new __DRIimage will share the content with the old one, see dup(2).
1153     */
1154    __DRIimage *(*dupImage)(__DRIimage *image, void *loaderPrivate);
1155
1156    /**
1157     * Validate that a __DRIimage can be used a certain way.
1158     *
1159     * \since 2
1160     */
1161    GLboolean (*validateUsage)(__DRIimage *image, unsigned int use);
1162
1163    /**
1164     * Unlike createImageFromName __DRI_IMAGE_FORMAT is not but instead
1165     * __DRI_IMAGE_FOURCC and strides are in bytes not pixels. Stride is
1166     * also per block and not per pixel (for non-RGB, see gallium blocks).
1167     *
1168     * \since 5
1169     */
1170    __DRIimage *(*createImageFromNames)(__DRIscreen *screen,
1171                                        int width, int height, int fourcc,
1172                                        int *names, int num_names,
1173                                        int *strides, int *offsets,
1174                                        void *loaderPrivate);
1175
1176    /**
1177     * Create an image out of a sub-region of a parent image.  This
1178     * entry point lets us create individual __DRIimages for different
1179     * planes in a planar buffer (typically yuv), for example.  While a
1180     * sub-image shares the underlying buffer object with the parent
1181     * image and other sibling sub-images, the life times of parent and
1182     * sub-images are not dependent.  Destroying the parent or a
1183     * sub-image doesn't affect other images.  The underlying buffer
1184     * object is free when no __DRIimage remains that references it.
1185     *
1186     * Sub-images may overlap, but rendering to overlapping sub-images
1187     * is undefined.
1188     *
1189     * \since 5
1190     */
1191     __DRIimage *(*fromPlanar)(__DRIimage *image, int plane,
1192                               void *loaderPrivate);
1193
1194     /**
1195      * Create image from texture.
1196      *
1197      * \since 6
1198      */
1199    __DRIimage *(*createImageFromTexture)(__DRIcontext *context,
1200                                          int target,
1201                                          unsigned texture,
1202                                          int depth,
1203                                          int level,
1204                                          unsigned *error,
1205                                          void *loaderPrivate);
1206    /**
1207     * Like createImageFromNames, but takes a prime fd instead.
1208     *
1209     * \since 7
1210     */
1211    __DRIimage *(*createImageFromFds)(__DRIscreen *screen,
1212                                      int width, int height, int fourcc,
1213                                      int *fds, int num_fds,
1214                                      int *strides, int *offsets,
1215                                      void *loaderPrivate);
1216
1217    /**
1218     * Like createImageFromFds, but takes additional attributes.
1219     *
1220     * For EGL_EXT_image_dma_buf_import.
1221     *
1222     * \since 8
1223     */
1224    __DRIimage *(*createImageFromDmaBufs)(__DRIscreen *screen,
1225                                          int width, int height, int fourcc,
1226                                          int *fds, int num_fds,
1227                                          int *strides, int *offsets,
1228                                          enum __DRIYUVColorSpace color_space,
1229                                          enum __DRISampleRange sample_range,
1230                                          enum __DRIChromaSiting horiz_siting,
1231                                          enum __DRIChromaSiting vert_siting,
1232                                          unsigned *error,
1233                                          void *loaderPrivate);
1234 };
1235
1236
1237 /**
1238  * This extension must be implemented by the loader and passed to the
1239  * driver at screen creation time.  The EGLImage entry points in the
1240  * various client APIs take opaque EGLImage handles and use this
1241  * extension to map them to a __DRIimage.  At version 1, this
1242  * extensions allows mapping EGLImage pointers to __DRIimage pointers,
1243  * but future versions could support other EGLImage-like, opaque types
1244  * with new lookup functions.
1245  */
1246 #define __DRI_IMAGE_LOOKUP "DRI_IMAGE_LOOKUP"
1247 #define __DRI_IMAGE_LOOKUP_VERSION 1
1248
1249 typedef struct __DRIimageLookupExtensionRec __DRIimageLookupExtension;
1250 struct __DRIimageLookupExtensionRec {
1251     __DRIextension base;
1252
1253     __DRIimage *(*lookupEGLImage)(__DRIscreen *screen, void *image,
1254                                   void *loaderPrivate);
1255 };
1256
1257 /**
1258  * This extension allows for common DRI2 options
1259  */
1260 #define __DRI2_CONFIG_QUERY "DRI_CONFIG_QUERY"
1261 #define __DRI2_CONFIG_QUERY_VERSION 1
1262
1263 typedef struct __DRI2configQueryExtensionRec __DRI2configQueryExtension;
1264 struct __DRI2configQueryExtensionRec {
1265    __DRIextension base;
1266
1267    int (*configQueryb)(__DRIscreen *screen, const char *var, GLboolean *val);
1268    int (*configQueryi)(__DRIscreen *screen, const char *var, GLint *val);
1269    int (*configQueryf)(__DRIscreen *screen, const char *var, GLfloat *val);
1270 };
1271
1272 /**
1273  * Robust context driver extension.
1274  *
1275  * Existence of this extension means the driver can accept the
1276  * \c __DRI_CTX_FLAG_ROBUST_BUFFER_ACCESS flag and the
1277  * \c __DRI_CTX_ATTRIB_RESET_STRATEGY attribute in
1278  * \c __DRIdri2ExtensionRec::createContextAttribs.
1279  */
1280 #define __DRI2_ROBUSTNESS "DRI_Robustness"
1281 #define __DRI2_ROBUSTNESS_VERSION 1
1282
1283 typedef struct __DRIrobustnessExtensionRec __DRIrobustnessExtension;
1284 struct __DRIrobustnessExtensionRec {
1285    __DRIextension base;
1286 };
1287
1288 /**
1289  * DRI config options extension.
1290  *
1291  * This extension provides the XML string containing driver options for use by
1292  * the loader in supporting the driconf application.
1293  */
1294 #define __DRI_CONFIG_OPTIONS "DRI_ConfigOptions"
1295 #define __DRI_CONFIG_OPTIONS_VERSION 1
1296
1297 typedef struct __DRIconfigOptionsExtensionRec {
1298    __DRIextension base;
1299    const char *xml;
1300 } __DRIconfigOptionsExtension;
1301
1302 /**
1303  * This extension provides a driver vtable to a set of common driver helper
1304  * functions (driCoreExtension, driDRI2Extension) within the driver
1305  * implementation, as opposed to having to pass them through a global
1306  * variable.
1307  *
1308  * It is not intended to be public API to the actual loader, and the vtable
1309  * layout may change at any time.
1310  */
1311 #define __DRI_DRIVER_VTABLE "DRI_DriverVtable"
1312 #define __DRI_DRIVER_VTABLE_VERSION 1
1313
1314 typedef struct __DRIDriverVtableExtensionRec {
1315     __DRIextension base;
1316     const struct __DriverAPIRec *vtable;
1317 } __DRIDriverVtableExtension;
1318
1319 /**
1320  * Query renderer driver extension
1321  *
1322  * This allows the window system layer (either EGL or GLX) to query aspects of
1323  * hardware and driver support without creating a context.
1324  */
1325 #define __DRI2_RENDERER_QUERY "DRI_RENDERER_QUERY"
1326 #define __DRI2_RENDERER_QUERY_VERSION 1
1327
1328 #define __DRI2_RENDERER_VENDOR_ID                             0x0000
1329 #define __DRI2_RENDERER_DEVICE_ID                             0x0001
1330 #define __DRI2_RENDERER_VERSION                               0x0002
1331 #define __DRI2_RENDERER_ACCELERATED                           0x0003
1332 #define __DRI2_RENDERER_VIDEO_MEMORY                          0x0004
1333 #define __DRI2_RENDERER_UNIFIED_MEMORY_ARCHITECTURE           0x0005
1334 #define __DRI2_RENDERER_PREFERRED_PROFILE                     0x0006
1335 #define __DRI2_RENDERER_OPENGL_CORE_PROFILE_VERSION           0x0007
1336 #define __DRI2_RENDERER_OPENGL_COMPATIBILITY_PROFILE_VERSION  0x0008
1337 #define __DRI2_RENDERER_OPENGL_ES_PROFILE_VERSION             0x0009
1338 #define __DRI2_RENDERER_OPENGL_ES2_PROFILE_VERSION            0x000a
1339
1340 typedef struct __DRI2rendererQueryExtensionRec __DRI2rendererQueryExtension;
1341 struct __DRI2rendererQueryExtensionRec {
1342    __DRIextension base;
1343
1344    int (*queryInteger)(__DRIscreen *screen, int attribute, unsigned int *val);
1345    int (*queryString)(__DRIscreen *screen, int attribute, const char **val);
1346 };
1347
1348 /**
1349  * Image Loader extension. Drivers use this to allocate color buffers
1350  */
1351
1352 enum __DRIimageBufferMask {
1353    __DRI_IMAGE_BUFFER_BACK = (1 << 0),
1354    __DRI_IMAGE_BUFFER_FRONT = (1 << 1)
1355 };
1356
1357 struct __DRIimageList {
1358    uint32_t image_mask;
1359    __DRIimage *back;
1360    __DRIimage *front;
1361 };
1362
1363 #define __DRI_IMAGE_LOADER "DRI_IMAGE_LOADER"
1364 #define __DRI_IMAGE_LOADER_VERSION 1
1365
1366 struct __DRIimageLoaderExtensionRec {
1367     __DRIextension base;
1368
1369    /**
1370     * Allocate color buffers.
1371     *
1372     * \param driDrawable
1373     * \param width              Width of allocated buffers
1374     * \param height             Height of allocated buffers
1375     * \param format             one of __DRI_IMAGE_FORMAT_*
1376     * \param stamp              Address of variable to be updated when
1377     *                           getBuffers must be called again
1378     * \param loaderPrivate      The loaderPrivate for driDrawable
1379     * \param buffer_mask        Set of buffers to allocate
1380     * \param buffers            Returned buffers
1381     */
1382    int (*getBuffers)(__DRIdrawable *driDrawable,
1383                      unsigned int format,
1384                      uint32_t *stamp,
1385                      void *loaderPrivate,
1386                      uint32_t buffer_mask,
1387                      struct __DRIimageList *buffers);
1388
1389     /**
1390      * Flush pending front-buffer rendering
1391      *
1392      * Any rendering that has been performed to the
1393      * fake front will be flushed to the front
1394      *
1395      * \param driDrawable    Drawable whose front-buffer is to be flushed
1396      * \param loaderPrivate  Loader's private data that was previously passed
1397      *                       into __DRIdri2ExtensionRec::createNewDrawable
1398      */
1399     void (*flushFrontBuffer)(__DRIdrawable *driDrawable, void *loaderPrivate);
1400 };
1401
1402 /**
1403  * DRI extension.
1404  */
1405
1406 #define __DRI_IMAGE_DRIVER           "DRI_IMAGE_DRIVER"
1407 #define __DRI_IMAGE_DRIVER_VERSION   1
1408
1409 struct __DRIimageDriverExtensionRec {
1410    __DRIextension               base;
1411
1412    /* Common DRI functions, shared with DRI2 */
1413    __DRIcreateNewScreen2Func            createNewScreen2;
1414    __DRIcreateNewDrawableFunc           createNewDrawable;
1415    __DRIcreateContextAttribsFunc        createContextAttribs;
1416    __DRIgetAPIMaskFunc                  getAPIMask;
1417 };
1418
1419 #endif