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