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__)
47 typedef unsigned int drm_context_t
;
48 typedef unsigned int drm_drawable_t
;
49 typedef struct drm_clip_rect drm_clip_rect_t
;
53 * \name DRI interface structures
55 * The following structures define the interface between the GLX client
56 * side library and the DRI (direct rendering infrastructure).
59 typedef struct __DRIdisplayRec __DRIdisplay
;
60 typedef struct __DRIscreenRec __DRIscreen
;
61 typedef struct __DRIcontextRec __DRIcontext
;
62 typedef struct __DRIdrawableRec __DRIdrawable
;
63 typedef struct __DRIconfigRec __DRIconfig
;
64 typedef struct __DRIframebufferRec __DRIframebuffer
;
65 typedef struct __DRIversionRec __DRIversion
;
67 typedef struct __DRIcoreExtensionRec __DRIcoreExtension
;
68 typedef struct __DRIextensionRec __DRIextension
;
69 typedef struct __DRIcopySubBufferExtensionRec __DRIcopySubBufferExtension
;
70 typedef struct __DRIswapControlExtensionRec __DRIswapControlExtension
;
71 typedef struct __DRIallocateExtensionRec __DRIallocateExtension
;
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
;
87 * Extension struct. Drivers 'inherit' from this struct by embedding
88 * it as the first element in the extension struct.
90 * We never break API in for a DRI extension. If we need to change
91 * the way things work in a non-backwards compatible manner, we
92 * introduce a new extension. During a transition period, we can
93 * leave both the old and the new extension in the driver, which
94 * allows us to move to the new interface without having to update the
95 * loader(s) in lock step.
97 * However, we can add entry points to an extension over time as long
98 * as we don't break the old ones. As we add entry points to an
99 * extension, we increase the version number. The corresponding
100 * #define can be used to guard code that accesses the new entry
101 * points at compile time and the version field in the extension
102 * struct can be used at run-time to determine how to use the
105 struct __DRIextensionRec
{
111 * The first set of extension are the screen extensions, returned by
112 * __DRIcore::getExtensions(). This entry point will return a list of
113 * extensions and the loader can use the ones it knows about by
114 * casting them to more specific extensions and advertising any GLX
115 * extensions the DRI extensions enables.
119 * Used by drivers to indicate support for setting the read drawable.
121 #define __DRI_READ_DRAWABLE "DRI_ReadDrawable"
122 #define __DRI_READ_DRAWABLE_VERSION 1
125 * Used by drivers that implement the GLX_MESA_copy_sub_buffer extension.
127 #define __DRI_COPY_SUB_BUFFER "DRI_CopySubBuffer"
128 #define __DRI_COPY_SUB_BUFFER_VERSION 1
129 struct __DRIcopySubBufferExtensionRec
{
131 void (*copySubBuffer
)(__DRIdrawable
*drawable
, int x
, int y
, int w
, int h
);
135 * Used by drivers that implement the GLX_SGI_swap_control or
136 * GLX_MESA_swap_control extension.
138 #define __DRI_SWAP_CONTROL "DRI_SwapControl"
139 #define __DRI_SWAP_CONTROL_VERSION 1
140 struct __DRIswapControlExtensionRec
{
142 void (*setSwapInterval
)(__DRIdrawable
*drawable
, unsigned int inteval
);
143 unsigned int (*getSwapInterval
)(__DRIdrawable
*drawable
);
147 * Used by drivers that implement the GLX_MESA_allocate_memory.
149 #define __DRI_ALLOCATE "DRI_Allocate"
150 #define __DRI_ALLOCATE_VERSION 1
151 struct __DRIallocateExtensionRec
{
154 void *(*allocateMemory
)(__DRIscreen
*screen
, GLsizei size
,
155 GLfloat readfreq
, GLfloat writefreq
,
158 void (*freeMemory
)(__DRIscreen
*screen
, GLvoid
*pointer
);
160 GLuint (*memoryOffset
)(__DRIscreen
*screen
, const GLvoid
*pointer
);
164 * Used by drivers that implement the GLX_MESA_swap_frame_usage extension.
166 #define __DRI_FRAME_TRACKING "DRI_FrameTracking"
167 #define __DRI_FRAME_TRACKING_VERSION 1
168 struct __DRIframeTrackingExtensionRec
{
172 * Enable or disable frame usage tracking.
174 * \since Internal API version 20030317.
176 int (*frameTracking
)(__DRIdrawable
*drawable
, GLboolean enable
);
179 * Retrieve frame usage information.
181 * \since Internal API version 20030317.
183 int (*queryFrameTracking
)(__DRIdrawable
*drawable
,
184 int64_t * sbc
, int64_t * missedFrames
,
185 float * lastMissedUsage
, float * usage
);
190 * Used by drivers that implement the GLX_SGI_video_sync extension.
192 #define __DRI_MEDIA_STREAM_COUNTER "DRI_MediaStreamCounter"
193 #define __DRI_MEDIA_STREAM_COUNTER_VERSION 1
194 struct __DRImediaStreamCounterExtensionRec
{
198 * Wait for the MSC to equal target_msc, or, if that has already passed,
199 * the next time (MSC % divisor) is equal to remainder. If divisor is
200 * zero, the function will return as soon as MSC is greater than or equal
203 int (*waitForMSC
)(__DRIdrawable
*drawable
,
204 int64_t target_msc
, int64_t divisor
, int64_t remainder
,
205 int64_t * msc
, int64_t * sbc
);
208 * Get the number of vertical refreshes since some point in time before
209 * this function was first called (i.e., system start up).
211 int (*getDrawableMSC
)(__DRIscreen
*screen
, __DRIdrawable
*drawable
,
216 #define __DRI_TEX_OFFSET "DRI_TexOffset"
217 #define __DRI_TEX_OFFSET_VERSION 1
218 struct __DRItexOffsetExtensionRec
{
222 * Method to override base texture image with a driver specific 'offset'.
223 * The depth passed in allows e.g. to ignore the alpha channel of texture
224 * images where the non-alpha components don't occupy a whole texel.
226 * For GLX_EXT_texture_from_pixmap with AIGLX.
228 void (*setTexOffset
)(__DRIcontext
*pDRICtx
, GLint texname
,
229 unsigned long long offset
, GLint depth
, GLuint pitch
);
233 /* Valid values for format in the setTexBuffer2 function below. These
234 * values match the GLX tokens for compatibility reasons, but we
235 * define them here since the DRI interface can't depend on GLX. */
236 #define __DRI_TEXTURE_FORMAT_NONE 0x20D8
237 #define __DRI_TEXTURE_FORMAT_RGB 0x20D9
238 #define __DRI_TEXTURE_FORMAT_RGBA 0x20DA
240 #define __DRI_TEX_BUFFER "DRI_TexBuffer"
241 #define __DRI_TEX_BUFFER_VERSION 2
242 struct __DRItexBufferExtensionRec
{
246 * Method to override base texture image with the contents of a
249 * For GLX_EXT_texture_from_pixmap with AIGLX. Deprecated in favor of
250 * setTexBuffer2 in version 2 of this interface
252 void (*setTexBuffer
)(__DRIcontext
*pDRICtx
,
254 __DRIdrawable
*pDraw
);
257 * Method to override base texture image with the contents of a
258 * __DRIdrawable, including the required texture format attribute.
260 * For GLX_EXT_texture_from_pixmap with AIGLX.
262 void (*setTexBuffer2
)(__DRIcontext
*pDRICtx
,
265 __DRIdrawable
*pDraw
);
269 * Used by drivers that implement DRI2
271 #define __DRI2_FLUSH "DRI2_Flush"
272 #define __DRI2_FLUSH_VERSION 3
273 struct __DRI2flushExtensionRec
{
275 void (*flush
)(__DRIdrawable
*drawable
);
278 * Ask the driver to call getBuffers/getBuffersWithFormat before
279 * it starts rendering again.
281 * \param drawable the drawable to invalidate
285 void (*invalidate
)(__DRIdrawable
*drawable
);
290 * XML document describing the configuration options supported by the
293 extern const char __driConfigOptions
[];
298 * The following extensions describe loader features that the DRI
299 * driver can make use of. Some of these are mandatory, such as the
300 * getDrawableInfo extension for DRI and the DRI Loader extensions for
301 * DRI2, while others are optional, and if present allow the driver to
302 * expose certain features. The loader pass in a NULL terminated
303 * array of these extensions to the driver in the createNewScreen
307 typedef struct __DRIgetDrawableInfoExtensionRec __DRIgetDrawableInfoExtension
;
308 typedef struct __DRIsystemTimeExtensionRec __DRIsystemTimeExtension
;
309 typedef struct __DRIdamageExtensionRec __DRIdamageExtension
;
310 typedef struct __DRIloaderExtensionRec __DRIloaderExtension
;
311 typedef struct __DRIswrastLoaderExtensionRec __DRIswrastLoaderExtension
;
315 * Callback to getDrawableInfo protocol
317 #define __DRI_GET_DRAWABLE_INFO "DRI_GetDrawableInfo"
318 #define __DRI_GET_DRAWABLE_INFO_VERSION 1
319 struct __DRIgetDrawableInfoExtensionRec
{
323 * This function is used to get information about the position, size, and
324 * clip rects of a drawable.
326 GLboolean (* getDrawableInfo
) ( __DRIdrawable
*drawable
,
327 unsigned int * index
, unsigned int * stamp
,
328 int * x
, int * y
, int * width
, int * height
,
329 int * numClipRects
, drm_clip_rect_t
** pClipRects
,
330 int * backX
, int * backY
,
331 int * numBackClipRects
, drm_clip_rect_t
** pBackClipRects
,
332 void *loaderPrivate
);
336 * Callback to get system time for media stream counter extensions.
338 #define __DRI_SYSTEM_TIME "DRI_SystemTime"
339 #define __DRI_SYSTEM_TIME_VERSION 1
340 struct __DRIsystemTimeExtensionRec
{
344 * Get the 64-bit unadjusted system time (UST).
346 int (*getUST
)(int64_t * ust
);
349 * Get the media stream counter (MSC) rate.
351 * Matching the definition in GLX_OML_sync_control, this function returns
352 * the rate of the "media stream counter". In practical terms, this is
353 * the frame refresh rate of the display.
355 GLboolean (*getMSCRate
)(__DRIdrawable
*draw
,
356 int32_t * numerator
, int32_t * denominator
,
357 void *loaderPrivate
);
363 #define __DRI_DAMAGE "DRI_Damage"
364 #define __DRI_DAMAGE_VERSION 1
365 struct __DRIdamageExtensionRec
{
369 * Reports areas of the given drawable which have been modified by the
372 * \param drawable which the drawing was done to.
373 * \param rects rectangles affected, with the drawable origin as the
375 * \param x X offset of the drawable within the screen (used in the
377 * \param y Y offset of the drawable within the screen.
378 * \param front_buffer boolean flag for whether the drawing to the
379 * drawable was actually done directly to the front buffer (instead
380 * of backing storage, for example)
381 * \param loaderPrivate the data passed in at createNewDrawable time
383 void (*reportDamage
)(__DRIdrawable
*draw
,
385 drm_clip_rect_t
*rects
, int num_rects
,
386 GLboolean front_buffer
,
387 void *loaderPrivate
);
390 #define __DRI_SWRAST_IMAGE_OP_DRAW 1
391 #define __DRI_SWRAST_IMAGE_OP_CLEAR 2
392 #define __DRI_SWRAST_IMAGE_OP_SWAP 3
395 * SWRast Loader extension.
397 #define __DRI_SWRAST_LOADER "DRI_SWRastLoader"
398 #define __DRI_SWRAST_LOADER_VERSION 1
399 struct __DRIswrastLoaderExtensionRec
{
403 * Drawable position and size
405 void (*getDrawableInfo
)(__DRIdrawable
*drawable
,
406 int *x
, int *y
, int *width
, int *height
,
407 void *loaderPrivate
);
410 * Put image to drawable
412 void (*putImage
)(__DRIdrawable
*drawable
, int op
,
413 int x
, int y
, int width
, int height
, char *data
,
414 void *loaderPrivate
);
417 * Get image from drawable
419 void (*getImage
)(__DRIdrawable
*drawable
,
420 int x
, int y
, int width
, int height
, char *data
,
421 void *loaderPrivate
);
425 * The remaining extensions describe driver extensions, immediately
426 * available interfaces provided by the driver. To start using the
427 * driver, dlsym() for the __DRI_DRIVER_EXTENSIONS symbol and look for
428 * the extension you need in the array.
430 #define __DRI_DRIVER_EXTENSIONS "__driDriverExtensions"
433 * Tokens for __DRIconfig attribs. A number of attributes defined by
434 * GLX or EGL standards are not in the table, as they must be provided
435 * by the loader. For example, FBConfig ID or visual ID, drawable type.
438 #define __DRI_ATTRIB_BUFFER_SIZE 1
439 #define __DRI_ATTRIB_LEVEL 2
440 #define __DRI_ATTRIB_RED_SIZE 3
441 #define __DRI_ATTRIB_GREEN_SIZE 4
442 #define __DRI_ATTRIB_BLUE_SIZE 5
443 #define __DRI_ATTRIB_LUMINANCE_SIZE 6
444 #define __DRI_ATTRIB_ALPHA_SIZE 7
445 #define __DRI_ATTRIB_ALPHA_MASK_SIZE 8
446 #define __DRI_ATTRIB_DEPTH_SIZE 9
447 #define __DRI_ATTRIB_STENCIL_SIZE 10
448 #define __DRI_ATTRIB_ACCUM_RED_SIZE 11
449 #define __DRI_ATTRIB_ACCUM_GREEN_SIZE 12
450 #define __DRI_ATTRIB_ACCUM_BLUE_SIZE 13
451 #define __DRI_ATTRIB_ACCUM_ALPHA_SIZE 14
452 #define __DRI_ATTRIB_SAMPLE_BUFFERS 15
453 #define __DRI_ATTRIB_SAMPLES 16
454 #define __DRI_ATTRIB_RENDER_TYPE 17
455 #define __DRI_ATTRIB_CONFIG_CAVEAT 18
456 #define __DRI_ATTRIB_CONFORMANT 19
457 #define __DRI_ATTRIB_DOUBLE_BUFFER 20
458 #define __DRI_ATTRIB_STEREO 21
459 #define __DRI_ATTRIB_AUX_BUFFERS 22
460 #define __DRI_ATTRIB_TRANSPARENT_TYPE 23
461 #define __DRI_ATTRIB_TRANSPARENT_INDEX_VALUE 24
462 #define __DRI_ATTRIB_TRANSPARENT_RED_VALUE 25
463 #define __DRI_ATTRIB_TRANSPARENT_GREEN_VALUE 26
464 #define __DRI_ATTRIB_TRANSPARENT_BLUE_VALUE 27
465 #define __DRI_ATTRIB_TRANSPARENT_ALPHA_VALUE 28
466 #define __DRI_ATTRIB_FLOAT_MODE 29
467 #define __DRI_ATTRIB_RED_MASK 30
468 #define __DRI_ATTRIB_GREEN_MASK 31
469 #define __DRI_ATTRIB_BLUE_MASK 32
470 #define __DRI_ATTRIB_ALPHA_MASK 33
471 #define __DRI_ATTRIB_MAX_PBUFFER_WIDTH 34
472 #define __DRI_ATTRIB_MAX_PBUFFER_HEIGHT 35
473 #define __DRI_ATTRIB_MAX_PBUFFER_PIXELS 36
474 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_WIDTH 37
475 #define __DRI_ATTRIB_OPTIMAL_PBUFFER_HEIGHT 38
476 #define __DRI_ATTRIB_VISUAL_SELECT_GROUP 39
477 #define __DRI_ATTRIB_SWAP_METHOD 40
478 #define __DRI_ATTRIB_MAX_SWAP_INTERVAL 41
479 #define __DRI_ATTRIB_MIN_SWAP_INTERVAL 42
480 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGB 43
481 #define __DRI_ATTRIB_BIND_TO_TEXTURE_RGBA 44
482 #define __DRI_ATTRIB_BIND_TO_MIPMAP_TEXTURE 45
483 #define __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS 46
484 #define __DRI_ATTRIB_YINVERTED 47
486 /* __DRI_ATTRIB_RENDER_TYPE */
487 #define __DRI_ATTRIB_RGBA_BIT 0x01
488 #define __DRI_ATTRIB_COLOR_INDEX_BIT 0x02
489 #define __DRI_ATTRIB_LUMINANCE_BIT 0x04
491 /* __DRI_ATTRIB_CONFIG_CAVEAT */
492 #define __DRI_ATTRIB_SLOW_BIT 0x01
493 #define __DRI_ATTRIB_NON_CONFORMANT_CONFIG 0x02
495 /* __DRI_ATTRIB_TRANSPARENT_TYPE */
496 #define __DRI_ATTRIB_TRANSPARENT_RGB 0x00
497 #define __DRI_ATTRIB_TRANSPARENT_INDEX 0x01
499 /* __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS */
500 #define __DRI_ATTRIB_TEXTURE_1D_BIT 0x01
501 #define __DRI_ATTRIB_TEXTURE_2D_BIT 0x02
502 #define __DRI_ATTRIB_TEXTURE_RECTANGLE_BIT 0x04
505 * This extension defines the core DRI functionality.
507 #define __DRI_CORE "DRI_Core"
508 #define __DRI_CORE_VERSION 1
510 struct __DRIcoreExtensionRec
{
513 __DRIscreen
*(*createNewScreen
)(int screen
, int fd
,
514 unsigned int sarea_handle
,
515 const __DRIextension
**extensions
,
516 const __DRIconfig
***driverConfigs
,
517 void *loaderPrivate
);
519 void (*destroyScreen
)(__DRIscreen
*screen
);
521 const __DRIextension
**(*getExtensions
)(__DRIscreen
*screen
);
523 int (*getConfigAttrib
)(const __DRIconfig
*config
,
525 unsigned int *value
);
527 int (*indexConfigAttrib
)(const __DRIconfig
*config
, int index
,
528 unsigned int *attrib
, unsigned int *value
);
530 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
531 const __DRIconfig
*config
,
532 unsigned int drawable_id
,
534 void *loaderPrivate
);
536 void (*destroyDrawable
)(__DRIdrawable
*drawable
);
538 void (*swapBuffers
)(__DRIdrawable
*drawable
);
540 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
541 const __DRIconfig
*config
,
542 __DRIcontext
*shared
,
543 void *loaderPrivate
);
545 int (*copyContext
)(__DRIcontext
*dest
,
549 void (*destroyContext
)(__DRIcontext
*context
);
551 int (*bindContext
)(__DRIcontext
*ctx
,
552 __DRIdrawable
*pdraw
,
553 __DRIdrawable
*pread
);
555 int (*unbindContext
)(__DRIcontext
*ctx
);
559 * Stored version of some component (i.e., server-side DRI module, kernel-side
563 * There are several data structures that explicitly store a major version,
564 * minor version, and patch level. These structures should be modified to
565 * have a \c __DRIversionRec instead.
567 struct __DRIversionRec
{
568 int major
; /**< Major version number. */
569 int minor
; /**< Minor version number. */
570 int patch
; /**< Patch-level. */
574 * Framebuffer information record. Used by libGL to communicate information
575 * about the framebuffer to the driver's \c __driCreateNewScreen function.
577 * In XFree86, most of this information is derrived from data returned by
578 * calling \c XF86DRIGetDeviceInfo.
580 * \sa XF86DRIGetDeviceInfo __DRIdisplayRec::createNewScreen
581 * __driUtilCreateNewScreen CallCreateNewScreen
583 * \bug This structure could be better named.
585 struct __DRIframebufferRec
{
586 unsigned char *base
; /**< Framebuffer base address in the CPU's
587 * address space. This value is calculated by
588 * calling \c drmMap on the framebuffer handle
589 * returned by \c XF86DRIGetDeviceInfo (or a
592 int size
; /**< Framebuffer size, in bytes. */
593 int stride
; /**< Number of bytes from one line to the next. */
594 int width
; /**< Pixel width of the framebuffer. */
595 int height
; /**< Pixel height of the framebuffer. */
596 int dev_priv_size
; /**< Size of the driver's dev-priv structure. */
597 void *dev_priv
; /**< Pointer to the driver's dev-priv structure. */
602 * This extension provides alternative screen, drawable and context
603 * constructors for legacy DRI functionality. This is used in
604 * conjunction with the core extension.
606 #define __DRI_LEGACY "DRI_Legacy"
607 #define __DRI_LEGACY_VERSION 1
609 struct __DRIlegacyExtensionRec
{
612 __DRIscreen
*(*createNewScreen
)(int screen
,
613 const __DRIversion
*ddx_version
,
614 const __DRIversion
*dri_version
,
615 const __DRIversion
*drm_version
,
616 const __DRIframebuffer
*frame_buffer
,
617 void *pSAREA
, int fd
,
618 const __DRIextension
**extensions
,
619 const __DRIconfig
***driver_configs
,
620 void *loaderPrivate
);
622 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
623 const __DRIconfig
*config
,
624 drm_drawable_t hwDrawable
,
625 int renderType
, const int *attrs
,
626 void *loaderPrivate
);
628 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
629 const __DRIconfig
*config
,
631 __DRIcontext
*shared
,
632 drm_context_t hwContext
,
633 void *loaderPrivate
);
637 * This extension provides alternative screen, drawable and context
638 * constructors for swrast DRI functionality. This is used in
639 * conjunction with the core extension.
641 #define __DRI_SWRAST "DRI_SWRast"
642 #define __DRI_SWRAST_VERSION 1
644 struct __DRIswrastExtensionRec
{
647 __DRIscreen
*(*createNewScreen
)(int screen
,
648 const __DRIextension
**extensions
,
649 const __DRIconfig
***driver_configs
,
650 void *loaderPrivate
);
652 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
653 const __DRIconfig
*config
,
654 void *loaderPrivate
);
658 * DRI2 Loader extension.
660 #define __DRI_BUFFER_FRONT_LEFT 0
661 #define __DRI_BUFFER_BACK_LEFT 1
662 #define __DRI_BUFFER_FRONT_RIGHT 2
663 #define __DRI_BUFFER_BACK_RIGHT 3
664 #define __DRI_BUFFER_DEPTH 4
665 #define __DRI_BUFFER_STENCIL 5
666 #define __DRI_BUFFER_ACCUM 6
667 #define __DRI_BUFFER_FAKE_FRONT_LEFT 7
668 #define __DRI_BUFFER_FAKE_FRONT_RIGHT 8
669 #define __DRI_BUFFER_DEPTH_STENCIL 9 /**< Only available with DRI2 1.1 */
671 struct __DRIbufferRec
{
672 unsigned int attachment
;
679 #define __DRI_DRI2_LOADER "DRI_DRI2Loader"
680 #define __DRI_DRI2_LOADER_VERSION 3
681 struct __DRIdri2LoaderExtensionRec
{
684 __DRIbuffer
*(*getBuffers
)(__DRIdrawable
*driDrawable
,
685 int *width
, int *height
,
686 unsigned int *attachments
, int count
,
687 int *out_count
, void *loaderPrivate
);
690 * Flush pending front-buffer rendering
692 * Any rendering that has been performed to the
693 * \c __DRI_BUFFER_FAKE_FRONT_LEFT will be flushed to the
694 * \c __DRI_BUFFER_FRONT_LEFT.
696 * \param driDrawable Drawable whose front-buffer is to be flushed
697 * \param loaderPrivate Loader's private data that was previously passed
698 * into __DRIdri2ExtensionRec::createNewDrawable
700 void (*flushFrontBuffer
)(__DRIdrawable
*driDrawable
, void *loaderPrivate
);
704 * Get list of buffers from the server
706 * Gets a list of buffer for the specified set of attachments. Unlike
707 * \c ::getBuffers, this function takes a list of attachments paired with
708 * opaque \c unsigned \c int value describing the format of the buffer.
709 * It is the responsibility of the caller to know what the service that
710 * allocates the buffers will expect to receive for the format.
712 * \param driDrawable Drawable whose buffers are being queried.
713 * \param width Output where the width of the buffers is stored.
714 * \param height Output where the height of the buffers is stored.
715 * \param attachments List of pairs of attachment ID and opaque format
716 * requested for the drawable.
717 * \param count Number of attachment / format pairs stored in
719 * \param loaderPrivate Loader's private data that was previously passed
720 * into __DRIdri2ExtensionRec::createNewDrawable.
722 __DRIbuffer
*(*getBuffersWithFormat
)(__DRIdrawable
*driDrawable
,
723 int *width
, int *height
,
724 unsigned int *attachments
, int count
,
725 int *out_count
, void *loaderPrivate
);
729 * This extension provides alternative screen, drawable and context
730 * constructors for DRI2.
732 #define __DRI_DRI2 "DRI_DRI2"
733 #define __DRI_DRI2_VERSION 1
735 struct __DRIdri2ExtensionRec
{
738 __DRIscreen
*(*createNewScreen
)(int screen
, int fd
,
739 const __DRIextension
**extensions
,
740 const __DRIconfig
***driver_configs
,
741 void *loaderPrivate
);
743 __DRIdrawable
*(*createNewDrawable
)(__DRIscreen
*screen
,
744 const __DRIconfig
*config
,
745 void *loaderPrivate
);
747 __DRIcontext
*(*createNewContext
)(__DRIscreen
*screen
,
748 const __DRIconfig
*config
,
749 __DRIcontext
*shared
,
750 void *loaderPrivate
);
756 * This extension provides functionality to enable various EGLImage
759 #define __DRI_IMAGE "DRI_IMAGE"
760 #define __DRI_IMAGE_VERSION 1
763 * These formats correspond to the similarly named MESA_FORMAT_*
764 * tokens, except in the native endian of the CPU. For example, on
765 * little endian __DRI_IMAGE_FORMAT_XRGB8888 corresponds to
766 * MESA_FORMAT_XRGB8888, but MESA_FORMAT_XRGB8888_REV on big endian.
768 #define __DRI_IMAGE_FORMAT_RGB565 0x1001
769 #define __DRI_IMAGE_FORMAT_XRGB8888 0x1002
770 #define __DRI_IMAGE_FORMAT_ARGB8888 0x1003
772 typedef struct __DRIimageRec __DRIimage
;
773 typedef struct __DRIimageExtensionRec __DRIimageExtension
;
774 struct __DRIimageExtensionRec
{
777 __DRIimage
*(*createImageFromName
)(__DRIcontext
*context
,
778 int width
, int height
, int format
,
780 void *loaderPrivate
);
782 __DRIimage
*(*createImageFromRenderbuffer
)(__DRIcontext
*context
,
784 void *loaderPrivate
);
786 void (*destroyImage
)(__DRIimage
*image
);
790 * This extension must be implemented by the loader and passed to the
791 * driver at screen creation time. The EGLImage entry points in the
792 * various client APIs take opaque EGLImage handles and use this
793 * extension to map them to a __DRIimage. At version 1, this
794 * extensions allows mapping EGLImage pointers to __DRIimage pointers,
795 * but future versions could support other EGLImage-like, opaque types
796 * with new lookup functions.
798 #define __DRI_IMAGE_LOOKUP "DRI_IMAGE_LOOKUP"
799 #define __DRI_IMAGE_LOOKUP_VERSION 1
801 typedef struct __DRIimageLookupExtensionRec __DRIimageLookupExtension
;
802 struct __DRIimageLookupExtensionRec
{
805 __DRIimage
*(*lookupEGLImage
)(__DRIcontext
*context
, void *image
,
806 void *loaderPrivate
);