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