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