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