blob: 2b49a2941e19077a7d5f18dde7ed06be9de9cf64 [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
Emil Velikov0efd7732015-07-07 15:13:46 +010043#ifdef HAVE_LIBDRM
Ian Romanickfabe2b92004-06-01 16:38:56 +000044#include <drm.h>
Jeremy Huddleston01ac4542008-08-08 02:19:52 -070045#else
46typedef unsigned int drm_context_t;
47typedef unsigned int drm_drawable_t;
48typedef struct drm_clip_rect drm_clip_rect_t;
49#endif
Brian Paul192c9882004-03-22 23:31:29 +000050
51/**
52 * \name DRI interface structures
53 *
54 * The following structures define the interface between the GLX client
55 * side library and the DRI (direct rendering infrastructure).
56 */
57/*@{*/
Kristian Høgsberg4a22ae82007-01-07 08:12:01 -050058typedef struct __DRIdisplayRec __DRIdisplay;
59typedef struct __DRIscreenRec __DRIscreen;
60typedef struct __DRIcontextRec __DRIcontext;
61typedef struct __DRIdrawableRec __DRIdrawable;
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -040062typedef struct __DRIconfigRec __DRIconfig;
Kristian Høgsberg4a22ae82007-01-07 08:12:01 -050063typedef struct __DRIframebufferRec __DRIframebuffer;
64typedef struct __DRIversionRec __DRIversion;
Kristian Høgsbergf616a262007-05-15 12:31:31 -040065
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -040066typedef struct __DRIcoreExtensionRec __DRIcoreExtension;
Kristian Høgsberg78a6aa52007-05-16 14:10:29 -040067typedef struct __DRIextensionRec __DRIextension;
Kristian Høgsbergac3e8382007-05-15 15:17:30 -040068typedef struct __DRIcopySubBufferExtensionRec __DRIcopySubBufferExtension;
Kristian Høgsbergefaf90b2007-05-15 16:09:44 -040069typedef struct __DRIswapControlExtensionRec __DRIswapControlExtension;
Kristian Høgsberga7a0a2b2007-05-16 15:50:40 -040070typedef struct __DRIframeTrackingExtensionRec __DRIframeTrackingExtension;
Kristian Høgsberg106a6f22007-05-16 18:13:41 -040071typedef struct __DRImediaStreamCounterExtensionRec __DRImediaStreamCounterExtension;
Kristian Høgsbergf29f0ae2007-05-22 12:26:02 -040072typedef struct __DRItexOffsetExtensionRec __DRItexOffsetExtension;
Kristian Høgsberg6d487792008-02-14 22:12:51 -050073typedef struct __DRItexBufferExtensionRec __DRItexBufferExtension;
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -040074typedef struct __DRIlegacyExtensionRec __DRIlegacyExtension;
George Sapountzis280bf892008-05-11 14:43:40 +030075typedef struct __DRIswrastExtensionRec __DRIswrastExtension;
Kristian Høgsbergf56b5692008-08-13 11:46:25 -040076typedef struct __DRIbufferRec __DRIbuffer;
77typedef struct __DRIdri2ExtensionRec __DRIdri2Extension;
78typedef struct __DRIdri2LoaderExtensionRec __DRIdri2LoaderExtension;
Alan Hourihane65562452009-02-19 18:39:08 +000079typedef struct __DRI2flushExtensionRec __DRI2flushExtension;
Thomas Hellstrom511dc292011-10-10 16:38:19 +020080typedef struct __DRI2throttleExtensionRec __DRI2throttleExtension;
Marek Olšákb02a5bf2015-04-10 10:43:26 +020081typedef struct __DRI2fenceExtensionRec __DRI2fenceExtension;
Kristian Høgsbergf56b5692008-08-13 11:46:25 -040082
Keith Packard44244202013-11-04 18:09:51 -080083
84typedef struct __DRIimageLoaderExtensionRec __DRIimageLoaderExtension;
85typedef struct __DRIimageDriverExtensionRec __DRIimageDriverExtension;
86
Brian Paul192c9882004-03-22 23:31:29 +000087/*@}*/
88
89
90/**
Kristian Høgsbergf616a262007-05-15 12:31:31 -040091 * Extension struct. Drivers 'inherit' from this struct by embedding
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -040092 * it as the first element in the extension struct.
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -040093 *
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.
100 *
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
107 * extension.
Kristian Høgsbergf616a262007-05-15 12:31:31 -0400108 */
109struct __DRIextensionRec {
110 const char *name;
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400111 int version;
Kristian Høgsbergf616a262007-05-15 12:31:31 -0400112};
113
Kristian Høgsbergac3e8382007-05-15 15:17:30 -0400114/**
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400115 * 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.
120 */
121
122/**
Kristian Høgsbergf968f672007-05-17 14:39:06 -0400123 * Used by drivers to indicate support for setting the read drawable.
124 */
125#define __DRI_READ_DRAWABLE "DRI_ReadDrawable"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400126#define __DRI_READ_DRAWABLE_VERSION 1
Kristian Høgsbergf968f672007-05-17 14:39:06 -0400127
128/**
Kristian Høgsbergac3e8382007-05-15 15:17:30 -0400129 * Used by drivers that implement the GLX_MESA_copy_sub_buffer extension.
130 */
131#define __DRI_COPY_SUB_BUFFER "DRI_CopySubBuffer"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400132#define __DRI_COPY_SUB_BUFFER_VERSION 1
Kristian Høgsbergac3e8382007-05-15 15:17:30 -0400133struct __DRIcopySubBufferExtensionRec {
134 __DRIextension base;
135 void (*copySubBuffer)(__DRIdrawable *drawable, int x, int y, int w, int h);
136};
137
Kristian Høgsbergefaf90b2007-05-15 16:09:44 -0400138/**
139 * Used by drivers that implement the GLX_SGI_swap_control or
140 * GLX_MESA_swap_control extension.
141 */
142#define __DRI_SWAP_CONTROL "DRI_SwapControl"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400143#define __DRI_SWAP_CONTROL_VERSION 1
Kristian Høgsbergefaf90b2007-05-15 16:09:44 -0400144struct __DRIswapControlExtensionRec {
145 __DRIextension base;
146 void (*setSwapInterval)(__DRIdrawable *drawable, unsigned int inteval);
147 unsigned int (*getSwapInterval)(__DRIdrawable *drawable);
148};
Kristian Høgsbergf616a262007-05-15 12:31:31 -0400149
150/**
Kristian Høgsberga7a0a2b2007-05-16 15:50:40 -0400151 * Used by drivers that implement the GLX_MESA_swap_frame_usage extension.
152 */
153#define __DRI_FRAME_TRACKING "DRI_FrameTracking"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400154#define __DRI_FRAME_TRACKING_VERSION 1
Kristian Høgsberga7a0a2b2007-05-16 15:50:40 -0400155struct __DRIframeTrackingExtensionRec {
156 __DRIextension base;
157
158 /**
159 * Enable or disable frame usage tracking.
160 *
161 * \since Internal API version 20030317.
162 */
163 int (*frameTracking)(__DRIdrawable *drawable, GLboolean enable);
164
165 /**
166 * Retrieve frame usage information.
167 *
168 * \since Internal API version 20030317.
169 */
170 int (*queryFrameTracking)(__DRIdrawable *drawable,
171 int64_t * sbc, int64_t * missedFrames,
172 float * lastMissedUsage, float * usage);
173};
174
Kristian Høgsberg106a6f22007-05-16 18:13:41 -0400175
176/**
177 * Used by drivers that implement the GLX_SGI_video_sync extension.
178 */
179#define __DRI_MEDIA_STREAM_COUNTER "DRI_MediaStreamCounter"
Kristian Høgsberg6e8d21d2008-02-25 16:14:37 -0500180#define __DRI_MEDIA_STREAM_COUNTER_VERSION 1
Kristian Høgsberg106a6f22007-05-16 18:13:41 -0400181struct __DRImediaStreamCounterExtensionRec {
182 __DRIextension base;
183
184 /**
Kristian Høgsberg106a6f22007-05-16 18:13:41 -0400185 * 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
188 * to target_msc.
189 */
190 int (*waitForMSC)(__DRIdrawable *drawable,
191 int64_t target_msc, int64_t divisor, int64_t remainder,
192 int64_t * msc, int64_t * sbc);
Jesse Barnes38fdb472007-10-29 11:56:31 -0700193
194 /**
Jesse Barnes38fdb472007-10-29 11:56:31 -0700195 * Get the number of vertical refreshes since some point in time before
196 * this function was first called (i.e., system start up).
Jesse Barnes38fdb472007-10-29 11:56:31 -0700197 */
Kristian Høgsberg6e8d21d2008-02-25 16:14:37 -0500198 int (*getDrawableMSC)(__DRIscreen *screen, __DRIdrawable *drawable,
Jesse Barnes38fdb472007-10-29 11:56:31 -0700199 int64_t *msc);
Kristian Høgsberg106a6f22007-05-16 18:13:41 -0400200};
201
202
Kristian Høgsbergf29f0ae2007-05-22 12:26:02 -0400203#define __DRI_TEX_OFFSET "DRI_TexOffset"
Kristian Høgsbergccff0cb2007-06-07 19:35:54 -0400204#define __DRI_TEX_OFFSET_VERSION 1
Kristian Høgsbergf29f0ae2007-05-22 12:26:02 -0400205struct __DRItexOffsetExtensionRec {
206 __DRIextension base;
207
208 /**
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.
212 *
213 * For GLX_EXT_texture_from_pixmap with AIGLX.
214 */
215 void (*setTexOffset)(__DRIcontext *pDRICtx, GLint texname,
216 unsigned long long offset, GLint depth, GLuint pitch);
217};
218
219
Kristian Høgsbergdebf00e2010-02-09 15:26:14 -0500220/* 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
226
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500227#define __DRI_TEX_BUFFER "DRI_TexBuffer"
Emil Velikov9b42fd12014-02-18 03:04:03 +0000228#define __DRI_TEX_BUFFER_VERSION 3
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500229struct __DRItexBufferExtensionRec {
230 __DRIextension base;
231
232 /**
Kristian Høgsbergdcbe2152008-03-09 21:28:04 -0400233 * Method to override base texture image with the contents of a
234 * __DRIdrawable.
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500235 *
Eric Anholt66175aa2009-03-18 12:07:09 -0700236 * For GLX_EXT_texture_from_pixmap with AIGLX. Deprecated in favor of
237 * setTexBuffer2 in version 2 of this interface
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500238 */
239 void (*setTexBuffer)(__DRIcontext *pDRICtx,
Kristian Høgsbergdcbe2152008-03-09 21:28:04 -0400240 GLint target,
241 __DRIdrawable *pDraw);
Eric Anholt66175aa2009-03-18 12:07:09 -0700242
243 /**
244 * Method to override base texture image with the contents of a
245 * __DRIdrawable, including the required texture format attribute.
246 *
247 * For GLX_EXT_texture_from_pixmap with AIGLX.
Emil Velikovc9fff072014-02-12 19:00:21 +0000248 *
249 * \since 2
Eric Anholt66175aa2009-03-18 12:07:09 -0700250 */
251 void (*setTexBuffer2)(__DRIcontext *pDRICtx,
252 GLint target,
253 GLint format,
254 __DRIdrawable *pDraw);
Juan Zhaoe59fa4c2011-01-09 12:03:02 -0500255 /**
256 * Method to release texture buffer in case some special platform
257 * need this.
258 *
259 * For GLX_EXT_texture_from_pixmap with AIGLX.
Emil Velikovc9fff072014-02-12 19:00:21 +0000260 *
261 * \since 3
Juan Zhaoe59fa4c2011-01-09 12:03:02 -0500262 */
263 void (*releaseTexBuffer)(__DRIcontext *pDRICtx,
264 GLint target,
265 __DRIdrawable *pDraw);
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500266};
267
Alan Hourihane65562452009-02-19 18:39:08 +0000268/**
269 * Used by drivers that implement DRI2
270 */
271#define __DRI2_FLUSH "DRI2_Flush"
Marek Olšák4a486f82012-11-23 18:31:42 +0100272#define __DRI2_FLUSH_VERSION 4
273
274#define __DRI2_FLUSH_DRAWABLE (1 << 0) /* the drawable should be flushed. */
275#define __DRI2_FLUSH_CONTEXT (1 << 1) /* glFlush should be called */
Eric Anholt70e8ccc2014-12-21 11:51:33 -0800276#define __DRI2_FLUSH_INVALIDATE_ANCILLARY (1 << 2)
Marek Olšák4a486f82012-11-23 18:31:42 +0100277
Chad Versacee5f1f8d2012-12-01 17:03:59 -0800278enum __DRI2throttleReason {
279 __DRI2_THROTTLE_SWAPBUFFER,
280 __DRI2_THROTTLE_COPYSUBBUFFER,
281 __DRI2_THROTTLE_FLUSHFRONT
282};
Marek Olšák4a486f82012-11-23 18:31:42 +0100283
Alan Hourihane65562452009-02-19 18:39:08 +0000284struct __DRI2flushExtensionRec {
285 __DRIextension base;
286 void (*flush)(__DRIdrawable *drawable);
Jesse Barnesa35f6bb2009-07-17 03:30:29 -0400287
288 /**
Francisco Jerez61d26bc2010-02-08 19:27:56 +0100289 * Ask the driver to call getBuffers/getBuffersWithFormat before
290 * it starts rendering again.
Jesse Barnesa35f6bb2009-07-17 03:30:29 -0400291 *
Francisco Jerez61d26bc2010-02-08 19:27:56 +0100292 * \param drawable the drawable to invalidate
Jesse Barnesa35f6bb2009-07-17 03:30:29 -0400293 *
Francisco Jerez61d26bc2010-02-08 19:27:56 +0100294 * \since 3
Jesse Barnesa35f6bb2009-07-17 03:30:29 -0400295 */
Francisco Jerez61d26bc2010-02-08 19:27:56 +0100296 void (*invalidate)(__DRIdrawable *drawable);
Marek Olšák4a486f82012-11-23 18:31:42 +0100297
298 /**
299 * This function reduces the number of flushes in the driver by combining
300 * several operations into one call.
301 *
302 * It can:
303 * - throttle
304 * - flush a drawable
305 * - flush a context
306 *
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
311 *
312 * \since 4
313 */
314 void (*flush_with_flags)(__DRIcontext *ctx,
315 __DRIdrawable *drawable,
316 unsigned flags,
317 enum __DRI2throttleReason throttle_reason);
Alan Hourihane65562452009-02-19 18:39:08 +0000318};
319
Kristian Høgsberg6d487792008-02-14 22:12:51 -0500320
Kristian Høgsberga7a0a2b2007-05-16 15:50:40 -0400321/**
Thomas Hellstrom511dc292011-10-10 16:38:19 +0200322 * Extension that the driver uses to request
323 * throttle callbacks.
324 */
325
326#define __DRI2_THROTTLE "DRI2_Throttle"
327#define __DRI2_THROTTLE_VERSION 1
328
Thomas Hellstrom511dc292011-10-10 16:38:19 +0200329struct __DRI2throttleExtensionRec {
330 __DRIextension base;
331 void (*throttle)(__DRIcontext *ctx,
332 __DRIdrawable *drawable,
333 enum __DRI2throttleReason reason);
334};
335
Marek Olšákb02a5bf2015-04-10 10:43:26 +0200336
337/**
338 * Extension for fences / synchronization objects.
339 */
340
341#define __DRI2_FENCE "DRI2_Fence"
342#define __DRI2_FENCE_VERSION 1
343
344#define __DRI2_FENCE_TIMEOUT_INFINITE 0xffffffffffffffffllu
345
346#define __DRI2_FENCE_FLAG_FLUSH_COMMANDS (1 << 0)
347
348struct __DRI2fenceExtensionRec {
349 __DRIextension base;
350
351 /**
352 * Create and insert a fence into the command stream of the context.
353 */
354 void *(*create_fence)(__DRIcontext *ctx);
355
356 /**
357 * Get a fence associated with the OpenCL event object.
358 * This can be NULL, meaning that OpenCL interoperability is not supported.
359 */
360 void *(*get_fence_from_cl_event)(__DRIscreen *screen, intptr_t cl_event);
361
362 /**
363 * Destroy a fence.
364 */
365 void (*destroy_fence)(__DRIscreen *screen, void *fence);
366
367 /**
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.
370 *
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
375 */
376 GLboolean (*client_wait_sync)(__DRIcontext *ctx, void *fence,
377 unsigned flags, uint64_t timeout);
378
379 /**
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.
385 *
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)
390 */
391 void (*server_wait_sync)(__DRIcontext *ctx, void *fence, unsigned flags);
392};
393
394
Brian Paul192c9882004-03-22 23:31:29 +0000395/*@}*/
396
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500397/**
398 * The following extensions describe loader features that the DRI
399 * driver can make use of. Some of these are mandatory, such as the
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400400 * getDrawableInfo extension for DRI and the DRI Loader extensions for
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500401 * 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
404 * constructor.
405 */
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000406
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500407typedef struct __DRIgetDrawableInfoExtensionRec __DRIgetDrawableInfoExtension;
408typedef struct __DRIsystemTimeExtensionRec __DRIsystemTimeExtension;
409typedef struct __DRIdamageExtensionRec __DRIdamageExtension;
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400410typedef struct __DRIloaderExtensionRec __DRIloaderExtension;
George Sapountzis280bf892008-05-11 14:43:40 +0300411typedef struct __DRIswrastLoaderExtensionRec __DRIswrastLoaderExtension;
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000412
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000413
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500414/**
415 * Callback to getDrawableInfo protocol
416 */
417#define __DRI_GET_DRAWABLE_INFO "DRI_GetDrawableInfo"
418#define __DRI_GET_DRAWABLE_INFO_VERSION 1
419struct __DRIgetDrawableInfoExtensionRec {
420 __DRIextension base;
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000421
422 /**
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000423 * This function is used to get information about the position, size, and
424 * clip rects of a drawable.
425 */
Kristian Høgsberg4ff95e72007-05-10 17:14:38 -0400426 GLboolean (* getDrawableInfo) ( __DRIdrawable *drawable,
Kristian Høgsbergaceccda2007-05-10 15:52:22 -0400427 unsigned int * index, unsigned int * stamp,
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000428 int * x, int * y, int * width, int * height,
429 int * numClipRects, drm_clip_rect_t ** pClipRects,
430 int * backX, int * backY,
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400431 int * numBackClipRects, drm_clip_rect_t ** pBackClipRects,
432 void *loaderPrivate);
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500433};
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000434
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500435/**
436 * Callback to get system time for media stream counter extensions.
437 */
438#define __DRI_SYSTEM_TIME "DRI_SystemTime"
439#define __DRI_SYSTEM_TIME_VERSION 1
440struct __DRIsystemTimeExtensionRec {
441 __DRIextension base;
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000442
443 /**
Ian Romanick5f1ba3e2005-07-26 02:44:01 +0000444 * Get the 64-bit unadjusted system time (UST).
445 */
446 int (*getUST)(int64_t * ust);
447
448 /**
449 * Get the media stream counter (MSC) rate.
450 *
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.
454 */
Kristian Høgsbergaceccda2007-05-10 15:52:22 -0400455 GLboolean (*getMSCRate)(__DRIdrawable *draw,
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400456 int32_t * numerator, int32_t * denominator,
457 void *loaderPrivate);
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500458};
459
460/**
461 * Damage reporting
462 */
463#define __DRI_DAMAGE "DRI_Damage"
464#define __DRI_DAMAGE_VERSION 1
465struct __DRIdamageExtensionRec {
466 __DRIextension base;
Eric Anholtc2b185c2007-01-05 18:19:58 -0800467
468 /**
469 * Reports areas of the given drawable which have been modified by the
470 * driver.
471 *
472 * \param drawable which the drawing was done to.
473 * \param rects rectangles affected, with the drawable origin as the
474 * origin.
475 * \param x X offset of the drawable within the screen (used in the
476 * front_buffer case)
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)
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400481 * \param loaderPrivate the data passed in at createNewDrawable time
Eric Anholtc2b185c2007-01-05 18:19:58 -0800482 */
Kristian Høgsbergaceccda2007-05-10 15:52:22 -0400483 void (*reportDamage)(__DRIdrawable *draw,
Eric Anholtc2b185c2007-01-05 18:19:58 -0800484 int x, int y,
485 drm_clip_rect_t *rects, int num_rects,
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400486 GLboolean front_buffer,
487 void *loaderPrivate);
Kristian Høgsberg6cb3f5c2008-02-28 10:32:28 -0500488};
489
George Sapountzis280bf892008-05-11 14:43:40 +0300490#define __DRI_SWRAST_IMAGE_OP_DRAW 1
491#define __DRI_SWRAST_IMAGE_OP_CLEAR 2
492#define __DRI_SWRAST_IMAGE_OP_SWAP 3
493
494/**
495 * SWRast Loader extension.
496 */
497#define __DRI_SWRAST_LOADER "DRI_SWRastLoader"
Dave Airlie2b676572015-10-09 01:38:08 +0100498#define __DRI_SWRAST_LOADER_VERSION 3
George Sapountzis280bf892008-05-11 14:43:40 +0300499struct __DRIswrastLoaderExtensionRec {
500 __DRIextension base;
501
502 /*
503 * Drawable position and size
504 */
505 void (*getDrawableInfo)(__DRIdrawable *drawable,
506 int *x, int *y, int *width, int *height,
507 void *loaderPrivate);
508
509 /**
510 * Put image to drawable
511 */
512 void (*putImage)(__DRIdrawable *drawable, int op,
George Sapountzisf4e561c2010-03-27 20:32:52 +0200513 int x, int y, int width, int height,
514 char *data, void *loaderPrivate);
George Sapountzis280bf892008-05-11 14:43:40 +0300515
516 /**
George Sapountzisf4e561c2010-03-27 20:32:52 +0200517 * Get image from readable
George Sapountzis280bf892008-05-11 14:43:40 +0300518 */
George Sapountzisf4e561c2010-03-27 20:32:52 +0200519 void (*getImage)(__DRIdrawable *readable,
520 int x, int y, int width, int height,
521 char *data, void *loaderPrivate);
Dave Airlieba00f2f2013-11-28 11:08:11 +1000522
523 /**
524 * Put image to drawable
Emil Velikovacf2fae2014-02-18 02:31:27 +0000525 *
526 * \since 2
Dave Airlieba00f2f2013-11-28 11:08:11 +1000527 */
528 void (*putImage2)(__DRIdrawable *drawable, int op,
529 int x, int y, int width, int height, int stride,
530 char *data, void *loaderPrivate);
Dave Airlie2b676572015-10-09 01:38:08 +0100531
532 /**
533 * Put image to drawable
534 *
535 * \since 3
536 */
537 void (*getImage2)(__DRIdrawable *readable,
538 int x, int y, int width, int height, int stride,
539 char *data, void *loaderPrivate);
George Sapountzis280bf892008-05-11 14:43:40 +0300540};
541
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400542/**
Kristian Høgsberg97a6cbc2010-05-11 09:09:30 -0400543 * 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
547 * glViewport().
548 *
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.
553 */
554#define __DRI_USE_INVALIDATE "DRI_UseInvalidate"
555#define __DRI_USE_INVALIDATE_VERSION 1
556
557typedef struct __DRIuseInvalidateExtensionRec __DRIuseInvalidateExtension;
558struct __DRIuseInvalidateExtensionRec {
559 __DRIextension base;
560};
561
562/**
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400563 * 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.
567 */
568#define __DRI_DRIVER_EXTENSIONS "__driDriverExtensions"
569
570/**
Eric Anholtfcb57a82013-09-23 14:44:10 -0700571 * 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
575 * system state.
576 *
577 * The function prototype is:
578 *
579 * const __DRIextension **__driDriverGetExtensions_drivername(void);
580 */
581#define __DRI_DRIVER_GET_EXTENSIONS "__driDriverGetExtensions"
582
583/**
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400584 * 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.
587 */
588
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
Dave Airlie476db2b2011-01-28 11:44:51 +1000636#define __DRI_ATTRIB_FRAMEBUFFER_SRGB_CAPABLE 48
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400637
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
Tomasz Lisc37c3672013-07-17 13:49:21 +0200642#define __DRI_ATTRIB_FLOAT_BIT 0x08
643#define __DRI_ATTRIB_UNSIGNED_FLOAT_BIT 0x10
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400644
645/* __DRI_ATTRIB_CONFIG_CAVEAT */
646#define __DRI_ATTRIB_SLOW_BIT 0x01
647#define __DRI_ATTRIB_NON_CONFORMANT_CONFIG 0x02
648
649/* __DRI_ATTRIB_TRANSPARENT_TYPE */
650#define __DRI_ATTRIB_TRANSPARENT_RGB 0x00
651#define __DRI_ATTRIB_TRANSPARENT_INDEX 0x01
652
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
657
658/**
659 * This extension defines the core DRI functionality.
660 */
661#define __DRI_CORE "DRI_Core"
662#define __DRI_CORE_VERSION 1
663
664struct __DRIcoreExtensionRec {
665 __DRIextension base;
666
667 __DRIscreen *(*createNewScreen)(int screen, int fd,
668 unsigned int sarea_handle,
669 const __DRIextension **extensions,
670 const __DRIconfig ***driverConfigs,
671 void *loaderPrivate);
672
673 void (*destroyScreen)(__DRIscreen *screen);
674
675 const __DRIextension **(*getExtensions)(__DRIscreen *screen);
676
677 int (*getConfigAttrib)(const __DRIconfig *config,
678 unsigned int attrib,
679 unsigned int *value);
680
681 int (*indexConfigAttrib)(const __DRIconfig *config, int index,
682 unsigned int *attrib, unsigned int *value);
683
684 __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
685 const __DRIconfig *config,
686 unsigned int drawable_id,
687 unsigned int head,
688 void *loaderPrivate);
689
690 void (*destroyDrawable)(__DRIdrawable *drawable);
691
692 void (*swapBuffers)(__DRIdrawable *drawable);
693
694 __DRIcontext *(*createNewContext)(__DRIscreen *screen,
695 const __DRIconfig *config,
696 __DRIcontext *shared,
697 void *loaderPrivate);
698
699 int (*copyContext)(__DRIcontext *dest,
700 __DRIcontext *src,
701 unsigned long mask);
702
703 void (*destroyContext)(__DRIcontext *context);
704
705 int (*bindContext)(__DRIcontext *ctx,
706 __DRIdrawable *pdraw,
707 __DRIdrawable *pread);
708
709 int (*unbindContext)(__DRIcontext *ctx);
710};
711
712/**
713 * Stored version of some component (i.e., server-side DRI module, kernel-side
714 * DRM, etc.).
715 *
716 * \todo
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.
720 */
721struct __DRIversionRec {
722 int major; /**< Major version number. */
723 int minor; /**< Minor version number. */
724 int patch; /**< Patch-level. */
725};
726
Brian Paul192c9882004-03-22 23:31:29 +0000727/**
728 * Framebuffer information record. Used by libGL to communicate information
729 * about the framebuffer to the driver's \c __driCreateNewScreen function.
730 *
731 * In XFree86, most of this information is derrived from data returned by
732 * calling \c XF86DRIGetDeviceInfo.
733 *
734 * \sa XF86DRIGetDeviceInfo __DRIdisplayRec::createNewScreen
735 * __driUtilCreateNewScreen CallCreateNewScreen
736 *
737 * \bug This structure could be better named.
738 */
739struct __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
744 * similar function).
745 */
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. */
752};
753
754
755/**
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400756 * This extension provides alternative screen, drawable and context
757 * constructors for legacy DRI functionality. This is used in
758 * conjunction with the core extension.
Brian Paul192c9882004-03-22 23:31:29 +0000759 */
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400760#define __DRI_LEGACY "DRI_Legacy"
761#define __DRI_LEGACY_VERSION 1
Brian Paul192c9882004-03-22 23:31:29 +0000762
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400763struct __DRIlegacyExtensionRec {
764 __DRIextension base;
Kristian Høgsbergf616a262007-05-15 12:31:31 -0400765
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400766 __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);
Brian Paul192c9882004-03-22 23:31:29 +0000775
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400776 __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
777 const __DRIconfig *config,
778 drm_drawable_t hwDrawable,
779 int renderType, const int *attrs,
780 void *loaderPrivate);
Brian Paul192c9882004-03-22 23:31:29 +0000781
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400782 __DRIcontext *(*createNewContext)(__DRIscreen *screen,
783 const __DRIconfig *config,
784 int render_type,
785 __DRIcontext *shared,
786 drm_context_t hwContext,
787 void *loaderPrivate);
Brian Paul192c9882004-03-22 23:31:29 +0000788};
Keith Whitwell74d563c2004-04-29 12:23:39 +0000789
George Sapountzis280bf892008-05-11 14:43:40 +0300790/**
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.
794 */
795#define __DRI_SWRAST "DRI_SWRast"
Eric Anholtf93533d2013-09-27 11:39:25 -0700796#define __DRI_SWRAST_VERSION 4
George Sapountzis280bf892008-05-11 14:43:40 +0300797
798struct __DRIswrastExtensionRec {
799 __DRIextension base;
800
801 __DRIscreen *(*createNewScreen)(int screen,
802 const __DRIextension **extensions,
803 const __DRIconfig ***driver_configs,
804 void *loaderPrivate);
805
806 __DRIdrawable *(*createNewDrawable)(__DRIscreen *screen,
807 const __DRIconfig *config,
808 void *loaderPrivate);
Haitao Fengb43a1472011-01-30 16:03:35 +0800809
810 /* Since version 2 */
811 __DRIcontext *(*createNewContextForAPI)(__DRIscreen *screen,
812 int api,
813 const __DRIconfig *config,
814 __DRIcontext *shared,
815 void *data);
Ian Romanickb5b20812011-12-01 13:56:38 -0800816
817 /**
818 * Create a context for a particular API with a set of attributes
819 *
820 * \since version 3
821 *
822 * \sa __DRIdri2ExtensionRec::createContextAttribs
823 */
824 __DRIcontext *(*createContextAttribs)(__DRIscreen *screen,
825 int api,
826 const __DRIconfig *config,
827 __DRIcontext *shared,
828 unsigned num_attribs,
829 const uint32_t *attribs,
830 unsigned *error,
831 void *loaderPrivate);
Eric Anholtf93533d2013-09-27 11:39:25 -0700832
833 /**
834 * createNewScreen() with the driver extensions passed in.
835 *
836 * \since version 4
837 */
838 __DRIscreen *(*createNewScreen2)(int screen,
839 const __DRIextension **loader_extensions,
840 const __DRIextension **driver_extensions,
841 const __DRIconfig ***driver_configs,
842 void *loaderPrivate);
843
George Sapountzis280bf892008-05-11 14:43:40 +0300844};
845
Keith Packardf66a6c52013-06-03 20:49:25 -0700846/** Common DRI function definitions, shared among DRI2 and Image extensions
847 */
848
849typedef __DRIscreen *
850(*__DRIcreateNewScreen2Func)(int screen, int fd,
851 const __DRIextension **extensions,
852 const __DRIextension **driver_extensions,
853 const __DRIconfig ***driver_configs,
854 void *loaderPrivate);
855
856typedef __DRIdrawable *
857(*__DRIcreateNewDrawableFunc)(__DRIscreen *screen,
858 const __DRIconfig *config,
859 void *loaderPrivate);
860
861typedef __DRIcontext *
Keith Packardf66a6c52013-06-03 20:49:25 -0700862(*__DRIcreateContextAttribsFunc)(__DRIscreen *screen,
863 int api,
864 const __DRIconfig *config,
865 __DRIcontext *shared,
866 unsigned num_attribs,
867 const uint32_t *attribs,
868 unsigned *error,
869 void *loaderPrivate);
870
871typedef unsigned int
872(*__DRIgetAPIMaskFunc)(__DRIscreen *screen);
873
Kristian Høgsbergf56b5692008-08-13 11:46:25 -0400874/**
875 * DRI2 Loader extension.
876 */
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
Alan Hourihane396711b2009-01-19 15:40:30 +0000884#define __DRI_BUFFER_FAKE_FRONT_LEFT 7
885#define __DRI_BUFFER_FAKE_FRONT_RIGHT 8
Ian Romanickdbf87f22009-04-20 20:55:56 -0700886#define __DRI_BUFFER_DEPTH_STENCIL 9 /**< Only available with DRI2 1.1 */
Chad Versace4501a5d2011-05-26 16:50:30 -0700887#define __DRI_BUFFER_HIZ 10
Kristian Høgsbergf56b5692008-08-13 11:46:25 -0400888
Benjamin Franzke8c409402011-08-15 09:50:19 +0200889/* Inofficial and for internal use. Increase when adding a new buffer token. */
890#define __DRI_BUFFER_COUNT 11
891
Kristian Høgsbergf56b5692008-08-13 11:46:25 -0400892struct __DRIbufferRec {
893 unsigned int attachment;
894 unsigned int name;
895 unsigned int pitch;
896 unsigned int cpp;
897 unsigned int flags;
898};
899
900#define __DRI_DRI2_LOADER "DRI_DRI2Loader"
Ian Romanickdbf87f22009-04-20 20:55:56 -0700901#define __DRI_DRI2_LOADER_VERSION 3
Kristian Høgsbergf56b5692008-08-13 11:46:25 -0400902struct __DRIdri2LoaderExtensionRec {
903 __DRIextension base;
904
905 __DRIbuffer *(*getBuffers)(__DRIdrawable *driDrawable,
906 int *width, int *height,
907 unsigned int *attachments, int count,
908 int *out_count, void *loaderPrivate);
Ian Romanick82634ee2009-04-06 12:44:18 -0700909
910 /**
911 * Flush pending front-buffer rendering
912 *
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.
916 *
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
Emil Velikov6dffab22014-02-12 19:05:08 +0000920 *
921 * \since 2
Ian Romanick82634ee2009-04-06 12:44:18 -0700922 */
923 void (*flushFrontBuffer)(__DRIdrawable *driDrawable, void *loaderPrivate);
Ian Romanickdbf87f22009-04-20 20:55:56 -0700924
925
926 /**
927 * Get list of buffers from the server
928 *
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.
934 *
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
941 * \c attachments.
942 * \param loaderPrivate Loader's private data that was previously passed
943 * into __DRIdri2ExtensionRec::createNewDrawable.
Emil Velikov6dffab22014-02-12 19:05:08 +0000944 *
945 * \since 3
Ian Romanickdbf87f22009-04-20 20:55:56 -0700946 */
947 __DRIbuffer *(*getBuffersWithFormat)(__DRIdrawable *driDrawable,
948 int *width, int *height,
949 unsigned int *attachments, int count,
950 int *out_count, void *loaderPrivate);
Kristian Høgsbergf56b5692008-08-13 11:46:25 -0400951};
952
953/**
954 * This extension provides alternative screen, drawable and context
955 * constructors for DRI2.
956 */
957#define __DRI_DRI2 "DRI_DRI2"
Eric Anholtf93533d2013-09-27 11:39:25 -0700958#define __DRI_DRI2_VERSION 4
Kristian Høgsberga7a9a912010-04-27 11:04:51 -0400959
Ian Romanick1ab54542011-11-30 12:16:19 -0800960#define __DRI_API_OPENGL 0 /**< OpenGL compatibility profile */
Ian Romanicka2ce2eb2012-07-18 14:29:29 -0700961#define __DRI_API_GLES 1 /**< OpenGL ES 1.x */
Chad Versacee90c08e2012-11-20 13:27:14 -0800962#define __DRI_API_GLES2 2 /**< OpenGL ES 2.x */
Ian Romanick1ab54542011-11-30 12:16:19 -0800963#define __DRI_API_OPENGL_CORE 3 /**< OpenGL 3.2+ core profile */
Chad Versacee90c08e2012-11-20 13:27:14 -0800964#define __DRI_API_GLES3 4 /**< OpenGL ES 3.x */
Ian Romanick1ab54542011-11-30 12:16:19 -0800965
966#define __DRI_CTX_ATTRIB_MAJOR_VERSION 0
967#define __DRI_CTX_ATTRIB_MINOR_VERSION 1
968#define __DRI_CTX_ATTRIB_FLAGS 2
969
Ian Romanicka8724d82012-07-03 11:32:59 -0700970/**
971 * \requires __DRI2_ROBUSTNESS.
972 */
973#define __DRI_CTX_ATTRIB_RESET_STRATEGY 3
974
Ian Romanick1ab54542011-11-30 12:16:19 -0800975#define __DRI_CTX_FLAG_DEBUG 0x00000001
976#define __DRI_CTX_FLAG_FORWARD_COMPATIBLE 0x00000002
977
978/**
Ian Romanicka8724d82012-07-03 11:32:59 -0700979 * \requires __DRI2_ROBUSTNESS.
980 */
981#define __DRI_CTX_FLAG_ROBUST_BUFFER_ACCESS 0x00000004
982
983/**
984 * \name Context reset strategies.
985 */
986/*@{*/
987#define __DRI_CTX_RESET_NO_NOTIFICATION 0
988#define __DRI_CTX_RESET_LOSE_CONTEXT 1
989/*@}*/
990
991/**
Ian Romanick1ab54542011-11-30 12:16:19 -0800992 * \name Reasons that __DRIdri2Extension::createContextAttribs might fail
993 */
994/*@{*/
995/** Success! */
996#define __DRI_CTX_ERROR_SUCCESS 0
997
998/** Memory allocation failure */
999#define __DRI_CTX_ERROR_NO_MEMORY 1
1000
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
1003
1004/** Client requested an API version that the driver can't do. */
1005#define __DRI_CTX_ERROR_BAD_VERSION 3
1006
1007/** Client requested a flag or combination of flags the driver can't do. */
1008#define __DRI_CTX_ERROR_BAD_FLAG 4
1009
1010/** Client requested an attribute the driver doesn't understand. */
1011#define __DRI_CTX_ERROR_UNKNOWN_ATTRIBUTE 5
1012
1013/** Client requested a flag the driver doesn't understand. */
1014#define __DRI_CTX_ERROR_UNKNOWN_FLAG 6
1015/*@}*/
Kristian Høgsbergf56b5692008-08-13 11:46:25 -04001016
1017struct __DRIdri2ExtensionRec {
1018 __DRIextension base;
1019
1020 __DRIscreen *(*createNewScreen)(int screen, int fd,
1021 const __DRIextension **extensions,
1022 const __DRIconfig ***driver_configs,
1023 void *loaderPrivate);
1024
Keith Packardf66a6c52013-06-03 20:49:25 -07001025 __DRIcreateNewDrawableFunc createNewDrawable;
Kristian Høgsberge0489532013-11-11 16:35:35 -08001026 __DRIcontext *(*createNewContext)(__DRIscreen *screen,
1027 const __DRIconfig *config,
1028 __DRIcontext *shared,
1029 void *loaderPrivate);
Kristian Høgsbergf56b5692008-08-13 11:46:25 -04001030
Kristian Høgsberga7a9a912010-04-27 11:04:51 -04001031 /* Since version 2 */
Keith Packardf66a6c52013-06-03 20:49:25 -07001032 __DRIgetAPIMaskFunc getAPIMask;
Kristian Høgsberga7a9a912010-04-27 11:04:51 -04001033
1034 __DRIcontext *(*createNewContextForAPI)(__DRIscreen *screen,
1035 int api,
1036 const __DRIconfig *config,
1037 __DRIcontext *shared,
1038 void *data);
Benjamin Franzke1b8ef942011-02-04 11:59:12 +01001039
1040 __DRIbuffer *(*allocateBuffer)(__DRIscreen *screen,
1041 unsigned int attachment,
1042 unsigned int format,
1043 int width,
1044 int height);
1045 void (*releaseBuffer)(__DRIscreen *screen,
1046 __DRIbuffer *buffer);
Ian Romanick1ab54542011-11-30 12:16:19 -08001047
1048 /**
1049 * Create a context for a particular API with a set of attributes
1050 *
1051 * \since version 3
Ian Romanickb5b20812011-12-01 13:56:38 -08001052 *
1053 * \sa __DRIswrastExtensionRec::createContextAttribs
Ian Romanick1ab54542011-11-30 12:16:19 -08001054 */
Keith Packardf66a6c52013-06-03 20:49:25 -07001055 __DRIcreateContextAttribsFunc createContextAttribs;
Eric Anholtf93533d2013-09-27 11:39:25 -07001056
1057 /**
1058 * createNewScreen with the driver's extension list passed in.
1059 *
1060 * \since version 4
1061 */
Keith Packardf66a6c52013-06-03 20:49:25 -07001062 __DRIcreateNewScreen2Func createNewScreen2;
Kristian Høgsbergf56b5692008-08-13 11:46:25 -04001063};
1064
Kristian Høgsberg79cbcb62010-02-11 17:45:24 -05001065
1066/**
1067 * This extension provides functionality to enable various EGLImage
1068 * extensions.
1069 */
1070#define __DRI_IMAGE "DRI_IMAGE"
Dave Airlie8f7338f2014-03-03 13:57:16 +10001071#define __DRI_IMAGE_VERSION 11
Kristian Høgsberg79cbcb62010-02-11 17:45:24 -05001072
1073/**
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.
Kristian Høgsbergc0298342012-07-04 22:56:09 -04001078 *
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.
Jakob Bornecrantz6a7dea92012-08-31 19:48:26 +02001082 *
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).
Kristian Høgsberg79cbcb62010-02-11 17:45:24 -05001086 */
1087#define __DRI_IMAGE_FORMAT_RGB565 0x1001
1088#define __DRI_IMAGE_FORMAT_XRGB8888 0x1002
1089#define __DRI_IMAGE_FORMAT_ARGB8888 0x1003
Chia-I Wue3cf7b62011-08-21 21:22:41 +08001090#define __DRI_IMAGE_FORMAT_ABGR8888 0x1004
Sean V Kelley81f95ce2012-04-24 07:49:09 -07001091#define __DRI_IMAGE_FORMAT_XBGR8888 0x1005
Kristian Høgsbergc0298342012-07-04 22:56:09 -04001092#define __DRI_IMAGE_FORMAT_R8 0x1006 /* Since version 5 */
1093#define __DRI_IMAGE_FORMAT_GR88 0x1007
1094#define __DRI_IMAGE_FORMAT_NONE 0x1008
Kristian Høgsberg3160ec32013-09-14 23:31:08 -07001095#define __DRI_IMAGE_FORMAT_XRGB2101010 0x1009
1096#define __DRI_IMAGE_FORMAT_ARGB2101010 0x100a
Keith Packardaba6b842013-11-04 17:27:43 -08001097#define __DRI_IMAGE_FORMAT_SARGB8 0x100b
Kristian Høgsberg79cbcb62010-02-11 17:45:24 -05001098
Kristian Høgsberg5aaa53e2010-06-03 21:36:40 -04001099#define __DRI_IMAGE_USE_SHARE 0x0001
1100#define __DRI_IMAGE_USE_SCANOUT 0x0002
Jakob Bornecrantz6bb71b82012-08-15 11:37:18 +02001101#define __DRI_IMAGE_USE_CURSOR 0x0004 /* Depricated */
Axel Davye8f91952013-08-15 12:47:58 +02001102#define __DRI_IMAGE_USE_LINEAR 0x0008
Axel Davyd943ac42015-10-21 12:28:00 +02001103/* The buffer will only be read by an external process after SwapBuffers,
1104 * in contrary to gbm buffers, front buffers and fake front buffers, which
1105 * could be read after a flush."
1106 */
1107#define __DRI_IMAGE_USE_BACKBUFFER 0x0010
Kristian Høgsberg5aaa53e2010-06-03 21:36:40 -04001108
Jakob Bornecrantz6a7dea92012-08-31 19:48:26 +02001109
1110/**
Chad Versace56f1f472015-06-23 15:48:40 -07001111 * Four CC formats that matches with WL_DRM_FORMAT_* from wayland_drm.h,
1112 * GBM_FORMAT_* from gbm.h, and DRM_FORMAT_* from drm_fourcc.h. Used with
1113 * createImageFromNames.
Jakob Bornecrantz6a7dea92012-08-31 19:48:26 +02001114 *
1115 * \since 5
1116 */
1117
Chad Versace56f1f472015-06-23 15:48:40 -07001118#define __DRI_IMAGE_FOURCC_R8 0x20203852
1119#define __DRI_IMAGE_FOURCC_GR88 0x38385247
Jakob Bornecrantz6a7dea92012-08-31 19:48:26 +02001120#define __DRI_IMAGE_FOURCC_RGB565 0x36314752
1121#define __DRI_IMAGE_FOURCC_ARGB8888 0x34325241
1122#define __DRI_IMAGE_FOURCC_XRGB8888 0x34325258
1123#define __DRI_IMAGE_FOURCC_ABGR8888 0x34324241
1124#define __DRI_IMAGE_FOURCC_XBGR8888 0x34324258
Keith Packardaea47572013-11-21 20:08:35 -08001125#define __DRI_IMAGE_FOURCC_SARGB8888 0x83324258
Jakob Bornecrantz6a7dea92012-08-31 19:48:26 +02001126#define __DRI_IMAGE_FOURCC_YUV410 0x39565559
1127#define __DRI_IMAGE_FOURCC_YUV411 0x31315559
1128#define __DRI_IMAGE_FOURCC_YUV420 0x32315559
1129#define __DRI_IMAGE_FOURCC_YUV422 0x36315559
1130#define __DRI_IMAGE_FOURCC_YUV444 0x34325559
1131#define __DRI_IMAGE_FOURCC_NV12 0x3231564e
1132#define __DRI_IMAGE_FOURCC_NV16 0x3631564e
1133#define __DRI_IMAGE_FOURCC_YUYV 0x56595559
1134
1135
1136/**
1137 * Queryable on images created by createImageFromNames.
1138 *
1139 * RGB and RGBA are may be usable directly as images but its still
1140 * recommended to call fromPlanar with plane == 0.
1141 *
1142 * Y_U_V, Y_UV and Y_XUXV all requires call to fromPlanar to create
1143 * usable sub-images, sampling from images return raw YUV data and
1144 * color conversion needs to be done in the shader.
1145 *
1146 * \since 5
1147 */
1148
1149#define __DRI_IMAGE_COMPONENTS_RGB 0x3001
1150#define __DRI_IMAGE_COMPONENTS_RGBA 0x3002
1151#define __DRI_IMAGE_COMPONENTS_Y_U_V 0x3003
1152#define __DRI_IMAGE_COMPONENTS_Y_UV 0x3004
1153#define __DRI_IMAGE_COMPONENTS_Y_XUXV 0x3005
Chad Versace56f1f472015-06-23 15:48:40 -07001154#define __DRI_IMAGE_COMPONENTS_R 0x3006
1155#define __DRI_IMAGE_COMPONENTS_RG 0x3007
Jakob Bornecrantz6a7dea92012-08-31 19:48:26 +02001156
1157
Kristian Høgsberg5aaa53e2010-06-03 21:36:40 -04001158/**
1159 * queryImage attributes
1160 */
1161
1162#define __DRI_IMAGE_ATTRIB_STRIDE 0x2000
1163#define __DRI_IMAGE_ATTRIB_HANDLE 0x2001
1164#define __DRI_IMAGE_ATTRIB_NAME 0x2002
Jesse Barnes8de5c352012-02-21 12:53:09 -08001165#define __DRI_IMAGE_ATTRIB_FORMAT 0x2003 /* available in versions 3+ */
Jakob Bornecrantz93ebec82012-08-21 18:01:55 +02001166#define __DRI_IMAGE_ATTRIB_WIDTH 0x2004 /* available in versions 4+ */
Kristian Høgsberg44f066b2012-07-13 11:19:24 -04001167#define __DRI_IMAGE_ATTRIB_HEIGHT 0x2005
Jakob Bornecrantz6a7dea92012-08-31 19:48:26 +02001168#define __DRI_IMAGE_ATTRIB_COMPONENTS 0x2006 /* available in versions 5+ */
Kristian Høgsberg2356e282013-02-02 08:38:07 -05001169#define __DRI_IMAGE_ATTRIB_FD 0x2007 /* available in versions
1170 * 7+. Each query will return a
1171 * new fd. */
Dave Airlie8f7338f2014-03-03 13:57:16 +10001172#define __DRI_IMAGE_ATTRIB_FOURCC 0x2008 /* available in versions 11 */
1173#define __DRI_IMAGE_ATTRIB_NUM_PLANES 0x2009 /* available in versions 11 */
Kristian Høgsberg5aaa53e2010-06-03 21:36:40 -04001174
Topi Pohjolainen674dedc2013-03-26 15:14:20 +02001175enum __DRIYUVColorSpace {
1176 __DRI_YUV_COLOR_SPACE_UNDEFINED = 0,
1177 __DRI_YUV_COLOR_SPACE_ITU_REC601 = 0x327F,
1178 __DRI_YUV_COLOR_SPACE_ITU_REC709 = 0x3280,
1179 __DRI_YUV_COLOR_SPACE_ITU_REC2020 = 0x3281
1180};
1181
1182enum __DRISampleRange {
1183 __DRI_YUV_RANGE_UNDEFINED = 0,
1184 __DRI_YUV_FULL_RANGE = 0x3282,
1185 __DRI_YUV_NARROW_RANGE = 0x3283
1186};
1187
1188enum __DRIChromaSiting {
1189 __DRI_YUV_CHROMA_SITING_UNDEFINED = 0,
1190 __DRI_YUV_CHROMA_SITING_0 = 0x3284,
1191 __DRI_YUV_CHROMA_SITING_0_5 = 0x3285
1192};
1193
Abdiel Janulgue7b7af482012-11-27 15:19:54 +02001194/**
Frank Binnscfc32002015-07-31 09:11:46 +01001195 * \name Reasons that __DRIimageExtensionRec::createImageFromTexture or
1196 * __DRIimageExtensionRec::createImageFromDmaBufs might fail
Abdiel Janulgue7b7af482012-11-27 15:19:54 +02001197 */
1198/*@{*/
1199/** Success! */
1200#define __DRI_IMAGE_ERROR_SUCCESS 0
1201
1202/** Memory allocation failure */
1203#define __DRI_IMAGE_ERROR_BAD_ALLOC 1
1204
Frank Binnscfc32002015-07-31 09:11:46 +01001205/** Client requested an invalid attribute */
Abdiel Janulgue7b7af482012-11-27 15:19:54 +02001206#define __DRI_IMAGE_ERROR_BAD_MATCH 2
1207
1208/** Client requested an invalid texture object */
1209#define __DRI_IMAGE_ERROR_BAD_PARAMETER 3
Frank Binnscfc32002015-07-31 09:11:46 +01001210
1211/** Client requested an invalid pitch and/or offset */
1212#define __DRI_IMAGE_ERROR_BAD_ACCESS 4
Abdiel Janulgue7b7af482012-11-27 15:19:54 +02001213/*@}*/
1214
Axel Davy8a66a5d2014-06-18 23:27:35 -04001215/**
Giovanni Campagnae57ad3d2014-07-23 19:28:52 +01001216 * \name Capabilities that might be returned by __DRIimageExtensionRec::getCapabilities
1217 */
1218/*@{*/
1219#define __DRI_IMAGE_CAP_GLOBAL_NAMES 1
1220/*@}*/
1221
1222/**
Axel Davy8a66a5d2014-06-18 23:27:35 -04001223 * blitImage flags
1224 */
1225
1226#define __BLIT_FLAG_FLUSH 0x0001
1227#define __BLIT_FLAG_FINISH 0x0002
1228
Kristian Høgsberg79cbcb62010-02-11 17:45:24 -05001229typedef struct __DRIimageRec __DRIimage;
1230typedef struct __DRIimageExtensionRec __DRIimageExtension;
1231struct __DRIimageExtensionRec {
1232 __DRIextension base;
1233
Kristian Høgsberg9ec0b2a2010-09-22 15:07:15 -04001234 __DRIimage *(*createImageFromName)(__DRIscreen *screen,
Kristian Høgsberg79cbcb62010-02-11 17:45:24 -05001235 int width, int height, int format,
1236 int name, int pitch,
1237 void *loaderPrivate);
1238
1239 __DRIimage *(*createImageFromRenderbuffer)(__DRIcontext *context,
1240 int renderbuffer,
1241 void *loaderPrivate);
1242
1243 void (*destroyImage)(__DRIimage *image);
Kristian Høgsberg5aaa53e2010-06-03 21:36:40 -04001244
1245 __DRIimage *(*createImage)(__DRIscreen *screen,
1246 int width, int height, int format,
1247 unsigned int use,
1248 void *loaderPrivate);
1249
1250 GLboolean (*queryImage)(__DRIimage *image, int attrib, int *value);
Benjamin Franzke5fbbd4c2011-03-09 20:47:42 +01001251
1252 /**
1253 * The new __DRIimage will share the content with the old one, see dup(2).
1254 */
1255 __DRIimage *(*dupImage)(__DRIimage *image, void *loaderPrivate);
Kristian Høgsberg221c6782012-01-18 15:32:35 -05001256
1257 /**
1258 * Validate that a __DRIimage can be used a certain way.
1259 *
1260 * \since 2
1261 */
1262 GLboolean (*validateUsage)(__DRIimage *image, unsigned int use);
Kristian Høgsberg4fddb2b2012-05-02 15:30:13 -04001263
1264 /**
Jakob Bornecrantz6a7dea92012-08-31 19:48:26 +02001265 * Unlike createImageFromName __DRI_IMAGE_FORMAT is not but instead
1266 * __DRI_IMAGE_FOURCC and strides are in bytes not pixels. Stride is
1267 * also per block and not per pixel (for non-RGB, see gallium blocks).
1268 *
1269 * \since 5
1270 */
1271 __DRIimage *(*createImageFromNames)(__DRIscreen *screen,
1272 int width, int height, int fourcc,
1273 int *names, int num_names,
1274 int *strides, int *offsets,
1275 void *loaderPrivate);
1276
1277 /**
Kristian Høgsbergc0298342012-07-04 22:56:09 -04001278 * Create an image out of a sub-region of a parent image. This
1279 * entry point lets us create individual __DRIimages for different
1280 * planes in a planar buffer (typically yuv), for example. While a
1281 * sub-image shares the underlying buffer object with the parent
1282 * image and other sibling sub-images, the life times of parent and
1283 * sub-images are not dependent. Destroying the parent or a
1284 * sub-image doesn't affect other images. The underlying buffer
1285 * object is free when no __DRIimage remains that references it.
1286 *
1287 * Sub-images may overlap, but rendering to overlapping sub-images
1288 * is undefined.
1289 *
1290 * \since 5
1291 */
Jakob Bornecrantz6a7dea92012-08-31 19:48:26 +02001292 __DRIimage *(*fromPlanar)(__DRIimage *image, int plane,
1293 void *loaderPrivate);
Abdiel Janulgue7b7af482012-11-27 15:19:54 +02001294
1295 /**
1296 * Create image from texture.
1297 *
1298 * \since 6
1299 */
1300 __DRIimage *(*createImageFromTexture)(__DRIcontext *context,
1301 int target,
1302 unsigned texture,
1303 int depth,
1304 int level,
1305 unsigned *error,
1306 void *loaderPrivate);
Kristian Høgsberg2356e282013-02-02 08:38:07 -05001307 /**
1308 * Like createImageFromNames, but takes a prime fd instead.
1309 *
1310 * \since 7
1311 */
1312 __DRIimage *(*createImageFromFds)(__DRIscreen *screen,
1313 int width, int height, int fourcc,
1314 int *fds, int num_fds,
1315 int *strides, int *offsets,
1316 void *loaderPrivate);
Topi Pohjolainen674dedc2013-03-26 15:14:20 +02001317
1318 /**
1319 * Like createImageFromFds, but takes additional attributes.
1320 *
1321 * For EGL_EXT_image_dma_buf_import.
1322 *
1323 * \since 8
1324 */
1325 __DRIimage *(*createImageFromDmaBufs)(__DRIscreen *screen,
1326 int width, int height, int fourcc,
1327 int *fds, int num_fds,
1328 int *strides, int *offsets,
1329 enum __DRIYUVColorSpace color_space,
1330 enum __DRISampleRange sample_range,
1331 enum __DRIChromaSiting horiz_siting,
1332 enum __DRIChromaSiting vert_siting,
1333 unsigned *error,
1334 void *loaderPrivate);
Axel Davy8a66a5d2014-06-18 23:27:35 -04001335
1336 /**
1337 * Blit a part of a __DRIimage to another and flushes
1338 *
1339 * flush_flag:
1340 * 0: no flush
1341 * __BLIT_FLAG_FLUSH: flush after the blit operation
1342 * __BLIT_FLAG_FINISH: flush and wait the blit finished
1343 *
1344 * \since 9
1345 */
1346 void (*blitImage)(__DRIcontext *context, __DRIimage *dst, __DRIimage *src,
1347 int dstx0, int dsty0, int dstwidth, int dstheight,
1348 int srcx0, int srcy0, int srcwidth, int srcheight,
1349 int flush_flag);
Giovanni Campagnae57ad3d2014-07-23 19:28:52 +01001350
1351 /**
1352 * Query for general capabilities of the driver that concern
1353 * buffer sharing and image importing.
1354 *
1355 * \since 10
1356 */
1357 int (*getCapabilities)(__DRIscreen *screen);
Kristian Høgsberg79cbcb62010-02-11 17:45:24 -05001358};
1359
Kristian Høgsberg5aaa53e2010-06-03 21:36:40 -04001360
Kristian Høgsberg79cbcb62010-02-11 17:45:24 -05001361/**
1362 * This extension must be implemented by the loader and passed to the
1363 * driver at screen creation time. The EGLImage entry points in the
1364 * various client APIs take opaque EGLImage handles and use this
1365 * extension to map them to a __DRIimage. At version 1, this
1366 * extensions allows mapping EGLImage pointers to __DRIimage pointers,
1367 * but future versions could support other EGLImage-like, opaque types
1368 * with new lookup functions.
1369 */
1370#define __DRI_IMAGE_LOOKUP "DRI_IMAGE_LOOKUP"
1371#define __DRI_IMAGE_LOOKUP_VERSION 1
1372
1373typedef struct __DRIimageLookupExtensionRec __DRIimageLookupExtension;
1374struct __DRIimageLookupExtensionRec {
1375 __DRIextension base;
1376
Kristian Høgsberg17eace52010-09-22 22:01:17 -04001377 __DRIimage *(*lookupEGLImage)(__DRIscreen *screen, void *image,
Kristian Høgsberg79cbcb62010-02-11 17:45:24 -05001378 void *loaderPrivate);
1379};
1380
Jesse Barnes234286c2010-04-22 12:47:41 -07001381/**
1382 * This extension allows for common DRI2 options
1383 */
1384#define __DRI2_CONFIG_QUERY "DRI_CONFIG_QUERY"
1385#define __DRI2_CONFIG_QUERY_VERSION 1
1386
1387typedef struct __DRI2configQueryExtensionRec __DRI2configQueryExtension;
1388struct __DRI2configQueryExtensionRec {
1389 __DRIextension base;
1390
Dave Airlie83921792014-07-02 08:24:05 +10001391 int (*configQueryb)(__DRIscreen *screen, const char *var, unsigned char *val);
Dave Airlie29800e62014-06-27 13:23:24 +10001392 int (*configQueryi)(__DRIscreen *screen, const char *var, int *val);
1393 int (*configQueryf)(__DRIscreen *screen, const char *var, float *val);
Jesse Barnes234286c2010-04-22 12:47:41 -07001394};
Ian Romanicka8724d82012-07-03 11:32:59 -07001395
1396/**
1397 * Robust context driver extension.
1398 *
1399 * Existence of this extension means the driver can accept the
1400 * \c __DRI_CTX_FLAG_ROBUST_BUFFER_ACCESS flag and the
1401 * \c __DRI_CTX_ATTRIB_RESET_STRATEGY attribute in
1402 * \c __DRIdri2ExtensionRec::createContextAttribs.
1403 */
1404#define __DRI2_ROBUSTNESS "DRI_Robustness"
1405#define __DRI2_ROBUSTNESS_VERSION 1
1406
1407typedef struct __DRIrobustnessExtensionRec __DRIrobustnessExtension;
1408struct __DRIrobustnessExtensionRec {
1409 __DRIextension base;
1410};
1411
Eric Anholtcf5d8fc2013-06-26 15:15:57 -07001412/**
1413 * DRI config options extension.
1414 *
1415 * This extension provides the XML string containing driver options for use by
1416 * the loader in supporting the driconf application.
1417 */
1418#define __DRI_CONFIG_OPTIONS "DRI_ConfigOptions"
1419#define __DRI_CONFIG_OPTIONS_VERSION 1
1420
1421typedef struct __DRIconfigOptionsExtensionRec {
1422 __DRIextension base;
1423 const char *xml;
1424} __DRIconfigOptionsExtension;
1425
Eric Anholt4e547512013-09-26 10:51:29 -07001426/**
1427 * This extension provides a driver vtable to a set of common driver helper
1428 * functions (driCoreExtension, driDRI2Extension) within the driver
1429 * implementation, as opposed to having to pass them through a global
1430 * variable.
1431 *
1432 * It is not intended to be public API to the actual loader, and the vtable
1433 * layout may change at any time.
1434 */
1435#define __DRI_DRIVER_VTABLE "DRI_DriverVtable"
1436#define __DRI_DRIVER_VTABLE_VERSION 1
1437
1438typedef struct __DRIDriverVtableExtensionRec {
1439 __DRIextension base;
1440 const struct __DriverAPIRec *vtable;
1441} __DRIDriverVtableExtension;
1442
Ian Romanick64bb1e82013-02-14 15:51:52 -08001443/**
1444 * Query renderer driver extension
1445 *
1446 * This allows the window system layer (either EGL or GLX) to query aspects of
1447 * hardware and driver support without creating a context.
1448 */
1449#define __DRI2_RENDERER_QUERY "DRI_RENDERER_QUERY"
1450#define __DRI2_RENDERER_QUERY_VERSION 1
1451
1452#define __DRI2_RENDERER_VENDOR_ID 0x0000
1453#define __DRI2_RENDERER_DEVICE_ID 0x0001
1454#define __DRI2_RENDERER_VERSION 0x0002
1455#define __DRI2_RENDERER_ACCELERATED 0x0003
1456#define __DRI2_RENDERER_VIDEO_MEMORY 0x0004
1457#define __DRI2_RENDERER_UNIFIED_MEMORY_ARCHITECTURE 0x0005
1458#define __DRI2_RENDERER_PREFERRED_PROFILE 0x0006
1459#define __DRI2_RENDERER_OPENGL_CORE_PROFILE_VERSION 0x0007
1460#define __DRI2_RENDERER_OPENGL_COMPATIBILITY_PROFILE_VERSION 0x0008
1461#define __DRI2_RENDERER_OPENGL_ES_PROFILE_VERSION 0x0009
1462#define __DRI2_RENDERER_OPENGL_ES2_PROFILE_VERSION 0x000a
Marek Olšák4f57ccd2015-06-10 14:45:58 +02001463#define __DRI2_RENDERER_HAS_TEXTURE_3D 0x000b
1464/* Whether there is an sRGB format support for every supported 32-bit UNORM
1465 * color format.
1466 */
1467#define __DRI2_RENDERER_HAS_FRAMEBUFFER_SRGB 0x000c
Ian Romanick64bb1e82013-02-14 15:51:52 -08001468
1469typedef struct __DRI2rendererQueryExtensionRec __DRI2rendererQueryExtension;
1470struct __DRI2rendererQueryExtensionRec {
1471 __DRIextension base;
1472
1473 int (*queryInteger)(__DRIscreen *screen, int attribute, unsigned int *val);
1474 int (*queryString)(__DRIscreen *screen, int attribute, const char **val);
1475};
1476
Keith Packard44244202013-11-04 18:09:51 -08001477/**
1478 * Image Loader extension. Drivers use this to allocate color buffers
1479 */
1480
1481enum __DRIimageBufferMask {
1482 __DRI_IMAGE_BUFFER_BACK = (1 << 0),
1483 __DRI_IMAGE_BUFFER_FRONT = (1 << 1)
1484};
1485
1486struct __DRIimageList {
1487 uint32_t image_mask;
1488 __DRIimage *back;
1489 __DRIimage *front;
1490};
1491
1492#define __DRI_IMAGE_LOADER "DRI_IMAGE_LOADER"
1493#define __DRI_IMAGE_LOADER_VERSION 1
1494
1495struct __DRIimageLoaderExtensionRec {
1496 __DRIextension base;
1497
1498 /**
1499 * Allocate color buffers.
1500 *
1501 * \param driDrawable
1502 * \param width Width of allocated buffers
1503 * \param height Height of allocated buffers
1504 * \param format one of __DRI_IMAGE_FORMAT_*
1505 * \param stamp Address of variable to be updated when
1506 * getBuffers must be called again
1507 * \param loaderPrivate The loaderPrivate for driDrawable
1508 * \param buffer_mask Set of buffers to allocate
1509 * \param buffers Returned buffers
1510 */
1511 int (*getBuffers)(__DRIdrawable *driDrawable,
1512 unsigned int format,
1513 uint32_t *stamp,
1514 void *loaderPrivate,
1515 uint32_t buffer_mask,
1516 struct __DRIimageList *buffers);
1517
1518 /**
1519 * Flush pending front-buffer rendering
1520 *
1521 * Any rendering that has been performed to the
1522 * fake front will be flushed to the front
1523 *
1524 * \param driDrawable Drawable whose front-buffer is to be flushed
1525 * \param loaderPrivate Loader's private data that was previously passed
1526 * into __DRIdri2ExtensionRec::createNewDrawable
1527 */
1528 void (*flushFrontBuffer)(__DRIdrawable *driDrawable, void *loaderPrivate);
1529};
1530
1531/**
1532 * DRI extension.
1533 */
1534
1535#define __DRI_IMAGE_DRIVER "DRI_IMAGE_DRIVER"
1536#define __DRI_IMAGE_DRIVER_VERSION 1
1537
1538struct __DRIimageDriverExtensionRec {
1539 __DRIextension base;
1540
1541 /* Common DRI functions, shared with DRI2 */
1542 __DRIcreateNewScreen2Func createNewScreen2;
1543 __DRIcreateNewDrawableFunc createNewDrawable;
Keith Packard44244202013-11-04 18:09:51 -08001544 __DRIcreateContextAttribsFunc createContextAttribs;
1545 __DRIgetAPIMaskFunc getAPIMask;
1546};
1547
Keith Whitwell74d563c2004-04-29 12:23:39 +00001548#endif