2 * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
3 * Copyright 2007-2008 Red Hat, Inc.
4 * (C) Copyright IBM Corporation 2004
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:
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
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.
28 * \file dri_interface.h
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.
35 * \author Kevin E. Martin <kevin@precisioninsight.com>
36 * \author Ian Romanick <idr@us.ibm.com>
37 * \author Kristian Høgsberg <krh@redhat.com>
40 #ifndef DRI_INTERFACE_H
41 #define DRI_INTERFACE_H
46 typedef unsigned int drm_context_t
;
47 typedef unsigned int drm_drawable_t
;
48 typedef struct drm_clip_rect drm_clip_rect_t
;
54 * \name DRI interface structures
56 * The following structures define the interface between the GLX client
57 * side library and the DRI (direct rendering infrastructure).
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
;
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
;
87 typedef struct __DRIimageLoaderExtensionRec __DRIimageLoaderExtension
;
88 typedef struct __DRIimageDriverExtensionRec __DRIimageDriverExtension
;
94 * Extension struct. Drivers 'inherit' from this struct by embedding
95 * it as the first element in the extension struct.
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.
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
112 struct __DRIextensionRec
{
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.
126 * Used by drivers to indicate support for setting the read drawable.
128 #define __DRI_READ_DRAWABLE "DRI_ReadDrawable"
129 #define __DRI_READ_DRAWABLE_VERSION 1
132 * Used by drivers that implement the GLX_MESA_copy_sub_buffer extension.
134 #define __DRI_COPY_SUB_BUFFER "DRI_CopySubBuffer"
135 #define __DRI_COPY_SUB_BUFFER_VERSION 1
136 struct __DRIcopySubBufferExtensionRec
{
138 void (*copySubBuffer
)(__DRIdrawable
*drawable
, int x
, int y
, int w
, int h
);
142 * Used by drivers that implement the GLX_SGI_swap_control or
143 * GLX_MESA_swap_control extension.
145 #define __DRI_SWAP_CONTROL "DRI_SwapControl"
146 #define __DRI_SWAP_CONTROL_VERSION 1
147 struct __DRIswapControlExtensionRec
{
149 void (*setSwapInterval
)(__DRIdrawable
*drawable
, unsigned int inteval
);
150 unsigned int (*getSwapInterval
)(__DRIdrawable
*drawable
);
154 * Used by drivers that implement the GLX_MESA_swap_frame_usage extension.
156 #define __DRI_FRAME_TRACKING "DRI_FrameTracking"
157 #define __DRI_FRAME_TRACKING_VERSION 1
158 struct __DRIframeTrackingExtensionRec
{
162 * Enable or disable frame usage tracking.
164 * \since Internal API version 20030317.
166 int (*frameTracking
)(__DRIdrawable
*drawable
, GLboolean enable
);
169 * Retrieve frame usage information.
171 * \since Internal API version 20030317.
173 int (*queryFrameTracking
)(__DRIdrawable
*drawable
,
174 int64_t * sbc
, int64_t * missedFrames
,
175 float * lastMissedUsage
, float * usage
);
180 * Used by drivers that implement the GLX_SGI_video_sync extension.
182 #define __DRI_MEDIA_STREAM_COUNTER "DRI_MediaStreamCounter"
183 #define __DRI_MEDIA_STREAM_COUNTER_VERSION 1
184 struct __DRImediaStreamCounterExtensionRec
{
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
193 int (*waitForMSC
)(__DRIdrawable
*drawable
,
194 int64_t target_msc
, int64_t divisor
, int64_t remainder
,
195 int64_t * msc
, int64_t * sbc
);
198 * Get the number of vertical refreshes since some point in time before
199 * this function was first called (i.e., system start up).
201 int (*getDrawableMSC
)(__DRIscreen
*screen
, __DRIdrawable
*drawable
,
206 #define __DRI_TEX_OFFSET "DRI_TexOffset"
207 #define __DRI_TEX_OFFSET_VERSION 1
208 struct __DRItexOffsetExtensionRec
{
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.
216 * For GLX_EXT_texture_from_pixmap with AIGLX.
218 void (*setTexOffset
)(__DRIcontext
*pDRICtx
, GLint texname
,
219 unsigned long long offset
, GLint depth
, GLuint pitch
);
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
230 #define __DRI_TEX_BUFFER "DRI_TexBuffer"
231 #define __DRI_TEX_BUFFER_VERSION 3
232 struct __DRItexBufferExtensionRec
{
236 * Method to override base texture image with the contents of a
239 * For GLX_EXT_texture_from_pixmap with AIGLX. Deprecated in favor of
240 * setTexBuffer2 in version 2 of this interface
242 void (*setTexBuffer
)(__DRIcontext
*pDRICtx
,
244 __DRIdrawable
*pDraw
);
247 * Method to override base texture image with the contents of a
248 * __DRIdrawable, including the required texture format attribute.
250 * For GLX_EXT_texture_from_pixmap with AIGLX.
254 void (*setTexBuffer2
)(__DRIcontext
*pDRICtx
,
257 __DRIdrawable
*pDraw
);
259 * Method to release texture buffer in case some special platform
262 * For GLX_EXT_texture_from_pixmap with AIGLX.
266 void (*releaseTexBuffer
)(__DRIcontext
*pDRICtx
,
268 __DRIdrawable
*pDraw
);
272 * Used by drivers that implement DRI2
274 #define __DRI2_FLUSH "DRI2_Flush"
275 #define __DRI2_FLUSH_VERSION 4
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)
281 enum __DRI2throttleReason
{
282 __DRI2_THROTTLE_SWAPBUFFER
,
283 __DRI2_THROTTLE_COPYSUBBUFFER
,
284 __DRI2_THROTTLE_FLUSHFRONT
287 struct __DRI2flushExtensionRec
{
289 void (*flush
)(__DRIdrawable
*drawable
);
292 * Ask the driver to call getBuffers/getBuffersWithFormat before
293 * it starts rendering again.
295 * \param drawable the drawable to invalidate
299 void (*invalidate
)(__DRIdrawable
*drawable
);
302 * This function reduces the number of flushes in the driver by combining
303 * several operations into one call.
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
317 void (*flush_with_flags
)(__DRIcontext
*ctx
,
318 __DRIdrawable
*drawable
,
320 enum __DRI2throttleReason throttle_reason
);
325 * Extension that the driver uses to request
326 * throttle callbacks.
329 #define __DRI2_THROTTLE "DRI2_Throttle"
330 #define __DRI2_THROTTLE_VERSION 1
332 struct __DRI2throttleExtensionRec
{
334 void (*throttle
)(__DRIcontext
*ctx
,
335 __DRIdrawable
*drawable
,
336 enum __DRI2throttleReason reason
);
341 * Extension for fences / synchronization objects.
344 #define __DRI2_FENCE "DRI2_Fence"
345 #define __DRI2_FENCE_VERSION 2
347 #define __DRI2_FENCE_TIMEOUT_INFINITE 0xffffffffffffffffull
349 #define __DRI2_FENCE_FLAG_FLUSH_COMMANDS (1 << 0)
352 * \name Capabilities that might be returned by __DRI2fenceExtensionRec::get_capabilities
355 #define __DRI_FENCE_CAP_NATIVE_FD 1
358 struct __DRI2fenceExtensionRec
{
362 * Create and insert a fence into the command stream of the context.
364 void *(*create_fence
)(__DRIcontext
*ctx
);
367 * Get a fence associated with the OpenCL event object.
368 * This can be NULL, meaning that OpenCL interoperability is not supported.
370 void *(*get_fence_from_cl_event
)(__DRIscreen
*screen
, intptr_t cl_event
);
375 void (*destroy_fence
)(__DRIscreen
*screen
, void *fence
);
378 * This function waits and doesn't return until the fence is signalled
379 * or the timeout expires. It returns true if the fence has been signaled.
381 * \param ctx the context where commands are flushed
382 * \param fence the fence
383 * \param flags a combination of __DRI2_FENCE_FLAG_xxx flags
384 * \param timeout the timeout in ns or __DRI2_FENCE_TIMEOUT_INFINITE
386 GLboolean (*client_wait_sync
)(__DRIcontext
*ctx
, void *fence
,
387 unsigned flags
, uint64_t timeout
);
390 * This function enqueues a wait command into the command stream of
391 * the context and then returns. When the execution reaches the wait
392 * command, no further execution will be done in the context until
393 * the fence is signaled. This is a no-op if the device doesn't support
394 * parallel execution of contexts.
396 * \param ctx the context where the waiting is done
397 * \param fence the fence
398 * \param flags a combination of __DRI2_FENCE_FLAG_xxx flags that make
399 * sense with this function (right now there are none)
401 void (*server_wait_sync
)(__DRIcontext
*ctx
, void *fence
, unsigned flags
);
404 * Query for general capabilities of the driver that concern fences.
405 * Returns a bitmask of __DRI_FENCE_CAP_x
409 unsigned (*get_capabilities
)(__DRIscreen
*screen
);
412 * Create an fd (file descriptor) associated fence. If the fence fd
413 * is -1, this behaves similarly to create_fence() except that when
414 * rendering is flushed the driver creates a fence fd. Otherwise,
415 * the driver wraps an existing fence fd.
417 * This is used to implement the EGL_ANDROID_native_fence_sync extension.
421 * \param ctx the context associated with the fence
422 * \param fd the fence fd or -1
424 void *(*create_fence_fd
)(__DRIcontext
*ctx
, int fd
);
427 * For fences created with create_fence_fd(), after rendering is flushed,
428 * this retrieves the native fence fd. Caller takes ownership of the
429 * fd and will close() it when it is no longer needed.
433 * \param screen the screen associated with the fence
434 * \param fence the fence
436 int (*get_fence_fd
)(__DRIscreen
*screen
, void *fence
);
441 * Extension for API interop.
442 * See GL/mesa_glinterop.h.
445 #define __DRI2_INTEROP "DRI2_Interop"
446 #define __DRI2_INTEROP_VERSION 1
448 struct mesa_glinterop_device_info
;
449 struct mesa_glinterop_export_in
;
450 struct mesa_glinterop_export_out
;
452 struct __DRI2interopExtensionRec
{
455 /** Same as MesaGLInterop*QueryDeviceInfo. */
456 int (*query_device_info
)(__DRIcontext
*ctx
,
457 struct mesa_glinterop_device_info
*out
);
459 /** Same as MesaGLInterop*ExportObject. */
460 int (*export_object
)(__DRIcontext
*ctx
,
461 struct mesa_glinterop_export_in
*in
,
462 struct mesa_glinterop_export_out
*out
);
468 * The following extensions describe loader features that the DRI
469 * driver can make use of. Some of these are mandatory, such as the
470 * getDrawableInfo extension for DRI and the DRI Loader extensions for
471 * DRI2, while others are optional, and if present allow the driver to
472 * expose certain features. The loader pass in a NULL terminated
473 * array of these extensions to the driver in the createNewScreen
477 typedef struct __DRIgetDrawableInfoExtensionRec __DRIgetDrawableInfoExtension
;
478 typedef struct __DRIsystemTimeExtensionRec __DRIsystemTimeExtension
;
479 typedef struct __DRIdamageExtensionRec __DRIdamageExtension
;
480 typedef struct __DRIloaderExtensionRec __DRIloaderExtension
;
481 typedef struct __DRIswrastLoaderExtensionRec __DRIswrastLoaderExtension
;
485 * Callback to getDrawableInfo protocol
487 #define __DRI_GET_DRAWABLE_INFO "DRI_GetDrawableInfo"
488 #define __DRI_GET_DRAWABLE_INFO_VERSION 1
489 struct __DRIgetDrawableInfoExtensionRec
{
493 * This function is used to get information about the position, size, and
494 * clip rects of a drawable.
496 GLboolean (* getDrawableInfo
) ( __DRIdrawable
*drawable
,
497 unsigned int * index
, unsigned int * stamp
,
498 int * x
, int * y
, int * width
, int * height
,
499 int * numClipRects
, drm_clip_rect_t
** pClipRects
,
500 int * backX
, int * backY
,
501 int * numBackClipRects
, drm_clip_rect_t
** pBackClipRects
,
502 void *loaderPrivate
);
506 * Callback to get system time for media stream counter extensions.
508 #define __DRI_SYSTEM_TIME "DRI_SystemTime"
509 #define __DRI_SYSTEM_TIME_VERSION 1
510 struct __DRIsystemTimeExtensionRec
{
514 * Get the 64-bit unadjusted system time (UST).
516 int (*getUST
)(int64_t * ust
);
519 * Get the media stream counter (MSC) rate.
521 * Matching the definition in GLX_OML_sync_control, this function returns
522 * the rate of the "media stream counter". In practical terms, this is
523 * the frame refresh rate of the display.
525 GLboolean (*getMSCRate
)(__DRIdrawable
*draw
,
526 int32_t * numerator
, int32_t * denominator
,
527 void *loaderPrivate
);
533 #define __DRI_DAMAGE "DRI_Damage"
534 #define __DRI_DAMAGE_VERSION 1
535 struct __DRIdamageExtensionRec
{
539 * Reports areas of the given drawable which have been modified by the
542 * \param drawable which the drawing was done to.
543 * \param rects rectangles affected, with the drawable origin as the
545 * \param x X offset of the drawable within the screen (used in the
547 * \param y Y offset of the drawable within the screen.
548 * \param front_buffer boolean flag for whether the drawing to the
549 * drawable was actually done directly to the front buffer (instead
550 * of backing storage, for example)
551 * \param loaderPrivate the data passed in at createNewDrawable time
553 void (*reportDamage
)(__DRIdrawable
*draw
,
555 drm_clip_rect_t
*rects
, int num_rects
,
556 GLboolean front_buffer
,
557 void *loaderPrivate
);
560 #define __DRI_SWRAST_IMAGE_OP_DRAW 1
561 #define __DRI_SWRAST_IMAGE_OP_CLEAR 2
562 #define __DRI_SWRAST_IMAGE_OP_SWAP 3
565 * SWRast Loader extension.
567 #define __DRI_SWRAST_LOADER "DRI_SWRastLoader"
568 #define __DRI_SWRAST_LOADER_VERSION 3
569 struct __DRIswrastLoaderExtensionRec
{
573 * Drawable position and size
575 void (*getDrawableInfo
)(__DRIdrawable
*drawable
,
576 int *x
, int *y
, int *width
, int *height
,
577 void *loaderPrivate
);
580 * Put image to drawable
582 void (*putImage
)(__DRIdrawable
*drawable
, int op
,
583 int x
, int y
, int width
, int height
,
584 char *data
, void *loaderPrivate
);
587 * Get image from readable
589 void (*getImage
)(__DRIdrawable
*readable
,
590 int x
, int y
, int width
, int height
,
591 char *data
, void *loaderPrivate
);
594 * Put image to drawable
598 void (*putImage2
)(__DRIdrawable
*drawable
, int op
,
599 int x
, int y
, int width
, int height
, int stride
,
600 char *data
, void *loaderPrivate
);
603 * Put image to drawable
607 void (*getImage2
)(__DRIdrawable
*readable
,
608 int x
, int y
, int width
, int height
, int stride
,
609 char *data
, void *loaderPrivate
);
613 * Invalidate loader extension. The presence of this extension
614 * indicates to the DRI driver that the loader will call invalidate in
615 * the __DRI2_FLUSH extension, whenever the needs to query for new
616 * buffers. This means that the DRI driver can drop the polling in
619 * The extension doesn't provide any functionality, it's only use to
620 * indicate to the driver that it can use the new semantics. A DRI
621 * driver can use this to switch between the different semantics or
622 * just refuse to initialize if this extension isn't present.
624 #define __DRI_USE_INVALIDATE "DRI_UseInvalidate"
625 #define __DRI_USE_INVALIDATE_VERSION 1
627 typedef struct __DRIuseInvalidateExtensionRec __DRIuseInvalidateExtension
;
628 struct __DRIuseInvalidateExtensionRec
{
633 * The remaining extensions describe driver extensions, immediately
634 * available interfaces provided by the driver. To start using the
635 * driver, dlsym() for the __DRI_DRIVER_EXTENSIONS symbol and look for
636 * the extension you need in the array.
638 #define __DRI_DRIVER_EXTENSIONS "__driDriverExtensions"
641 * This symbol replaces the __DRI_DRIVER_EXTENSIONS symbol, and will be
642 * suffixed by "_drivername", allowing multiple drivers to be built into one
643 * library, and also giving the driver the chance to return a variable driver
644 * extensions struct depending on the driver name being loaded or any other
647 * The function prototype is:
649 * const __DRIextension **__driDriverGetExtensions_drivername(void);
651 #define __DRI_DRIVER_GET_EXTENSIONS "__driDriverGetExtensions"
654 * Tokens for __DRIconfig attribs. A number of attributes defined by
655 * GLX or EGL standards are not in the table, as they must be provided
656 * by the loader. For example, FBConfig ID or visual ID, drawable type.
659 #define __DRI_ATTRIB_BUFFER_SIZE 1
660 #define __DRI_ATTRIB_LEVEL 2
661 #define __DRI_ATTRIB_RED_SIZE 3
662 #define __DRI_ATTRIB_GREEN_SIZE 4
663 #define __DRI_ATTRIB_BLUE_SIZE 5
664 #define __DRI_ATTRIB_LUMINANCE_SIZE 6
665 #define __DRI_ATTRIB_ALPHA_SIZE 7
666 #define __DRI_ATTRIB_ALPHA_MASK_SIZE 8
667 #define __DRI_ATTRIB_DEPTH_SIZE 9
668 #define __DRI_ATTRIB_STENCIL_SIZE 10
669 #define __DRI_ATTRIB_ACCUM_RED_SIZE 11
670 #define __DRI_ATTRIB_ACCUM_GREEN_SIZE 12
671 #define __DRI_ATTRIB_ACCUM_BLUE_SIZE 13
672 #define __DRI_ATTRIB_ACCUM_ALPHA_SIZE 14
673 #define __DRI_ATTRIB_SAMPLE_BUFFERS 15
674 #define __DRI_ATTRIB_SAMPLES 16
675 #define __DRI_ATTRIB_RENDER_TYPE 17
676 #define __DRI_ATTRIB_CONFIG_CAVEAT 18
677 #define __DRI_ATTRIB_CONFORMANT 19
678 #define __DRI_ATTRIB_DOUBLE_BUFFER 20
679 #define __DRI_ATTRIB_STEREO 21
680 #define __DRI_ATTRIB_AUX_BUFFERS 22
681 #define __DRI_ATTRIB_TRANSPARENT_TYPE 23
682 #define __DRI_ATTRIB_TRANSPARENT_INDEX_VALUE 24
683 #define __DRI_ATTRIB_TRANSPARENT_RED_VALUE 25
684 #define __DRI_ATTRIB_TRANSPARENT_GREEN_VALUE 26
685 #define __DRI_ATTRIB_TRANSPARENT_BLUE_VALUE 27
686 #define __DRI_ATTRIB_TRANSPARENT_ALPHA_VALUE 28
687 #define __DRI_ATTRIB_FLOAT_MODE 29
688 #define __DRI_ATTRIB_RED_MASK 30
689 #define __DRI_ATTRIB_GREEN_MASK 31
690 #define __DRI_ATTRIB_BLUE_MASK 32
691 #define __DRI_ATTRIB_ALPHA_MASK 33
692 #define __DRI_ATTRIB_MAX_PBUFFER_WIDTH 34
693 #define __DRI_ATTRIB_MAX_PBUFFER_HEIGHT 35
694 #define __DRI_ATTRIB_MAX_PBUFFER_PIXELS 36
695 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_WIDTH 37
696 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_HEIGHT 38
697 #define __DRI_ATTRIB_VISUAL_SELECT_GROUP 39
698 #define __DRI_ATTRIB_SWAP_METHOD 40
699 #define __DRI_ATTRIB_MAX_SWAP_INTERVAL 41
700 #define __DRI_ATTRIB_MIN_SWAP_INTERVAL 42
701 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGB 43
702 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGBA 44
703 #define __DRI_ATTRIB_BIND_TO_MIPMAP_TEXTURE 45
704 #define __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS 46
705 #define __DRI_ATTRIB_YINVERTED 47
706 #define __DRI_ATTRIB_FRAMEBUFFER_SRGB_CAPABLE 48
707 #define __DRI_ATTRIB_MAX (__DRI_ATTRIB_FRAMEBUFFER_SRGB_CAPABLE + 1)
709 /* __DRI_ATTRIB_RENDER_TYPE */
710 #define __DRI_ATTRIB_RGBA_BIT 0x01
711 #define __DRI_ATTRIB_COLOR_INDEX_BIT 0x02
712 #define __DRI_ATTRIB_LUMINANCE_BIT 0x04
713 #define __DRI_ATTRIB_FLOAT_BIT 0x08
714 #define __DRI_ATTRIB_UNSIGNED_FLOAT_BIT 0x10
716 /* __DRI_ATTRIB_CONFIG_CAVEAT */
717 #define __DRI_ATTRIB_SLOW_BIT 0x01
718 #define __DRI_ATTRIB_NON_CONFORMANT_CONFIG 0x02
720 /* __DRI_ATTRIB_TRANSPARENT_TYPE */
721 #define __DRI_ATTRIB_TRANSPARENT_RGB 0x00
722 #define __DRI_ATTRIB_TRANSPARENT_INDEX 0x01
724 /* __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS */
725 #define __DRI_ATTRIB_TEXTURE_1D_BIT 0x01
726 #define __DRI_ATTRIB_TEXTURE_2D_BIT 0x02
727 #define __DRI_ATTRIB_TEXTURE_RECTANGLE_BIT 0x04
729 /* __DRI_ATTRIB_SWAP_METHOD */
730 /* Note that with the exception of __DRI_ATTRIB_SWAP_NONE, we need to define
731 * the same tokens as GLX. This is because old and current X servers will
732 * transmit the driconf value grabbed from the AIGLX driver untranslated as
733 * the GLX fbconfig value. __DRI_ATTRIB_SWAP_NONE is only used by dri drivers
734 * to signal to the dri core that the driconfig is single-buffer.
736 #define __DRI_ATTRIB_SWAP_NONE 0x0000
737 #define __DRI_ATTRIB_SWAP_EXCHANGE 0x8061
738 #define __DRI_ATTRIB_SWAP_COPY 0x8062
739 #define __DRI_ATTRIB_SWAP_UNDEFINED 0x8063
742 * This extension defines the core DRI functionality.
744 * Version >= 2 indicates that getConfigAttrib with __DRI_ATTRIB_SWAP_METHOD
745 * returns a reliable value.
747 #define __DRI_CORE "DRI_Core"
748 #define __DRI_CORE_VERSION 2
750 struct __DRIcoreExtensionRec
{
753 __DRIscreen
*(*createNewScreen
)(int screen
, int fd
,
754 unsigned int sarea_handle
,
755 const __DRIextension
**extensions
,
756 const __DRIconfig
***driverConfigs
,
757 void *loaderPrivate
);
759 void (*destroyScreen
)(__DRIscreen
*screen
);
761 const __DRIextension
**(*getExtensions
)(__DRIscreen
*screen
);
763 int (*getConfigAttrib
)(const __DRIconfig
*config
,
765 unsigned int *value
);
767 int (*indexConfigAttrib
)(const __DRIconfig
*config
, int index
,
768 unsigned int *attrib
, unsigned int *value
);
770 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
771 const __DRIconfig
*config
,
772 unsigned int drawable_id
,
774 void *loaderPrivate
);
776 void (*destroyDrawable
)(__DRIdrawable
*drawable
);
778 void (*swapBuffers
)(__DRIdrawable
*drawable
);
780 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
781 const __DRIconfig
*config
,
782 __DRIcontext
*shared
,
783 void *loaderPrivate
);
785 int (*copyContext
)(__DRIcontext
*dest
,
789 void (*destroyContext
)(__DRIcontext
*context
);
791 int (*bindContext
)(__DRIcontext
*ctx
,
792 __DRIdrawable
*pdraw
,
793 __DRIdrawable
*pread
);
795 int (*unbindContext
)(__DRIcontext
*ctx
);
799 * Stored version of some component (i.e., server-side DRI module, kernel-side
803 * There are several data structures that explicitly store a major version,
804 * minor version, and patch level. These structures should be modified to
805 * have a \c __DRIversionRec instead.
807 struct __DRIversionRec
{
808 int major
; /**< Major version number. */
809 int minor
; /**< Minor version number. */
810 int patch
; /**< Patch-level. */
814 * Framebuffer information record. Used by libGL to communicate information
815 * about the framebuffer to the driver's \c __driCreateNewScreen function.
817 * In XFree86, most of this information is derrived from data returned by
818 * calling \c XF86DRIGetDeviceInfo.
820 * \sa XF86DRIGetDeviceInfo __DRIdisplayRec::createNewScreen
821 * __driUtilCreateNewScreen CallCreateNewScreen
823 * \bug This structure could be better named.
825 struct __DRIframebufferRec
{
826 unsigned char *base
; /**< Framebuffer base address in the CPU's
827 * address space. This value is calculated by
828 * calling \c drmMap on the framebuffer handle
829 * returned by \c XF86DRIGetDeviceInfo (or a
832 int size
; /**< Framebuffer size, in bytes. */
833 int stride
; /**< Number of bytes from one line to the next. */
834 int width
; /**< Pixel width of the framebuffer. */
835 int height
; /**< Pixel height of the framebuffer. */
836 int dev_priv_size
; /**< Size of the driver's dev-priv structure. */
837 void *dev_priv
; /**< Pointer to the driver's dev-priv structure. */
842 * This extension provides alternative screen, drawable and context
843 * constructors for legacy DRI functionality. This is used in
844 * conjunction with the core extension.
846 #define __DRI_LEGACY "DRI_Legacy"
847 #define __DRI_LEGACY_VERSION 1
849 struct __DRIlegacyExtensionRec
{
852 __DRIscreen
*(*createNewScreen
)(int screen
,
853 const __DRIversion
*ddx_version
,
854 const __DRIversion
*dri_version
,
855 const __DRIversion
*drm_version
,
856 const __DRIframebuffer
*frame_buffer
,
857 void *pSAREA
, int fd
,
858 const __DRIextension
**extensions
,
859 const __DRIconfig
***driver_configs
,
860 void *loaderPrivate
);
862 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
863 const __DRIconfig
*config
,
864 drm_drawable_t hwDrawable
,
865 int renderType
, const int *attrs
,
866 void *loaderPrivate
);
868 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
869 const __DRIconfig
*config
,
871 __DRIcontext
*shared
,
872 drm_context_t hwContext
,
873 void *loaderPrivate
);
877 * This extension provides alternative screen, drawable and context
878 * constructors for swrast DRI functionality. This is used in
879 * conjunction with the core extension.
881 #define __DRI_SWRAST "DRI_SWRast"
882 #define __DRI_SWRAST_VERSION 4
884 struct __DRIswrastExtensionRec
{
887 __DRIscreen
*(*createNewScreen
)(int screen
,
888 const __DRIextension
**extensions
,
889 const __DRIconfig
***driver_configs
,
890 void *loaderPrivate
);
892 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
893 const __DRIconfig
*config
,
894 void *loaderPrivate
);
896 /* Since version 2 */
897 __DRIcontext
*(*createNewContextForAPI
)(__DRIscreen
*screen
,
899 const __DRIconfig
*config
,
900 __DRIcontext
*shared
,
904 * Create a context for a particular API with a set of attributes
908 * \sa __DRIdri2ExtensionRec::createContextAttribs
910 __DRIcontext
*(*createContextAttribs
)(__DRIscreen
*screen
,
912 const __DRIconfig
*config
,
913 __DRIcontext
*shared
,
914 unsigned num_attribs
,
915 const uint32_t *attribs
,
917 void *loaderPrivate
);
920 * createNewScreen() with the driver extensions passed in.
924 __DRIscreen
*(*createNewScreen2
)(int screen
,
925 const __DRIextension
**loader_extensions
,
926 const __DRIextension
**driver_extensions
,
927 const __DRIconfig
***driver_configs
,
928 void *loaderPrivate
);
932 /** Common DRI function definitions, shared among DRI2 and Image extensions
935 typedef __DRIscreen
*
936 (*__DRIcreateNewScreen2Func
)(int screen
, int fd
,
937 const __DRIextension
**extensions
,
938 const __DRIextension
**driver_extensions
,
939 const __DRIconfig
***driver_configs
,
940 void *loaderPrivate
);
942 typedef __DRIdrawable
*
943 (*__DRIcreateNewDrawableFunc
)(__DRIscreen
*screen
,
944 const __DRIconfig
*config
,
945 void *loaderPrivate
);
947 typedef __DRIcontext
*
948 (*__DRIcreateContextAttribsFunc
)(__DRIscreen
*screen
,
950 const __DRIconfig
*config
,
951 __DRIcontext
*shared
,
952 unsigned num_attribs
,
953 const uint32_t *attribs
,
955 void *loaderPrivate
);
958 (*__DRIgetAPIMaskFunc
)(__DRIscreen
*screen
);
961 * DRI2 Loader extension.
963 #define __DRI_BUFFER_FRONT_LEFT 0
964 #define __DRI_BUFFER_BACK_LEFT 1
965 #define __DRI_BUFFER_FRONT_RIGHT 2
966 #define __DRI_BUFFER_BACK_RIGHT 3
967 #define __DRI_BUFFER_DEPTH 4
968 #define __DRI_BUFFER_STENCIL 5
969 #define __DRI_BUFFER_ACCUM 6
970 #define __DRI_BUFFER_FAKE_FRONT_LEFT 7
971 #define __DRI_BUFFER_FAKE_FRONT_RIGHT 8
972 #define __DRI_BUFFER_DEPTH_STENCIL 9 /**< Only available with DRI2 1.1 */
973 #define __DRI_BUFFER_HIZ 10
975 /* Inofficial and for internal use. Increase when adding a new buffer token. */
976 #define __DRI_BUFFER_COUNT 11
978 struct __DRIbufferRec
{
979 unsigned int attachment
;
986 #define __DRI_DRI2_LOADER "DRI_DRI2Loader"
987 #define __DRI_DRI2_LOADER_VERSION 4
989 enum dri_loader_cap
{
990 /* Whether the loader handles RGBA channel ordering correctly. If not,
991 * only BGRA ordering can be exposed.
993 DRI_LOADER_CAP_RGBA_ORDERING
,
996 struct __DRIdri2LoaderExtensionRec
{
999 __DRIbuffer
*(*getBuffers
)(__DRIdrawable
*driDrawable
,
1000 int *width
, int *height
,
1001 unsigned int *attachments
, int count
,
1002 int *out_count
, void *loaderPrivate
);
1005 * Flush pending front-buffer rendering
1007 * Any rendering that has been performed to the
1008 * \c __DRI_BUFFER_FAKE_FRONT_LEFT will be flushed to the
1009 * \c __DRI_BUFFER_FRONT_LEFT.
1011 * \param driDrawable Drawable whose front-buffer is to be flushed
1012 * \param loaderPrivate Loader's private data that was previously passed
1013 * into __DRIdri2ExtensionRec::createNewDrawable
1017 void (*flushFrontBuffer
)(__DRIdrawable
*driDrawable
, void *loaderPrivate
);
1021 * Get list of buffers from the server
1023 * Gets a list of buffer for the specified set of attachments. Unlike
1024 * \c ::getBuffers, this function takes a list of attachments paired with
1025 * opaque \c unsigned \c int value describing the format of the buffer.
1026 * It is the responsibility of the caller to know what the service that
1027 * allocates the buffers will expect to receive for the format.
1029 * \param driDrawable Drawable whose buffers are being queried.
1030 * \param width Output where the width of the buffers is stored.
1031 * \param height Output where the height of the buffers is stored.
1032 * \param attachments List of pairs of attachment ID and opaque format
1033 * requested for the drawable.
1034 * \param count Number of attachment / format pairs stored in
1036 * \param loaderPrivate Loader's private data that was previously passed
1037 * into __DRIdri2ExtensionRec::createNewDrawable.
1041 __DRIbuffer
*(*getBuffersWithFormat
)(__DRIdrawable
*driDrawable
,
1042 int *width
, int *height
,
1043 unsigned int *attachments
, int count
,
1044 int *out_count
, void *loaderPrivate
);
1047 * Return a loader capability value. If the loader doesn't know the enum,
1050 * \param loaderPrivate The last parameter of createNewScreen or
1052 * \param cap See the enum.
1056 unsigned (*getCapability
)(void *loaderPrivate
, enum dri_loader_cap cap
);
1060 * This extension provides alternative screen, drawable and context
1061 * constructors for DRI2.
1063 #define __DRI_DRI2 "DRI_DRI2"
1064 #define __DRI_DRI2_VERSION 4
1066 #define __DRI_API_OPENGL 0 /**< OpenGL compatibility profile */
1067 #define __DRI_API_GLES 1 /**< OpenGL ES 1.x */
1068 #define __DRI_API_GLES2 2 /**< OpenGL ES 2.x */
1069 #define __DRI_API_OPENGL_CORE 3 /**< OpenGL 3.2+ core profile */
1070 #define __DRI_API_GLES3 4 /**< OpenGL ES 3.x */
1072 #define __DRI_CTX_ATTRIB_MAJOR_VERSION 0
1073 #define __DRI_CTX_ATTRIB_MINOR_VERSION 1
1074 #define __DRI_CTX_ATTRIB_FLAGS 2
1077 * \requires __DRI2_ROBUSTNESS.
1079 #define __DRI_CTX_ATTRIB_RESET_STRATEGY 3
1081 #define __DRI_CTX_FLAG_DEBUG 0x00000001
1082 #define __DRI_CTX_FLAG_FORWARD_COMPATIBLE 0x00000002
1085 * \requires __DRI2_ROBUSTNESS.
1087 #define __DRI_CTX_FLAG_ROBUST_BUFFER_ACCESS 0x00000004
1090 * \requires __DRI2_NO_ERROR.
1093 #define __DRI_CTX_FLAG_NO_ERROR 0x00000008
1096 * \name Context reset strategies.
1099 #define __DRI_CTX_RESET_NO_NOTIFICATION 0
1100 #define __DRI_CTX_RESET_LOSE_CONTEXT 1
1104 * \name Reasons that __DRIdri2Extension::createContextAttribs might fail
1108 #define __DRI_CTX_ERROR_SUCCESS 0
1110 /** Memory allocation failure */
1111 #define __DRI_CTX_ERROR_NO_MEMORY 1
1113 /** Client requested an API (e.g., OpenGL ES 2.0) that the driver can't do. */
1114 #define __DRI_CTX_ERROR_BAD_API 2
1116 /** Client requested an API version that the driver can't do. */
1117 #define __DRI_CTX_ERROR_BAD_VERSION 3
1119 /** Client requested a flag or combination of flags the driver can't do. */
1120 #define __DRI_CTX_ERROR_BAD_FLAG 4
1122 /** Client requested an attribute the driver doesn't understand. */
1123 #define __DRI_CTX_ERROR_UNKNOWN_ATTRIBUTE 5
1125 /** Client requested a flag the driver doesn't understand. */
1126 #define __DRI_CTX_ERROR_UNKNOWN_FLAG 6
1129 struct __DRIdri2ExtensionRec
{
1130 __DRIextension base
;
1132 __DRIscreen
*(*createNewScreen
)(int screen
, int fd
,
1133 const __DRIextension
**extensions
,
1134 const __DRIconfig
***driver_configs
,
1135 void *loaderPrivate
);
1137 __DRIcreateNewDrawableFunc createNewDrawable
;
1138 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
1139 const __DRIconfig
*config
,
1140 __DRIcontext
*shared
,
1141 void *loaderPrivate
);
1143 /* Since version 2 */
1144 __DRIgetAPIMaskFunc getAPIMask
;
1146 __DRIcontext
*(*createNewContextForAPI
)(__DRIscreen
*screen
,
1148 const __DRIconfig
*config
,
1149 __DRIcontext
*shared
,
1152 __DRIbuffer
*(*allocateBuffer
)(__DRIscreen
*screen
,
1153 unsigned int attachment
,
1154 unsigned int format
,
1157 void (*releaseBuffer
)(__DRIscreen
*screen
,
1158 __DRIbuffer
*buffer
);
1161 * Create a context for a particular API with a set of attributes
1165 * \sa __DRIswrastExtensionRec::createContextAttribs
1167 __DRIcreateContextAttribsFunc createContextAttribs
;
1170 * createNewScreen with the driver's extension list passed in.
1174 __DRIcreateNewScreen2Func createNewScreen2
;
1179 * This extension provides functionality to enable various EGLImage
1182 #define __DRI_IMAGE "DRI_IMAGE"
1183 #define __DRI_IMAGE_VERSION 15
1186 * These formats correspond to the similarly named MESA_FORMAT_*
1187 * tokens, except in the native endian of the CPU. For example, on
1188 * little endian __DRI_IMAGE_FORMAT_XRGB8888 corresponds to
1189 * MESA_FORMAT_XRGB8888, but MESA_FORMAT_XRGB8888_REV on big endian.
1191 * __DRI_IMAGE_FORMAT_NONE is for images that aren't directly usable
1192 * by the driver (YUV planar formats) but serve as a base image for
1193 * creating sub-images for the different planes within the image.
1195 * R8, GR88 and NONE should not be used with createImageFromName or
1196 * createImage, and are returned by query from sub images created with
1197 * createImageFromNames (NONE, see above) and fromPlane (R8 & GR88).
1199 #define __DRI_IMAGE_FORMAT_RGB565 0x1001
1200 #define __DRI_IMAGE_FORMAT_XRGB8888 0x1002
1201 #define __DRI_IMAGE_FORMAT_ARGB8888 0x1003
1202 #define __DRI_IMAGE_FORMAT_ABGR8888 0x1004
1203 #define __DRI_IMAGE_FORMAT_XBGR8888 0x1005
1204 #define __DRI_IMAGE_FORMAT_R8 0x1006 /* Since version 5 */
1205 #define __DRI_IMAGE_FORMAT_GR88 0x1007
1206 #define __DRI_IMAGE_FORMAT_NONE 0x1008
1207 #define __DRI_IMAGE_FORMAT_XRGB2101010 0x1009
1208 #define __DRI_IMAGE_FORMAT_ARGB2101010 0x100a
1209 #define __DRI_IMAGE_FORMAT_SARGB8 0x100b
1210 #define __DRI_IMAGE_FORMAT_ARGB1555 0x100c
1211 #define __DRI_IMAGE_FORMAT_R16 0x100d
1212 #define __DRI_IMAGE_FORMAT_GR1616 0x100e
1214 #define __DRI_IMAGE_USE_SHARE 0x0001
1215 #define __DRI_IMAGE_USE_SCANOUT 0x0002
1216 #define __DRI_IMAGE_USE_CURSOR 0x0004 /* Deprecated */
1217 #define __DRI_IMAGE_USE_LINEAR 0x0008
1218 /* The buffer will only be read by an external process after SwapBuffers,
1219 * in contrary to gbm buffers, front buffers and fake front buffers, which
1220 * could be read after a flush."
1222 #define __DRI_IMAGE_USE_BACKBUFFER 0x0010
1225 #define __DRI_IMAGE_TRANSFER_READ 0x1
1226 #define __DRI_IMAGE_TRANSFER_WRITE 0x2
1227 #define __DRI_IMAGE_TRANSFER_READ_WRITE \
1228 (__DRI_IMAGE_TRANSFER_READ | __DRI_IMAGE_TRANSFER_WRITE)
1231 * Four CC formats that matches with WL_DRM_FORMAT_* from wayland_drm.h,
1232 * GBM_FORMAT_* from gbm.h, and DRM_FORMAT_* from drm_fourcc.h. Used with
1233 * createImageFromNames.
1238 #define __DRI_IMAGE_FOURCC_R8 0x20203852
1239 #define __DRI_IMAGE_FOURCC_GR88 0x38385247
1240 #define __DRI_IMAGE_FOURCC_ARGB1555 0x35315241
1241 #define __DRI_IMAGE_FOURCC_R16 0x20363152
1242 #define __DRI_IMAGE_FOURCC_GR1616 0x32335247
1243 #define __DRI_IMAGE_FOURCC_RGB565 0x36314752
1244 #define __DRI_IMAGE_FOURCC_ARGB8888 0x34325241
1245 #define __DRI_IMAGE_FOURCC_XRGB8888 0x34325258
1246 #define __DRI_IMAGE_FOURCC_ABGR8888 0x34324241
1247 #define __DRI_IMAGE_FOURCC_XBGR8888 0x34324258
1248 #define __DRI_IMAGE_FOURCC_SARGB8888 0x83324258
1249 #define __DRI_IMAGE_FOURCC_YUV410 0x39565559
1250 #define __DRI_IMAGE_FOURCC_YUV411 0x31315559
1251 #define __DRI_IMAGE_FOURCC_YUV420 0x32315559
1252 #define __DRI_IMAGE_FOURCC_YUV422 0x36315559
1253 #define __DRI_IMAGE_FOURCC_YUV444 0x34325559
1254 #define __DRI_IMAGE_FOURCC_NV12 0x3231564e
1255 #define __DRI_IMAGE_FOURCC_NV16 0x3631564e
1256 #define __DRI_IMAGE_FOURCC_YUYV 0x56595559
1257 #define __DRI_IMAGE_FOURCC_UYVY 0x59565955
1259 #define __DRI_IMAGE_FOURCC_YVU410 0x39555659
1260 #define __DRI_IMAGE_FOURCC_YVU411 0x31315659
1261 #define __DRI_IMAGE_FOURCC_YVU420 0x32315659
1262 #define __DRI_IMAGE_FOURCC_YVU422 0x36315659
1263 #define __DRI_IMAGE_FOURCC_YVU444 0x34325659
1266 * Queryable on images created by createImageFromNames.
1268 * RGB and RGBA are may be usable directly as images but its still
1269 * recommended to call fromPlanar with plane == 0.
1271 * Y_U_V, Y_UV,Y_XUXV and Y_UXVX all requires call to fromPlanar to create
1272 * usable sub-images, sampling from images return raw YUV data and
1273 * color conversion needs to be done in the shader.
1278 #define __DRI_IMAGE_COMPONENTS_RGB 0x3001
1279 #define __DRI_IMAGE_COMPONENTS_RGBA 0x3002
1280 #define __DRI_IMAGE_COMPONENTS_Y_U_V 0x3003
1281 #define __DRI_IMAGE_COMPONENTS_Y_UV 0x3004
1282 #define __DRI_IMAGE_COMPONENTS_Y_XUXV 0x3005
1283 #define __DRI_IMAGE_COMPONENTS_Y_UXVX 0x3008
1284 #define __DRI_IMAGE_COMPONENTS_R 0x3006
1285 #define __DRI_IMAGE_COMPONENTS_RG 0x3007
1289 * queryImage attributes
1292 #define __DRI_IMAGE_ATTRIB_STRIDE 0x2000
1293 #define __DRI_IMAGE_ATTRIB_HANDLE 0x2001
1294 #define __DRI_IMAGE_ATTRIB_NAME 0x2002
1295 #define __DRI_IMAGE_ATTRIB_FORMAT 0x2003 /* available in versions 3+ */
1296 #define __DRI_IMAGE_ATTRIB_WIDTH 0x2004 /* available in versions 4+ */
1297 #define __DRI_IMAGE_ATTRIB_HEIGHT 0x2005
1298 #define __DRI_IMAGE_ATTRIB_COMPONENTS 0x2006 /* available in versions 5+ */
1299 #define __DRI_IMAGE_ATTRIB_FD 0x2007 /* available in versions
1300 * 7+. Each query will return a
1302 #define __DRI_IMAGE_ATTRIB_FOURCC 0x2008 /* available in versions 11 */
1303 #define __DRI_IMAGE_ATTRIB_NUM_PLANES 0x2009 /* available in versions 11 */
1305 #define __DRI_IMAGE_ATTRIB_OFFSET 0x200A /* available in versions 13 */
1306 #define __DRI_IMAGE_ATTRIB_MODIFIER_LOWER 0x200B /* available in versions 14 */
1307 #define __DRI_IMAGE_ATTRIB_MODIFIER_UPPER 0x200C /* available in versions 14 */
1309 enum __DRIYUVColorSpace
{
1310 __DRI_YUV_COLOR_SPACE_UNDEFINED
= 0,
1311 __DRI_YUV_COLOR_SPACE_ITU_REC601
= 0x327F,
1312 __DRI_YUV_COLOR_SPACE_ITU_REC709
= 0x3280,
1313 __DRI_YUV_COLOR_SPACE_ITU_REC2020
= 0x3281
1316 enum __DRISampleRange
{
1317 __DRI_YUV_RANGE_UNDEFINED
= 0,
1318 __DRI_YUV_FULL_RANGE
= 0x3282,
1319 __DRI_YUV_NARROW_RANGE
= 0x3283
1322 enum __DRIChromaSiting
{
1323 __DRI_YUV_CHROMA_SITING_UNDEFINED
= 0,
1324 __DRI_YUV_CHROMA_SITING_0
= 0x3284,
1325 __DRI_YUV_CHROMA_SITING_0_5
= 0x3285
1329 * \name Reasons that __DRIimageExtensionRec::createImageFromTexture or
1330 * __DRIimageExtensionRec::createImageFromDmaBufs might fail
1334 #define __DRI_IMAGE_ERROR_SUCCESS 0
1336 /** Memory allocation failure */
1337 #define __DRI_IMAGE_ERROR_BAD_ALLOC 1
1339 /** Client requested an invalid attribute */
1340 #define __DRI_IMAGE_ERROR_BAD_MATCH 2
1342 /** Client requested an invalid texture object */
1343 #define __DRI_IMAGE_ERROR_BAD_PARAMETER 3
1345 /** Client requested an invalid pitch and/or offset */
1346 #define __DRI_IMAGE_ERROR_BAD_ACCESS 4
1350 * \name Capabilities that might be returned by __DRIimageExtensionRec::getCapabilities
1353 #define __DRI_IMAGE_CAP_GLOBAL_NAMES 1
1360 #define __BLIT_FLAG_FLUSH 0x0001
1361 #define __BLIT_FLAG_FINISH 0x0002
1363 typedef struct __DRIimageRec __DRIimage
;
1364 typedef struct __DRIimageExtensionRec __DRIimageExtension
;
1365 struct __DRIimageExtensionRec
{
1366 __DRIextension base
;
1368 __DRIimage
*(*createImageFromName
)(__DRIscreen
*screen
,
1369 int width
, int height
, int format
,
1370 int name
, int pitch
,
1371 void *loaderPrivate
);
1373 __DRIimage
*(*createImageFromRenderbuffer
)(__DRIcontext
*context
,
1375 void *loaderPrivate
);
1377 void (*destroyImage
)(__DRIimage
*image
);
1379 __DRIimage
*(*createImage
)(__DRIscreen
*screen
,
1380 int width
, int height
, int format
,
1382 void *loaderPrivate
);
1384 GLboolean (*queryImage
)(__DRIimage
*image
, int attrib
, int *value
);
1387 * The new __DRIimage will share the content with the old one, see dup(2).
1389 __DRIimage
*(*dupImage
)(__DRIimage
*image
, void *loaderPrivate
);
1392 * Validate that a __DRIimage can be used a certain way.
1396 GLboolean (*validateUsage
)(__DRIimage
*image
, unsigned int use
);
1399 * Unlike createImageFromName __DRI_IMAGE_FORMAT is not but instead
1400 * __DRI_IMAGE_FOURCC and strides are in bytes not pixels. Stride is
1401 * also per block and not per pixel (for non-RGB, see gallium blocks).
1405 __DRIimage
*(*createImageFromNames
)(__DRIscreen
*screen
,
1406 int width
, int height
, int fourcc
,
1407 int *names
, int num_names
,
1408 int *strides
, int *offsets
,
1409 void *loaderPrivate
);
1412 * Create an image out of a sub-region of a parent image. This
1413 * entry point lets us create individual __DRIimages for different
1414 * planes in a planar buffer (typically yuv), for example. While a
1415 * sub-image shares the underlying buffer object with the parent
1416 * image and other sibling sub-images, the life times of parent and
1417 * sub-images are not dependent. Destroying the parent or a
1418 * sub-image doesn't affect other images. The underlying buffer
1419 * object is free when no __DRIimage remains that references it.
1421 * Sub-images may overlap, but rendering to overlapping sub-images
1426 __DRIimage
*(*fromPlanar
)(__DRIimage
*image
, int plane
,
1427 void *loaderPrivate
);
1430 * Create image from texture.
1434 __DRIimage
*(*createImageFromTexture
)(__DRIcontext
*context
,
1440 void *loaderPrivate
);
1442 * Like createImageFromNames, but takes a prime fd instead.
1446 __DRIimage
*(*createImageFromFds
)(__DRIscreen
*screen
,
1447 int width
, int height
, int fourcc
,
1448 int *fds
, int num_fds
,
1449 int *strides
, int *offsets
,
1450 void *loaderPrivate
);
1453 * Like createImageFromFds, but takes additional attributes.
1455 * For EGL_EXT_image_dma_buf_import.
1459 __DRIimage
*(*createImageFromDmaBufs
)(__DRIscreen
*screen
,
1460 int width
, int height
, int fourcc
,
1461 int *fds
, int num_fds
,
1462 int *strides
, int *offsets
,
1463 enum __DRIYUVColorSpace color_space
,
1464 enum __DRISampleRange sample_range
,
1465 enum __DRIChromaSiting horiz_siting
,
1466 enum __DRIChromaSiting vert_siting
,
1468 void *loaderPrivate
);
1471 * Blit a part of a __DRIimage to another and flushes
1475 * __BLIT_FLAG_FLUSH: flush after the blit operation
1476 * __BLIT_FLAG_FINISH: flush and wait the blit finished
1480 void (*blitImage
)(__DRIcontext
*context
, __DRIimage
*dst
, __DRIimage
*src
,
1481 int dstx0
, int dsty0
, int dstwidth
, int dstheight
,
1482 int srcx0
, int srcy0
, int srcwidth
, int srcheight
,
1486 * Query for general capabilities of the driver that concern
1487 * buffer sharing and image importing.
1491 int (*getCapabilities
)(__DRIscreen
*screen
);
1494 * Returns a map of the specified region of a __DRIimage for the specified usage.
1496 * flags may include __DRI_IMAGE_TRANSFER_READ, which will populate the
1497 * mapping with the current buffer content. If __DRI_IMAGE_TRANSFER_READ
1498 * is not included in the flags, the buffer content at map time is
1499 * undefined. Users wanting to modify the mapping must include
1500 * __DRI_IMAGE_TRANSFER_WRITE; if __DRI_IMAGE_TRANSFER_WRITE is not
1501 * included, behaviour when writing the mapping is undefined.
1503 * Returns the byte stride in *stride, and an opaque pointer to data
1504 * tracking the mapping in **data, which must be passed to unmapImage().
1508 void *(*mapImage
)(__DRIcontext
*context
, __DRIimage
*image
,
1509 int x0
, int y0
, int width
, int height
,
1510 unsigned int flags
, int *stride
, void **data
);
1513 * Unmap a previously mapped __DRIimage
1517 void (*unmapImage
)(__DRIcontext
*context
, __DRIimage
*image
, void *data
);
1521 * Creates an image with implementation's favorite modifiers.
1523 * This acts like createImage except there is a list of modifiers passed in
1524 * which the implementation may selectively use to create the DRIimage. The
1525 * result should be the implementation selects one modifier (perhaps it would
1526 * hold on to a few and later pick).
1528 * The created image should be destroyed with destroyImage().
1530 * Returns the new DRIimage. The chosen modifier can be obtained later on
1531 * and passed back to things like the kernel's AddFB2 interface.
1533 * \sa __DRIimageRec::createImage
1537 __DRIimage
*(*createImageWithModifiers
)(__DRIscreen
*screen
,
1538 int width
, int height
, int format
,
1539 const uint64_t *modifiers
,
1540 const unsigned int modifier_count
,
1541 void *loaderPrivate
);
1544 * Like createImageFromDmaBufs, but takes also format modifiers.
1546 * For EGL_EXT_image_dma_buf_import_modifiers.
1550 __DRIimage
*(*createImageFromDmaBufs2
)(__DRIscreen
*screen
,
1551 int width
, int height
, int fourcc
,
1553 int *fds
, int num_fds
,
1554 int *strides
, int *offsets
,
1555 enum __DRIYUVColorSpace color_space
,
1556 enum __DRISampleRange sample_range
,
1557 enum __DRIChromaSiting horiz_siting
,
1558 enum __DRIChromaSiting vert_siting
,
1560 void *loaderPrivate
);
1563 * dmabuf format query to support EGL_EXT_image_dma_buf_import_modifiers.
1565 * \param max Maximum number of formats that can be accomodated into
1566 * \param formats. If zero, no formats are returned -
1567 * instead, the driver returns the total number of
1568 * supported dmabuf formats in \param count.
1569 * \param formats Buffer to fill formats into.
1570 * \param count Count of formats returned, or, total number of
1571 * supported formats in case \param max is zero.
1573 * Returns true on success.
1577 GLboolean (*queryDmaBufFormats
)(__DRIscreen
*screen
, int max
,
1578 int *formats
, int *count
);
1581 * dmabuf format modifier query for a given format to support
1582 * EGL_EXT_image_dma_buf_import_modifiers.
1584 * \param fourcc The format to query modifiers for. If this format
1585 * is not supported by the driver, return false.
1586 * \param max Maximum number of modifiers that can be accomodated in
1587 * \param modifiers. If zero, no modifiers are returned -
1588 * instead, the driver returns the total number of
1589 * modifiers for \param format in \param count.
1590 * \param modifiers Buffer to fill modifiers into.
1591 * \param count Count of the modifiers returned, or, total number of
1592 * supported modifiers for \param fourcc in case
1593 * \param max is zero.
1595 * Returns true upon success.
1599 GLboolean (*queryDmaBufModifiers
)(__DRIscreen
*screen
, int fourcc
,
1600 int max
, uint64_t *modifiers
,
1601 unsigned int *external_only
,
1607 * This extension must be implemented by the loader and passed to the
1608 * driver at screen creation time. The EGLImage entry points in the
1609 * various client APIs take opaque EGLImage handles and use this
1610 * extension to map them to a __DRIimage. At version 1, this
1611 * extensions allows mapping EGLImage pointers to __DRIimage pointers,
1612 * but future versions could support other EGLImage-like, opaque types
1613 * with new lookup functions.
1615 #define __DRI_IMAGE_LOOKUP "DRI_IMAGE_LOOKUP"
1616 #define __DRI_IMAGE_LOOKUP_VERSION 1
1618 typedef struct __DRIimageLookupExtensionRec __DRIimageLookupExtension
;
1619 struct __DRIimageLookupExtensionRec
{
1620 __DRIextension base
;
1622 __DRIimage
*(*lookupEGLImage
)(__DRIscreen
*screen
, void *image
,
1623 void *loaderPrivate
);
1627 * This extension allows for common DRI2 options
1629 #define __DRI2_CONFIG_QUERY "DRI_CONFIG_QUERY"
1630 #define __DRI2_CONFIG_QUERY_VERSION 1
1632 typedef struct __DRI2configQueryExtensionRec __DRI2configQueryExtension
;
1633 struct __DRI2configQueryExtensionRec
{
1634 __DRIextension base
;
1636 int (*configQueryb
)(__DRIscreen
*screen
, const char *var
, unsigned char *val
);
1637 int (*configQueryi
)(__DRIscreen
*screen
, const char *var
, int *val
);
1638 int (*configQueryf
)(__DRIscreen
*screen
, const char *var
, float *val
);
1642 * Robust context driver extension.
1644 * Existence of this extension means the driver can accept the
1645 * \c __DRI_CTX_FLAG_ROBUST_BUFFER_ACCESS flag and the
1646 * \c __DRI_CTX_ATTRIB_RESET_STRATEGY attribute in
1647 * \c __DRIdri2ExtensionRec::createContextAttribs.
1649 #define __DRI2_ROBUSTNESS "DRI_Robustness"
1650 #define __DRI2_ROBUSTNESS_VERSION 1
1652 typedef struct __DRIrobustnessExtensionRec __DRIrobustnessExtension
;
1653 struct __DRIrobustnessExtensionRec
{
1654 __DRIextension base
;
1658 * No-error context driver extension.
1660 * Existence of this extension means the driver can accept the
1661 * __DRI_CTX_FLAG_NO_ERROR flag.
1663 #define __DRI2_NO_ERROR "DRI_NoError"
1664 #define __DRI2_NO_ERROR_VERSION 1
1666 typedef struct __DRInoErrorExtensionRec
{
1667 __DRIextension base
;
1668 } __DRInoErrorExtension
;
1671 * DRI config options extension.
1673 * This extension provides the XML string containing driver options for use by
1674 * the loader in supporting the driconf application.
1677 * - Add the getXml getter function which allows the driver more flexibility in
1678 * how the XML is provided.
1679 * - Deprecate the direct xml pointer. It is only provided as a fallback for
1680 * older versions of libGL and must not be used by clients that are aware of
1681 * the newer version. Future driver versions may set it to NULL.
1683 #define __DRI_CONFIG_OPTIONS "DRI_ConfigOptions"
1684 #define __DRI_CONFIG_OPTIONS_VERSION 2
1686 typedef struct __DRIconfigOptionsExtensionRec
{
1687 __DRIextension base
;
1688 const char *xml
; /**< deprecated since v2, use getXml instead */
1691 * Get an XML string that describes available driver options for use by a
1692 * config application.
1694 * The returned string must be heap-allocated. The caller is responsible for
1697 char *(*getXml
)(const char *driver_name
);
1698 } __DRIconfigOptionsExtension
;
1701 * This extension provides a driver vtable to a set of common driver helper
1702 * functions (driCoreExtension, driDRI2Extension) within the driver
1703 * implementation, as opposed to having to pass them through a global
1706 * It is not intended to be public API to the actual loader, and the vtable
1707 * layout may change at any time.
1709 #define __DRI_DRIVER_VTABLE "DRI_DriverVtable"
1710 #define __DRI_DRIVER_VTABLE_VERSION 1
1712 typedef struct __DRIDriverVtableExtensionRec
{
1713 __DRIextension base
;
1714 const struct __DriverAPIRec
*vtable
;
1715 } __DRIDriverVtableExtension
;
1718 * Query renderer driver extension
1720 * This allows the window system layer (either EGL or GLX) to query aspects of
1721 * hardware and driver support without creating a context.
1723 #define __DRI2_RENDERER_QUERY "DRI_RENDERER_QUERY"
1724 #define __DRI2_RENDERER_QUERY_VERSION 1
1726 #define __DRI2_RENDERER_VENDOR_ID 0x0000
1727 #define __DRI2_RENDERER_DEVICE_ID 0x0001
1728 #define __DRI2_RENDERER_VERSION 0x0002
1729 #define __DRI2_RENDERER_ACCELERATED 0x0003
1730 #define __DRI2_RENDERER_VIDEO_MEMORY 0x0004
1731 #define __DRI2_RENDERER_UNIFIED_MEMORY_ARCHITECTURE 0x0005
1732 #define __DRI2_RENDERER_PREFERRED_PROFILE 0x0006
1733 #define __DRI2_RENDERER_OPENGL_CORE_PROFILE_VERSION 0x0007
1734 #define __DRI2_RENDERER_OPENGL_COMPATIBILITY_PROFILE_VERSION 0x0008
1735 #define __DRI2_RENDERER_OPENGL_ES_PROFILE_VERSION 0x0009
1736 #define __DRI2_RENDERER_OPENGL_ES2_PROFILE_VERSION 0x000a
1737 #define __DRI2_RENDERER_HAS_TEXTURE_3D 0x000b
1738 /* Whether there is an sRGB format support for every supported 32-bit UNORM
1741 #define __DRI2_RENDERER_HAS_FRAMEBUFFER_SRGB 0x000c
1743 typedef struct __DRI2rendererQueryExtensionRec __DRI2rendererQueryExtension
;
1744 struct __DRI2rendererQueryExtensionRec
{
1745 __DRIextension base
;
1747 int (*queryInteger
)(__DRIscreen
*screen
, int attribute
, unsigned int *val
);
1748 int (*queryString
)(__DRIscreen
*screen
, int attribute
, const char **val
);
1752 * Image Loader extension. Drivers use this to allocate color buffers
1755 enum __DRIimageBufferMask
{
1756 __DRI_IMAGE_BUFFER_BACK
= (1 << 0),
1757 __DRI_IMAGE_BUFFER_FRONT
= (1 << 1)
1760 struct __DRIimageList
{
1761 uint32_t image_mask
;
1766 #define __DRI_IMAGE_LOADER "DRI_IMAGE_LOADER"
1767 #define __DRI_IMAGE_LOADER_VERSION 3
1769 struct __DRIimageLoaderExtensionRec
{
1770 __DRIextension base
;
1773 * Allocate color buffers.
1775 * \param driDrawable
1776 * \param width Width of allocated buffers
1777 * \param height Height of allocated buffers
1778 * \param format one of __DRI_IMAGE_FORMAT_*
1779 * \param stamp Address of variable to be updated when
1780 * getBuffers must be called again
1781 * \param loaderPrivate The loaderPrivate for driDrawable
1782 * \param buffer_mask Set of buffers to allocate
1783 * \param buffers Returned buffers
1785 int (*getBuffers
)(__DRIdrawable
*driDrawable
,
1786 unsigned int format
,
1788 void *loaderPrivate
,
1789 uint32_t buffer_mask
,
1790 struct __DRIimageList
*buffers
);
1793 * Flush pending front-buffer rendering
1795 * Any rendering that has been performed to the
1796 * fake front will be flushed to the front
1798 * \param driDrawable Drawable whose front-buffer is to be flushed
1799 * \param loaderPrivate Loader's private data that was previously passed
1800 * into __DRIdri2ExtensionRec::createNewDrawable
1802 void (*flushFrontBuffer
)(__DRIdrawable
*driDrawable
, void *loaderPrivate
);
1805 * Return a loader capability value. If the loader doesn't know the enum,
1810 unsigned (*getCapability
)(void *loaderPrivate
, enum dri_loader_cap cap
);
1813 * Flush swap buffers
1815 * Make sure any outstanding swap buffers have been submitted to the
1818 * \param driDrawable Drawable whose swaps need to be flushed
1819 * \param loaderPrivate Loader's private data that was previously passed
1820 * into __DRIdri2ExtensionRec::createNewDrawable
1824 void (*flushSwapBuffers
)(__DRIdrawable
*driDrawable
, void *loaderPrivate
);
1831 #define __DRI_IMAGE_DRIVER "DRI_IMAGE_DRIVER"
1832 #define __DRI_IMAGE_DRIVER_VERSION 1
1834 struct __DRIimageDriverExtensionRec
{
1835 __DRIextension base
;
1837 /* Common DRI functions, shared with DRI2 */
1838 __DRIcreateNewScreen2Func createNewScreen2
;
1839 __DRIcreateNewDrawableFunc createNewDrawable
;
1840 __DRIcreateContextAttribsFunc createContextAttribs
;
1841 __DRIgetAPIMaskFunc getAPIMask
;
1845 * Background callable loader extension.
1847 * Loaders expose this extension to indicate to drivers that they are capable
1848 * of handling callbacks from the driver's background drawing threads.
1850 #define __DRI_BACKGROUND_CALLABLE "DRI_BackgroundCallable"
1851 #define __DRI_BACKGROUND_CALLABLE_VERSION 1
1853 typedef struct __DRIbackgroundCallableExtensionRec __DRIbackgroundCallableExtension
;
1854 struct __DRIbackgroundCallableExtensionRec
{
1855 __DRIextension base
;
1858 * Indicate that this thread is being used by the driver as a background
1859 * drawing thread which may make callbacks to the loader.
1861 * \param loaderPrivate is the value that was passed to to the driver when
1862 * the context was created. This can be used by the loader to identify
1863 * which context any callbacks are associated with.
1865 * If this function is called more than once from any given thread, each
1866 * subsequent call overrides the loaderPrivate data that was passed in the
1867 * previous call. The driver can take advantage of this to re-use a
1868 * background thread to perform drawing on behalf of multiple contexts.
1870 * It is permissible for the driver to call this function from a
1871 * non-background thread (i.e. a thread that has already been bound to a
1872 * context using __DRIcoreExtensionRec::bindContext()); when this happens,
1873 * the \c loaderPrivate pointer must be equal to the pointer that was
1874 * passed to the driver when the currently bound context was created.
1876 * This call should execute quickly enough that the driver can call it with
1877 * impunity whenever a background thread starts performing drawing
1878 * operations (e.g. it should just set a thread-local variable).
1880 void (*setBackgroundContext
)(void *loaderPrivate
);
1883 * Indicate that it is multithread safe to use glthread. For GLX/EGL
1884 * platforms using Xlib, that involves calling XInitThreads, before
1885 * opening an X display.
1887 * Note: only supported if extension version is at least 2.
1889 * \param loaderPrivate is the value that was passed to to the driver when
1890 * the context was created. This can be used by the loader to identify
1891 * which context any callbacks are associated with.
1893 GLboolean (*isThreadSafe
)(void *loaderPrivate
);