blob: ec6238f873420401741a3544c70215ceaca55768 [file] [log] [blame]
Brian Paul192c9882004-03-22 23:31:29 +00001/*
2 * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -04003 * Copyright 2007-2008 Red Hat, Inc.
Brian Paul192c9882004-03-22 23:31:29 +00004 * (C) Copyright IBM Corporation 2004
5 * All Rights Reserved.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * on the rights to use, copy, modify, merge, publish, distribute, sub
11 * license, and/or sell copies of the Software, and to permit persons to whom
12 * the Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the next
15 * paragraph) shall be included in all copies or substantial portions of the
16 * Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDERS AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24 * USE OR OTHER DEALINGS IN THE SOFTWARE.
25 */
26
27/**
28 * \file dri_interface.h
29 *
30 * This file contains all the types and functions that define the interface
31 * between a DRI driver and driver loader. Currently, the most common driver
32 * loader is the XFree86 libGL.so. However, other loaders do exist, and in
33 * the future the server-side libglx.a will also be a loader.
34 *
35 * \author Kevin E. Martin <kevin@precisioninsight.com>
36 * \author Ian Romanick <idr@us.ibm.com>
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -040037 * \author Kristian Høgsberg <krh@redhat.com>
Brian Paul192c9882004-03-22 23:31:29 +000038 */
39
Keith Whitwell74d563c2004-04-29 12:23:39 +000040#ifndef DRI_INTERFACE_H
41#define DRI_INTERFACE_H
42
Jon Turney8e759982008-12-17 18:01:16 -070043/* For archs with no drm.h */
Samuel Thibaultd18dd6a2009-04-23 05:43:22 -070044#if !defined(__APPLE__) && !defined(__CYGWIN__) && !defined(__GNU__)
Ian Romanickfabe2b92004-06-01 16:38:56 +000045#include <drm.h>
Jeremy Huddleston01ac4542008-08-08 02:19:52 -070046#else
47typedef unsigned int drm_context_t;
48typedef unsigned int drm_drawable_t;
49typedef struct drm_clip_rect drm_clip_rect_t;
50#endif
Brian Paul192c9882004-03-22 23:31:29 +000051
52/**
53 * \name DRI interface structures
54 *
55 * The following structures define the interface between the GLX client
56 * side library and the DRI (direct rendering infrastructure).
57 */
58/*@{*/
Kristian Høgsberg4a22ae82007-01-07 08:12:01 -050059typedef struct __DRIdisplayRec __DRIdisplay;
60typedef struct __DRIscreenRec __DRIscreen;
61typedef struct __DRIcontextRec __DRIcontext;
62typedef struct __DRIdrawableRec __DRIdrawable;
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -040063typedef struct __DRIconfigRec __DRIconfig;
Kristian Høgsberg4a22ae82007-01-07 08:12:01 -050064typedef struct __DRIframebufferRec __DRIframebuffer;
65typedef struct __DRIversionRec __DRIversion;
Kristian Høgsbergf616a262007-05-15 12:31:31 -040066
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -040067typedef struct __DRIcoreExtensionRec __DRIcoreExtension;
Kristian Høgsberg78a6aa52007-05-16 14:10:29 -040068typedef struct __DRIextensionRec __DRIextension;
Kristian Høgsbergac3e8382007-05-15 15:17:30 -040069typedef struct __DRIcopySubBufferExtensionRec __DRIcopySubBufferExtension;
Kristian Høgsbergefaf90b2007-05-15 16:09:44 -040070typedef struct __DRIswapControlExtensionRec __DRIswapControlExtension;
Kristian Høgsberg78a6aa52007-05-16 14:10:29 -040071typedef struct __DRIallocateExtensionRec __DRIallocateExtension;
Kristian Høgsberga7a0a2b2007-05-16 15:50:40 -040072typedef struct __DRIframeTrackingExtensionRec __DRIframeTrackingExtension;
Kristian Høgsberg106a6f22007-05-16 18:13:41 -040073typedef struct __DRImediaStreamCounterExtensionRec __DRImediaStreamCounterExtension;
Kristian Høgsbergf29f0ae2007-05-22 12:26:02 -040074typedef struct __DRItexOffsetExtensionRec __DRItexOffsetExtension;
Kristian Høgsberg6d487792008-02-14 22:12:51 -050075typedef struct __DRItexBufferExtensionRec __DRItexBufferExtension;
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -040076typedef struct __DRIlegacyExtensionRec __DRIlegacyExtension;
George Sapountzis280bf892008-05-11 14:43:40 +030077typedef struct __DRIswrastExtensionRec __DRIswrastExtension;
Kristian Høgsbergf56b5692008-08-13 11:46:25 -040078typedef struct __DRIbufferRec __DRIbuffer;
79typedef struct __DRIdri2ExtensionRec __DRIdri2Extension;
80typedef struct __DRIdri2LoaderExtensionRec __DRIdri2LoaderExtension;
Alan Hourihane65562452009-02-19 18:39:08 +000081typedef struct __DRI2flushExtensionRec __DRI2flushExtension;
Kristian Høgsbergf56b5692008-08-13 11:46:25 -040082
Brian Paul192c9882004-03-22 23:31:29 +000083/*@}*/
84
85
86/**
Kristian Høgsbergf616a262007-05-15 12:31:31 -040087 * Extension struct. Drivers 'inherit' from this struct by embedding
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -040088 * it as the first element in the extension struct.
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -040089 *
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.
96 *
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
103 * extension.
Kristian Høgsbergf616a262007-05-15 12:31:31 -0400104 */
105struct __DRIextensionRec {
106 const char *name;
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400107 int version;
Kristian Høgsbergf616a262007-05-15 12:31:31 -0400108};
109
Kristian Høgsbergac3e8382007-05-15 15:17:30 -0400110/**
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400111 * 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.
116 */
117
118/**
Kristian Høgsbergf968f672007-05-17 14:39:06 -0400119 * Used by drivers to indicate support for setting the read drawable.
120 */
121#define __DRI_READ_DRAWABLE "DRI_ReadDrawable"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400122#define __DRI_READ_DRAWABLE_VERSION 1
Kristian Høgsbergf968f672007-05-17 14:39:06 -0400123
124/**
Kristian Høgsbergac3e8382007-05-15 15:17:30 -0400125 * Used by drivers that implement the GLX_MESA_copy_sub_buffer extension.
126 */
127#define __DRI_COPY_SUB_BUFFER "DRI_CopySubBuffer"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400128#define __DRI_COPY_SUB_BUFFER_VERSION 1
Kristian Høgsbergac3e8382007-05-15 15:17:30 -0400129struct __DRIcopySubBufferExtensionRec {
130 __DRIextension base;
131 void (*copySubBuffer)(__DRIdrawable *drawable, int x, int y, int w, int h);
132};
133
Kristian Høgsbergefaf90b2007-05-15 16:09:44 -0400134/**
135 * Used by drivers that implement the GLX_SGI_swap_control or
136 * GLX_MESA_swap_control extension.
137 */
138#define __DRI_SWAP_CONTROL "DRI_SwapControl"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400139#define __DRI_SWAP_CONTROL_VERSION 1
Kristian Høgsbergefaf90b2007-05-15 16:09:44 -0400140struct __DRIswapControlExtensionRec {
141 __DRIextension base;
142 void (*setSwapInterval)(__DRIdrawable *drawable, unsigned int inteval);
143 unsigned int (*getSwapInterval)(__DRIdrawable *drawable);
144};
Kristian Høgsbergf616a262007-05-15 12:31:31 -0400145
146/**
Kristian Høgsberg78a6aa52007-05-16 14:10:29 -0400147 * Used by drivers that implement the GLX_MESA_allocate_memory.
148 */
149#define __DRI_ALLOCATE "DRI_Allocate"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400150#define __DRI_ALLOCATE_VERSION 1
Kristian Høgsberg78a6aa52007-05-16 14:10:29 -0400151struct __DRIallocateExtensionRec {
152 __DRIextension base;
153
154 void *(*allocateMemory)(__DRIscreen *screen, GLsizei size,
155 GLfloat readfreq, GLfloat writefreq,
156 GLfloat priority);
157
158 void (*freeMemory)(__DRIscreen *screen, GLvoid *pointer);
159
160 GLuint (*memoryOffset)(__DRIscreen *screen, const GLvoid *pointer);
161};
162
163/**
Kristian Høgsberga7a0a2b2007-05-16 15:50:40 -0400164 * Used by drivers that implement the GLX_MESA_swap_frame_usage extension.
165 */
166#define __DRI_FRAME_TRACKING "DRI_FrameTracking"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400167#define __DRI_FRAME_TRACKING_VERSION 1
Kristian Høgsberga7a0a2b2007-05-16 15:50:40 -0400168struct __DRIframeTrackingExtensionRec {
169 __DRIextension base;
170
171 /**
172 * Enable or disable frame usage tracking.
173 *
174 * \since Internal API version 20030317.
175 */
176 int (*frameTracking)(__DRIdrawable *drawable, GLboolean enable);
177
178 /**
179 * Retrieve frame usage information.
180 *
181 * \since Internal API version 20030317.
182 */
183 int (*queryFrameTracking)(__DRIdrawable *drawable,
184 int64_t * sbc, int64_t * missedFrames,
185 float * lastMissedUsage, float * usage);
186};
187
Kristian Høgsberg106a6f22007-05-16 18:13:41 -0400188
189/**
190 * Used by drivers that implement the GLX_SGI_video_sync extension.
191 */
192#define __DRI_MEDIA_STREAM_COUNTER "DRI_MediaStreamCounter"
Kristian Høgsberg6e8d21d2008-02-25 16:14:37 -0500193#define __DRI_MEDIA_STREAM_COUNTER_VERSION 1
Kristian Høgsberg106a6f22007-05-16 18:13:41 -0400194struct __DRImediaStreamCounterExtensionRec {
195 __DRIextension base;
196
197 /**
Kristian Høgsberg106a6f22007-05-16 18:13:41 -0400198 * 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
201 * to target_msc.
202 */
203 int (*waitForMSC)(__DRIdrawable *drawable,
204 int64_t target_msc, int64_t divisor, int64_t remainder,
205 int64_t * msc, int64_t * sbc);
Jesse Barnes38fdb472007-10-29 11:56:31 -0700206
207 /**
Jesse Barnes38fdb472007-10-29 11:56:31 -0700208 * Get the number of vertical refreshes since some point in time before
209 * this function was first called (i.e., system start up).
Jesse Barnes38fdb472007-10-29 11:56:31 -0700210 */
Kristian Høgsberg6e8d21d2008-02-25 16:14:37 -0500211 int (*getDrawableMSC)(__DRIscreen *screen, __DRIdrawable *drawable,
Jesse Barnes38fdb472007-10-29 11:56:31 -0700212 int64_t *msc);
Kristian Høgsberg106a6f22007-05-16 18:13:41 -0400213};
214
215
Kristian Høgsbergf29f0ae2007-05-22 12:26:02 -0400216#define __DRI_TEX_OFFSET "DRI_TexOffset"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400217#define __DRI_TEX_OFFSET_VERSION 1
Kristian Høgsbergf29f0ae2007-05-22 12:26:02 -0400218struct __DRItexOffsetExtensionRec {
219 __DRIextension base;
220
221 /**
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.
225 *
226 * For GLX_EXT_texture_from_pixmap with AIGLX.
227 */
228 void (*setTexOffset)(__DRIcontext *pDRICtx, GLint texname,
229 unsigned long long offset, GLint depth, GLuint pitch);
230};
231
232
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500233#define __DRI_TEX_BUFFER "DRI_TexBuffer"
Eric Anholt66175aa2009-03-18 12:07:09 -0700234#define __DRI_TEX_BUFFER_VERSION 2
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500235struct __DRItexBufferExtensionRec {
236 __DRIextension base;
237
238 /**
Kristian Høgsbergdcbe2152008-03-09 21:28:04 -0400239 * Method to override base texture image with the contents of a
240 * __DRIdrawable.
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500241 *
Eric Anholt66175aa2009-03-18 12:07:09 -0700242 * For GLX_EXT_texture_from_pixmap with AIGLX. Deprecated in favor of
243 * setTexBuffer2 in version 2 of this interface
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500244 */
245 void (*setTexBuffer)(__DRIcontext *pDRICtx,
Kristian Høgsbergdcbe2152008-03-09 21:28:04 -0400246 GLint target,
247 __DRIdrawable *pDraw);
Eric Anholt66175aa2009-03-18 12:07:09 -0700248
249 /**
250 * Method to override base texture image with the contents of a
251 * __DRIdrawable, including the required texture format attribute.
252 *
253 * For GLX_EXT_texture_from_pixmap with AIGLX.
254 */
255 void (*setTexBuffer2)(__DRIcontext *pDRICtx,
256 GLint target,
257 GLint format,
258 __DRIdrawable *pDraw);
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500259};
260
Alan Hourihane65562452009-02-19 18:39:08 +0000261/**
262 * Used by drivers that implement DRI2
263 */
264#define __DRI2_FLUSH "DRI2_Flush"
Jesse Barnesa35f6bb2009-07-17 03:30:29 -0400265#define __DRI2_FLUSH_VERSION 2
Alan Hourihane65562452009-02-19 18:39:08 +0000266struct __DRI2flushExtensionRec {
267 __DRIextension base;
268 void (*flush)(__DRIdrawable *drawable);
Jesse Barnesa35f6bb2009-07-17 03:30:29 -0400269
270 /**
271 * Flush all rendering queue in the driver to the drm and
272 * invalidate all buffers. The driver will call out to
273 * getBuffers/getBuffersWithFormat before it starts rendering
274 * again.
275 *
276 * \param drawable the drawable to flush and invalidate
277 *
278 * \since 2
279 */
280 void (*flushInvalidate)(__DRIdrawable *drawable);
Alan Hourihane65562452009-02-19 18:39:08 +0000281};
282
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500283
Kristian Høgsberga7a0a2b2007-05-16 15:50:40 -0400284/**
Brian Paul192c9882004-03-22 23:31:29 +0000285 * XML document describing the configuration options supported by the
286 * driver.
287 */
288extern const char __driConfigOptions[];
289
290/*@}*/
291
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500292/**
293 * The following extensions describe loader features that the DRI
294 * driver can make use of. Some of these are mandatory, such as the
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400295 * getDrawableInfo extension for DRI and the DRI Loader extensions for
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500296 * DRI2, while others are optional, and if present allow the driver to
297 * expose certain features. The loader pass in a NULL terminated
298 * array of these extensions to the driver in the createNewScreen
299 * constructor.
300 */
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000301
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500302typedef struct __DRIgetDrawableInfoExtensionRec __DRIgetDrawableInfoExtension;
303typedef struct __DRIsystemTimeExtensionRec __DRIsystemTimeExtension;
304typedef struct __DRIdamageExtensionRec __DRIdamageExtension;
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400305typedef struct __DRIloaderExtensionRec __DRIloaderExtension;
George Sapountzis280bf892008-05-11 14:43:40 +0300306typedef struct __DRIswrastLoaderExtensionRec __DRIswrastLoaderExtension;
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000307
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000308
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500309/**
310 * Callback to getDrawableInfo protocol
311 */
312#define __DRI_GET_DRAWABLE_INFO "DRI_GetDrawableInfo"
313#define __DRI_GET_DRAWABLE_INFO_VERSION 1
314struct __DRIgetDrawableInfoExtensionRec {
315 __DRIextension base;
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000316
317 /**
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000318 * This function is used to get information about the position, size, and
319 * clip rects of a drawable.
320 */
Kristian Høgsberg4ff95e72007-05-10 17:14:38 -0400321 GLboolean (* getDrawableInfo) ( __DRIdrawable *drawable,
Kristian Høgsbergaceccda2007-05-10 15:52:22 -0400322 unsigned int * index, unsigned int * stamp,
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000323 int * x, int * y, int * width, int * height,
324 int * numClipRects, drm_clip_rect_t ** pClipRects,
325 int * backX, int * backY,
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400326 int * numBackClipRects, drm_clip_rect_t ** pBackClipRects,
327 void *loaderPrivate);
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500328};
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000329
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500330/**
331 * Callback to get system time for media stream counter extensions.
332 */
333#define __DRI_SYSTEM_TIME "DRI_SystemTime"
334#define __DRI_SYSTEM_TIME_VERSION 1
335struct __DRIsystemTimeExtensionRec {
336 __DRIextension base;
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000337
338 /**
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000339 * Get the 64-bit unadjusted system time (UST).
340 */
341 int (*getUST)(int64_t * ust);
342
343 /**
344 * Get the media stream counter (MSC) rate.
345 *
346 * Matching the definition in GLX_OML_sync_control, this function returns
347 * the rate of the "media stream counter". In practical terms, this is
348 * the frame refresh rate of the display.
349 */
Kristian Høgsbergaceccda2007-05-10 15:52:22 -0400350 GLboolean (*getMSCRate)(__DRIdrawable *draw,
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400351 int32_t * numerator, int32_t * denominator,
352 void *loaderPrivate);
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500353};
354
355/**
356 * Damage reporting
357 */
358#define __DRI_DAMAGE "DRI_Damage"
359#define __DRI_DAMAGE_VERSION 1
360struct __DRIdamageExtensionRec {
361 __DRIextension base;
Eric Anholtc2b185c2007-01-05 18:19:58 -0800362
363 /**
364 * Reports areas of the given drawable which have been modified by the
365 * driver.
366 *
367 * \param drawable which the drawing was done to.
368 * \param rects rectangles affected, with the drawable origin as the
369 * origin.
370 * \param x X offset of the drawable within the screen (used in the
371 * front_buffer case)
372 * \param y Y offset of the drawable within the screen.
373 * \param front_buffer boolean flag for whether the drawing to the
374 * drawable was actually done directly to the front buffer (instead
375 * of backing storage, for example)
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400376 * \param loaderPrivate the data passed in at createNewDrawable time
Eric Anholtc2b185c2007-01-05 18:19:58 -0800377 */
Kristian Høgsbergaceccda2007-05-10 15:52:22 -0400378 void (*reportDamage)(__DRIdrawable *draw,
Eric Anholtc2b185c2007-01-05 18:19:58 -0800379 int x, int y,
380 drm_clip_rect_t *rects, int num_rects,
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400381 GLboolean front_buffer,
382 void *loaderPrivate);
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500383};
384
George Sapountzis280bf892008-05-11 14:43:40 +0300385#define __DRI_SWRAST_IMAGE_OP_DRAW 1
386#define __DRI_SWRAST_IMAGE_OP_CLEAR 2
387#define __DRI_SWRAST_IMAGE_OP_SWAP 3
388
389/**
390 * SWRast Loader extension.
391 */
392#define __DRI_SWRAST_LOADER "DRI_SWRastLoader"
393#define __DRI_SWRAST_LOADER_VERSION 1
394struct __DRIswrastLoaderExtensionRec {
395 __DRIextension base;
396
397 /*
398 * Drawable position and size
399 */
400 void (*getDrawableInfo)(__DRIdrawable *drawable,
401 int *x, int *y, int *width, int *height,
402 void *loaderPrivate);
403
404 /**
405 * Put image to drawable
406 */
407 void (*putImage)(__DRIdrawable *drawable, int op,
408 int x, int y, int width, int height, char *data,
409 void *loaderPrivate);
410
411 /**
412 * Get image from drawable
413 */
414 void (*getImage)(__DRIdrawable *drawable,
415 int x, int y, int width, int height, char *data,
416 void *loaderPrivate);
417};
418
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400419/**
420 * The remaining extensions describe driver extensions, immediately
421 * available interfaces provided by the driver. To start using the
422 * driver, dlsym() for the __DRI_DRIVER_EXTENSIONS symbol and look for
423 * the extension you need in the array.
424 */
425#define __DRI_DRIVER_EXTENSIONS "__driDriverExtensions"
426
427/**
428 * Tokens for __DRIconfig attribs. A number of attributes defined by
429 * GLX or EGL standards are not in the table, as they must be provided
430 * by the loader. For example, FBConfig ID or visual ID, drawable type.
431 */
432
433#define __DRI_ATTRIB_BUFFER_SIZE 1
434#define __DRI_ATTRIB_LEVEL 2
435#define __DRI_ATTRIB_RED_SIZE 3
436#define __DRI_ATTRIB_GREEN_SIZE 4
437#define __DRI_ATTRIB_BLUE_SIZE 5
438#define __DRI_ATTRIB_LUMINANCE_SIZE 6
439#define __DRI_ATTRIB_ALPHA_SIZE 7
440#define __DRI_ATTRIB_ALPHA_MASK_SIZE 8
441#define __DRI_ATTRIB_DEPTH_SIZE 9
442#define __DRI_ATTRIB_STENCIL_SIZE 10
443#define __DRI_ATTRIB_ACCUM_RED_SIZE 11
444#define __DRI_ATTRIB_ACCUM_GREEN_SIZE 12
445#define __DRI_ATTRIB_ACCUM_BLUE_SIZE 13
446#define __DRI_ATTRIB_ACCUM_ALPHA_SIZE 14
447#define __DRI_ATTRIB_SAMPLE_BUFFERS 15
448#define __DRI_ATTRIB_SAMPLES 16
449#define __DRI_ATTRIB_RENDER_TYPE 17
450#define __DRI_ATTRIB_CONFIG_CAVEAT 18
451#define __DRI_ATTRIB_CONFORMANT 19
452#define __DRI_ATTRIB_DOUBLE_BUFFER 20
453#define __DRI_ATTRIB_STEREO 21
454#define __DRI_ATTRIB_AUX_BUFFERS 22
455#define __DRI_ATTRIB_TRANSPARENT_TYPE 23
456#define __DRI_ATTRIB_TRANSPARENT_INDEX_VALUE 24
457#define __DRI_ATTRIB_TRANSPARENT_RED_VALUE 25
458#define __DRI_ATTRIB_TRANSPARENT_GREEN_VALUE 26
459#define __DRI_ATTRIB_TRANSPARENT_BLUE_VALUE 27
460#define __DRI_ATTRIB_TRANSPARENT_ALPHA_VALUE 28
461#define __DRI_ATTRIB_FLOAT_MODE 29
462#define __DRI_ATTRIB_RED_MASK 30
463#define __DRI_ATTRIB_GREEN_MASK 31
464#define __DRI_ATTRIB_BLUE_MASK 32
465#define __DRI_ATTRIB_ALPHA_MASK 33
466#define __DRI_ATTRIB_MAX_PBUFFER_WIDTH 34
467#define __DRI_ATTRIB_MAX_PBUFFER_HEIGHT 35
468#define __DRI_ATTRIB_MAX_PBUFFER_PIXELS 36
469#define __DRI_ATTRIB_OPTIMAL_PBUFFER_WIDTH 37
470#define __DRI_ATTRIB_OPTIMAL_PBUFFER_HEIGHT 38
471#define __DRI_ATTRIB_VISUAL_SELECT_GROUP 39
472#define __DRI_ATTRIB_SWAP_METHOD 40
473#define __DRI_ATTRIB_MAX_SWAP_INTERVAL 41
474#define __DRI_ATTRIB_MIN_SWAP_INTERVAL 42
475#define __DRI_ATTRIB_BIND_TO_TEXTURE_RGB 43
476#define __DRI_ATTRIB_BIND_TO_TEXTURE_RGBA 44
477#define __DRI_ATTRIB_BIND_TO_MIPMAP_TEXTURE 45
478#define __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS 46
479#define __DRI_ATTRIB_YINVERTED 47
480
481/* __DRI_ATTRIB_RENDER_TYPE */
482#define __DRI_ATTRIB_RGBA_BIT 0x01
483#define __DRI_ATTRIB_COLOR_INDEX_BIT 0x02
484#define __DRI_ATTRIB_LUMINANCE_BIT 0x04
485
486/* __DRI_ATTRIB_CONFIG_CAVEAT */
487#define __DRI_ATTRIB_SLOW_BIT 0x01
488#define __DRI_ATTRIB_NON_CONFORMANT_CONFIG 0x02
489
490/* __DRI_ATTRIB_TRANSPARENT_TYPE */
491#define __DRI_ATTRIB_TRANSPARENT_RGB 0x00
492#define __DRI_ATTRIB_TRANSPARENT_INDEX 0x01
493
494/* __DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS */
495#define __DRI_ATTRIB_TEXTURE_1D_BIT 0x01
496#define __DRI_ATTRIB_TEXTURE_2D_BIT 0x02
497#define __DRI_ATTRIB_TEXTURE_RECTANGLE_BIT 0x04
498
499/**
500 * This extension defines the core DRI functionality.
501 */
502#define __DRI_CORE "DRI_Core"
503#define __DRI_CORE_VERSION 1
504
505struct __DRIcoreExtensionRec {
506 __DRIextension base;
507
508 __DRIscreen *(*createNewScreen)(int screen, int fd,
509 unsigned int sarea_handle,
510 const __DRIextension **extensions,
511 const __DRIconfig ***driverConfigs,
512 void *loaderPrivate);
513
514 void (*destroyScreen)(__DRIscreen *screen);
515
516 const __DRIextension **(*getExtensions)(__DRIscreen *screen);
517
518 int (*getConfigAttrib)(const __DRIconfig *config,
519 unsigned int attrib,
520 unsigned int *value);
521
522 int (*indexConfigAttrib)(const __DRIconfig *config, int index,
523 unsigned int *attrib, unsigned int *value);
524
525 __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
526 const __DRIconfig *config,
527 unsigned int drawable_id,
528 unsigned int head,
529 void *loaderPrivate);
530
531 void (*destroyDrawable)(__DRIdrawable *drawable);
532
533 void (*swapBuffers)(__DRIdrawable *drawable);
534
535 __DRIcontext *(*createNewContext)(__DRIscreen *screen,
536 const __DRIconfig *config,
537 __DRIcontext *shared,
538 void *loaderPrivate);
539
540 int (*copyContext)(__DRIcontext *dest,
541 __DRIcontext *src,
542 unsigned long mask);
543
544 void (*destroyContext)(__DRIcontext *context);
545
546 int (*bindContext)(__DRIcontext *ctx,
547 __DRIdrawable *pdraw,
548 __DRIdrawable *pread);
549
550 int (*unbindContext)(__DRIcontext *ctx);
551};
552
553/**
554 * Stored version of some component (i.e., server-side DRI module, kernel-side
555 * DRM, etc.).
556 *
557 * \todo
558 * There are several data structures that explicitly store a major version,
559 * minor version, and patch level. These structures should be modified to
560 * have a \c __DRIversionRec instead.
561 */
562struct __DRIversionRec {
563 int major; /**< Major version number. */
564 int minor; /**< Minor version number. */
565 int patch; /**< Patch-level. */
566};
567
Brian Paul192c9882004-03-22 23:31:29 +0000568/**
569 * Framebuffer information record. Used by libGL to communicate information
570 * about the framebuffer to the driver's \c __driCreateNewScreen function.
571 *
572 * In XFree86, most of this information is derrived from data returned by
573 * calling \c XF86DRIGetDeviceInfo.
574 *
575 * \sa XF86DRIGetDeviceInfo __DRIdisplayRec::createNewScreen
576 * __driUtilCreateNewScreen CallCreateNewScreen
577 *
578 * \bug This structure could be better named.
579 */
580struct __DRIframebufferRec {
581 unsigned char *base; /**< Framebuffer base address in the CPU's
582 * address space. This value is calculated by
583 * calling \c drmMap on the framebuffer handle
584 * returned by \c XF86DRIGetDeviceInfo (or a
585 * similar function).
586 */
587 int size; /**< Framebuffer size, in bytes. */
588 int stride; /**< Number of bytes from one line to the next. */
589 int width; /**< Pixel width of the framebuffer. */
590 int height; /**< Pixel height of the framebuffer. */
591 int dev_priv_size; /**< Size of the driver's dev-priv structure. */
592 void *dev_priv; /**< Pointer to the driver's dev-priv structure. */
593};
594
595
596/**
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400597 * This extension provides alternative screen, drawable and context
598 * constructors for legacy DRI functionality. This is used in
599 * conjunction with the core extension.
Brian Paul192c9882004-03-22 23:31:29 +0000600 */
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400601#define __DRI_LEGACY "DRI_Legacy"
602#define __DRI_LEGACY_VERSION 1
Brian Paul192c9882004-03-22 23:31:29 +0000603
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400604struct __DRIlegacyExtensionRec {
605 __DRIextension base;
Kristian Høgsbergf616a262007-05-15 12:31:31 -0400606
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400607 __DRIscreen *(*createNewScreen)(int screen,
608 const __DRIversion *ddx_version,
609 const __DRIversion *dri_version,
610 const __DRIversion *drm_version,
611 const __DRIframebuffer *frame_buffer,
612 void *pSAREA, int fd,
613 const __DRIextension **extensions,
614 const __DRIconfig ***driver_configs,
615 void *loaderPrivate);
Brian Paul192c9882004-03-22 23:31:29 +0000616
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400617 __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
618 const __DRIconfig *config,
619 drm_drawable_t hwDrawable,
620 int renderType, const int *attrs,
621 void *loaderPrivate);
Brian Paul192c9882004-03-22 23:31:29 +0000622
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400623 __DRIcontext *(*createNewContext)(__DRIscreen *screen,
624 const __DRIconfig *config,
625 int render_type,
626 __DRIcontext *shared,
627 drm_context_t hwContext,
628 void *loaderPrivate);
Brian Paul192c9882004-03-22 23:31:29 +0000629};
Keith Whitwell74d563c2004-04-29 12:23:39 +0000630
George Sapountzis280bf892008-05-11 14:43:40 +0300631/**
632 * This extension provides alternative screen, drawable and context
633 * constructors for swrast DRI functionality. This is used in
634 * conjunction with the core extension.
635 */
636#define __DRI_SWRAST "DRI_SWRast"
637#define __DRI_SWRAST_VERSION 1
638
639struct __DRIswrastExtensionRec {
640 __DRIextension base;
641
642 __DRIscreen *(*createNewScreen)(int screen,
643 const __DRIextension **extensions,
644 const __DRIconfig ***driver_configs,
645 void *loaderPrivate);
646
647 __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
648 const __DRIconfig *config,
649 void *loaderPrivate);
650};
651
Kristian Høgsbergf56b5692008-08-13 11:46:25 -0400652/**
653 * DRI2 Loader extension.
654 */
655#define __DRI_BUFFER_FRONT_LEFT 0
656#define __DRI_BUFFER_BACK_LEFT 1
657#define __DRI_BUFFER_FRONT_RIGHT 2
658#define __DRI_BUFFER_BACK_RIGHT 3
659#define __DRI_BUFFER_DEPTH 4
660#define __DRI_BUFFER_STENCIL 5
661#define __DRI_BUFFER_ACCUM 6
Alan Hourihane396711b2009-01-19 15:40:30 +0000662#define __DRI_BUFFER_FAKE_FRONT_LEFT 7
663#define __DRI_BUFFER_FAKE_FRONT_RIGHT 8
Ian Romanickdbf87f22009-04-20 20:55:56 -0700664#define __DRI_BUFFER_DEPTH_STENCIL 9 /**< Only available with DRI2 1.1 */
Kristian Høgsbergf56b5692008-08-13 11:46:25 -0400665
666struct __DRIbufferRec {
667 unsigned int attachment;
668 unsigned int name;
669 unsigned int pitch;
670 unsigned int cpp;
671 unsigned int flags;
672};
673
674#define __DRI_DRI2_LOADER "DRI_DRI2Loader"
Ian Romanickdbf87f22009-04-20 20:55:56 -0700675#define __DRI_DRI2_LOADER_VERSION 3
Kristian Høgsbergf56b5692008-08-13 11:46:25 -0400676struct __DRIdri2LoaderExtensionRec {
677 __DRIextension base;
678
679 __DRIbuffer *(*getBuffers)(__DRIdrawable *driDrawable,
680 int *width, int *height,
681 unsigned int *attachments, int count,
682 int *out_count, void *loaderPrivate);
Ian Romanick82634ee2009-04-06 12:44:18 -0700683
684 /**
685 * Flush pending front-buffer rendering
686 *
687 * Any rendering that has been performed to the
688 * \c __DRI_BUFFER_FAKE_FRONT_LEFT will be flushed to the
689 * \c __DRI_BUFFER_FRONT_LEFT.
690 *
691 * \param driDrawable Drawable whose front-buffer is to be flushed
692 * \param loaderPrivate Loader's private data that was previously passed
693 * into __DRIdri2ExtensionRec::createNewDrawable
694 */
695 void (*flushFrontBuffer)(__DRIdrawable *driDrawable, void *loaderPrivate);
Ian Romanickdbf87f22009-04-20 20:55:56 -0700696
697
698 /**
699 * Get list of buffers from the server
700 *
701 * Gets a list of buffer for the specified set of attachments. Unlike
702 * \c ::getBuffers, this function takes a list of attachments paired with
703 * opaque \c unsigned \c int value describing the format of the buffer.
704 * It is the responsibility of the caller to know what the service that
705 * allocates the buffers will expect to receive for the format.
706 *
707 * \param driDrawable Drawable whose buffers are being queried.
708 * \param width Output where the width of the buffers is stored.
709 * \param height Output where the height of the buffers is stored.
710 * \param attachments List of pairs of attachment ID and opaque format
711 * requested for the drawable.
712 * \param count Number of attachment / format pairs stored in
713 * \c attachments.
714 * \param loaderPrivate Loader's private data that was previously passed
715 * into __DRIdri2ExtensionRec::createNewDrawable.
716 */
717 __DRIbuffer *(*getBuffersWithFormat)(__DRIdrawable *driDrawable,
718 int *width, int *height,
719 unsigned int *attachments, int count,
720 int *out_count, void *loaderPrivate);
Kristian Høgsbergf56b5692008-08-13 11:46:25 -0400721};
722
723/**
724 * This extension provides alternative screen, drawable and context
725 * constructors for DRI2.
726 */
727#define __DRI_DRI2 "DRI_DRI2"
728#define __DRI_DRI2_VERSION 1
729
730struct __DRIdri2ExtensionRec {
731 __DRIextension base;
732
733 __DRIscreen *(*createNewScreen)(int screen, int fd,
734 const __DRIextension **extensions,
735 const __DRIconfig ***driver_configs,
736 void *loaderPrivate);
737
738 __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
739 const __DRIconfig *config,
740 void *loaderPrivate);
741
742 __DRIcontext *(*createNewContext)(__DRIscreen *screen,
743 const __DRIconfig *config,
744 __DRIcontext *shared,
745 void *loaderPrivate);
746
747};
748
Keith Whitwell74d563c2004-04-29 12:23:39 +0000749#endif