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 #ifdef HAVE_LIBDRM
  44 #include <drm.h>
  45 #else
  46 typedef unsigned int drm_context_t;
  47 typedef unsigned int drm_drawable_t;
  48 typedef struct drm_clip_rect drm_clip_rect_t;
  49 #endif
  50
  51 #include <stdint.h>
  52
  53 /**
  54  * \name DRI interface structures
  55  *
  56  * The following structures define the interface between the GLX client
  57  * side library and the DRI (direct rendering infrastructure).
  58  */
  59 /*@{*/
  60 typedef struct __DRIdisplayRec          __DRIdisplay;
  61 typedef struct __DRIscreenRec           __DRIscreen;
  62 typedef struct __DRIcontextRec          __DRIcontext;
  63 typedef struct __DRIdrawableRec         __DRIdrawable;
  64 typedef struct __DRIconfigRec           __DRIconfig;
  65 typedef struct __DRIframebufferRec      __DRIframebuffer;
  66 typedef struct __DRIversionRec          __DRIversion;
  67
  68 typedef struct __DRIcoreExtensionRec            __DRIcoreExtension;
  69 typedef struct __DRIextensionRec                __DRIextension;
  70 typedef struct __DRIcopySubBufferExtensionRec   __DRIcopySubBufferExtension;
  71 typedef struct __DRIswapControlExtensionRec     __DRIswapControlExtension;
  72 typedef struct __DRIframeTrackingExtensionRec   __DRIframeTrackingExtension;
  73 typedef struct __DRImediaStreamCounterExtensionRec      __DRImediaStreamCounterExtension;
  74 typedef struct __DRItexOffsetExtensionRec       __DRItexOffsetExtension;
  75 typedef struct __DRItexBufferExtensionRec       __DRItexBufferExtension;
  76 typedef struct __DRIlegacyExtensionRec          __DRIlegacyExtension;
  77 typedef struct __DRIswrastExtensionRec          __DRIswrastExtension;
  78 typedef struct __DRIbufferRec                   __DRIbuffer;
  79 typedef struct __DRIdri2ExtensionRec            __DRIdri2Extension;
  80 typedef struct __DRIdri2LoaderExtensionRec      __DRIdri2LoaderExtension;
  81 typedef struct __DRI2flushExtensionRec  __DRI2flushExtension;
  82 typedef struct __DRI2throttleExtensionRec       __DRI2throttleExtension;
  83 typedef struct __DRI2fenceExtensionRec          __DRI2fenceExtension;
  84 typedef struct __DRI2interopExtensionRec        __DRI2interopExtension;
  85 typedef struct __DRI2blobExtensionRec           __DRI2blobExtension;
  86
  87 typedef struct __DRIimageLoaderExtensionRec     __DRIimageLoaderExtension;
  88 typedef struct __DRIimageDriverExtensionRec     __DRIimageDriverExtension;
  89
  90 /*@}*/
  91
  92
  93 /**
  94  * Extension struct.  Drivers 'inherit' from this struct by embedding
  95  * it as the first element in the extension struct.
  96  *
  97  * We never break API in for a DRI extension.  If we need to change
  98  * the way things work in a non-backwards compatible manner, we
  99  * introduce a new extension.  During a transition period, we can
 100  * leave both the old and the new extension in the driver, which
 101  * allows us to move to the new interface without having to update the
 102  * loader(s) in lock step.
 103  *
 104  * However, we can add entry points to an extension over time as long
 105  * as we don't break the old ones.  As we add entry points to an
 106  * extension, we increase the version number.  The corresponding
 107  * #define can be used to guard code that accesses the new entry
 108  * points at compile time and the version field in the extension
 109  * struct can be used at run-time to determine how to use the
 110  * extension.
 111  */
 112 struct __DRIextensionRec {
 113     const char *name;
 114     int version;
 115 };
 116
 117 /**
 118  * The first set of extension are the screen extensions, returned by
 119  * __DRIcore::getExtensions().  This entry point will return a list of
 120  * extensions and the loader can use the ones it knows about by
 121  * casting them to more specific extensions and advertising any GLX
 122  * extensions the DRI extensions enables.
 123  */
 124
 125 /**
 126  * Used by drivers to indicate support for setting the read drawable.
 127  */
 128 #define __DRI_READ_DRAWABLE "DRI_ReadDrawable"
 129 #define __DRI_READ_DRAWABLE_VERSION 1
 130
 131 /**
 132  * Used by drivers that implement the GLX_MESA_copy_sub_buffer extension.
 133  */
 134 #define __DRI_COPY_SUB_BUFFER "DRI_CopySubBuffer"
 135 #define __DRI_COPY_SUB_BUFFER_VERSION 1
 136 struct __DRIcopySubBufferExtensionRec {
 137     __DRIextension base;
 138     void (*copySubBuffer)(__DRIdrawable *drawable, int x, int y, int w, int h);
 139 };
 140
 141 /**
 142  * Used by drivers that implement the GLX_SGI_swap_control or
 143  * GLX_MESA_swap_control extension.
 144  */
 145 #define __DRI_SWAP_CONTROL "DRI_SwapControl"
 146 #define __DRI_SWAP_CONTROL_VERSION 1
 147 struct __DRIswapControlExtensionRec {
 148     __DRIextension base;
 149     void (*setSwapInterval)(__DRIdrawable *drawable, unsigned int inteval);
 150     unsigned int (*getSwapInterval)(__DRIdrawable *drawable);
 151 };
 152
 153 /**
 154  * Used by drivers that implement the GLX_MESA_swap_frame_usage extension.
 155  */
 156 #define __DRI_FRAME_TRACKING "DRI_FrameTracking"
 157 #define __DRI_FRAME_TRACKING_VERSION 1
 158 struct __DRIframeTrackingExtensionRec {
 159     __DRIextension base;
 160
 161     /**
 162      * Enable or disable frame usage tracking.
 163      *
 164      * \since Internal API version 20030317.
 165      */
 166     int (*frameTracking)(__DRIdrawable *drawable, GLboolean enable);
 167
 168     /**
 169      * Retrieve frame usage information.
 170      *
 171      * \since Internal API version 20030317.
 172      */
 173     int (*queryFrameTracking)(__DRIdrawable *drawable,
 174                               int64_t * sbc, int64_t * missedFrames,
 175                               float * lastMissedUsage, float * usage);
 176 };
 177
 178
 179 /**
 180  * Used by drivers that implement the GLX_SGI_video_sync extension.
 181  */
 182 #define __DRI_MEDIA_STREAM_COUNTER "DRI_MediaStreamCounter"
 183 #define __DRI_MEDIA_STREAM_COUNTER_VERSION 1
 184 struct __DRImediaStreamCounterExtensionRec {
 185     __DRIextension base;
 186
 187     /**
 188      * Wait for the MSC to equal target_msc, or, if that has already passed,
 189      * the next time (MSC % divisor) is equal to remainder.  If divisor is
 190      * zero, the function will return as soon as MSC is greater than or equal
 191      * to target_msc.
 192      */
 193     int (*waitForMSC)(__DRIdrawable *drawable,
 194                       int64_t target_msc, int64_t divisor, int64_t remainder,
 195                       int64_t * msc, int64_t * sbc);
 196
 197     /**
 198      * Get the number of vertical refreshes since some point in time before
 199      * this function was first called (i.e., system start up).
 200      */
 201     int (*getDrawableMSC)(__DRIscreen *screen, __DRIdrawable *drawable,
 202                           int64_t *msc);
 203 };
 204
 205
 206 #define __DRI_TEX_OFFSET "DRI_TexOffset"
 207 #define __DRI_TEX_OFFSET_VERSION 1
 208 struct __DRItexOffsetExtensionRec {
 209     __DRIextension base;
 210
 211     /**
 212      * Method to override base texture image with a driver specific 'offset'.
 213      * The depth passed in allows e.g. to ignore the alpha channel of texture
 214      * images where the non-alpha components don't occupy a whole texel.
 215      *
 216      * For GLX_EXT_texture_from_pixmap with AIGLX.
 217      */
 218     void (*setTexOffset)(__DRIcontext *pDRICtx, GLint texname,
 219                          unsigned long long offset, GLint depth, GLuint pitch);
 220 };
 221
 222
 223 /* Valid values for format in the setTexBuffer2 function below.  These
 224  * values match the GLX tokens for compatibility reasons, but we
 225  * define them here since the DRI interface can't depend on GLX. */
 226 #define __DRI_TEXTURE_FORMAT_NONE        0x20D8
 227 #define __DRI_TEXTURE_FORMAT_RGB         0x20D9
 228 #define __DRI_TEXTURE_FORMAT_RGBA        0x20DA
 229
 230 #define __DRI_TEX_BUFFER "DRI_TexBuffer"
 231 #define __DRI_TEX_BUFFER_VERSION 3
 232 struct __DRItexBufferExtensionRec {
 233     __DRIextension base;
 234
 235     /**
 236      * Method to override base texture image with the contents of a
 237      * __DRIdrawable.
 238      *
 239      * For GLX_EXT_texture_from_pixmap with AIGLX.  Deprecated in favor of
 240      * setTexBuffer2 in version 2 of this interface
 241      */
 242     void (*setTexBuffer)(__DRIcontext *pDRICtx,
 243                          GLint target,
 244                          __DRIdrawable *pDraw);
 245
 246     /**
 247      * Method to override base texture image with the contents of a
 248      * __DRIdrawable, including the required texture format attribute.
 249      *
 250      * For GLX_EXT_texture_from_pixmap with AIGLX.
 251      *
 252      * \since 2
 253      */
 254     void (*setTexBuffer2)(__DRIcontext *pDRICtx,
 255                           GLint target,
 256                           GLint format,
 257                           __DRIdrawable *pDraw);
 258     /**
 259      * Method to release texture buffer in case some special platform
 260      * need this.
 261      *
 262      * For GLX_EXT_texture_from_pixmap with AIGLX.
 263      *
 264      * \since 3
 265      */
 266     void (*releaseTexBuffer)(__DRIcontext *pDRICtx,
 267                         GLint target,
 268                         __DRIdrawable *pDraw);
 269 };
 270
 271 /**
 272  * Used by drivers that implement DRI2
 273  */
 274 #define __DRI2_FLUSH "DRI2_Flush"
 275 #define __DRI2_FLUSH_VERSION 4
 276
 277 #define __DRI2_FLUSH_DRAWABLE (1 << 0) /* the drawable should be flushed. */
 278 #define __DRI2_FLUSH_CONTEXT  (1 << 1) /* glFlush should be called */
 279 #define __DRI2_FLUSH_INVALIDATE_ANCILLARY (1 << 2)
 280
 281 enum __DRI2throttleReason {
 282    __DRI2_THROTTLE_SWAPBUFFER,
 283    __DRI2_THROTTLE_COPYSUBBUFFER,
 284    __DRI2_THROTTLE_FLUSHFRONT
 285 };
 286
 287 struct __DRI2flushExtensionRec {
 288     __DRIextension base;
 289     void (*flush)(__DRIdrawable *drawable);
 290
 291     /**
 292      * Ask the driver to call getBuffers/getBuffersWithFormat before
 293      * it starts rendering again.
 294      *
 295      * \param drawable the drawable to invalidate
 296      *
 297      * \since 3
 298      */
 299     void (*invalidate)(__DRIdrawable *drawable);
 300
 301     /**
 302      * This function reduces the number of flushes in the driver by combining
 303      * several operations into one call.
 304      *
 305      * It can:
 306      * - throttle
 307      * - flush a drawable
 308      * - flush a context
 309      *
 310      * \param context           the context
 311      * \param drawable          the drawable to flush
 312      * \param flags             a combination of _DRI2_FLUSH_xxx flags
 313      * \param throttle_reason   the reason for throttling, 0 = no throttling
 314      *
 315      * \since 4
 316      */
 317     void (*flush_with_flags)(__DRIcontext *ctx,
 318                              __DRIdrawable *drawable,
 319                              unsigned flags,
 320                              enum __DRI2throttleReason throttle_reason);
 321 };
 322
 323
 324 /**
 325  * Extension that the driver uses to request
 326  * throttle callbacks.
 327  */
 328
 329 #define __DRI2_THROTTLE "DRI2_Throttle"
 330 #define __DRI2_THROTTLE_VERSION 1
 331
 332 struct __DRI2throttleExtensionRec {
 333    __DRIextension base;
 334    void (*throttle)(__DRIcontext *ctx,
 335                     __DRIdrawable *drawable,
 336                     enum __DRI2throttleReason reason);
 337 };
 338
 339 /**
 340  * Extension for EGL_ANDROID_blob_cache
 341  */
 342
 343 #define __DRI2_BLOB "DRI2_Blob"
 344 #define __DRI2_BLOB_VERSION 1
 345
 346 typedef void
 347 (*__DRIblobCacheSet) (const void *key, signed long keySize,
 348                       const void *value, signed long valueSize);
 349
 350 typedef signed long
 351 (*__DRIblobCacheGet) (const void *key, signed long keySize,
 352                       void *value, signed long valueSize);
 353
 354 struct __DRI2blobExtensionRec {
 355    __DRIextension base;
 356
 357    /**
 358     * Set cache functions for setting and getting cache entries.
 359     */
 360    void (*set_cache_funcs) (__DRIscreen *screen,
 361                             __DRIblobCacheSet set, __DRIblobCacheGet get);
 362 };
 363
 364 /**
 365  * Extension for fences / synchronization objects.
 366  */
 367
 368 #define __DRI2_FENCE "DRI2_Fence"
 369 #define __DRI2_FENCE_VERSION 2
 370
 371 #define __DRI2_FENCE_TIMEOUT_INFINITE     0xffffffffffffffffull
 372
 373 #define __DRI2_FENCE_FLAG_FLUSH_COMMANDS  (1 << 0)
 374
 375 /**
 376  * \name Capabilities that might be returned by __DRI2fenceExtensionRec::get_capabilities
 377  */
 378 /*@{*/
 379 #define __DRI_FENCE_CAP_NATIVE_FD 1
 380 /*@}*/
 381
 382 struct __DRI2fenceExtensionRec {
 383    __DRIextension base;
 384
 385    /**
 386     * Create and insert a fence into the command stream of the context.
 387     */
 388    void *(*create_fence)(__DRIcontext *ctx);
 389
 390    /**
 391     * Get a fence associated with the OpenCL event object.
 392     * This can be NULL, meaning that OpenCL interoperability is not supported.
 393     */
 394    void *(*get_fence_from_cl_event)(__DRIscreen *screen, intptr_t cl_event);
 395
 396    /**
 397     * Destroy a fence.
 398     */
 399    void (*destroy_fence)(__DRIscreen *screen, void *fence);
 400
 401    /**
 402     * This function waits and doesn't return until the fence is signalled
 403     * or the timeout expires. It returns true if the fence has been signaled.
 404     *
 405     * \param ctx     the context where commands are flushed
 406     * \param fence   the fence
 407     * \param flags   a combination of __DRI2_FENCE_FLAG_xxx flags
 408     * \param timeout the timeout in ns or __DRI2_FENCE_TIMEOUT_INFINITE
 409     */
 410    GLboolean (*client_wait_sync)(__DRIcontext *ctx, void *fence,
 411                                  unsigned flags, uint64_t timeout);
 412
 413    /**
 414     * This function enqueues a wait command into the command stream of
 415     * the context and then returns. When the execution reaches the wait
 416     * command, no further execution will be done in the context until
 417     * the fence is signaled. This is a no-op if the device doesn't support
 418     * parallel execution of contexts.
 419     *
 420     * \param ctx     the context where the waiting is done
 421     * \param fence   the fence
 422     * \param flags   a combination of __DRI2_FENCE_FLAG_xxx flags that make
 423     *                sense with this function (right now there are none)
 424     */
 425    void (*server_wait_sync)(__DRIcontext *ctx, void *fence, unsigned flags);
 426
 427    /**
 428     * Query for general capabilities of the driver that concern fences.
 429     * Returns a bitmask of __DRI_FENCE_CAP_x
 430     *
 431     * \since 2
 432     */
 433    unsigned (*get_capabilities)(__DRIscreen *screen);
 434
 435    /**
 436     * Create an fd (file descriptor) associated fence.  If the fence fd
 437     * is -1, this behaves similarly to create_fence() except that when
 438     * rendering is flushed the driver creates a fence fd.  Otherwise,
 439     * the driver wraps an existing fence fd.
 440     *
 441     * This is used to implement the EGL_ANDROID_native_fence_sync extension.
 442     *
 443     * \since 2
 444     *
 445     * \param ctx     the context associated with the fence
 446     * \param fd      the fence fd or -1
 447     */
 448    void *(*create_fence_fd)(__DRIcontext *ctx, int fd);
 449
 450    /**
 451     * For fences created with create_fence_fd(), after rendering is flushed,
 452     * this retrieves the native fence fd.  Caller takes ownership of the
 453     * fd and will close() it when it is no longer needed.
 454     *
 455     * \since 2
 456     *
 457     * \param screen  the screen associated with the fence
 458     * \param fence   the fence
 459     */
 460    int (*get_fence_fd)(__DRIscreen *screen, void *fence);
 461 };
 462
 463
 464 /**
 465  * Extension for API interop.
 466  * See GL/mesa_glinterop.h.
 467  */
 468
 469 #define __DRI2_INTEROP "DRI2_Interop"
 470 #define __DRI2_INTEROP_VERSION 1
 471
 472 struct mesa_glinterop_device_info;
 473 struct mesa_glinterop_export_in;
 474 struct mesa_glinterop_export_out;
 475
 476 struct __DRI2interopExtensionRec {
 477    __DRIextension base;
 478
 479    /** Same as MesaGLInterop*QueryDeviceInfo. */
 480    int (*query_device_info)(__DRIcontext *ctx,
 481                             struct mesa_glinterop_device_info *out);
 482
 483    /** Same as MesaGLInterop*ExportObject. */
 484    int (*export_object)(__DRIcontext *ctx,
 485                         struct mesa_glinterop_export_in *in,
 486                         struct mesa_glinterop_export_out *out);
 487 };
 488
 489 /*@}*/
 490
 491 /**
 492  * The following extensions describe loader features that the DRI
 493  * driver can make use of.  Some of these are mandatory, such as the
 494  * getDrawableInfo extension for DRI and the DRI Loader extensions for
 495  * DRI2, while others are optional, and if present allow the driver to
 496  * expose certain features.  The loader pass in a NULL terminated
 497  * array of these extensions to the driver in the createNewScreen
 498  * constructor.
 499  */
 500
 501 typedef struct __DRIgetDrawableInfoExtensionRec __DRIgetDrawableInfoExtension;
 502 typedef struct __DRIsystemTimeExtensionRec __DRIsystemTimeExtension;
 503 typedef struct __DRIdamageExtensionRec __DRIdamageExtension;
 504 typedef struct __DRIloaderExtensionRec __DRIloaderExtension;
 505 typedef struct __DRIswrastLoaderExtensionRec __DRIswrastLoaderExtension;
 506
 507
 508 /**
 509  * Callback to getDrawableInfo protocol
 510  */
 511 #define __DRI_GET_DRAWABLE_INFO "DRI_GetDrawableInfo"
 512 #define __DRI_GET_DRAWABLE_INFO_VERSION 1
 513 struct __DRIgetDrawableInfoExtensionRec {
 514     __DRIextension base;
 515
 516     /**
 517      * This function is used to get information about the position, size, and
 518      * clip rects of a drawable.
 519      */
 520     GLboolean (* getDrawableInfo) ( __DRIdrawable *drawable,
 521         unsigned int * index, unsigned int * stamp,
 522         int * x, int * y, int * width, int * height,
 523         int * numClipRects, drm_clip_rect_t ** pClipRects,
 524         int * backX, int * backY,
 525         int * numBackClipRects, drm_clip_rect_t ** pBackClipRects,
 526         void *loaderPrivate);
 527 };
 528
 529 /**
 530  * Callback to get system time for media stream counter extensions.
 531  */
 532 #define __DRI_SYSTEM_TIME "DRI_SystemTime"
 533 #define __DRI_SYSTEM_TIME_VERSION 1
 534 struct __DRIsystemTimeExtensionRec {
 535     __DRIextension base;
 536
 537     /**
 538      * Get the 64-bit unadjusted system time (UST).
 539      */
 540     int (*getUST)(int64_t * ust);
 541
 542     /**
 543      * Get the media stream counter (MSC) rate.
 544      *
 545      * Matching the definition in GLX_OML_sync_control, this function returns
 546      * the rate of the "media stream counter".  In practical terms, this is
 547      * the frame refresh rate of the display.
 548      */
 549     GLboolean (*getMSCRate)(__DRIdrawable *draw,
 550                             int32_t * numerator, int32_t * denominator,
 551                             void *loaderPrivate);
 552 };
 553
 554 /**
 555  * Damage reporting
 556  */
 557 #define __DRI_DAMAGE "DRI_Damage"
 558 #define __DRI_DAMAGE_VERSION 1
 559 struct __DRIdamageExtensionRec {
 560     __DRIextension base;
 561
 562     /**
 563      * Reports areas of the given drawable which have been modified by the
 564      * driver.
 565      *
 566      * \param drawable which the drawing was done to.
 567      * \param rects rectangles affected, with the drawable origin as the
 568      *        origin.
 569      * \param x X offset of the drawable within the screen (used in the
 570      *        front_buffer case)
 571      * \param y Y offset of the drawable within the screen.
 572      * \param front_buffer boolean flag for whether the drawing to the
 573      *        drawable was actually done directly to the front buffer (instead
 574      *        of backing storage, for example)
 575      * \param loaderPrivate the data passed in at createNewDrawable time
 576      */
 577     void (*reportDamage)(__DRIdrawable *draw,
 578                          int x, int y,
 579                          drm_clip_rect_t *rects, int num_rects,
 580                          GLboolean front_buffer,
 581                          void *loaderPrivate);
 582 };
 583
 584 #define __DRI_SWRAST_IMAGE_OP_DRAW      1
 585 #define __DRI_SWRAST_IMAGE_OP_CLEAR     2
 586 #define __DRI_SWRAST_IMAGE_OP_SWAP      3
 587
 588 /**
 589  * SWRast Loader extension.
 590  */
 591 #define __DRI_SWRAST_LOADER "DRI_SWRastLoader"
 592 #define __DRI_SWRAST_LOADER_VERSION 4
 593 struct __DRIswrastLoaderExtensionRec {
 594     __DRIextension base;
 595
 596     /*
 597      * Drawable position and size
 598      */
 599     void (*getDrawableInfo)(__DRIdrawable *drawable,
 600                             int *x, int *y, int *width, int *height,
 601                             void *loaderPrivate);
 602
 603     /**
 604      * Put image to drawable
 605      */
 606     void (*putImage)(__DRIdrawable *drawable, int op,
 607                      int x, int y, int width, int height,
 608                      char *data, void *loaderPrivate);
 609
 610     /**
 611      * Get image from readable
 612      */
 613     void (*getImage)(__DRIdrawable *readable,
 614                      int x, int y, int width, int height,
 615                      char *data, void *loaderPrivate);
 616
 617     /**
 618      * Put image to drawable
 619      *
 620      * \since 2
 621      */
 622     void (*putImage2)(__DRIdrawable *drawable, int op,
 623                       int x, int y, int width, int height, int stride,
 624                       char *data, void *loaderPrivate);
 625
 626    /**
 627      * Put image to drawable
 628      *
 629      * \since 3
 630      */
 631    void (*getImage2)(__DRIdrawable *readable,
 632                      int x, int y, int width, int height, int stride,
 633                      char *data, void *loaderPrivate);
 634
 635     /**
 636      * Put shm image to drawable
 637      *
 638      * \since 4
 639      */
 640     void (*putImageShm)(__DRIdrawable *drawable, int op,
 641                         int x, int y, int width, int height, int stride,
 642                         int shmid, char *shmaddr, unsigned offset,
 643                         void *loaderPrivate);
 644     /**
 645      * Get shm image from readable
 646      *
 647      * \since 4
 648      */
 649     void (*getImageShm)(__DRIdrawable *readable,
 650                         int x, int y, int width, int height,
 651                         int shmid, void *loaderPrivate);
 652 };
 653
 654 /**
 655  * Invalidate loader extension.  The presence of this extension
 656  * indicates to the DRI driver that the loader will call invalidate in
 657  * the __DRI2_FLUSH extension, whenever the needs to query for new
 658  * buffers.  This means that the DRI driver can drop the polling in
 659  * glViewport().
 660  *
 661  * The extension doesn't provide any functionality, it's only use to
 662  * indicate to the driver that it can use the new semantics.  A DRI
 663  * driver can use this to switch between the different semantics or
 664  * just refuse to initialize if this extension isn't present.
 665  */
 666 #define __DRI_USE_INVALIDATE "DRI_UseInvalidate"
 667 #define __DRI_USE_INVALIDATE_VERSION 1
 668
 669 typedef struct __DRIuseInvalidateExtensionRec __DRIuseInvalidateExtension;
 670 struct __DRIuseInvalidateExtensionRec {
 671    __DRIextension base;
 672 };
 673
 674 /**
 675  * The remaining extensions describe driver extensions, immediately
 676  * available interfaces provided by the driver.  To start using the
 677  * driver, dlsym() for the __DRI_DRIVER_EXTENSIONS symbol and look for
 678  * the extension you need in the array.
 679  */
 680 #define __DRI_DRIVER_EXTENSIONS "__driDriverExtensions"
 681
 682 /**
 683  * This symbol replaces the __DRI_DRIVER_EXTENSIONS symbol, and will be
 684  * suffixed by "_drivername", allowing multiple drivers to be built into one
 685  * library, and also giving the driver the chance to return a variable driver
 686  * extensions struct depending on the driver name being loaded or any other
 687  * system state.
 688  *
 689  * The function prototype is:
 690  *
 691  * const __DRIextension **__driDriverGetExtensions_drivername(void);
 692  */
 693 #define __DRI_DRIVER_GET_EXTENSIONS "__driDriverGetExtensions"
 694
 695 /**
 696  * Tokens for __DRIconfig attribs.  A number of attributes defined by
 697  * GLX or EGL standards are not in the table, as they must be provided
 698  * by the loader.  For example, FBConfig ID or visual ID, drawable type.
 699  */
 700
 701 #define __DRI_ATTRIB_BUFFER_SIZE                 1
 702 #define __DRI_ATTRIB_LEVEL                       2
 703 #define __DRI_ATTRIB_RED_SIZE                    3
 704 #define __DRI_ATTRIB_GREEN_SIZE                  4
 705 #define __DRI_ATTRIB_BLUE_SIZE                   5
 706 #define __DRI_ATTRIB_LUMINANCE_SIZE              6
 707 #define __DRI_ATTRIB_ALPHA_SIZE                  7
 708 #define __DRI_ATTRIB_ALPHA_MASK_SIZE             8
 709 #define __DRI_ATTRIB_DEPTH_SIZE                  9
 710 #define __DRI_ATTRIB_STENCIL_SIZE               10
 711 #define __DRI_ATTRIB_ACCUM_RED_SIZE             11
 712 #define __DRI_ATTRIB_ACCUM_GREEN_SIZE           12
 713 #define __DRI_ATTRIB_ACCUM_BLUE_SIZE            13
 714 #define __DRI_ATTRIB_ACCUM_ALPHA_SIZE           14
 715 #define __DRI_ATTRIB_SAMPLE_BUFFERS             15
 716 #define __DRI_ATTRIB_SAMPLES                    16
 717 #define __DRI_ATTRIB_RENDER_TYPE                17
 718 #define __DRI_ATTRIB_CONFIG_CAVEAT              18
 719 #define __DRI_ATTRIB_CONFORMANT                 19
 720 #define __DRI_ATTRIB_DOUBLE_BUFFER              20
 721 #define __DRI_ATTRIB_STEREO                     21
 722 #define __DRI_ATTRIB_AUX_BUFFERS                22
 723 #define __DRI_ATTRIB_TRANSPARENT_TYPE           23
 724 #define __DRI_ATTRIB_TRANSPARENT_INDEX_VALUE    24
 725 #define __DRI_ATTRIB_TRANSPARENT_RED_VALUE      25
 726 #define __DRI_ATTRIB_TRANSPARENT_GREEN_VALUE    26
 727 #define __DRI_ATTRIB_TRANSPARENT_BLUE_VALUE     27
 728 #define __DRI_ATTRIB_TRANSPARENT_ALPHA_VALUE    28
 729 #define __DRI_ATTRIB_FLOAT_MODE                 29
 730 #define __DRI_ATTRIB_RED_MASK                   30
 731 #define __DRI_ATTRIB_GREEN_MASK                 31
 732 #define __DRI_ATTRIB_BLUE_MASK                  32
 733 #define __DRI_ATTRIB_ALPHA_MASK                 33
 734 #define __DRI_ATTRIB_MAX_PBUFFER_WIDTH          34
 735 #define __DRI_ATTRIB_MAX_PBUFFER_HEIGHT         35
 736 #define __DRI_ATTRIB_MAX_PBUFFER_PIXELS         36
 737 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_WIDTH      37
 738 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_HEIGHT     38
 739 #define __DRI_ATTRIB_VISUAL_SELECT_GROUP        39
 740 #define __DRI_ATTRIB_SWAP_METHOD                40
 741 #define __DRI_ATTRIB_MAX_SWAP_INTERVAL          41
 742 #define __DRI_ATTRIB_MIN_SWAP_INTERVAL          42
 743 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGB        43
 744 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGBA       44
 745 #define __DRI_ATTRIB_BIND_TO_MIPMAP_TEXTURE     45
 746 #define __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS    46
 747 #define __DRI_ATTRIB_YINVERTED                  47
 748 #define __DRI_ATTRIB_FRAMEBUFFER_SRGB_CAPABLE   48
 749 #define __DRI_ATTRIB_MAX                        (__DRI_ATTRIB_FRAMEBUFFER_SRGB_CAPABLE + 1)
 750
 751 /* __DRI_ATTRIB_RENDER_TYPE */
 752 #define __DRI_ATTRIB_RGBA_BIT                   0x01
 753 #define __DRI_ATTRIB_COLOR_INDEX_BIT            0x02
 754 #define __DRI_ATTRIB_LUMINANCE_BIT              0x04
 755 #define __DRI_ATTRIB_FLOAT_BIT                  0x08
 756 #define __DRI_ATTRIB_UNSIGNED_FLOAT_BIT         0x10
 757
 758 /* __DRI_ATTRIB_CONFIG_CAVEAT */
 759 #define __DRI_ATTRIB_SLOW_BIT                   0x01
 760 #define __DRI_ATTRIB_NON_CONFORMANT_CONFIG      0x02
 761
 762 /* __DRI_ATTRIB_TRANSPARENT_TYPE */
 763 #define __DRI_ATTRIB_TRANSPARENT_RGB            0x00
 764 #define __DRI_ATTRIB_TRANSPARENT_INDEX          0x01
 765
 766 /* __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS  */
 767 #define __DRI_ATTRIB_TEXTURE_1D_BIT             0x01
 768 #define __DRI_ATTRIB_TEXTURE_2D_BIT             0x02
 769 #define __DRI_ATTRIB_TEXTURE_RECTANGLE_BIT      0x04
 770
 771 /* __DRI_ATTRIB_SWAP_METHOD */
 772 /* Note that with the exception of __DRI_ATTRIB_SWAP_NONE, we need to define
 773  * the same tokens as GLX. This is because old and current X servers will
 774  * transmit the driconf value grabbed from the AIGLX driver untranslated as
 775  * the GLX fbconfig value. __DRI_ATTRIB_SWAP_NONE is only used by dri drivers
 776  * to signal to the dri core that the driconfig is single-buffer.
 777  */
 778 #define __DRI_ATTRIB_SWAP_NONE                  0x0000
 779 #define __DRI_ATTRIB_SWAP_EXCHANGE              0x8061
 780 #define __DRI_ATTRIB_SWAP_COPY                  0x8062
 781 #define __DRI_ATTRIB_SWAP_UNDEFINED             0x8063
 782
 783 /**
 784  * This extension defines the core DRI functionality.
 785  *
 786  * Version >= 2 indicates that getConfigAttrib with __DRI_ATTRIB_SWAP_METHOD
 787  * returns a reliable value.
 788  */
 789 #define __DRI_CORE "DRI_Core"
 790 #define __DRI_CORE_VERSION 2
 791
 792 struct __DRIcoreExtensionRec {
 793     __DRIextension base;
 794
 795     __DRIscreen *(*createNewScreen)(int screen, int fd,
 796                                     unsigned int sarea_handle,
 797                                     const __DRIextension **extensions,
 798                                     const __DRIconfig ***driverConfigs,
 799                                     void *loaderPrivate);
 800
 801     void (*destroyScreen)(__DRIscreen *screen);
 802
 803     const __DRIextension **(*getExtensions)(__DRIscreen *screen);
 804
 805     int (*getConfigAttrib)(const __DRIconfig *config,
 806                            unsigned int attrib,
 807                            unsigned int *value);
 808
 809     int (*indexConfigAttrib)(const __DRIconfig *config, int index,
 810                              unsigned int *attrib, unsigned int *value);
 811
 812     __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
 813                                         const __DRIconfig *config,
 814                                         unsigned int drawable_id,
 815                                         unsigned int head,
 816                                         void *loaderPrivate);
 817
 818     void (*destroyDrawable)(__DRIdrawable *drawable);
 819
 820     void (*swapBuffers)(__DRIdrawable *drawable);
 821
 822     __DRIcontext *(*createNewContext)(__DRIscreen *screen,
 823                                       const __DRIconfig *config,
 824                                       __DRIcontext *shared,
 825                                       void *loaderPrivate);
 826
 827     int (*copyContext)(__DRIcontext *dest,
 828                        __DRIcontext *src,
 829                        unsigned long mask);
 830
 831     void (*destroyContext)(__DRIcontext *context);
 832
 833     int (*bindContext)(__DRIcontext *ctx,
 834                        __DRIdrawable *pdraw,
 835                        __DRIdrawable *pread);
 836
 837     int (*unbindContext)(__DRIcontext *ctx);
 838 };
 839
 840 /**
 841  * Stored version of some component (i.e., server-side DRI module, kernel-side
 842  * DRM, etc.).
 843  *
 844  * \todo
 845  * There are several data structures that explicitly store a major version,
 846  * minor version, and patch level.  These structures should be modified to
 847  * have a \c __DRIversionRec instead.
 848  */
 849 struct __DRIversionRec {
 850     int    major;        /**< Major version number. */
 851     int    minor;        /**< Minor version number. */
 852     int    patch;        /**< Patch-level. */
 853 };
 854
 855 /**
 856  * Framebuffer information record.  Used by libGL to communicate information
 857  * about the framebuffer to the driver's \c __driCreateNewScreen function.
 858  *
 859  * In XFree86, most of this information is derrived from data returned by
 860  * calling \c XF86DRIGetDeviceInfo.
 861  *
 862  * \sa XF86DRIGetDeviceInfo __DRIdisplayRec::createNewScreen
 863  *     __driUtilCreateNewScreen CallCreateNewScreen
 864  *
 865  * \bug This structure could be better named.
 866  */
 867 struct __DRIframebufferRec {
 868     unsigned char *base;    /**< Framebuffer base address in the CPU's
 869                              * address space.  This value is calculated by
 870                              * calling \c drmMap on the framebuffer handle
 871                              * returned by \c XF86DRIGetDeviceInfo (or a
 872                              * similar function).
 873                              */
 874     int size;               /**< Framebuffer size, in bytes. */
 875     int stride;             /**< Number of bytes from one line to the next. */
 876     int width;              /**< Pixel width of the framebuffer. */
 877     int height;             /**< Pixel height of the framebuffer. */
 878     int dev_priv_size;      /**< Size of the driver's dev-priv structure. */
 879     void *dev_priv;         /**< Pointer to the driver's dev-priv structure. */
 880 };
 881
 882
 883 /**
 884  * This extension provides alternative screen, drawable and context
 885  * constructors for legacy DRI functionality.  This is used in
 886  * conjunction with the core extension.
 887  */
 888 #define __DRI_LEGACY "DRI_Legacy"
 889 #define __DRI_LEGACY_VERSION 1
 890
 891 struct __DRIlegacyExtensionRec {
 892     __DRIextension base;
 893
 894     __DRIscreen *(*createNewScreen)(int screen,
 895                                     const __DRIversion *ddx_version,
 896                                     const __DRIversion *dri_version,
 897                                     const __DRIversion *drm_version,
 898                                     const __DRIframebuffer *frame_buffer,
 899                                     void *pSAREA, int fd,
 900                                     const __DRIextension **extensions,
 901                                     const __DRIconfig ***driver_configs,
 902                                     void *loaderPrivate);
 903
 904     __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
 905                                         const __DRIconfig *config,
 906                                         drm_drawable_t hwDrawable,
 907                                         int renderType, const int *attrs,
 908                                         void *loaderPrivate);
 909
 910     __DRIcontext *(*createNewContext)(__DRIscreen *screen,
 911                                       const __DRIconfig *config,
 912                                       int render_type,
 913                                       __DRIcontext *shared,
 914                                       drm_context_t hwContext,
 915                                       void *loaderPrivate);
 916 };
 917
 918 /**
 919  * This extension provides alternative screen, drawable and context
 920  * constructors for swrast DRI functionality.  This is used in
 921  * conjunction with the core extension.
 922  */
 923 #define __DRI_SWRAST "DRI_SWRast"
 924 #define __DRI_SWRAST_VERSION 4
 925
 926 struct __DRIswrastExtensionRec {
 927     __DRIextension base;
 928
 929     __DRIscreen *(*createNewScreen)(int screen,
 930                                     const __DRIextension **extensions,
 931                                     const __DRIconfig ***driver_configs,
 932                                     void *loaderPrivate);
 933
 934     __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
 935                                         const __DRIconfig *config,
 936                                         void *loaderPrivate);
 937
 938    /* Since version 2 */
 939    __DRIcontext *(*createNewContextForAPI)(__DRIscreen *screen,
 940                                            int api,
 941                                            const __DRIconfig *config,
 942                                            __DRIcontext *shared,
 943                                            void *data);
 944
 945    /**
 946     * Create a context for a particular API with a set of attributes
 947     *
 948     * \since version 3
 949     *
 950     * \sa __DRIdri2ExtensionRec::createContextAttribs
 951     */
 952    __DRIcontext *(*createContextAttribs)(__DRIscreen *screen,
 953                                          int api,
 954                                          const __DRIconfig *config,
 955                                          __DRIcontext *shared,
 956                                          unsigned num_attribs,
 957                                          const uint32_t *attribs,
 958                                          unsigned *error,
 959                                          void *loaderPrivate);
 960
 961    /**
 962     * createNewScreen() with the driver extensions passed in.
 963     *
 964     * \since version 4
 965     */
 966    __DRIscreen *(*createNewScreen2)(int screen,
 967                                     const __DRIextension **loader_extensions,
 968                                     const __DRIextension **driver_extensions,
 969                                     const __DRIconfig ***driver_configs,
 970                                     void *loaderPrivate);
 971
 972 };
 973
 974 /** Common DRI function definitions, shared among DRI2 and Image extensions
 975  */
 976
 977 typedef __DRIscreen *
 978 (*__DRIcreateNewScreen2Func)(int screen, int fd,
 979                              const __DRIextension **extensions,
 980                              const __DRIextension **driver_extensions,
 981                              const __DRIconfig ***driver_configs,
 982                              void *loaderPrivate);
 983
 984 typedef __DRIdrawable *
 985 (*__DRIcreateNewDrawableFunc)(__DRIscreen *screen,
 986                               const __DRIconfig *config,
 987                               void *loaderPrivate);
 988
 989 typedef __DRIcontext *
 990 (*__DRIcreateContextAttribsFunc)(__DRIscreen *screen,
 991                                  int api,
 992                                  const __DRIconfig *config,
 993                                  __DRIcontext *shared,
 994                                  unsigned num_attribs,
 995                                  const uint32_t *attribs,
 996                                  unsigned *error,
 997                                  void *loaderPrivate);
 998
 999 typedef unsigned int
1000 (*__DRIgetAPIMaskFunc)(__DRIscreen *screen);
1001
1002 /**
1003  * DRI2 Loader extension.
1004  */
1005 #define __DRI_BUFFER_FRONT_LEFT         0
1006 #define __DRI_BUFFER_BACK_LEFT          1
1007 #define __DRI_BUFFER_FRONT_RIGHT        2
1008 #define __DRI_BUFFER_BACK_RIGHT         3
1009 #define __DRI_BUFFER_DEPTH              4
1010 #define __DRI_BUFFER_STENCIL            5
1011 #define __DRI_BUFFER_ACCUM              6
1012 #define __DRI_BUFFER_FAKE_FRONT_LEFT    7
1013 #define __DRI_BUFFER_FAKE_FRONT_RIGHT   8
1014 #define __DRI_BUFFER_DEPTH_STENCIL      9  /**< Only available with DRI2 1.1 */
1015 #define __DRI_BUFFER_HIZ                10
1016
1017 /* Inofficial and for internal use. Increase when adding a new buffer token. */
1018 #define __DRI_BUFFER_COUNT              11
1019
1020 struct __DRIbufferRec {
1021     unsigned int attachment;
1022     unsigned int name;
1023     unsigned int pitch;
1024     unsigned int cpp;
1025     unsigned int flags;
1026 };
1027
1028 #define __DRI_DRI2_LOADER "DRI_DRI2Loader"
1029 #define __DRI_DRI2_LOADER_VERSION 4
1030
1031 enum dri_loader_cap {
1032    /* Whether the loader handles RGBA channel ordering correctly. If not,
1033     * only BGRA ordering can be exposed.
1034     */
1035    DRI_LOADER_CAP_RGBA_ORDERING,
1036 };
1037
1038 struct __DRIdri2LoaderExtensionRec {
1039     __DRIextension base;
1040
1041     __DRIbuffer *(*getBuffers)(__DRIdrawable *driDrawable,
1042                                int *width, int *height,
1043                                unsigned int *attachments, int count,
1044                                int *out_count, void *loaderPrivate);
1045
1046     /**
1047      * Flush pending front-buffer rendering
1048      *
1049      * Any rendering that has been performed to the
1050      * \c __DRI_BUFFER_FAKE_FRONT_LEFT will be flushed to the
1051      * \c __DRI_BUFFER_FRONT_LEFT.
1052      *
1053      * \param driDrawable    Drawable whose front-buffer is to be flushed
1054      * \param loaderPrivate  Loader's private data that was previously passed
1055      *                       into __DRIdri2ExtensionRec::createNewDrawable
1056      *
1057      * \since 2
1058      */
1059     void (*flushFrontBuffer)(__DRIdrawable *driDrawable, void *loaderPrivate);
1060
1061
1062     /**
1063      * Get list of buffers from the server
1064      *
1065      * Gets a list of buffer for the specified set of attachments.  Unlike
1066      * \c ::getBuffers, this function takes a list of attachments paired with
1067      * opaque \c unsigned \c int value describing the format of the buffer.
1068      * It is the responsibility of the caller to know what the service that
1069      * allocates the buffers will expect to receive for the format.
1070      *
1071      * \param driDrawable    Drawable whose buffers are being queried.
1072      * \param width          Output where the width of the buffers is stored.
1073      * \param height         Output where the height of the buffers is stored.
1074      * \param attachments    List of pairs of attachment ID and opaque format
1075      *                       requested for the drawable.
1076      * \param count          Number of attachment / format pairs stored in
1077      *                       \c attachments.
1078      * \param loaderPrivate  Loader's private data that was previously passed
1079      *                       into __DRIdri2ExtensionRec::createNewDrawable.
1080      *
1081      * \since 3
1082      */
1083     __DRIbuffer *(*getBuffersWithFormat)(__DRIdrawable *driDrawable,
1084                                          int *width, int *height,
1085                                          unsigned int *attachments, int count,
1086                                          int *out_count, void *loaderPrivate);
1087
1088     /**
1089      * Return a loader capability value. If the loader doesn't know the enum,
1090      * it will return 0.
1091      *
1092      * \param loaderPrivate The last parameter of createNewScreen or
1093      *                      createNewScreen2.
1094      * \param cap           See the enum.
1095      *
1096      * \since 4
1097      */
1098     unsigned (*getCapability)(void *loaderPrivate, enum dri_loader_cap cap);
1099 };
1100
1101 /**
1102  * This extension provides alternative screen, drawable and context
1103  * constructors for DRI2.
1104  */
1105 #define __DRI_DRI2 "DRI_DRI2"
1106 #define __DRI_DRI2_VERSION 4
1107
1108 #define __DRI_API_OPENGL        0       /**< OpenGL compatibility profile */
1109 #define __DRI_API_GLES          1       /**< OpenGL ES 1.x */
1110 #define __DRI_API_GLES2         2       /**< OpenGL ES 2.x */
1111 #define __DRI_API_OPENGL_CORE   3       /**< OpenGL 3.2+ core profile */
1112 #define __DRI_API_GLES3         4       /**< OpenGL ES 3.x */
1113
1114 #define __DRI_CTX_ATTRIB_MAJOR_VERSION          0
1115 #define __DRI_CTX_ATTRIB_MINOR_VERSION          1
1116 #define __DRI_CTX_ATTRIB_FLAGS                  2
1117
1118 /**
1119  * \requires __DRI2_ROBUSTNESS.
1120  */
1121 #define __DRI_CTX_ATTRIB_RESET_STRATEGY         3
1122
1123 #define __DRI_CTX_FLAG_DEBUG                    0x00000001
1124 #define __DRI_CTX_FLAG_FORWARD_COMPATIBLE       0x00000002
1125
1126 /**
1127  * \requires __DRI2_ROBUSTNESS.
1128  */
1129 #define __DRI_CTX_FLAG_ROBUST_BUFFER_ACCESS     0x00000004
1130
1131 /**
1132  * \requires __DRI2_NO_ERROR.
1133  *
1134  */
1135 #define __DRI_CTX_FLAG_NO_ERROR                 0x00000008
1136
1137 /**
1138  * \name Context reset strategies.
1139  */
1140 /*@{*/
1141 #define __DRI_CTX_RESET_NO_NOTIFICATION         0
1142 #define __DRI_CTX_RESET_LOSE_CONTEXT            1
1143 /*@}*/
1144
1145 #define __DRI_CTX_ATTRIB_PRIORITY               4
1146
1147 #define __DRI_CTX_PRIORITY_LOW                  0
1148 #define __DRI_CTX_PRIORITY_MEDIUM               1
1149 #define __DRI_CTX_PRIORITY_HIGH                 2
1150
1151 /**
1152  * \name Context release behaviors.
1153  */
1154 /*@{*/
1155 #define __DRI_CTX_ATTRIB_RELEASE_BEHAVIOR       5
1156
1157 #define __DRI_CTX_RELEASE_BEHAVIOR_NONE         0
1158 #define __DRI_CTX_RELEASE_BEHAVIOR_FLUSH        1
1159 /*@}*/
1160
1161 /**
1162  * \name Reasons that __DRIdri2Extension::createContextAttribs might fail
1163  */
1164 /*@{*/
1165 /** Success! */
1166 #define __DRI_CTX_ERROR_SUCCESS                 0
1167
1168 /** Memory allocation failure */
1169 #define __DRI_CTX_ERROR_NO_MEMORY               1
1170
1171 /** Client requested an API (e.g., OpenGL ES 2.0) that the driver can't do. */
1172 #define __DRI_CTX_ERROR_BAD_API                 2
1173
1174 /** Client requested an API version that the driver can't do. */
1175 #define __DRI_CTX_ERROR_BAD_VERSION             3
1176
1177 /** Client requested a flag or combination of flags the driver can't do. */
1178 #define __DRI_CTX_ERROR_BAD_FLAG                4
1179
1180 /** Client requested an attribute the driver doesn't understand. */
1181 #define __DRI_CTX_ERROR_UNKNOWN_ATTRIBUTE       5
1182
1183 /** Client requested a flag the driver doesn't understand. */
1184 #define __DRI_CTX_ERROR_UNKNOWN_FLAG            6
1185 /*@}*/
1186
1187 struct __DRIdri2ExtensionRec {
1188     __DRIextension base;
1189
1190     __DRIscreen *(*createNewScreen)(int screen, int fd,
1191                                     const __DRIextension **extensions,
1192                                     const __DRIconfig ***driver_configs,
1193                                     void *loaderPrivate);
1194
1195    __DRIcreateNewDrawableFunc   createNewDrawable;
1196    __DRIcontext *(*createNewContext)(__DRIscreen *screen,
1197                                      const __DRIconfig *config,
1198                                      __DRIcontext *shared,
1199                                      void *loaderPrivate);
1200
1201    /* Since version 2 */
1202    __DRIgetAPIMaskFunc          getAPIMask;
1203
1204    __DRIcontext *(*createNewContextForAPI)(__DRIscreen *screen,
1205                                            int api,
1206                                            const __DRIconfig *config,
1207                                            __DRIcontext *shared,
1208                                            void *data);
1209
1210    __DRIbuffer *(*allocateBuffer)(__DRIscreen *screen,
1211                                   unsigned int attachment,
1212                                   unsigned int format,
1213                                   int width,
1214                                   int height);
1215    void (*releaseBuffer)(__DRIscreen *screen,
1216                          __DRIbuffer *buffer);
1217
1218    /**
1219     * Create a context for a particular API with a set of attributes
1220     *
1221     * \since version 3
1222     *
1223     * \sa __DRIswrastExtensionRec::createContextAttribs
1224     */
1225    __DRIcreateContextAttribsFunc        createContextAttribs;
1226
1227    /**
1228     * createNewScreen with the driver's extension list passed in.
1229     *
1230     * \since version 4
1231     */
1232    __DRIcreateNewScreen2Func            createNewScreen2;
1233 };
1234
1235
1236 /**
1237  * This extension provides functionality to enable various EGLImage
1238  * extensions.
1239  */
1240 #define __DRI_IMAGE "DRI_IMAGE"
1241 #define __DRI_IMAGE_VERSION 17
1242
1243 /**
1244  * These formats correspond to the similarly named MESA_FORMAT_*
1245  * tokens, except in the native endian of the CPU.  For example, on
1246  * little endian __DRI_IMAGE_FORMAT_XRGB8888 corresponds to
1247  * MESA_FORMAT_XRGB8888, but MESA_FORMAT_XRGB8888_REV on big endian.
1248  *
1249  * __DRI_IMAGE_FORMAT_NONE is for images that aren't directly usable
1250  * by the driver (YUV planar formats) but serve as a base image for
1251  * creating sub-images for the different planes within the image.
1252  *
1253  * R8, GR88 and NONE should not be used with createImageFromName or
1254  * createImage, and are returned by query from sub images created with
1255  * createImageFromNames (NONE, see above) and fromPlane (R8 & GR88).
1256  */
1257 #define __DRI_IMAGE_FORMAT_RGB565       0x1001
1258 #define __DRI_IMAGE_FORMAT_XRGB8888     0x1002
1259 #define __DRI_IMAGE_FORMAT_ARGB8888     0x1003
1260 #define __DRI_IMAGE_FORMAT_ABGR8888     0x1004
1261 #define __DRI_IMAGE_FORMAT_XBGR8888     0x1005
1262 #define __DRI_IMAGE_FORMAT_R8           0x1006 /* Since version 5 */
1263 #define __DRI_IMAGE_FORMAT_GR88         0x1007
1264 #define __DRI_IMAGE_FORMAT_NONE         0x1008
1265 #define __DRI_IMAGE_FORMAT_XRGB2101010  0x1009
1266 #define __DRI_IMAGE_FORMAT_ARGB2101010  0x100a
1267 #define __DRI_IMAGE_FORMAT_SARGB8       0x100b
1268 #define __DRI_IMAGE_FORMAT_ARGB1555     0x100c
1269 #define __DRI_IMAGE_FORMAT_R16          0x100d
1270 #define __DRI_IMAGE_FORMAT_GR1616       0x100e
1271 #define __DRI_IMAGE_FORMAT_YUYV         0x100f
1272 #define __DRI_IMAGE_FORMAT_XBGR2101010  0x1010
1273 #define __DRI_IMAGE_FORMAT_ABGR2101010  0x1011
1274 #define __DRI_IMAGE_FORMAT_SABGR8       0x1012
1275
1276 #define __DRI_IMAGE_USE_SHARE           0x0001
1277 #define __DRI_IMAGE_USE_SCANOUT         0x0002
1278 #define __DRI_IMAGE_USE_CURSOR          0x0004 /* Deprecated */
1279 #define __DRI_IMAGE_USE_LINEAR          0x0008
1280 /* The buffer will only be read by an external process after SwapBuffers,
1281  * in contrary to gbm buffers, front buffers and fake front buffers, which
1282  * could be read after a flush."
1283  */
1284 #define __DRI_IMAGE_USE_BACKBUFFER      0x0010
1285
1286
1287 #define __DRI_IMAGE_TRANSFER_READ            0x1
1288 #define __DRI_IMAGE_TRANSFER_WRITE           0x2
1289 #define __DRI_IMAGE_TRANSFER_READ_WRITE      \
1290         (__DRI_IMAGE_TRANSFER_READ | __DRI_IMAGE_TRANSFER_WRITE)
1291
1292 /**
1293  * Four CC formats that matches with WL_DRM_FORMAT_* from wayland_drm.h,
1294  * GBM_FORMAT_* from gbm.h, and DRM_FORMAT_* from drm_fourcc.h. Used with
1295  * createImageFromNames.
1296  *
1297  * \since 5
1298  */
1299
1300 #define __DRI_IMAGE_FOURCC_R8           0x20203852
1301 #define __DRI_IMAGE_FOURCC_GR88         0x38385247
1302 #define __DRI_IMAGE_FOURCC_ARGB1555     0x35315241
1303 #define __DRI_IMAGE_FOURCC_R16          0x20363152
1304 #define __DRI_IMAGE_FOURCC_GR1616       0x32335247
1305 #define __DRI_IMAGE_FOURCC_RGB565       0x36314752
1306 #define __DRI_IMAGE_FOURCC_ARGB8888     0x34325241
1307 #define __DRI_IMAGE_FOURCC_XRGB8888     0x34325258
1308 #define __DRI_IMAGE_FOURCC_ABGR8888     0x34324241
1309 #define __DRI_IMAGE_FOURCC_XBGR8888     0x34324258
1310 #define __DRI_IMAGE_FOURCC_SARGB8888    0x83324258
1311 #define __DRI_IMAGE_FOURCC_SABGR8888    0x84324258
1312 #define __DRI_IMAGE_FOURCC_ARGB2101010  0x30335241
1313 #define __DRI_IMAGE_FOURCC_XRGB2101010  0x30335258
1314 #define __DRI_IMAGE_FOURCC_ABGR2101010  0x30334241
1315 #define __DRI_IMAGE_FOURCC_XBGR2101010  0x30334258
1316 #define __DRI_IMAGE_FOURCC_RGBA1010102  0x30334152
1317 #define __DRI_IMAGE_FOURCC_RGBX1010102  0x30335852
1318 #define __DRI_IMAGE_FOURCC_BGRA1010102  0x30334142
1319 #define __DRI_IMAGE_FOURCC_BGRX1010102  0x30335842
1320 #define __DRI_IMAGE_FOURCC_YUV410       0x39565559
1321 #define __DRI_IMAGE_FOURCC_YUV411       0x31315559
1322 #define __DRI_IMAGE_FOURCC_YUV420       0x32315559
1323 #define __DRI_IMAGE_FOURCC_YUV422       0x36315559
1324 #define __DRI_IMAGE_FOURCC_YUV444       0x34325559
1325 #define __DRI_IMAGE_FOURCC_NV12         0x3231564e
1326 #define __DRI_IMAGE_FOURCC_NV16         0x3631564e
1327 #define __DRI_IMAGE_FOURCC_YUYV         0x56595559
1328 #define __DRI_IMAGE_FOURCC_UYVY         0x59565955
1329
1330 #define __DRI_IMAGE_FOURCC_YVU410       0x39555659
1331 #define __DRI_IMAGE_FOURCC_YVU411       0x31315659
1332 #define __DRI_IMAGE_FOURCC_YVU420       0x32315659
1333 #define __DRI_IMAGE_FOURCC_YVU422       0x36315659
1334 #define __DRI_IMAGE_FOURCC_YVU444       0x34325659
1335
1336 /**
1337  * Queryable on images created by createImageFromNames.
1338  *
1339  * RGB and RGBA are may be usable directly as images but its still
1340  * recommended to call fromPlanar with plane == 0.
1341  *
1342  * Y_U_V, Y_UV,Y_XUXV and Y_UXVX all requires call to fromPlanar to create
1343  * usable sub-images, sampling from images return raw YUV data and
1344  * color conversion needs to be done in the shader.
1345  *
1346  * \since 5
1347  */
1348
1349 #define __DRI_IMAGE_COMPONENTS_RGB      0x3001
1350 #define __DRI_IMAGE_COMPONENTS_RGBA     0x3002
1351 #define __DRI_IMAGE_COMPONENTS_Y_U_V    0x3003
1352 #define __DRI_IMAGE_COMPONENTS_Y_UV     0x3004
1353 #define __DRI_IMAGE_COMPONENTS_Y_XUXV   0x3005
1354 #define __DRI_IMAGE_COMPONENTS_Y_UXVX   0x3008
1355 #define __DRI_IMAGE_COMPONENTS_R        0x3006
1356 #define __DRI_IMAGE_COMPONENTS_RG       0x3007
1357
1358
1359 /**
1360  * queryImage attributes
1361  */
1362
1363 #define __DRI_IMAGE_ATTRIB_STRIDE       0x2000
1364 #define __DRI_IMAGE_ATTRIB_HANDLE       0x2001
1365 #define __DRI_IMAGE_ATTRIB_NAME         0x2002
1366 #define __DRI_IMAGE_ATTRIB_FORMAT       0x2003 /* available in versions 3+ */
1367 #define __DRI_IMAGE_ATTRIB_WIDTH        0x2004 /* available in versions 4+ */
1368 #define __DRI_IMAGE_ATTRIB_HEIGHT       0x2005
1369 #define __DRI_IMAGE_ATTRIB_COMPONENTS   0x2006 /* available in versions 5+ */
1370 #define __DRI_IMAGE_ATTRIB_FD           0x2007 /* available in versions
1371                                                 * 7+. Each query will return a
1372                                                 * new fd. */
1373 #define __DRI_IMAGE_ATTRIB_FOURCC       0x2008 /* available in versions 11 */
1374 #define __DRI_IMAGE_ATTRIB_NUM_PLANES   0x2009 /* available in versions 11 */
1375
1376 #define __DRI_IMAGE_ATTRIB_OFFSET 0x200A /* available in versions 13 */
1377 #define __DRI_IMAGE_ATTRIB_MODIFIER_LOWER 0x200B /* available in versions 14 */
1378 #define __DRI_IMAGE_ATTRIB_MODIFIER_UPPER 0x200C /* available in versions 14 */
1379
1380 enum __DRIYUVColorSpace {
1381    __DRI_YUV_COLOR_SPACE_UNDEFINED = 0,
1382    __DRI_YUV_COLOR_SPACE_ITU_REC601 = 0x327F,
1383    __DRI_YUV_COLOR_SPACE_ITU_REC709 = 0x3280,
1384    __DRI_YUV_COLOR_SPACE_ITU_REC2020 = 0x3281
1385 };
1386
1387 enum __DRISampleRange {
1388    __DRI_YUV_RANGE_UNDEFINED = 0,
1389    __DRI_YUV_FULL_RANGE = 0x3282,
1390    __DRI_YUV_NARROW_RANGE = 0x3283
1391 };
1392
1393 enum __DRIChromaSiting {
1394    __DRI_YUV_CHROMA_SITING_UNDEFINED = 0,
1395    __DRI_YUV_CHROMA_SITING_0 = 0x3284,
1396    __DRI_YUV_CHROMA_SITING_0_5 = 0x3285
1397 };
1398
1399 /**
1400  * \name Reasons that __DRIimageExtensionRec::createImageFromTexture or
1401  * __DRIimageExtensionRec::createImageFromDmaBufs might fail
1402  */
1403 /*@{*/
1404 /** Success! */
1405 #define __DRI_IMAGE_ERROR_SUCCESS       0
1406
1407 /** Memory allocation failure */
1408 #define __DRI_IMAGE_ERROR_BAD_ALLOC     1
1409
1410 /** Client requested an invalid attribute */
1411 #define __DRI_IMAGE_ERROR_BAD_MATCH     2
1412
1413 /** Client requested an invalid texture object */
1414 #define __DRI_IMAGE_ERROR_BAD_PARAMETER 3
1415
1416 /** Client requested an invalid pitch and/or offset */
1417 #define __DRI_IMAGE_ERROR_BAD_ACCESS    4
1418 /*@}*/
1419
1420 /**
1421  * \name Capabilities that might be returned by __DRIimageExtensionRec::getCapabilities
1422  */
1423 /*@{*/
1424 #define __DRI_IMAGE_CAP_GLOBAL_NAMES 1
1425 /*@}*/
1426
1427 /**
1428  * blitImage flags
1429  */
1430
1431 #define __BLIT_FLAG_FLUSH               0x0001
1432 #define __BLIT_FLAG_FINISH              0x0002
1433
1434 /**
1435  * queryDmaBufFormatModifierAttribs attributes
1436  */
1437
1438 /* Available in version 16 */
1439 #define __DRI_IMAGE_FORMAT_MODIFIER_ATTRIB_PLANE_COUNT   0x0001
1440
1441 typedef struct __DRIimageRec          __DRIimage;
1442 typedef struct __DRIimageExtensionRec __DRIimageExtension;
1443 struct __DRIimageExtensionRec {
1444     __DRIextension base;
1445
1446     __DRIimage *(*createImageFromName)(__DRIscreen *screen,
1447                                        int width, int height, int format,
1448                                        int name, int pitch,
1449                                        void *loaderPrivate);
1450
1451     /* Deprecated since version 17; see createImageFromRenderbuffer2 */
1452     __DRIimage *(*createImageFromRenderbuffer)(__DRIcontext *context,
1453                                                int renderbuffer,
1454                                                void *loaderPrivate);
1455
1456     void (*destroyImage)(__DRIimage *image);
1457
1458     __DRIimage *(*createImage)(__DRIscreen *screen,
1459                                int width, int height, int format,
1460                                unsigned int use,
1461                                void *loaderPrivate);
1462
1463    GLboolean (*queryImage)(__DRIimage *image, int attrib, int *value);
1464
1465    /**
1466     * The new __DRIimage will share the content with the old one, see dup(2).
1467     */
1468    __DRIimage *(*dupImage)(__DRIimage *image, void *loaderPrivate);
1469
1470    /**
1471     * Validate that a __DRIimage can be used a certain way.
1472     *
1473     * \since 2
1474     */
1475    GLboolean (*validateUsage)(__DRIimage *image, unsigned int use);
1476
1477    /**
1478     * Unlike createImageFromName __DRI_IMAGE_FORMAT is not but instead
1479     * __DRI_IMAGE_FOURCC and strides are in bytes not pixels. Stride is
1480     * also per block and not per pixel (for non-RGB, see gallium blocks).
1481     *
1482     * \since 5
1483     */
1484    __DRIimage *(*createImageFromNames)(__DRIscreen *screen,
1485                                        int width, int height, int fourcc,
1486                                        int *names, int num_names,
1487                                        int *strides, int *offsets,
1488                                        void *loaderPrivate);
1489
1490    /**
1491     * Create an image out of a sub-region of a parent image.  This
1492     * entry point lets us create individual __DRIimages for different
1493     * planes in a planar buffer (typically yuv), for example.  While a
1494     * sub-image shares the underlying buffer object with the parent
1495     * image and other sibling sub-images, the life times of parent and
1496     * sub-images are not dependent.  Destroying the parent or a
1497     * sub-image doesn't affect other images.  The underlying buffer
1498     * object is free when no __DRIimage remains that references it.
1499     *
1500     * Sub-images may overlap, but rendering to overlapping sub-images
1501     * is undefined.
1502     *
1503     * \since 5
1504     */
1505     __DRIimage *(*fromPlanar)(__DRIimage *image, int plane,
1506                               void *loaderPrivate);
1507
1508     /**
1509      * Create image from texture.
1510      *
1511      * \since 6
1512      */
1513    __DRIimage *(*createImageFromTexture)(__DRIcontext *context,
1514                                          int target,
1515                                          unsigned texture,
1516                                          int depth,
1517                                          int level,
1518                                          unsigned *error,
1519                                          void *loaderPrivate);
1520    /**
1521     * Like createImageFromNames, but takes a prime fd instead.
1522     *
1523     * \since 7
1524     */
1525    __DRIimage *(*createImageFromFds)(__DRIscreen *screen,
1526                                      int width, int height, int fourcc,
1527                                      int *fds, int num_fds,
1528                                      int *strides, int *offsets,
1529                                      void *loaderPrivate);
1530
1531    /**
1532     * Like createImageFromFds, but takes additional attributes.
1533     *
1534     * For EGL_EXT_image_dma_buf_import.
1535     *
1536     * \since 8
1537     */
1538    __DRIimage *(*createImageFromDmaBufs)(__DRIscreen *screen,
1539                                          int width, int height, int fourcc,
1540                                          int *fds, int num_fds,
1541                                          int *strides, int *offsets,
1542                                          enum __DRIYUVColorSpace color_space,
1543                                          enum __DRISampleRange sample_range,
1544                                          enum __DRIChromaSiting horiz_siting,
1545                                          enum __DRIChromaSiting vert_siting,
1546                                          unsigned *error,
1547                                          void *loaderPrivate);
1548
1549    /**
1550     * Blit a part of a __DRIimage to another and flushes
1551     *
1552     * flush_flag:
1553     *    0:                  no flush
1554     *    __BLIT_FLAG_FLUSH:  flush after the blit operation
1555     *    __BLIT_FLAG_FINISH: flush and wait the blit finished
1556     *
1557     * \since 9
1558     */
1559    void (*blitImage)(__DRIcontext *context, __DRIimage *dst, __DRIimage *src,
1560                      int dstx0, int dsty0, int dstwidth, int dstheight,
1561                      int srcx0, int srcy0, int srcwidth, int srcheight,
1562                      int flush_flag);
1563
1564    /**
1565     * Query for general capabilities of the driver that concern
1566     * buffer sharing and image importing.
1567     *
1568     * \since 10
1569     */
1570    int (*getCapabilities)(__DRIscreen *screen);
1571
1572    /**
1573     * Returns a map of the specified region of a __DRIimage for the specified usage.
1574     *
1575     * flags may include __DRI_IMAGE_TRANSFER_READ, which will populate the
1576     * mapping with the current buffer content. If __DRI_IMAGE_TRANSFER_READ
1577     * is not included in the flags, the buffer content at map time is
1578     * undefined. Users wanting to modify the mapping must include
1579     * __DRI_IMAGE_TRANSFER_WRITE; if __DRI_IMAGE_TRANSFER_WRITE is not
1580     * included, behaviour when writing the mapping is undefined.
1581     *
1582     * Returns the byte stride in *stride, and an opaque pointer to data
1583     * tracking the mapping in **data, which must be passed to unmapImage().
1584     *
1585     * \since 12
1586     */
1587    void *(*mapImage)(__DRIcontext *context, __DRIimage *image,
1588                      int x0, int y0, int width, int height,
1589                      unsigned int flags, int *stride, void **data);
1590
1591    /**
1592     * Unmap a previously mapped __DRIimage
1593     *
1594     * \since 12
1595     */
1596    void (*unmapImage)(__DRIcontext *context, __DRIimage *image, void *data);
1597
1598
1599    /**
1600     * Creates an image with implementation's favorite modifiers.
1601     *
1602     * This acts like createImage except there is a list of modifiers passed in
1603     * which the implementation may selectively use to create the DRIimage. The
1604     * result should be the implementation selects one modifier (perhaps it would
1605     * hold on to a few and later pick).
1606     *
1607     * The created image should be destroyed with destroyImage().
1608     *
1609     * Returns the new DRIimage. The chosen modifier can be obtained later on
1610     * and passed back to things like the kernel's AddFB2 interface.
1611     *
1612     * \sa __DRIimageRec::createImage
1613     *
1614     * \since 14
1615     */
1616    __DRIimage *(*createImageWithModifiers)(__DRIscreen *screen,
1617                                            int width, int height, int format,
1618                                            const uint64_t *modifiers,
1619                                            const unsigned int modifier_count,
1620                                            void *loaderPrivate);
1621
1622    /*
1623     * Like createImageFromDmaBufs, but takes also format modifiers.
1624     *
1625     * For EGL_EXT_image_dma_buf_import_modifiers.
1626     *
1627     * \since 15
1628     */
1629    __DRIimage *(*createImageFromDmaBufs2)(__DRIscreen *screen,
1630                                           int width, int height, int fourcc,
1631                                           uint64_t modifier,
1632                                           int *fds, int num_fds,
1633                                           int *strides, int *offsets,
1634                                           enum __DRIYUVColorSpace color_space,
1635                                           enum __DRISampleRange sample_range,
1636                                           enum __DRIChromaSiting horiz_siting,
1637                                           enum __DRIChromaSiting vert_siting,
1638                                           unsigned *error,
1639                                           void *loaderPrivate);
1640
1641    /*
1642     * dmabuf format query to support EGL_EXT_image_dma_buf_import_modifiers.
1643     *
1644     * \param max      Maximum number of formats that can be accomodated into
1645     *                 \param formats. If zero, no formats are returned -
1646     *                 instead, the driver returns the total number of
1647     *                 supported dmabuf formats in \param count.
1648     * \param formats  Buffer to fill formats into.
1649     * \param count    Count of formats returned, or, total number of
1650     *                 supported formats in case \param max is zero.
1651     *
1652     * Returns true on success.
1653     *
1654     * \since 15
1655     */
1656    GLboolean (*queryDmaBufFormats)(__DRIscreen *screen, int max,
1657                                    int *formats, int *count);
1658
1659    /*
1660     * dmabuf format modifier query for a given format to support
1661     * EGL_EXT_image_dma_buf_import_modifiers.
1662     *
1663     * \param fourcc    The format to query modifiers for. If this format
1664     *                  is not supported by the driver, return false.
1665     * \param max       Maximum number of modifiers that can be accomodated in
1666     *                  \param modifiers. If zero, no modifiers are returned -
1667     *                  instead, the driver returns the total number of
1668     *                  modifiers for \param format in \param count.
1669     * \param modifiers Buffer to fill modifiers into.
1670     * \param count     Count of the modifiers returned, or, total number of
1671     *                  supported modifiers for \param fourcc in case
1672     *                  \param max is zero.
1673     *
1674     * Returns true upon success.
1675     *
1676     * \since 15
1677     */
1678    GLboolean (*queryDmaBufModifiers)(__DRIscreen *screen, int fourcc,
1679                                      int max, uint64_t *modifiers,
1680                                      unsigned int *external_only,
1681                                      int *count);
1682
1683    /**
1684     * dmabuf format modifier attribute query for a given format and modifier.
1685     *
1686     * \param fourcc    The format to query. If this format is not supported by
1687     *                  the driver, return false.
1688     * \param modifier  The modifier to query. If this format+modifier is not
1689     *                  supported by the driver, return false.
1690     * \param attrib    The __DRI_IMAGE_FORMAT_MODIFIER_ATTRIB to query.
1691     * \param value     A pointer to where to store the result of the query.
1692     *
1693     * Returns true upon success.
1694     *
1695     * \since 16
1696     */
1697    GLboolean (*queryDmaBufFormatModifierAttribs)(__DRIscreen *screen,
1698                                                  uint32_t fourcc, uint64_t modifier,
1699                                                  int attrib, uint64_t *value);
1700
1701    /**
1702     * Create a DRI image from the given renderbuffer.
1703     *
1704     * \param context       the current DRI context
1705     * \param renderbuffer  the GL name of the renderbuffer
1706     * \param loaderPrivate for callbacks into the loader related to the image
1707     * \param error         will be set to one of __DRI_IMAGE_ERROR_xxx
1708     * \return the newly created image on success, or NULL otherwise
1709     *
1710     * \since 17
1711     */
1712     __DRIimage *(*createImageFromRenderbuffer2)(__DRIcontext *context,
1713                                                 int renderbuffer,
1714                                                 void *loaderPrivate,
1715                                                 unsigned *error);
1716 };
1717
1718
1719 /**
1720  * This extension must be implemented by the loader and passed to the
1721  * driver at screen creation time.  The EGLImage entry points in the
1722  * various client APIs take opaque EGLImage handles and use this
1723  * extension to map them to a __DRIimage.  At version 1, this
1724  * extensions allows mapping EGLImage pointers to __DRIimage pointers,
1725  * but future versions could support other EGLImage-like, opaque types
1726  * with new lookup functions.
1727  */
1728 #define __DRI_IMAGE_LOOKUP "DRI_IMAGE_LOOKUP"
1729 #define __DRI_IMAGE_LOOKUP_VERSION 1
1730
1731 typedef struct __DRIimageLookupExtensionRec __DRIimageLookupExtension;
1732 struct __DRIimageLookupExtensionRec {
1733     __DRIextension base;
1734
1735     __DRIimage *(*lookupEGLImage)(__DRIscreen *screen, void *image,
1736                                   void *loaderPrivate);
1737 };
1738
1739 /**
1740  * This extension allows for common DRI2 options
1741  */
1742 #define __DRI2_CONFIG_QUERY "DRI_CONFIG_QUERY"
1743 #define __DRI2_CONFIG_QUERY_VERSION 1
1744
1745 typedef struct __DRI2configQueryExtensionRec __DRI2configQueryExtension;
1746 struct __DRI2configQueryExtensionRec {
1747    __DRIextension base;
1748
1749    int (*configQueryb)(__DRIscreen *screen, const char *var, unsigned char *val);
1750    int (*configQueryi)(__DRIscreen *screen, const char *var, int *val);
1751    int (*configQueryf)(__DRIscreen *screen, const char *var, float *val);
1752 };
1753
1754 /**
1755  * Robust context driver extension.
1756  *
1757  * Existence of this extension means the driver can accept the
1758  * \c __DRI_CTX_FLAG_ROBUST_BUFFER_ACCESS flag and the
1759  * \c __DRI_CTX_ATTRIB_RESET_STRATEGY attribute in
1760  * \c __DRIdri2ExtensionRec::createContextAttribs.
1761  */
1762 #define __DRI2_ROBUSTNESS "DRI_Robustness"
1763 #define __DRI2_ROBUSTNESS_VERSION 1
1764
1765 typedef struct __DRIrobustnessExtensionRec __DRIrobustnessExtension;
1766 struct __DRIrobustnessExtensionRec {
1767    __DRIextension base;
1768 };
1769
1770 /**
1771  * No-error context driver extension.
1772  *
1773  * Existence of this extension means the driver can accept the
1774  * __DRI_CTX_FLAG_NO_ERROR flag.
1775  */
1776 #define __DRI2_NO_ERROR "DRI_NoError"
1777 #define __DRI2_NO_ERROR_VERSION 1
1778
1779 typedef struct __DRInoErrorExtensionRec {
1780    __DRIextension base;
1781 } __DRInoErrorExtension;
1782
1783 /*
1784  * Flush control driver extension.
1785  *
1786  * Existence of this extension means the driver can accept the
1787  * \c __DRI_CTX_ATTRIB_RELEASE_BEHAVIOR attribute in
1788  * \c __DRIdri2ExtensionRec::createContextAttribs.
1789  */
1790 #define __DRI2_FLUSH_CONTROL "DRI_FlushControl"
1791 #define __DRI2_FLUSH_CONTROL_VERSION 1
1792
1793 typedef struct __DRI2flushControlExtensionRec __DRI2flushControlExtension;
1794 struct __DRI2flushControlExtensionRec {
1795    __DRIextension base;
1796 };
1797
1798 /**
1799  * DRI config options extension.
1800  *
1801  * This extension provides the XML string containing driver options for use by
1802  * the loader in supporting the driconf application.
1803  *
1804  * v2:
1805  * - Add the getXml getter function which allows the driver more flexibility in
1806  *   how the XML is provided.
1807  * - Deprecate the direct xml pointer. It is only provided as a fallback for
1808  *   older versions of libGL and must not be used by clients that are aware of
1809  *   the newer version. Future driver versions may set it to NULL.
1810  */
1811 #define __DRI_CONFIG_OPTIONS "DRI_ConfigOptions"
1812 #define __DRI_CONFIG_OPTIONS_VERSION 2
1813
1814 typedef struct __DRIconfigOptionsExtensionRec {
1815    __DRIextension base;
1816    const char *xml; /**< deprecated since v2, use getXml instead */
1817
1818    /**
1819     * Get an XML string that describes available driver options for use by a
1820     * config application.
1821     *
1822     * The returned string must be heap-allocated. The caller is responsible for
1823     * freeing it.
1824     */
1825    char *(*getXml)(const char *driver_name);
1826 } __DRIconfigOptionsExtension;
1827
1828 /**
1829  * This extension provides a driver vtable to a set of common driver helper
1830  * functions (driCoreExtension, driDRI2Extension) within the driver
1831  * implementation, as opposed to having to pass them through a global
1832  * variable.
1833  *
1834  * It is not intended to be public API to the actual loader, and the vtable
1835  * layout may change at any time.
1836  */
1837 #define __DRI_DRIVER_VTABLE "DRI_DriverVtable"
1838 #define __DRI_DRIVER_VTABLE_VERSION 1
1839
1840 typedef struct __DRIDriverVtableExtensionRec {
1841     __DRIextension base;
1842     const struct __DriverAPIRec *vtable;
1843 } __DRIDriverVtableExtension;
1844
1845 /**
1846  * Query renderer driver extension
1847  *
1848  * This allows the window system layer (either EGL or GLX) to query aspects of
1849  * hardware and driver support without creating a context.
1850  */
1851 #define __DRI2_RENDERER_QUERY "DRI_RENDERER_QUERY"
1852 #define __DRI2_RENDERER_QUERY_VERSION 1
1853
1854 #define __DRI2_RENDERER_VENDOR_ID                             0x0000
1855 #define __DRI2_RENDERER_DEVICE_ID                             0x0001
1856 #define __DRI2_RENDERER_VERSION                               0x0002
1857 #define __DRI2_RENDERER_ACCELERATED                           0x0003
1858 #define __DRI2_RENDERER_VIDEO_MEMORY                          0x0004
1859 #define __DRI2_RENDERER_UNIFIED_MEMORY_ARCHITECTURE           0x0005
1860 #define __DRI2_RENDERER_PREFERRED_PROFILE                     0x0006
1861 #define __DRI2_RENDERER_OPENGL_CORE_PROFILE_VERSION           0x0007
1862 #define __DRI2_RENDERER_OPENGL_COMPATIBILITY_PROFILE_VERSION  0x0008
1863 #define __DRI2_RENDERER_OPENGL_ES_PROFILE_VERSION             0x0009
1864 #define __DRI2_RENDERER_OPENGL_ES2_PROFILE_VERSION            0x000a
1865 #define __DRI2_RENDERER_HAS_TEXTURE_3D                        0x000b
1866 /* Whether there is an sRGB format support for every supported 32-bit UNORM
1867  * color format.
1868  */
1869 #define __DRI2_RENDERER_HAS_FRAMEBUFFER_SRGB                  0x000c
1870
1871 /* Bitmaks of supported/available context priorities - must match
1872  * __EGL_CONTEXT_PRIORITY_LOW_BIT et al
1873  */
1874 #define __DRI2_RENDERER_HAS_CONTEXT_PRIORITY                  0x000d
1875 #define   __DRI2_RENDERER_HAS_CONTEXT_PRIORITY_LOW            (1 << 0)
1876 #define   __DRI2_RENDERER_HAS_CONTEXT_PRIORITY_MEDIUM         (1 << 1)
1877 #define   __DRI2_RENDERER_HAS_CONTEXT_PRIORITY_HIGH           (1 << 2)
1878
1879 typedef struct __DRI2rendererQueryExtensionRec __DRI2rendererQueryExtension;
1880 struct __DRI2rendererQueryExtensionRec {
1881    __DRIextension base;
1882
1883    int (*queryInteger)(__DRIscreen *screen, int attribute, unsigned int *val);
1884    int (*queryString)(__DRIscreen *screen, int attribute, const char **val);
1885 };
1886
1887 /**
1888  * Image Loader extension. Drivers use this to allocate color buffers
1889  */
1890
1891 enum __DRIimageBufferMask {
1892    __DRI_IMAGE_BUFFER_BACK = (1 << 0),
1893    __DRI_IMAGE_BUFFER_FRONT = (1 << 1)
1894 };
1895
1896 struct __DRIimageList {
1897    uint32_t image_mask;
1898    __DRIimage *back;
1899    __DRIimage *front;
1900 };
1901
1902 #define __DRI_IMAGE_LOADER "DRI_IMAGE_LOADER"
1903 #define __DRI_IMAGE_LOADER_VERSION 3
1904
1905 struct __DRIimageLoaderExtensionRec {
1906     __DRIextension base;
1907
1908    /**
1909     * Allocate color buffers.
1910     *
1911     * \param driDrawable
1912     * \param width              Width of allocated buffers
1913     * \param height             Height of allocated buffers
1914     * \param format             one of __DRI_IMAGE_FORMAT_*
1915     * \param stamp              Address of variable to be updated when
1916     *                           getBuffers must be called again
1917     * \param loaderPrivate      The loaderPrivate for driDrawable
1918     * \param buffer_mask        Set of buffers to allocate
1919     * \param buffers            Returned buffers
1920     */
1921    int (*getBuffers)(__DRIdrawable *driDrawable,
1922                      unsigned int format,
1923                      uint32_t *stamp,
1924                      void *loaderPrivate,
1925                      uint32_t buffer_mask,
1926                      struct __DRIimageList *buffers);
1927
1928     /**
1929      * Flush pending front-buffer rendering
1930      *
1931      * Any rendering that has been performed to the
1932      * fake front will be flushed to the front
1933      *
1934      * \param driDrawable    Drawable whose front-buffer is to be flushed
1935      * \param loaderPrivate  Loader's private data that was previously passed
1936      *                       into __DRIdri2ExtensionRec::createNewDrawable
1937      */
1938     void (*flushFrontBuffer)(__DRIdrawable *driDrawable, void *loaderPrivate);
1939
1940     /**
1941      * Return a loader capability value. If the loader doesn't know the enum,
1942      * it will return 0.
1943      *
1944      * \since 2
1945      */
1946     unsigned (*getCapability)(void *loaderPrivate, enum dri_loader_cap cap);
1947
1948     /**
1949      * Flush swap buffers
1950      *
1951      * Make sure any outstanding swap buffers have been submitted to the
1952      * device.
1953      *
1954      * \param driDrawable    Drawable whose swaps need to be flushed
1955      * \param loaderPrivate  Loader's private data that was previously passed
1956      *                       into __DRIdri2ExtensionRec::createNewDrawable
1957      *
1958      * \since 3
1959      */
1960     void (*flushSwapBuffers)(__DRIdrawable *driDrawable, void *loaderPrivate);
1961 };
1962
1963 /**
1964  * DRI extension.
1965  */
1966
1967 #define __DRI_IMAGE_DRIVER           "DRI_IMAGE_DRIVER"
1968 #define __DRI_IMAGE_DRIVER_VERSION   1
1969
1970 struct __DRIimageDriverExtensionRec {
1971    __DRIextension               base;
1972
1973    /* Common DRI functions, shared with DRI2 */
1974    __DRIcreateNewScreen2Func            createNewScreen2;
1975    __DRIcreateNewDrawableFunc           createNewDrawable;
1976    __DRIcreateContextAttribsFunc        createContextAttribs;
1977    __DRIgetAPIMaskFunc                  getAPIMask;
1978 };
1979
1980 /**
1981  * Background callable loader extension.
1982  *
1983  * Loaders expose this extension to indicate to drivers that they are capable
1984  * of handling callbacks from the driver's background drawing threads.
1985  */
1986 #define __DRI_BACKGROUND_CALLABLE "DRI_BackgroundCallable"
1987 #define __DRI_BACKGROUND_CALLABLE_VERSION 1
1988
1989 typedef struct __DRIbackgroundCallableExtensionRec __DRIbackgroundCallableExtension;
1990 struct __DRIbackgroundCallableExtensionRec {
1991    __DRIextension base;
1992
1993    /**
1994     * Indicate that this thread is being used by the driver as a background
1995     * drawing thread which may make callbacks to the loader.
1996     *
1997     * \param loaderPrivate is the value that was passed to to the driver when
1998     * the context was created.  This can be used by the loader to identify
1999     * which context any callbacks are associated with.
2000     *
2001     * If this function is called more than once from any given thread, each
2002     * subsequent call overrides the loaderPrivate data that was passed in the
2003     * previous call.  The driver can take advantage of this to re-use a
2004     * background thread to perform drawing on behalf of multiple contexts.
2005     *
2006     * It is permissible for the driver to call this function from a
2007     * non-background thread (i.e. a thread that has already been bound to a
2008     * context using __DRIcoreExtensionRec::bindContext()); when this happens,
2009     * the \c loaderPrivate pointer must be equal to the pointer that was
2010     * passed to the driver when the currently bound context was created.
2011     *
2012     * This call should execute quickly enough that the driver can call it with
2013     * impunity whenever a background thread starts performing drawing
2014     * operations (e.g. it should just set a thread-local variable).
2015     */
2016    void (*setBackgroundContext)(void *loaderPrivate);
2017
2018    /**
2019     * Indicate that it is multithread safe to use glthread.  For GLX/EGL
2020     * platforms using Xlib, that involves calling XInitThreads, before
2021     * opening an X display.
2022     *
2023     * Note: only supported if extension version is at least 2.
2024     *
2025     * \param loaderPrivate is the value that was passed to to the driver when
2026     * the context was created.  This can be used by the loader to identify
2027     * which context any callbacks are associated with.
2028     */
2029    GLboolean (*isThreadSafe)(void *loaderPrivate);
2030 };
2031
2032 #endif