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
43 /* For archs with no drm.h */
44 #if defined(__APPLE__) || defined(__CYGWIN__) || defined(__GNU__)
45 #ifndef __NOT_HAVE_DRM_H
46 #define __NOT_HAVE_DRM_H
50 #ifndef __NOT_HAVE_DRM_H
53 typedef unsigned int drm_context_t
;
54 typedef unsigned int drm_drawable_t
;
55 typedef struct drm_clip_rect drm_clip_rect_t
;
59 * \name DRI interface structures
61 * The following structures define the interface between the GLX client
62 * side library and the DRI (direct rendering infrastructure).
65 typedef struct __DRIdisplayRec __DRIdisplay
;
66 typedef struct __DRIscreenRec __DRIscreen
;
67 typedef struct __DRIcontextRec __DRIcontext
;
68 typedef struct __DRIdrawableRec __DRIdrawable
;
69 typedef struct __DRIconfigRec __DRIconfig
;
70 typedef struct __DRIframebufferRec __DRIframebuffer
;
71 typedef struct __DRIversionRec __DRIversion
;
73 typedef struct __DRIcoreExtensionRec __DRIcoreExtension
;
74 typedef struct __DRIextensionRec __DRIextension
;
75 typedef struct __DRIcopySubBufferExtensionRec __DRIcopySubBufferExtension
;
76 typedef struct __DRIswapControlExtensionRec __DRIswapControlExtension
;
77 typedef struct __DRIframeTrackingExtensionRec __DRIframeTrackingExtension
;
78 typedef struct __DRImediaStreamCounterExtensionRec __DRImediaStreamCounterExtension
;
79 typedef struct __DRItexOffsetExtensionRec __DRItexOffsetExtension
;
80 typedef struct __DRItexBufferExtensionRec __DRItexBufferExtension
;
81 typedef struct __DRIlegacyExtensionRec __DRIlegacyExtension
;
82 typedef struct __DRIswrastExtensionRec __DRIswrastExtension
;
83 typedef struct __DRIbufferRec __DRIbuffer
;
84 typedef struct __DRIdri2ExtensionRec __DRIdri2Extension
;
85 typedef struct __DRIdri2LoaderExtensionRec __DRIdri2LoaderExtension
;
86 typedef struct __DRI2flushExtensionRec __DRI2flushExtension
;
92 * Extension struct. Drivers 'inherit' from this struct by embedding
93 * it as the first element in the extension struct.
95 * We never break API in for a DRI extension. If we need to change
96 * the way things work in a non-backwards compatible manner, we
97 * introduce a new extension. During a transition period, we can
98 * leave both the old and the new extension in the driver, which
99 * allows us to move to the new interface without having to update the
100 * loader(s) in lock step.
102 * However, we can add entry points to an extension over time as long
103 * as we don't break the old ones. As we add entry points to an
104 * extension, we increase the version number. The corresponding
105 * #define can be used to guard code that accesses the new entry
106 * points at compile time and the version field in the extension
107 * struct can be used at run-time to determine how to use the
110 struct __DRIextensionRec
{
116 * The first set of extension are the screen extensions, returned by
117 * __DRIcore::getExtensions(). This entry point will return a list of
118 * extensions and the loader can use the ones it knows about by
119 * casting them to more specific extensions and advertising any GLX
120 * extensions the DRI extensions enables.
124 * Used by drivers to indicate support for setting the read drawable.
126 #define __DRI_READ_DRAWABLE "DRI_ReadDrawable"
127 #define __DRI_READ_DRAWABLE_VERSION 1
130 * Used by drivers that implement the GLX_MESA_copy_sub_buffer extension.
132 #define __DRI_COPY_SUB_BUFFER "DRI_CopySubBuffer"
133 #define __DRI_COPY_SUB_BUFFER_VERSION 1
134 struct __DRIcopySubBufferExtensionRec
{
136 void (*copySubBuffer
)(__DRIdrawable
*drawable
, int x
, int y
, int w
, int h
);
140 * Used by drivers that implement the GLX_SGI_swap_control or
141 * GLX_MESA_swap_control extension.
143 #define __DRI_SWAP_CONTROL "DRI_SwapControl"
144 #define __DRI_SWAP_CONTROL_VERSION 1
145 struct __DRIswapControlExtensionRec
{
147 void (*setSwapInterval
)(__DRIdrawable
*drawable
, unsigned int inteval
);
148 unsigned int (*getSwapInterval
)(__DRIdrawable
*drawable
);
152 * Used by drivers that implement the GLX_MESA_swap_frame_usage extension.
154 #define __DRI_FRAME_TRACKING "DRI_FrameTracking"
155 #define __DRI_FRAME_TRACKING_VERSION 1
156 struct __DRIframeTrackingExtensionRec
{
160 * Enable or disable frame usage tracking.
162 * \since Internal API version 20030317.
164 int (*frameTracking
)(__DRIdrawable
*drawable
, GLboolean enable
);
167 * Retrieve frame usage information.
169 * \since Internal API version 20030317.
171 int (*queryFrameTracking
)(__DRIdrawable
*drawable
,
172 int64_t * sbc
, int64_t * missedFrames
,
173 float * lastMissedUsage
, float * usage
);
178 * Used by drivers that implement the GLX_SGI_video_sync extension.
180 #define __DRI_MEDIA_STREAM_COUNTER "DRI_MediaStreamCounter"
181 #define __DRI_MEDIA_STREAM_COUNTER_VERSION 1
182 struct __DRImediaStreamCounterExtensionRec
{
186 * Wait for the MSC to equal target_msc, or, if that has already passed,
187 * the next time (MSC % divisor) is equal to remainder. If divisor is
188 * zero, the function will return as soon as MSC is greater than or equal
191 int (*waitForMSC
)(__DRIdrawable
*drawable
,
192 int64_t target_msc
, int64_t divisor
, int64_t remainder
,
193 int64_t * msc
, int64_t * sbc
);
196 * Get the number of vertical refreshes since some point in time before
197 * this function was first called (i.e., system start up).
199 int (*getDrawableMSC
)(__DRIscreen
*screen
, __DRIdrawable
*drawable
,
204 #define __DRI_TEX_OFFSET "DRI_TexOffset"
205 #define __DRI_TEX_OFFSET_VERSION 1
206 struct __DRItexOffsetExtensionRec
{
210 * Method to override base texture image with a driver specific 'offset'.
211 * The depth passed in allows e.g. to ignore the alpha channel of texture
212 * images where the non-alpha components don't occupy a whole texel.
214 * For GLX_EXT_texture_from_pixmap with AIGLX.
216 void (*setTexOffset
)(__DRIcontext
*pDRICtx
, GLint texname
,
217 unsigned long long offset
, GLint depth
, GLuint pitch
);
221 /* Valid values for format in the setTexBuffer2 function below. These
222 * values match the GLX tokens for compatibility reasons, but we
223 * define them here since the DRI interface can't depend on GLX. */
224 #define __DRI_TEXTURE_FORMAT_NONE 0x20D8
225 #define __DRI_TEXTURE_FORMAT_RGB 0x20D9
226 #define __DRI_TEXTURE_FORMAT_RGBA 0x20DA
228 #define __DRI_TEX_BUFFER "DRI_TexBuffer"
229 #define __DRI_TEX_BUFFER_VERSION 2
230 struct __DRItexBufferExtensionRec
{
234 * Method to override base texture image with the contents of a
237 * For GLX_EXT_texture_from_pixmap with AIGLX. Deprecated in favor of
238 * setTexBuffer2 in version 2 of this interface
240 void (*setTexBuffer
)(__DRIcontext
*pDRICtx
,
242 __DRIdrawable
*pDraw
);
245 * Method to override base texture image with the contents of a
246 * __DRIdrawable, including the required texture format attribute.
248 * For GLX_EXT_texture_from_pixmap with AIGLX.
250 void (*setTexBuffer2
)(__DRIcontext
*pDRICtx
,
253 __DRIdrawable
*pDraw
);
255 * Method to release texture buffer in case some special platform
258 * For GLX_EXT_texture_from_pixmap with AIGLX.
260 void (*releaseTexBuffer
)(__DRIcontext
*pDRICtx
,
262 __DRIdrawable
*pDraw
);
266 * Used by drivers that implement DRI2
268 #define __DRI2_FLUSH "DRI2_Flush"
269 #define __DRI2_FLUSH_VERSION 3
270 struct __DRI2flushExtensionRec
{
272 void (*flush
)(__DRIdrawable
*drawable
);
275 * Ask the driver to call getBuffers/getBuffersWithFormat before
276 * it starts rendering again.
278 * \param drawable the drawable to invalidate
282 void (*invalidate
)(__DRIdrawable
*drawable
);
287 * XML document describing the configuration options supported by the
290 extern const char __driConfigOptions
[];
295 * The following extensions describe loader features that the DRI
296 * driver can make use of. Some of these are mandatory, such as the
297 * getDrawableInfo extension for DRI and the DRI Loader extensions for
298 * DRI2, while others are optional, and if present allow the driver to
299 * expose certain features. The loader pass in a NULL terminated
300 * array of these extensions to the driver in the createNewScreen
304 typedef struct __DRIgetDrawableInfoExtensionRec __DRIgetDrawableInfoExtension
;
305 typedef struct __DRIsystemTimeExtensionRec __DRIsystemTimeExtension
;
306 typedef struct __DRIdamageExtensionRec __DRIdamageExtension
;
307 typedef struct __DRIloaderExtensionRec __DRIloaderExtension
;
308 typedef struct __DRIswrastLoaderExtensionRec __DRIswrastLoaderExtension
;
312 * Callback to getDrawableInfo protocol
314 #define __DRI_GET_DRAWABLE_INFO "DRI_GetDrawableInfo"
315 #define __DRI_GET_DRAWABLE_INFO_VERSION 1
316 struct __DRIgetDrawableInfoExtensionRec
{
320 * This function is used to get information about the position, size, and
321 * clip rects of a drawable.
323 GLboolean (* getDrawableInfo
) ( __DRIdrawable
*drawable
,
324 unsigned int * index
, unsigned int * stamp
,
325 int * x
, int * y
, int * width
, int * height
,
326 int * numClipRects
, drm_clip_rect_t
** pClipRects
,
327 int * backX
, int * backY
,
328 int * numBackClipRects
, drm_clip_rect_t
** pBackClipRects
,
329 void *loaderPrivate
);
333 * Callback to get system time for media stream counter extensions.
335 #define __DRI_SYSTEM_TIME "DRI_SystemTime"
336 #define __DRI_SYSTEM_TIME_VERSION 1
337 struct __DRIsystemTimeExtensionRec
{
341 * Get the 64-bit unadjusted system time (UST).
343 int (*getUST
)(int64_t * ust
);
346 * Get the media stream counter (MSC) rate.
348 * Matching the definition in GLX_OML_sync_control, this function returns
349 * the rate of the "media stream counter". In practical terms, this is
350 * the frame refresh rate of the display.
352 GLboolean (*getMSCRate
)(__DRIdrawable
*draw
,
353 int32_t * numerator
, int32_t * denominator
,
354 void *loaderPrivate
);
360 #define __DRI_DAMAGE "DRI_Damage"
361 #define __DRI_DAMAGE_VERSION 1
362 struct __DRIdamageExtensionRec
{
366 * Reports areas of the given drawable which have been modified by the
369 * \param drawable which the drawing was done to.
370 * \param rects rectangles affected, with the drawable origin as the
372 * \param x X offset of the drawable within the screen (used in the
374 * \param y Y offset of the drawable within the screen.
375 * \param front_buffer boolean flag for whether the drawing to the
376 * drawable was actually done directly to the front buffer (instead
377 * of backing storage, for example)
378 * \param loaderPrivate the data passed in at createNewDrawable time
380 void (*reportDamage
)(__DRIdrawable
*draw
,
382 drm_clip_rect_t
*rects
, int num_rects
,
383 GLboolean front_buffer
,
384 void *loaderPrivate
);
387 #define __DRI_SWRAST_IMAGE_OP_DRAW 1
388 #define __DRI_SWRAST_IMAGE_OP_CLEAR 2
389 #define __DRI_SWRAST_IMAGE_OP_SWAP 3
392 * SWRast Loader extension.
394 #define __DRI_SWRAST_LOADER "DRI_SWRastLoader"
395 #define __DRI_SWRAST_LOADER_VERSION 1
396 struct __DRIswrastLoaderExtensionRec
{
400 * Drawable position and size
402 void (*getDrawableInfo
)(__DRIdrawable
*drawable
,
403 int *x
, int *y
, int *width
, int *height
,
404 void *loaderPrivate
);
407 * Put image to drawable
409 void (*putImage
)(__DRIdrawable
*drawable
, int op
,
410 int x
, int y
, int width
, int height
,
411 char *data
, void *loaderPrivate
);
414 * Get image from readable
416 void (*getImage
)(__DRIdrawable
*readable
,
417 int x
, int y
, int width
, int height
,
418 char *data
, void *loaderPrivate
);
422 * Invalidate loader extension. The presence of this extension
423 * indicates to the DRI driver that the loader will call invalidate in
424 * the __DRI2_FLUSH extension, whenever the needs to query for new
425 * buffers. This means that the DRI driver can drop the polling in
428 * The extension doesn't provide any functionality, it's only use to
429 * indicate to the driver that it can use the new semantics. A DRI
430 * driver can use this to switch between the different semantics or
431 * just refuse to initialize if this extension isn't present.
433 #define __DRI_USE_INVALIDATE "DRI_UseInvalidate"
434 #define __DRI_USE_INVALIDATE_VERSION 1
436 typedef struct __DRIuseInvalidateExtensionRec __DRIuseInvalidateExtension
;
437 struct __DRIuseInvalidateExtensionRec
{
442 * The remaining extensions describe driver extensions, immediately
443 * available interfaces provided by the driver. To start using the
444 * driver, dlsym() for the __DRI_DRIVER_EXTENSIONS symbol and look for
445 * the extension you need in the array.
447 #define __DRI_DRIVER_EXTENSIONS "__driDriverExtensions"
450 * Tokens for __DRIconfig attribs. A number of attributes defined by
451 * GLX or EGL standards are not in the table, as they must be provided
452 * by the loader. For example, FBConfig ID or visual ID, drawable type.
455 #define __DRI_ATTRIB_BUFFER_SIZE 1
456 #define __DRI_ATTRIB_LEVEL 2
457 #define __DRI_ATTRIB_RED_SIZE 3
458 #define __DRI_ATTRIB_GREEN_SIZE 4
459 #define __DRI_ATTRIB_BLUE_SIZE 5
460 #define __DRI_ATTRIB_LUMINANCE_SIZE 6
461 #define __DRI_ATTRIB_ALPHA_SIZE 7
462 #define __DRI_ATTRIB_ALPHA_MASK_SIZE 8
463 #define __DRI_ATTRIB_DEPTH_SIZE 9
464 #define __DRI_ATTRIB_STENCIL_SIZE 10
465 #define __DRI_ATTRIB_ACCUM_RED_SIZE 11
466 #define __DRI_ATTRIB_ACCUM_GREEN_SIZE 12
467 #define __DRI_ATTRIB_ACCUM_BLUE_SIZE 13
468 #define __DRI_ATTRIB_ACCUM_ALPHA_SIZE 14
469 #define __DRI_ATTRIB_SAMPLE_BUFFERS 15
470 #define __DRI_ATTRIB_SAMPLES 16
471 #define __DRI_ATTRIB_RENDER_TYPE 17
472 #define __DRI_ATTRIB_CONFIG_CAVEAT 18
473 #define __DRI_ATTRIB_CONFORMANT 19
474 #define __DRI_ATTRIB_DOUBLE_BUFFER 20
475 #define __DRI_ATTRIB_STEREO 21
476 #define __DRI_ATTRIB_AUX_BUFFERS 22
477 #define __DRI_ATTRIB_TRANSPARENT_TYPE 23
478 #define __DRI_ATTRIB_TRANSPARENT_INDEX_VALUE 24
479 #define __DRI_ATTRIB_TRANSPARENT_RED_VALUE 25
480 #define __DRI_ATTRIB_TRANSPARENT_GREEN_VALUE 26
481 #define __DRI_ATTRIB_TRANSPARENT_BLUE_VALUE 27
482 #define __DRI_ATTRIB_TRANSPARENT_ALPHA_VALUE 28
483 #define __DRI_ATTRIB_FLOAT_MODE 29
484 #define __DRI_ATTRIB_RED_MASK 30
485 #define __DRI_ATTRIB_GREEN_MASK 31
486 #define __DRI_ATTRIB_BLUE_MASK 32
487 #define __DRI_ATTRIB_ALPHA_MASK 33
488 #define __DRI_ATTRIB_MAX_PBUFFER_WIDTH 34
489 #define __DRI_ATTRIB_MAX_PBUFFER_HEIGHT 35
490 #define __DRI_ATTRIB_MAX_PBUFFER_PIXELS 36
491 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_WIDTH 37
492 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_HEIGHT 38
493 #define __DRI_ATTRIB_VISUAL_SELECT_GROUP 39
494 #define __DRI_ATTRIB_SWAP_METHOD 40
495 #define __DRI_ATTRIB_MAX_SWAP_INTERVAL 41
496 #define __DRI_ATTRIB_MIN_SWAP_INTERVAL 42
497 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGB 43
498 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGBA 44
499 #define __DRI_ATTRIB_BIND_TO_MIPMAP_TEXTURE 45
500 #define __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS 46
501 #define __DRI_ATTRIB_YINVERTED 47
502 #define __DRI_ATTRIB_FRAMEBUFFER_SRGB_CAPABLE 48
504 /* __DRI_ATTRIB_RENDER_TYPE */
505 #define __DRI_ATTRIB_RGBA_BIT 0x01
506 #define __DRI_ATTRIB_COLOR_INDEX_BIT 0x02
507 #define __DRI_ATTRIB_LUMINANCE_BIT 0x04
509 /* __DRI_ATTRIB_CONFIG_CAVEAT */
510 #define __DRI_ATTRIB_SLOW_BIT 0x01
511 #define __DRI_ATTRIB_NON_CONFORMANT_CONFIG 0x02
513 /* __DRI_ATTRIB_TRANSPARENT_TYPE */
514 #define __DRI_ATTRIB_TRANSPARENT_RGB 0x00
515 #define __DRI_ATTRIB_TRANSPARENT_INDEX 0x01
517 /* __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS */
518 #define __DRI_ATTRIB_TEXTURE_1D_BIT 0x01
519 #define __DRI_ATTRIB_TEXTURE_2D_BIT 0x02
520 #define __DRI_ATTRIB_TEXTURE_RECTANGLE_BIT 0x04
523 * This extension defines the core DRI functionality.
525 #define __DRI_CORE "DRI_Core"
526 #define __DRI_CORE_VERSION 1
528 struct __DRIcoreExtensionRec
{
531 __DRIscreen
*(*createNewScreen
)(int screen
, int fd
,
532 unsigned int sarea_handle
,
533 const __DRIextension
**extensions
,
534 const __DRIconfig
***driverConfigs
,
535 void *loaderPrivate
);
537 void (*destroyScreen
)(__DRIscreen
*screen
);
539 const __DRIextension
**(*getExtensions
)(__DRIscreen
*screen
);
541 int (*getConfigAttrib
)(const __DRIconfig
*config
,
543 unsigned int *value
);
545 int (*indexConfigAttrib
)(const __DRIconfig
*config
, int index
,
546 unsigned int *attrib
, unsigned int *value
);
548 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
549 const __DRIconfig
*config
,
550 unsigned int drawable_id
,
552 void *loaderPrivate
);
554 void (*destroyDrawable
)(__DRIdrawable
*drawable
);
556 void (*swapBuffers
)(__DRIdrawable
*drawable
);
558 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
559 const __DRIconfig
*config
,
560 __DRIcontext
*shared
,
561 void *loaderPrivate
);
563 int (*copyContext
)(__DRIcontext
*dest
,
567 void (*destroyContext
)(__DRIcontext
*context
);
569 int (*bindContext
)(__DRIcontext
*ctx
,
570 __DRIdrawable
*pdraw
,
571 __DRIdrawable
*pread
);
573 int (*unbindContext
)(__DRIcontext
*ctx
);
577 * Stored version of some component (i.e., server-side DRI module, kernel-side
581 * There are several data structures that explicitly store a major version,
582 * minor version, and patch level. These structures should be modified to
583 * have a \c __DRIversionRec instead.
585 struct __DRIversionRec
{
586 int major
; /**< Major version number. */
587 int minor
; /**< Minor version number. */
588 int patch
; /**< Patch-level. */
592 * Framebuffer information record. Used by libGL to communicate information
593 * about the framebuffer to the driver's \c __driCreateNewScreen function.
595 * In XFree86, most of this information is derrived from data returned by
596 * calling \c XF86DRIGetDeviceInfo.
598 * \sa XF86DRIGetDeviceInfo __DRIdisplayRec::createNewScreen
599 * __driUtilCreateNewScreen CallCreateNewScreen
601 * \bug This structure could be better named.
603 struct __DRIframebufferRec
{
604 unsigned char *base
; /**< Framebuffer base address in the CPU's
605 * address space. This value is calculated by
606 * calling \c drmMap on the framebuffer handle
607 * returned by \c XF86DRIGetDeviceInfo (or a
610 int size
; /**< Framebuffer size, in bytes. */
611 int stride
; /**< Number of bytes from one line to the next. */
612 int width
; /**< Pixel width of the framebuffer. */
613 int height
; /**< Pixel height of the framebuffer. */
614 int dev_priv_size
; /**< Size of the driver's dev-priv structure. */
615 void *dev_priv
; /**< Pointer to the driver's dev-priv structure. */
620 * This extension provides alternative screen, drawable and context
621 * constructors for legacy DRI functionality. This is used in
622 * conjunction with the core extension.
624 #define __DRI_LEGACY "DRI_Legacy"
625 #define __DRI_LEGACY_VERSION 1
627 struct __DRIlegacyExtensionRec
{
630 __DRIscreen
*(*createNewScreen
)(int screen
,
631 const __DRIversion
*ddx_version
,
632 const __DRIversion
*dri_version
,
633 const __DRIversion
*drm_version
,
634 const __DRIframebuffer
*frame_buffer
,
635 void *pSAREA
, int fd
,
636 const __DRIextension
**extensions
,
637 const __DRIconfig
***driver_configs
,
638 void *loaderPrivate
);
640 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
641 const __DRIconfig
*config
,
642 drm_drawable_t hwDrawable
,
643 int renderType
, const int *attrs
,
644 void *loaderPrivate
);
646 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
647 const __DRIconfig
*config
,
649 __DRIcontext
*shared
,
650 drm_context_t hwContext
,
651 void *loaderPrivate
);
655 * This extension provides alternative screen, drawable and context
656 * constructors for swrast DRI functionality. This is used in
657 * conjunction with the core extension.
659 #define __DRI_SWRAST "DRI_SWRast"
660 #define __DRI_SWRAST_VERSION 2
662 struct __DRIswrastExtensionRec
{
665 __DRIscreen
*(*createNewScreen
)(int screen
,
666 const __DRIextension
**extensions
,
667 const __DRIconfig
***driver_configs
,
668 void *loaderPrivate
);
670 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
671 const __DRIconfig
*config
,
672 void *loaderPrivate
);
674 /* Since version 2 */
675 __DRIcontext
*(*createNewContextForAPI
)(__DRIscreen
*screen
,
677 const __DRIconfig
*config
,
678 __DRIcontext
*shared
,
683 * DRI2 Loader extension.
685 #define __DRI_BUFFER_FRONT_LEFT 0
686 #define __DRI_BUFFER_BACK_LEFT 1
687 #define __DRI_BUFFER_FRONT_RIGHT 2
688 #define __DRI_BUFFER_BACK_RIGHT 3
689 #define __DRI_BUFFER_DEPTH 4
690 #define __DRI_BUFFER_STENCIL 5
691 #define __DRI_BUFFER_ACCUM 6
692 #define __DRI_BUFFER_FAKE_FRONT_LEFT 7
693 #define __DRI_BUFFER_FAKE_FRONT_RIGHT 8
694 #define __DRI_BUFFER_DEPTH_STENCIL 9 /**< Only available with DRI2 1.1 */
695 #define __DRI_BUFFER_HIZ 10
697 /* Inofficial and for internal use. Increase when adding a new buffer token. */
698 #define __DRI_BUFFER_COUNT 11
700 struct __DRIbufferRec
{
701 unsigned int attachment
;
708 #define __DRI_DRI2_LOADER "DRI_DRI2Loader"
709 #define __DRI_DRI2_LOADER_VERSION 3
710 struct __DRIdri2LoaderExtensionRec
{
713 __DRIbuffer
*(*getBuffers
)(__DRIdrawable
*driDrawable
,
714 int *width
, int *height
,
715 unsigned int *attachments
, int count
,
716 int *out_count
, void *loaderPrivate
);
719 * Flush pending front-buffer rendering
721 * Any rendering that has been performed to the
722 * \c __DRI_BUFFER_FAKE_FRONT_LEFT will be flushed to the
723 * \c __DRI_BUFFER_FRONT_LEFT.
725 * \param driDrawable Drawable whose front-buffer is to be flushed
726 * \param loaderPrivate Loader's private data that was previously passed
727 * into __DRIdri2ExtensionRec::createNewDrawable
729 void (*flushFrontBuffer
)(__DRIdrawable
*driDrawable
, void *loaderPrivate
);
733 * Get list of buffers from the server
735 * Gets a list of buffer for the specified set of attachments. Unlike
736 * \c ::getBuffers, this function takes a list of attachments paired with
737 * opaque \c unsigned \c int value describing the format of the buffer.
738 * It is the responsibility of the caller to know what the service that
739 * allocates the buffers will expect to receive for the format.
741 * \param driDrawable Drawable whose buffers are being queried.
742 * \param width Output where the width of the buffers is stored.
743 * \param height Output where the height of the buffers is stored.
744 * \param attachments List of pairs of attachment ID and opaque format
745 * requested for the drawable.
746 * \param count Number of attachment / format pairs stored in
748 * \param loaderPrivate Loader's private data that was previously passed
749 * into __DRIdri2ExtensionRec::createNewDrawable.
751 __DRIbuffer
*(*getBuffersWithFormat
)(__DRIdrawable
*driDrawable
,
752 int *width
, int *height
,
753 unsigned int *attachments
, int count
,
754 int *out_count
, void *loaderPrivate
);
758 * This extension provides alternative screen, drawable and context
759 * constructors for DRI2.
761 #define __DRI_DRI2 "DRI_DRI2"
762 #define __DRI_DRI2_VERSION 2
764 #define __DRI_API_OPENGL 0
765 #define __DRI_API_GLES 1
766 #define __DRI_API_GLES2 2
768 struct __DRIdri2ExtensionRec
{
771 __DRIscreen
*(*createNewScreen
)(int screen
, int fd
,
772 const __DRIextension
**extensions
,
773 const __DRIconfig
***driver_configs
,
774 void *loaderPrivate
);
776 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
777 const __DRIconfig
*config
,
778 void *loaderPrivate
);
780 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
781 const __DRIconfig
*config
,
782 __DRIcontext
*shared
,
783 void *loaderPrivate
);
785 /* Since version 2 */
786 unsigned int (*getAPIMask
)(__DRIscreen
*screen
);
788 __DRIcontext
*(*createNewContextForAPI
)(__DRIscreen
*screen
,
790 const __DRIconfig
*config
,
791 __DRIcontext
*shared
,
794 __DRIbuffer
*(*allocateBuffer
)(__DRIscreen
*screen
,
795 unsigned int attachment
,
799 void (*releaseBuffer
)(__DRIscreen
*screen
,
800 __DRIbuffer
*buffer
);
805 * This extension provides functionality to enable various EGLImage
808 #define __DRI_IMAGE "DRI_IMAGE"
809 #define __DRI_IMAGE_VERSION 1
812 * These formats correspond to the similarly named MESA_FORMAT_*
813 * tokens, except in the native endian of the CPU. For example, on
814 * little endian __DRI_IMAGE_FORMAT_XRGB8888 corresponds to
815 * MESA_FORMAT_XRGB8888, but MESA_FORMAT_XRGB8888_REV on big endian.
817 #define __DRI_IMAGE_FORMAT_RGB565 0x1001
818 #define __DRI_IMAGE_FORMAT_XRGB8888 0x1002
819 #define __DRI_IMAGE_FORMAT_ARGB8888 0x1003
821 #define __DRI_IMAGE_USE_SHARE 0x0001
822 #define __DRI_IMAGE_USE_SCANOUT 0x0002
823 #define __DRI_IMAGE_USE_CURSOR 0x0004
826 * queryImage attributes
829 #define __DRI_IMAGE_ATTRIB_STRIDE 0x2000
830 #define __DRI_IMAGE_ATTRIB_HANDLE 0x2001
831 #define __DRI_IMAGE_ATTRIB_NAME 0x2002
833 typedef struct __DRIimageRec __DRIimage
;
834 typedef struct __DRIimageExtensionRec __DRIimageExtension
;
835 struct __DRIimageExtensionRec
{
838 __DRIimage
*(*createImageFromName
)(__DRIscreen
*screen
,
839 int width
, int height
, int format
,
841 void *loaderPrivate
);
843 __DRIimage
*(*createImageFromRenderbuffer
)(__DRIcontext
*context
,
845 void *loaderPrivate
);
847 void (*destroyImage
)(__DRIimage
*image
);
849 __DRIimage
*(*createImage
)(__DRIscreen
*screen
,
850 int width
, int height
, int format
,
852 void *loaderPrivate
);
854 GLboolean (*queryImage
)(__DRIimage
*image
, int attrib
, int *value
);
857 * The new __DRIimage will share the content with the old one, see dup(2).
859 __DRIimage
*(*dupImage
)(__DRIimage
*image
, void *loaderPrivate
);
864 * This extension must be implemented by the loader and passed to the
865 * driver at screen creation time. The EGLImage entry points in the
866 * various client APIs take opaque EGLImage handles and use this
867 * extension to map them to a __DRIimage. At version 1, this
868 * extensions allows mapping EGLImage pointers to __DRIimage pointers,
869 * but future versions could support other EGLImage-like, opaque types
870 * with new lookup functions.
872 #define __DRI_IMAGE_LOOKUP "DRI_IMAGE_LOOKUP"
873 #define __DRI_IMAGE_LOOKUP_VERSION 1
875 typedef struct __DRIimageLookupExtensionRec __DRIimageLookupExtension
;
876 struct __DRIimageLookupExtensionRec
{
879 __DRIimage
*(*lookupEGLImage
)(__DRIscreen
*screen
, void *image
,
880 void *loaderPrivate
);
884 * This extension allows for common DRI2 options
886 #define __DRI2_CONFIG_QUERY "DRI_CONFIG_QUERY"
887 #define __DRI2_CONFIG_QUERY_VERSION 1
889 typedef struct __DRI2configQueryExtensionRec __DRI2configQueryExtension
;
890 struct __DRI2configQueryExtensionRec
{
893 int (*configQueryb
)(__DRIscreen
*screen
, const char *var
, GLboolean
*val
);
894 int (*configQueryi
)(__DRIscreen
*screen
, const char *var
, GLint
*val
);
895 int (*configQueryf
)(__DRIscreen
*screen
, const char *var
, GLfloat
*val
);