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
;
52 * \name DRI interface structures
54 * The following structures define the interface between the GLX client
55 * side library and the DRI (direct rendering infrastructure).
58 typedef struct __DRIdisplayRec __DRIdisplay
;
59 typedef struct __DRIscreenRec __DRIscreen
;
60 typedef struct __DRIcontextRec __DRIcontext
;
61 typedef struct __DRIdrawableRec __DRIdrawable
;
62 typedef struct __DRIconfigRec __DRIconfig
;
63 typedef struct __DRIframebufferRec __DRIframebuffer
;
64 typedef struct __DRIversionRec __DRIversion
;
66 typedef struct __DRIcoreExtensionRec __DRIcoreExtension
;
67 typedef struct __DRIextensionRec __DRIextension
;
68 typedef struct __DRIcopySubBufferExtensionRec __DRIcopySubBufferExtension
;
69 typedef struct __DRIswapControlExtensionRec __DRIswapControlExtension
;
70 typedef struct __DRIframeTrackingExtensionRec __DRIframeTrackingExtension
;
71 typedef struct __DRImediaStreamCounterExtensionRec __DRImediaStreamCounterExtension
;
72 typedef struct __DRItexOffsetExtensionRec __DRItexOffsetExtension
;
73 typedef struct __DRItexBufferExtensionRec __DRItexBufferExtension
;
74 typedef struct __DRIlegacyExtensionRec __DRIlegacyExtension
;
75 typedef struct __DRIswrastExtensionRec __DRIswrastExtension
;
76 typedef struct __DRIbufferRec __DRIbuffer
;
77 typedef struct __DRIdri2ExtensionRec __DRIdri2Extension
;
78 typedef struct __DRIdri2LoaderExtensionRec __DRIdri2LoaderExtension
;
79 typedef struct __DRI2flushExtensionRec __DRI2flushExtension
;
80 typedef struct __DRI2throttleExtensionRec __DRI2throttleExtension
;
81 typedef struct __DRI2fenceExtensionRec __DRI2fenceExtension
;
84 typedef struct __DRIimageLoaderExtensionRec __DRIimageLoaderExtension
;
85 typedef struct __DRIimageDriverExtensionRec __DRIimageDriverExtension
;
91 * Extension struct. Drivers 'inherit' from this struct by embedding
92 * it as the first element in the extension struct.
94 * We never break API in for a DRI extension. If we need to change
95 * the way things work in a non-backwards compatible manner, we
96 * introduce a new extension. During a transition period, we can
97 * leave both the old and the new extension in the driver, which
98 * allows us to move to the new interface without having to update the
99 * loader(s) in lock step.
101 * However, we can add entry points to an extension over time as long
102 * as we don't break the old ones. As we add entry points to an
103 * extension, we increase the version number. The corresponding
104 * #define can be used to guard code that accesses the new entry
105 * points at compile time and the version field in the extension
106 * struct can be used at run-time to determine how to use the
109 struct __DRIextensionRec
{
115 * The first set of extension are the screen extensions, returned by
116 * __DRIcore::getExtensions(). This entry point will return a list of
117 * extensions and the loader can use the ones it knows about by
118 * casting them to more specific extensions and advertising any GLX
119 * extensions the DRI extensions enables.
123 * Used by drivers to indicate support for setting the read drawable.
125 #define __DRI_READ_DRAWABLE "DRI_ReadDrawable"
126 #define __DRI_READ_DRAWABLE_VERSION 1
129 * Used by drivers that implement the GLX_MESA_copy_sub_buffer extension.
131 #define __DRI_COPY_SUB_BUFFER "DRI_CopySubBuffer"
132 #define __DRI_COPY_SUB_BUFFER_VERSION 1
133 struct __DRIcopySubBufferExtensionRec
{
135 void (*copySubBuffer
)(__DRIdrawable
*drawable
, int x
, int y
, int w
, int h
);
139 * Used by drivers that implement the GLX_SGI_swap_control or
140 * GLX_MESA_swap_control extension.
142 #define __DRI_SWAP_CONTROL "DRI_SwapControl"
143 #define __DRI_SWAP_CONTROL_VERSION 1
144 struct __DRIswapControlExtensionRec
{
146 void (*setSwapInterval
)(__DRIdrawable
*drawable
, unsigned int inteval
);
147 unsigned int (*getSwapInterval
)(__DRIdrawable
*drawable
);
151 * Used by drivers that implement the GLX_MESA_swap_frame_usage extension.
153 #define __DRI_FRAME_TRACKING "DRI_FrameTracking"
154 #define __DRI_FRAME_TRACKING_VERSION 1
155 struct __DRIframeTrackingExtensionRec
{
159 * Enable or disable frame usage tracking.
161 * \since Internal API version 20030317.
163 int (*frameTracking
)(__DRIdrawable
*drawable
, GLboolean enable
);
166 * Retrieve frame usage information.
168 * \since Internal API version 20030317.
170 int (*queryFrameTracking
)(__DRIdrawable
*drawable
,
171 int64_t * sbc
, int64_t * missedFrames
,
172 float * lastMissedUsage
, float * usage
);
177 * Used by drivers that implement the GLX_SGI_video_sync extension.
179 #define __DRI_MEDIA_STREAM_COUNTER "DRI_MediaStreamCounter"
180 #define __DRI_MEDIA_STREAM_COUNTER_VERSION 1
181 struct __DRImediaStreamCounterExtensionRec
{
185 * Wait for the MSC to equal target_msc, or, if that has already passed,
186 * the next time (MSC % divisor) is equal to remainder. If divisor is
187 * zero, the function will return as soon as MSC is greater than or equal
190 int (*waitForMSC
)(__DRIdrawable
*drawable
,
191 int64_t target_msc
, int64_t divisor
, int64_t remainder
,
192 int64_t * msc
, int64_t * sbc
);
195 * Get the number of vertical refreshes since some point in time before
196 * this function was first called (i.e., system start up).
198 int (*getDrawableMSC
)(__DRIscreen
*screen
, __DRIdrawable
*drawable
,
203 #define __DRI_TEX_OFFSET "DRI_TexOffset"
204 #define __DRI_TEX_OFFSET_VERSION 1
205 struct __DRItexOffsetExtensionRec
{
209 * Method to override base texture image with a driver specific 'offset'.
210 * The depth passed in allows e.g. to ignore the alpha channel of texture
211 * images where the non-alpha components don't occupy a whole texel.
213 * For GLX_EXT_texture_from_pixmap with AIGLX.
215 void (*setTexOffset
)(__DRIcontext
*pDRICtx
, GLint texname
,
216 unsigned long long offset
, GLint depth
, GLuint pitch
);
220 /* Valid values for format in the setTexBuffer2 function below. These
221 * values match the GLX tokens for compatibility reasons, but we
222 * define them here since the DRI interface can't depend on GLX. */
223 #define __DRI_TEXTURE_FORMAT_NONE 0x20D8
224 #define __DRI_TEXTURE_FORMAT_RGB 0x20D9
225 #define __DRI_TEXTURE_FORMAT_RGBA 0x20DA
227 #define __DRI_TEX_BUFFER "DRI_TexBuffer"
228 #define __DRI_TEX_BUFFER_VERSION 3
229 struct __DRItexBufferExtensionRec
{
233 * Method to override base texture image with the contents of a
236 * For GLX_EXT_texture_from_pixmap with AIGLX. Deprecated in favor of
237 * setTexBuffer2 in version 2 of this interface
239 void (*setTexBuffer
)(__DRIcontext
*pDRICtx
,
241 __DRIdrawable
*pDraw
);
244 * Method to override base texture image with the contents of a
245 * __DRIdrawable, including the required texture format attribute.
247 * For GLX_EXT_texture_from_pixmap with AIGLX.
251 void (*setTexBuffer2
)(__DRIcontext
*pDRICtx
,
254 __DRIdrawable
*pDraw
);
256 * Method to release texture buffer in case some special platform
259 * For GLX_EXT_texture_from_pixmap with AIGLX.
263 void (*releaseTexBuffer
)(__DRIcontext
*pDRICtx
,
265 __DRIdrawable
*pDraw
);
269 * Used by drivers that implement DRI2
271 #define __DRI2_FLUSH "DRI2_Flush"
272 #define __DRI2_FLUSH_VERSION 4
274 #define __DRI2_FLUSH_DRAWABLE (1 << 0) /* the drawable should be flushed. */
275 #define __DRI2_FLUSH_CONTEXT (1 << 1) /* glFlush should be called */
276 #define __DRI2_FLUSH_INVALIDATE_ANCILLARY (1 << 2)
278 enum __DRI2throttleReason
{
279 __DRI2_THROTTLE_SWAPBUFFER
,
280 __DRI2_THROTTLE_COPYSUBBUFFER
,
281 __DRI2_THROTTLE_FLUSHFRONT
284 struct __DRI2flushExtensionRec
{
286 void (*flush
)(__DRIdrawable
*drawable
);
289 * Ask the driver to call getBuffers/getBuffersWithFormat before
290 * it starts rendering again.
292 * \param drawable the drawable to invalidate
296 void (*invalidate
)(__DRIdrawable
*drawable
);
299 * This function reduces the number of flushes in the driver by combining
300 * several operations into one call.
307 * \param context the context
308 * \param drawable the drawable to flush
309 * \param flags a combination of _DRI2_FLUSH_xxx flags
310 * \param throttle_reason the reason for throttling, 0 = no throttling
314 void (*flush_with_flags
)(__DRIcontext
*ctx
,
315 __DRIdrawable
*drawable
,
317 enum __DRI2throttleReason throttle_reason
);
322 * Extension that the driver uses to request
323 * throttle callbacks.
326 #define __DRI2_THROTTLE "DRI2_Throttle"
327 #define __DRI2_THROTTLE_VERSION 1
329 struct __DRI2throttleExtensionRec
{
331 void (*throttle
)(__DRIcontext
*ctx
,
332 __DRIdrawable
*drawable
,
333 enum __DRI2throttleReason reason
);
338 * Extension for fences / synchronization objects.
341 #define __DRI2_FENCE "DRI2_Fence"
342 #define __DRI2_FENCE_VERSION 1
344 #define __DRI2_FENCE_TIMEOUT_INFINITE 0xffffffffffffffffllu
346 #define __DRI2_FENCE_FLAG_FLUSH_COMMANDS (1 << 0)
348 struct __DRI2fenceExtensionRec
{
352 * Create and insert a fence into the command stream of the context.
354 void *(*create_fence
)(__DRIcontext
*ctx
);
357 * Get a fence associated with the OpenCL event object.
358 * This can be NULL, meaning that OpenCL interoperability is not supported.
360 void *(*get_fence_from_cl_event
)(__DRIscreen
*screen
, intptr_t cl_event
);
365 void (*destroy_fence
)(__DRIscreen
*screen
, void *fence
);
368 * This function waits and doesn't return until the fence is signalled
369 * or the timeout expires. It returns true if the fence has been signaled.
371 * \param ctx the context where commands are flushed
372 * \param fence the fence
373 * \param flags a combination of __DRI2_FENCE_FLAG_xxx flags
374 * \param timeout the timeout in ns or __DRI2_FENCE_TIMEOUT_INFINITE
376 GLboolean (*client_wait_sync
)(__DRIcontext
*ctx
, void *fence
,
377 unsigned flags
, uint64_t timeout
);
380 * This function enqueues a wait command into the command stream of
381 * the context and then returns. When the execution reaches the wait
382 * command, no further execution will be done in the context until
383 * the fence is signaled. This is a no-op if the device doesn't support
384 * parallel execution of contexts.
386 * \param ctx the context where the waiting is done
387 * \param fence the fence
388 * \param flags a combination of __DRI2_FENCE_FLAG_xxx flags that make
389 * sense with this function (right now there are none)
391 void (*server_wait_sync
)(__DRIcontext
*ctx
, void *fence
, unsigned flags
);
398 * The following extensions describe loader features that the DRI
399 * driver can make use of. Some of these are mandatory, such as the
400 * getDrawableInfo extension for DRI and the DRI Loader extensions for
401 * DRI2, while others are optional, and if present allow the driver to
402 * expose certain features. The loader pass in a NULL terminated
403 * array of these extensions to the driver in the createNewScreen
407 typedef struct __DRIgetDrawableInfoExtensionRec __DRIgetDrawableInfoExtension
;
408 typedef struct __DRIsystemTimeExtensionRec __DRIsystemTimeExtension
;
409 typedef struct __DRIdamageExtensionRec __DRIdamageExtension
;
410 typedef struct __DRIloaderExtensionRec __DRIloaderExtension
;
411 typedef struct __DRIswrastLoaderExtensionRec __DRIswrastLoaderExtension
;
415 * Callback to getDrawableInfo protocol
417 #define __DRI_GET_DRAWABLE_INFO "DRI_GetDrawableInfo"
418 #define __DRI_GET_DRAWABLE_INFO_VERSION 1
419 struct __DRIgetDrawableInfoExtensionRec
{
423 * This function is used to get information about the position, size, and
424 * clip rects of a drawable.
426 GLboolean (* getDrawableInfo
) ( __DRIdrawable
*drawable
,
427 unsigned int * index
, unsigned int * stamp
,
428 int * x
, int * y
, int * width
, int * height
,
429 int * numClipRects
, drm_clip_rect_t
** pClipRects
,
430 int * backX
, int * backY
,
431 int * numBackClipRects
, drm_clip_rect_t
** pBackClipRects
,
432 void *loaderPrivate
);
436 * Callback to get system time for media stream counter extensions.
438 #define __DRI_SYSTEM_TIME "DRI_SystemTime"
439 #define __DRI_SYSTEM_TIME_VERSION 1
440 struct __DRIsystemTimeExtensionRec
{
444 * Get the 64-bit unadjusted system time (UST).
446 int (*getUST
)(int64_t * ust
);
449 * Get the media stream counter (MSC) rate.
451 * Matching the definition in GLX_OML_sync_control, this function returns
452 * the rate of the "media stream counter". In practical terms, this is
453 * the frame refresh rate of the display.
455 GLboolean (*getMSCRate
)(__DRIdrawable
*draw
,
456 int32_t * numerator
, int32_t * denominator
,
457 void *loaderPrivate
);
463 #define __DRI_DAMAGE "DRI_Damage"
464 #define __DRI_DAMAGE_VERSION 1
465 struct __DRIdamageExtensionRec
{
469 * Reports areas of the given drawable which have been modified by the
472 * \param drawable which the drawing was done to.
473 * \param rects rectangles affected, with the drawable origin as the
475 * \param x X offset of the drawable within the screen (used in the
477 * \param y Y offset of the drawable within the screen.
478 * \param front_buffer boolean flag for whether the drawing to the
479 * drawable was actually done directly to the front buffer (instead
480 * of backing storage, for example)
481 * \param loaderPrivate the data passed in at createNewDrawable time
483 void (*reportDamage
)(__DRIdrawable
*draw
,
485 drm_clip_rect_t
*rects
, int num_rects
,
486 GLboolean front_buffer
,
487 void *loaderPrivate
);
490 #define __DRI_SWRAST_IMAGE_OP_DRAW 1
491 #define __DRI_SWRAST_IMAGE_OP_CLEAR 2
492 #define __DRI_SWRAST_IMAGE_OP_SWAP 3
495 * SWRast Loader extension.
497 #define __DRI_SWRAST_LOADER "DRI_SWRastLoader"
498 #define __DRI_SWRAST_LOADER_VERSION 3
499 struct __DRIswrastLoaderExtensionRec
{
503 * Drawable position and size
505 void (*getDrawableInfo
)(__DRIdrawable
*drawable
,
506 int *x
, int *y
, int *width
, int *height
,
507 void *loaderPrivate
);
510 * Put image to drawable
512 void (*putImage
)(__DRIdrawable
*drawable
, int op
,
513 int x
, int y
, int width
, int height
,
514 char *data
, void *loaderPrivate
);
517 * Get image from readable
519 void (*getImage
)(__DRIdrawable
*readable
,
520 int x
, int y
, int width
, int height
,
521 char *data
, void *loaderPrivate
);
524 * Put image to drawable
528 void (*putImage2
)(__DRIdrawable
*drawable
, int op
,
529 int x
, int y
, int width
, int height
, int stride
,
530 char *data
, void *loaderPrivate
);
533 * Put image to drawable
537 void (*getImage2
)(__DRIdrawable
*readable
,
538 int x
, int y
, int width
, int height
, int stride
,
539 char *data
, void *loaderPrivate
);
543 * Invalidate loader extension. The presence of this extension
544 * indicates to the DRI driver that the loader will call invalidate in
545 * the __DRI2_FLUSH extension, whenever the needs to query for new
546 * buffers. This means that the DRI driver can drop the polling in
549 * The extension doesn't provide any functionality, it's only use to
550 * indicate to the driver that it can use the new semantics. A DRI
551 * driver can use this to switch between the different semantics or
552 * just refuse to initialize if this extension isn't present.
554 #define __DRI_USE_INVALIDATE "DRI_UseInvalidate"
555 #define __DRI_USE_INVALIDATE_VERSION 1
557 typedef struct __DRIuseInvalidateExtensionRec __DRIuseInvalidateExtension
;
558 struct __DRIuseInvalidateExtensionRec
{
563 * The remaining extensions describe driver extensions, immediately
564 * available interfaces provided by the driver. To start using the
565 * driver, dlsym() for the __DRI_DRIVER_EXTENSIONS symbol and look for
566 * the extension you need in the array.
568 #define __DRI_DRIVER_EXTENSIONS "__driDriverExtensions"
571 * This symbol replaces the __DRI_DRIVER_EXTENSIONS symbol, and will be
572 * suffixed by "_drivername", allowing multiple drivers to be built into one
573 * library, and also giving the driver the chance to return a variable driver
574 * extensions struct depending on the driver name being loaded or any other
577 * The function prototype is:
579 * const __DRIextension **__driDriverGetExtensions_drivername(void);
581 #define __DRI_DRIVER_GET_EXTENSIONS "__driDriverGetExtensions"
584 * Tokens for __DRIconfig attribs. A number of attributes defined by
585 * GLX or EGL standards are not in the table, as they must be provided
586 * by the loader. For example, FBConfig ID or visual ID, drawable type.
589 #define __DRI_ATTRIB_BUFFER_SIZE 1
590 #define __DRI_ATTRIB_LEVEL 2
591 #define __DRI_ATTRIB_RED_SIZE 3
592 #define __DRI_ATTRIB_GREEN_SIZE 4
593 #define __DRI_ATTRIB_BLUE_SIZE 5
594 #define __DRI_ATTRIB_LUMINANCE_SIZE 6
595 #define __DRI_ATTRIB_ALPHA_SIZE 7
596 #define __DRI_ATTRIB_ALPHA_MASK_SIZE 8
597 #define __DRI_ATTRIB_DEPTH_SIZE 9
598 #define __DRI_ATTRIB_STENCIL_SIZE 10
599 #define __DRI_ATTRIB_ACCUM_RED_SIZE 11
600 #define __DRI_ATTRIB_ACCUM_GREEN_SIZE 12
601 #define __DRI_ATTRIB_ACCUM_BLUE_SIZE 13
602 #define __DRI_ATTRIB_ACCUM_ALPHA_SIZE 14
603 #define __DRI_ATTRIB_SAMPLE_BUFFERS 15
604 #define __DRI_ATTRIB_SAMPLES 16
605 #define __DRI_ATTRIB_RENDER_TYPE 17
606 #define __DRI_ATTRIB_CONFIG_CAVEAT 18
607 #define __DRI_ATTRIB_CONFORMANT 19
608 #define __DRI_ATTRIB_DOUBLE_BUFFER 20
609 #define __DRI_ATTRIB_STEREO 21
610 #define __DRI_ATTRIB_AUX_BUFFERS 22
611 #define __DRI_ATTRIB_TRANSPARENT_TYPE 23
612 #define __DRI_ATTRIB_TRANSPARENT_INDEX_VALUE 24
613 #define __DRI_ATTRIB_TRANSPARENT_RED_VALUE 25
614 #define __DRI_ATTRIB_TRANSPARENT_GREEN_VALUE 26
615 #define __DRI_ATTRIB_TRANSPARENT_BLUE_VALUE 27
616 #define __DRI_ATTRIB_TRANSPARENT_ALPHA_VALUE 28
617 #define __DRI_ATTRIB_FLOAT_MODE 29
618 #define __DRI_ATTRIB_RED_MASK 30
619 #define __DRI_ATTRIB_GREEN_MASK 31
620 #define __DRI_ATTRIB_BLUE_MASK 32
621 #define __DRI_ATTRIB_ALPHA_MASK 33
622 #define __DRI_ATTRIB_MAX_PBUFFER_WIDTH 34
623 #define __DRI_ATTRIB_MAX_PBUFFER_HEIGHT 35
624 #define __DRI_ATTRIB_MAX_PBUFFER_PIXELS 36
625 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_WIDTH 37
626 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_HEIGHT 38
627 #define __DRI_ATTRIB_VISUAL_SELECT_GROUP 39
628 #define __DRI_ATTRIB_SWAP_METHOD 40
629 #define __DRI_ATTRIB_MAX_SWAP_INTERVAL 41
630 #define __DRI_ATTRIB_MIN_SWAP_INTERVAL 42
631 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGB 43
632 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGBA 44
633 #define __DRI_ATTRIB_BIND_TO_MIPMAP_TEXTURE 45
634 #define __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS 46
635 #define __DRI_ATTRIB_YINVERTED 47
636 #define __DRI_ATTRIB_FRAMEBUFFER_SRGB_CAPABLE 48
638 /* __DRI_ATTRIB_RENDER_TYPE */
639 #define __DRI_ATTRIB_RGBA_BIT 0x01
640 #define __DRI_ATTRIB_COLOR_INDEX_BIT 0x02
641 #define __DRI_ATTRIB_LUMINANCE_BIT 0x04
642 #define __DRI_ATTRIB_FLOAT_BIT 0x08
643 #define __DRI_ATTRIB_UNSIGNED_FLOAT_BIT 0x10
645 /* __DRI_ATTRIB_CONFIG_CAVEAT */
646 #define __DRI_ATTRIB_SLOW_BIT 0x01
647 #define __DRI_ATTRIB_NON_CONFORMANT_CONFIG 0x02
649 /* __DRI_ATTRIB_TRANSPARENT_TYPE */
650 #define __DRI_ATTRIB_TRANSPARENT_RGB 0x00
651 #define __DRI_ATTRIB_TRANSPARENT_INDEX 0x01
653 /* __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS */
654 #define __DRI_ATTRIB_TEXTURE_1D_BIT 0x01
655 #define __DRI_ATTRIB_TEXTURE_2D_BIT 0x02
656 #define __DRI_ATTRIB_TEXTURE_RECTANGLE_BIT 0x04
659 * This extension defines the core DRI functionality.
661 #define __DRI_CORE "DRI_Core"
662 #define __DRI_CORE_VERSION 1
664 struct __DRIcoreExtensionRec
{
667 __DRIscreen
*(*createNewScreen
)(int screen
, int fd
,
668 unsigned int sarea_handle
,
669 const __DRIextension
**extensions
,
670 const __DRIconfig
***driverConfigs
,
671 void *loaderPrivate
);
673 void (*destroyScreen
)(__DRIscreen
*screen
);
675 const __DRIextension
**(*getExtensions
)(__DRIscreen
*screen
);
677 int (*getConfigAttrib
)(const __DRIconfig
*config
,
679 unsigned int *value
);
681 int (*indexConfigAttrib
)(const __DRIconfig
*config
, int index
,
682 unsigned int *attrib
, unsigned int *value
);
684 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
685 const __DRIconfig
*config
,
686 unsigned int drawable_id
,
688 void *loaderPrivate
);
690 void (*destroyDrawable
)(__DRIdrawable
*drawable
);
692 void (*swapBuffers
)(__DRIdrawable
*drawable
);
694 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
695 const __DRIconfig
*config
,
696 __DRIcontext
*shared
,
697 void *loaderPrivate
);
699 int (*copyContext
)(__DRIcontext
*dest
,
703 void (*destroyContext
)(__DRIcontext
*context
);
705 int (*bindContext
)(__DRIcontext
*ctx
,
706 __DRIdrawable
*pdraw
,
707 __DRIdrawable
*pread
);
709 int (*unbindContext
)(__DRIcontext
*ctx
);
713 * Stored version of some component (i.e., server-side DRI module, kernel-side
717 * There are several data structures that explicitly store a major version,
718 * minor version, and patch level. These structures should be modified to
719 * have a \c __DRIversionRec instead.
721 struct __DRIversionRec
{
722 int major
; /**< Major version number. */
723 int minor
; /**< Minor version number. */
724 int patch
; /**< Patch-level. */
728 * Framebuffer information record. Used by libGL to communicate information
729 * about the framebuffer to the driver's \c __driCreateNewScreen function.
731 * In XFree86, most of this information is derrived from data returned by
732 * calling \c XF86DRIGetDeviceInfo.
734 * \sa XF86DRIGetDeviceInfo __DRIdisplayRec::createNewScreen
735 * __driUtilCreateNewScreen CallCreateNewScreen
737 * \bug This structure could be better named.
739 struct __DRIframebufferRec
{
740 unsigned char *base
; /**< Framebuffer base address in the CPU's
741 * address space. This value is calculated by
742 * calling \c drmMap on the framebuffer handle
743 * returned by \c XF86DRIGetDeviceInfo (or a
746 int size
; /**< Framebuffer size, in bytes. */
747 int stride
; /**< Number of bytes from one line to the next. */
748 int width
; /**< Pixel width of the framebuffer. */
749 int height
; /**< Pixel height of the framebuffer. */
750 int dev_priv_size
; /**< Size of the driver's dev-priv structure. */
751 void *dev_priv
; /**< Pointer to the driver's dev-priv structure. */
756 * This extension provides alternative screen, drawable and context
757 * constructors for legacy DRI functionality. This is used in
758 * conjunction with the core extension.
760 #define __DRI_LEGACY "DRI_Legacy"
761 #define __DRI_LEGACY_VERSION 1
763 struct __DRIlegacyExtensionRec
{
766 __DRIscreen
*(*createNewScreen
)(int screen
,
767 const __DRIversion
*ddx_version
,
768 const __DRIversion
*dri_version
,
769 const __DRIversion
*drm_version
,
770 const __DRIframebuffer
*frame_buffer
,
771 void *pSAREA
, int fd
,
772 const __DRIextension
**extensions
,
773 const __DRIconfig
***driver_configs
,
774 void *loaderPrivate
);
776 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
777 const __DRIconfig
*config
,
778 drm_drawable_t hwDrawable
,
779 int renderType
, const int *attrs
,
780 void *loaderPrivate
);
782 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
783 const __DRIconfig
*config
,
785 __DRIcontext
*shared
,
786 drm_context_t hwContext
,
787 void *loaderPrivate
);
791 * This extension provides alternative screen, drawable and context
792 * constructors for swrast DRI functionality. This is used in
793 * conjunction with the core extension.
795 #define __DRI_SWRAST "DRI_SWRast"
796 #define __DRI_SWRAST_VERSION 4
798 struct __DRIswrastExtensionRec
{
801 __DRIscreen
*(*createNewScreen
)(int screen
,
802 const __DRIextension
**extensions
,
803 const __DRIconfig
***driver_configs
,
804 void *loaderPrivate
);
806 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
807 const __DRIconfig
*config
,
808 void *loaderPrivate
);
810 /* Since version 2 */
811 __DRIcontext
*(*createNewContextForAPI
)(__DRIscreen
*screen
,
813 const __DRIconfig
*config
,
814 __DRIcontext
*shared
,
818 * Create a context for a particular API with a set of attributes
822 * \sa __DRIdri2ExtensionRec::createContextAttribs
824 __DRIcontext
*(*createContextAttribs
)(__DRIscreen
*screen
,
826 const __DRIconfig
*config
,
827 __DRIcontext
*shared
,
828 unsigned num_attribs
,
829 const uint32_t *attribs
,
831 void *loaderPrivate
);
834 * createNewScreen() with the driver extensions passed in.
838 __DRIscreen
*(*createNewScreen2
)(int screen
,
839 const __DRIextension
**loader_extensions
,
840 const __DRIextension
**driver_extensions
,
841 const __DRIconfig
***driver_configs
,
842 void *loaderPrivate
);
846 /** Common DRI function definitions, shared among DRI2 and Image extensions
849 typedef __DRIscreen
*
850 (*__DRIcreateNewScreen2Func
)(int screen
, int fd
,
851 const __DRIextension
**extensions
,
852 const __DRIextension
**driver_extensions
,
853 const __DRIconfig
***driver_configs
,
854 void *loaderPrivate
);
856 typedef __DRIdrawable
*
857 (*__DRIcreateNewDrawableFunc
)(__DRIscreen
*screen
,
858 const __DRIconfig
*config
,
859 void *loaderPrivate
);
861 typedef __DRIcontext
*
862 (*__DRIcreateContextAttribsFunc
)(__DRIscreen
*screen
,
864 const __DRIconfig
*config
,
865 __DRIcontext
*shared
,
866 unsigned num_attribs
,
867 const uint32_t *attribs
,
869 void *loaderPrivate
);
872 (*__DRIgetAPIMaskFunc
)(__DRIscreen
*screen
);
875 * DRI2 Loader extension.
877 #define __DRI_BUFFER_FRONT_LEFT 0
878 #define __DRI_BUFFER_BACK_LEFT 1
879 #define __DRI_BUFFER_FRONT_RIGHT 2
880 #define __DRI_BUFFER_BACK_RIGHT 3
881 #define __DRI_BUFFER_DEPTH 4
882 #define __DRI_BUFFER_STENCIL 5
883 #define __DRI_BUFFER_ACCUM 6
884 #define __DRI_BUFFER_FAKE_FRONT_LEFT 7
885 #define __DRI_BUFFER_FAKE_FRONT_RIGHT 8
886 #define __DRI_BUFFER_DEPTH_STENCIL 9 /**< Only available with DRI2 1.1 */
887 #define __DRI_BUFFER_HIZ 10
889 /* Inofficial and for internal use. Increase when adding a new buffer token. */
890 #define __DRI_BUFFER_COUNT 11
892 struct __DRIbufferRec
{
893 unsigned int attachment
;
900 #define __DRI_DRI2_LOADER "DRI_DRI2Loader"
901 #define __DRI_DRI2_LOADER_VERSION 3
902 struct __DRIdri2LoaderExtensionRec
{
905 __DRIbuffer
*(*getBuffers
)(__DRIdrawable
*driDrawable
,
906 int *width
, int *height
,
907 unsigned int *attachments
, int count
,
908 int *out_count
, void *loaderPrivate
);
911 * Flush pending front-buffer rendering
913 * Any rendering that has been performed to the
914 * \c __DRI_BUFFER_FAKE_FRONT_LEFT will be flushed to the
915 * \c __DRI_BUFFER_FRONT_LEFT.
917 * \param driDrawable Drawable whose front-buffer is to be flushed
918 * \param loaderPrivate Loader's private data that was previously passed
919 * into __DRIdri2ExtensionRec::createNewDrawable
923 void (*flushFrontBuffer
)(__DRIdrawable
*driDrawable
, void *loaderPrivate
);
927 * Get list of buffers from the server
929 * Gets a list of buffer for the specified set of attachments. Unlike
930 * \c ::getBuffers, this function takes a list of attachments paired with
931 * opaque \c unsigned \c int value describing the format of the buffer.
932 * It is the responsibility of the caller to know what the service that
933 * allocates the buffers will expect to receive for the format.
935 * \param driDrawable Drawable whose buffers are being queried.
936 * \param width Output where the width of the buffers is stored.
937 * \param height Output where the height of the buffers is stored.
938 * \param attachments List of pairs of attachment ID and opaque format
939 * requested for the drawable.
940 * \param count Number of attachment / format pairs stored in
942 * \param loaderPrivate Loader's private data that was previously passed
943 * into __DRIdri2ExtensionRec::createNewDrawable.
947 __DRIbuffer
*(*getBuffersWithFormat
)(__DRIdrawable
*driDrawable
,
948 int *width
, int *height
,
949 unsigned int *attachments
, int count
,
950 int *out_count
, void *loaderPrivate
);
954 * This extension provides alternative screen, drawable and context
955 * constructors for DRI2.
957 #define __DRI_DRI2 "DRI_DRI2"
958 #define __DRI_DRI2_VERSION 4
960 #define __DRI_API_OPENGL 0 /**< OpenGL compatibility profile */
961 #define __DRI_API_GLES 1 /**< OpenGL ES 1.x */
962 #define __DRI_API_GLES2 2 /**< OpenGL ES 2.x */
963 #define __DRI_API_OPENGL_CORE 3 /**< OpenGL 3.2+ core profile */
964 #define __DRI_API_GLES3 4 /**< OpenGL ES 3.x */
966 #define __DRI_CTX_ATTRIB_MAJOR_VERSION 0
967 #define __DRI_CTX_ATTRIB_MINOR_VERSION 1
968 #define __DRI_CTX_ATTRIB_FLAGS 2
971 * \requires __DRI2_ROBUSTNESS.
973 #define __DRI_CTX_ATTRIB_RESET_STRATEGY 3
975 #define __DRI_CTX_FLAG_DEBUG 0x00000001
976 #define __DRI_CTX_FLAG_FORWARD_COMPATIBLE 0x00000002
979 * \requires __DRI2_ROBUSTNESS.
981 #define __DRI_CTX_FLAG_ROBUST_BUFFER_ACCESS 0x00000004
984 * \name Context reset strategies.
987 #define __DRI_CTX_RESET_NO_NOTIFICATION 0
988 #define __DRI_CTX_RESET_LOSE_CONTEXT 1
992 * \name Reasons that __DRIdri2Extension::createContextAttribs might fail
996 #define __DRI_CTX_ERROR_SUCCESS 0
998 /** Memory allocation failure */
999 #define __DRI_CTX_ERROR_NO_MEMORY 1
1001 /** Client requested an API (e.g., OpenGL ES 2.0) that the driver can't do. */
1002 #define __DRI_CTX_ERROR_BAD_API 2
1004 /** Client requested an API version that the driver can't do. */
1005 #define __DRI_CTX_ERROR_BAD_VERSION 3
1007 /** Client requested a flag or combination of flags the driver can't do. */
1008 #define __DRI_CTX_ERROR_BAD_FLAG 4
1010 /** Client requested an attribute the driver doesn't understand. */
1011 #define __DRI_CTX_ERROR_UNKNOWN_ATTRIBUTE 5
1013 /** Client requested a flag the driver doesn't understand. */
1014 #define __DRI_CTX_ERROR_UNKNOWN_FLAG 6
1017 struct __DRIdri2ExtensionRec
{
1018 __DRIextension base
;
1020 __DRIscreen
*(*createNewScreen
)(int screen
, int fd
,
1021 const __DRIextension
**extensions
,
1022 const __DRIconfig
***driver_configs
,
1023 void *loaderPrivate
);
1025 __DRIcreateNewDrawableFunc createNewDrawable
;
1026 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
1027 const __DRIconfig
*config
,
1028 __DRIcontext
*shared
,
1029 void *loaderPrivate
);
1031 /* Since version 2 */
1032 __DRIgetAPIMaskFunc getAPIMask
;
1034 __DRIcontext
*(*createNewContextForAPI
)(__DRIscreen
*screen
,
1036 const __DRIconfig
*config
,
1037 __DRIcontext
*shared
,
1040 __DRIbuffer
*(*allocateBuffer
)(__DRIscreen
*screen
,
1041 unsigned int attachment
,
1042 unsigned int format
,
1045 void (*releaseBuffer
)(__DRIscreen
*screen
,
1046 __DRIbuffer
*buffer
);
1049 * Create a context for a particular API with a set of attributes
1053 * \sa __DRIswrastExtensionRec::createContextAttribs
1055 __DRIcreateContextAttribsFunc createContextAttribs
;
1058 * createNewScreen with the driver's extension list passed in.
1062 __DRIcreateNewScreen2Func createNewScreen2
;
1067 * This extension provides functionality to enable various EGLImage
1070 #define __DRI_IMAGE "DRI_IMAGE"
1071 #define __DRI_IMAGE_VERSION 11
1074 * These formats correspond to the similarly named MESA_FORMAT_*
1075 * tokens, except in the native endian of the CPU. For example, on
1076 * little endian __DRI_IMAGE_FORMAT_XRGB8888 corresponds to
1077 * MESA_FORMAT_XRGB8888, but MESA_FORMAT_XRGB8888_REV on big endian.
1079 * __DRI_IMAGE_FORMAT_NONE is for images that aren't directly usable
1080 * by the driver (YUV planar formats) but serve as a base image for
1081 * creating sub-images for the different planes within the image.
1083 * R8, GR88 and NONE should not be used with createImageFormName or
1084 * createImage, and are returned by query from sub images created with
1085 * createImageFromNames (NONE, see above) and fromPlane (R8 & GR88).
1087 #define __DRI_IMAGE_FORMAT_RGB565 0x1001
1088 #define __DRI_IMAGE_FORMAT_XRGB8888 0x1002
1089 #define __DRI_IMAGE_FORMAT_ARGB8888 0x1003
1090 #define __DRI_IMAGE_FORMAT_ABGR8888 0x1004
1091 #define __DRI_IMAGE_FORMAT_XBGR8888 0x1005
1092 #define __DRI_IMAGE_FORMAT_R8 0x1006 /* Since version 5 */
1093 #define __DRI_IMAGE_FORMAT_GR88 0x1007
1094 #define __DRI_IMAGE_FORMAT_NONE 0x1008
1095 #define __DRI_IMAGE_FORMAT_XRGB2101010 0x1009
1096 #define __DRI_IMAGE_FORMAT_ARGB2101010 0x100a
1097 #define __DRI_IMAGE_FORMAT_SARGB8 0x100b
1099 #define __DRI_IMAGE_USE_SHARE 0x0001
1100 #define __DRI_IMAGE_USE_SCANOUT 0x0002
1101 #define __DRI_IMAGE_USE_CURSOR 0x0004 /* Depricated */
1102 #define __DRI_IMAGE_USE_LINEAR 0x0008
1106 * Four CC formats that matches with WL_DRM_FORMAT_* from wayland_drm.h,
1107 * GBM_FORMAT_* from gbm.h, and DRM_FORMAT_* from drm_fourcc.h. Used with
1108 * createImageFromNames.
1113 #define __DRI_IMAGE_FOURCC_R8 0x20203852
1114 #define __DRI_IMAGE_FOURCC_GR88 0x38385247
1115 #define __DRI_IMAGE_FOURCC_RGB565 0x36314752
1116 #define __DRI_IMAGE_FOURCC_ARGB8888 0x34325241
1117 #define __DRI_IMAGE_FOURCC_XRGB8888 0x34325258
1118 #define __DRI_IMAGE_FOURCC_ABGR8888 0x34324241
1119 #define __DRI_IMAGE_FOURCC_XBGR8888 0x34324258
1120 #define __DRI_IMAGE_FOURCC_SARGB8888 0x83324258
1121 #define __DRI_IMAGE_FOURCC_YUV410 0x39565559
1122 #define __DRI_IMAGE_FOURCC_YUV411 0x31315559
1123 #define __DRI_IMAGE_FOURCC_YUV420 0x32315559
1124 #define __DRI_IMAGE_FOURCC_YUV422 0x36315559
1125 #define __DRI_IMAGE_FOURCC_YUV444 0x34325559
1126 #define __DRI_IMAGE_FOURCC_NV12 0x3231564e
1127 #define __DRI_IMAGE_FOURCC_NV16 0x3631564e
1128 #define __DRI_IMAGE_FOURCC_YUYV 0x56595559
1132 * Queryable on images created by createImageFromNames.
1134 * RGB and RGBA are may be usable directly as images but its still
1135 * recommended to call fromPlanar with plane == 0.
1137 * Y_U_V, Y_UV and Y_XUXV all requires call to fromPlanar to create
1138 * usable sub-images, sampling from images return raw YUV data and
1139 * color conversion needs to be done in the shader.
1144 #define __DRI_IMAGE_COMPONENTS_RGB 0x3001
1145 #define __DRI_IMAGE_COMPONENTS_RGBA 0x3002
1146 #define __DRI_IMAGE_COMPONENTS_Y_U_V 0x3003
1147 #define __DRI_IMAGE_COMPONENTS_Y_UV 0x3004
1148 #define __DRI_IMAGE_COMPONENTS_Y_XUXV 0x3005
1149 #define __DRI_IMAGE_COMPONENTS_R 0x3006
1150 #define __DRI_IMAGE_COMPONENTS_RG 0x3007
1154 * queryImage attributes
1157 #define __DRI_IMAGE_ATTRIB_STRIDE 0x2000
1158 #define __DRI_IMAGE_ATTRIB_HANDLE 0x2001
1159 #define __DRI_IMAGE_ATTRIB_NAME 0x2002
1160 #define __DRI_IMAGE_ATTRIB_FORMAT 0x2003 /* available in versions 3+ */
1161 #define __DRI_IMAGE_ATTRIB_WIDTH 0x2004 /* available in versions 4+ */
1162 #define __DRI_IMAGE_ATTRIB_HEIGHT 0x2005
1163 #define __DRI_IMAGE_ATTRIB_COMPONENTS 0x2006 /* available in versions 5+ */
1164 #define __DRI_IMAGE_ATTRIB_FD 0x2007 /* available in versions
1165 * 7+. Each query will return a
1167 #define __DRI_IMAGE_ATTRIB_FOURCC 0x2008 /* available in versions 11 */
1168 #define __DRI_IMAGE_ATTRIB_NUM_PLANES 0x2009 /* available in versions 11 */
1170 enum __DRIYUVColorSpace
{
1171 __DRI_YUV_COLOR_SPACE_UNDEFINED
= 0,
1172 __DRI_YUV_COLOR_SPACE_ITU_REC601
= 0x327F,
1173 __DRI_YUV_COLOR_SPACE_ITU_REC709
= 0x3280,
1174 __DRI_YUV_COLOR_SPACE_ITU_REC2020
= 0x3281
1177 enum __DRISampleRange
{
1178 __DRI_YUV_RANGE_UNDEFINED
= 0,
1179 __DRI_YUV_FULL_RANGE
= 0x3282,
1180 __DRI_YUV_NARROW_RANGE
= 0x3283
1183 enum __DRIChromaSiting
{
1184 __DRI_YUV_CHROMA_SITING_UNDEFINED
= 0,
1185 __DRI_YUV_CHROMA_SITING_0
= 0x3284,
1186 __DRI_YUV_CHROMA_SITING_0_5
= 0x3285
1190 * \name Reasons that __DRIimageExtensionRec::createImageFromTexture or
1191 * __DRIimageExtensionRec::createImageFromDmaBufs might fail
1195 #define __DRI_IMAGE_ERROR_SUCCESS 0
1197 /** Memory allocation failure */
1198 #define __DRI_IMAGE_ERROR_BAD_ALLOC 1
1200 /** Client requested an invalid attribute */
1201 #define __DRI_IMAGE_ERROR_BAD_MATCH 2
1203 /** Client requested an invalid texture object */
1204 #define __DRI_IMAGE_ERROR_BAD_PARAMETER 3
1206 /** Client requested an invalid pitch and/or offset */
1207 #define __DRI_IMAGE_ERROR_BAD_ACCESS 4
1211 * \name Capabilities that might be returned by __DRIimageExtensionRec::getCapabilities
1214 #define __DRI_IMAGE_CAP_GLOBAL_NAMES 1
1221 #define __BLIT_FLAG_FLUSH 0x0001
1222 #define __BLIT_FLAG_FINISH 0x0002
1224 typedef struct __DRIimageRec __DRIimage
;
1225 typedef struct __DRIimageExtensionRec __DRIimageExtension
;
1226 struct __DRIimageExtensionRec
{
1227 __DRIextension base
;
1229 __DRIimage
*(*createImageFromName
)(__DRIscreen
*screen
,
1230 int width
, int height
, int format
,
1231 int name
, int pitch
,
1232 void *loaderPrivate
);
1234 __DRIimage
*(*createImageFromRenderbuffer
)(__DRIcontext
*context
,
1236 void *loaderPrivate
);
1238 void (*destroyImage
)(__DRIimage
*image
);
1240 __DRIimage
*(*createImage
)(__DRIscreen
*screen
,
1241 int width
, int height
, int format
,
1243 void *loaderPrivate
);
1245 GLboolean (*queryImage
)(__DRIimage
*image
, int attrib
, int *value
);
1248 * The new __DRIimage will share the content with the old one, see dup(2).
1250 __DRIimage
*(*dupImage
)(__DRIimage
*image
, void *loaderPrivate
);
1253 * Validate that a __DRIimage can be used a certain way.
1257 GLboolean (*validateUsage
)(__DRIimage
*image
, unsigned int use
);
1260 * Unlike createImageFromName __DRI_IMAGE_FORMAT is not but instead
1261 * __DRI_IMAGE_FOURCC and strides are in bytes not pixels. Stride is
1262 * also per block and not per pixel (for non-RGB, see gallium blocks).
1266 __DRIimage
*(*createImageFromNames
)(__DRIscreen
*screen
,
1267 int width
, int height
, int fourcc
,
1268 int *names
, int num_names
,
1269 int *strides
, int *offsets
,
1270 void *loaderPrivate
);
1273 * Create an image out of a sub-region of a parent image. This
1274 * entry point lets us create individual __DRIimages for different
1275 * planes in a planar buffer (typically yuv), for example. While a
1276 * sub-image shares the underlying buffer object with the parent
1277 * image and other sibling sub-images, the life times of parent and
1278 * sub-images are not dependent. Destroying the parent or a
1279 * sub-image doesn't affect other images. The underlying buffer
1280 * object is free when no __DRIimage remains that references it.
1282 * Sub-images may overlap, but rendering to overlapping sub-images
1287 __DRIimage
*(*fromPlanar
)(__DRIimage
*image
, int plane
,
1288 void *loaderPrivate
);
1291 * Create image from texture.
1295 __DRIimage
*(*createImageFromTexture
)(__DRIcontext
*context
,
1301 void *loaderPrivate
);
1303 * Like createImageFromNames, but takes a prime fd instead.
1307 __DRIimage
*(*createImageFromFds
)(__DRIscreen
*screen
,
1308 int width
, int height
, int fourcc
,
1309 int *fds
, int num_fds
,
1310 int *strides
, int *offsets
,
1311 void *loaderPrivate
);
1314 * Like createImageFromFds, but takes additional attributes.
1316 * For EGL_EXT_image_dma_buf_import.
1320 __DRIimage
*(*createImageFromDmaBufs
)(__DRIscreen
*screen
,
1321 int width
, int height
, int fourcc
,
1322 int *fds
, int num_fds
,
1323 int *strides
, int *offsets
,
1324 enum __DRIYUVColorSpace color_space
,
1325 enum __DRISampleRange sample_range
,
1326 enum __DRIChromaSiting horiz_siting
,
1327 enum __DRIChromaSiting vert_siting
,
1329 void *loaderPrivate
);
1332 * Blit a part of a __DRIimage to another and flushes
1336 * __BLIT_FLAG_FLUSH: flush after the blit operation
1337 * __BLIT_FLAG_FINISH: flush and wait the blit finished
1341 void (*blitImage
)(__DRIcontext
*context
, __DRIimage
*dst
, __DRIimage
*src
,
1342 int dstx0
, int dsty0
, int dstwidth
, int dstheight
,
1343 int srcx0
, int srcy0
, int srcwidth
, int srcheight
,
1347 * Query for general capabilities of the driver that concern
1348 * buffer sharing and image importing.
1352 int (*getCapabilities
)(__DRIscreen
*screen
);
1357 * This extension must be implemented by the loader and passed to the
1358 * driver at screen creation time. The EGLImage entry points in the
1359 * various client APIs take opaque EGLImage handles and use this
1360 * extension to map them to a __DRIimage. At version 1, this
1361 * extensions allows mapping EGLImage pointers to __DRIimage pointers,
1362 * but future versions could support other EGLImage-like, opaque types
1363 * with new lookup functions.
1365 #define __DRI_IMAGE_LOOKUP "DRI_IMAGE_LOOKUP"
1366 #define __DRI_IMAGE_LOOKUP_VERSION 1
1368 typedef struct __DRIimageLookupExtensionRec __DRIimageLookupExtension
;
1369 struct __DRIimageLookupExtensionRec
{
1370 __DRIextension base
;
1372 __DRIimage
*(*lookupEGLImage
)(__DRIscreen
*screen
, void *image
,
1373 void *loaderPrivate
);
1377 * This extension allows for common DRI2 options
1379 #define __DRI2_CONFIG_QUERY "DRI_CONFIG_QUERY"
1380 #define __DRI2_CONFIG_QUERY_VERSION 1
1382 typedef struct __DRI2configQueryExtensionRec __DRI2configQueryExtension
;
1383 struct __DRI2configQueryExtensionRec
{
1384 __DRIextension base
;
1386 int (*configQueryb
)(__DRIscreen
*screen
, const char *var
, unsigned char *val
);
1387 int (*configQueryi
)(__DRIscreen
*screen
, const char *var
, int *val
);
1388 int (*configQueryf
)(__DRIscreen
*screen
, const char *var
, float *val
);
1392 * Robust context driver extension.
1394 * Existence of this extension means the driver can accept the
1395 * \c __DRI_CTX_FLAG_ROBUST_BUFFER_ACCESS flag and the
1396 * \c __DRI_CTX_ATTRIB_RESET_STRATEGY attribute in
1397 * \c __DRIdri2ExtensionRec::createContextAttribs.
1399 #define __DRI2_ROBUSTNESS "DRI_Robustness"
1400 #define __DRI2_ROBUSTNESS_VERSION 1
1402 typedef struct __DRIrobustnessExtensionRec __DRIrobustnessExtension
;
1403 struct __DRIrobustnessExtensionRec
{
1404 __DRIextension base
;
1408 * DRI config options extension.
1410 * This extension provides the XML string containing driver options for use by
1411 * the loader in supporting the driconf application.
1413 #define __DRI_CONFIG_OPTIONS "DRI_ConfigOptions"
1414 #define __DRI_CONFIG_OPTIONS_VERSION 1
1416 typedef struct __DRIconfigOptionsExtensionRec
{
1417 __DRIextension base
;
1419 } __DRIconfigOptionsExtension
;
1422 * This extension provides a driver vtable to a set of common driver helper
1423 * functions (driCoreExtension, driDRI2Extension) within the driver
1424 * implementation, as opposed to having to pass them through a global
1427 * It is not intended to be public API to the actual loader, and the vtable
1428 * layout may change at any time.
1430 #define __DRI_DRIVER_VTABLE "DRI_DriverVtable"
1431 #define __DRI_DRIVER_VTABLE_VERSION 1
1433 typedef struct __DRIDriverVtableExtensionRec
{
1434 __DRIextension base
;
1435 const struct __DriverAPIRec
*vtable
;
1436 } __DRIDriverVtableExtension
;
1439 * Query renderer driver extension
1441 * This allows the window system layer (either EGL or GLX) to query aspects of
1442 * hardware and driver support without creating a context.
1444 #define __DRI2_RENDERER_QUERY "DRI_RENDERER_QUERY"
1445 #define __DRI2_RENDERER_QUERY_VERSION 1
1447 #define __DRI2_RENDERER_VENDOR_ID 0x0000
1448 #define __DRI2_RENDERER_DEVICE_ID 0x0001
1449 #define __DRI2_RENDERER_VERSION 0x0002
1450 #define __DRI2_RENDERER_ACCELERATED 0x0003
1451 #define __DRI2_RENDERER_VIDEO_MEMORY 0x0004
1452 #define __DRI2_RENDERER_UNIFIED_MEMORY_ARCHITECTURE 0x0005
1453 #define __DRI2_RENDERER_PREFERRED_PROFILE 0x0006
1454 #define __DRI2_RENDERER_OPENGL_CORE_PROFILE_VERSION 0x0007
1455 #define __DRI2_RENDERER_OPENGL_COMPATIBILITY_PROFILE_VERSION 0x0008
1456 #define __DRI2_RENDERER_OPENGL_ES_PROFILE_VERSION 0x0009
1457 #define __DRI2_RENDERER_OPENGL_ES2_PROFILE_VERSION 0x000a
1458 #define __DRI2_RENDERER_HAS_TEXTURE_3D 0x000b
1459 /* Whether there is an sRGB format support for every supported 32-bit UNORM
1462 #define __DRI2_RENDERER_HAS_FRAMEBUFFER_SRGB 0x000c
1464 typedef struct __DRI2rendererQueryExtensionRec __DRI2rendererQueryExtension
;
1465 struct __DRI2rendererQueryExtensionRec
{
1466 __DRIextension base
;
1468 int (*queryInteger
)(__DRIscreen
*screen
, int attribute
, unsigned int *val
);
1469 int (*queryString
)(__DRIscreen
*screen
, int attribute
, const char **val
);
1473 * Image Loader extension. Drivers use this to allocate color buffers
1476 enum __DRIimageBufferMask
{
1477 __DRI_IMAGE_BUFFER_BACK
= (1 << 0),
1478 __DRI_IMAGE_BUFFER_FRONT
= (1 << 1)
1481 struct __DRIimageList
{
1482 uint32_t image_mask
;
1487 #define __DRI_IMAGE_LOADER "DRI_IMAGE_LOADER"
1488 #define __DRI_IMAGE_LOADER_VERSION 1
1490 struct __DRIimageLoaderExtensionRec
{
1491 __DRIextension base
;
1494 * Allocate color buffers.
1496 * \param driDrawable
1497 * \param width Width of allocated buffers
1498 * \param height Height of allocated buffers
1499 * \param format one of __DRI_IMAGE_FORMAT_*
1500 * \param stamp Address of variable to be updated when
1501 * getBuffers must be called again
1502 * \param loaderPrivate The loaderPrivate for driDrawable
1503 * \param buffer_mask Set of buffers to allocate
1504 * \param buffers Returned buffers
1506 int (*getBuffers
)(__DRIdrawable
*driDrawable
,
1507 unsigned int format
,
1509 void *loaderPrivate
,
1510 uint32_t buffer_mask
,
1511 struct __DRIimageList
*buffers
);
1514 * Flush pending front-buffer rendering
1516 * Any rendering that has been performed to the
1517 * fake front will be flushed to the front
1519 * \param driDrawable Drawable whose front-buffer is to be flushed
1520 * \param loaderPrivate Loader's private data that was previously passed
1521 * into __DRIdri2ExtensionRec::createNewDrawable
1523 void (*flushFrontBuffer
)(__DRIdrawable
*driDrawable
, void *loaderPrivate
);
1530 #define __DRI_IMAGE_DRIVER "DRI_IMAGE_DRIVER"
1531 #define __DRI_IMAGE_DRIVER_VERSION 1
1533 struct __DRIimageDriverExtensionRec
{
1534 __DRIextension base
;
1536 /* Common DRI functions, shared with DRI2 */
1537 __DRIcreateNewScreen2Func createNewScreen2
;
1538 __DRIcreateNewDrawableFunc createNewDrawable
;
1539 __DRIcreateContextAttribsFunc createContextAttribs
;
1540 __DRIgetAPIMaskFunc getAPIMask
;