dri2video support
[gstreamer-omap:libdri2.git] / include / X11 / extensions / dri2.h
1 /*
2  * Copyright © 2007,2008 Red Hat, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Soft-
6  * ware"), to deal in the Software without restriction, including without
7  * limitation the rights to use, copy, modify, merge, publish, distribute,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, provided that the above copyright
10  * notice(s) and this permission notice appear in all copies of the Soft-
11  * ware and that both the above copyright notice(s) and this permission
12  * notice appear in supporting documentation.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
16  * ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY
17  * RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN
18  * THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSE-
19  * QUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
20  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
21  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFOR-
22  * MANCE OF THIS SOFTWARE.
23  *
24  * Except as contained in this notice, the name of a copyright holder shall
25  * not be used in advertising or otherwise to promote the sale, use or
26  * other dealings in this Software without prior written authorization of
27  * the copyright holder.
28  *
29  * Authors:
30  *   Kristian Høgsberg (krh@redhat.com)
31  */
32
33 #ifndef _DRI2_H_
34 #define _DRI2_H_
35
36 #include <X11/Xmd.h>
37 #include <X11/Xproto.h>
38 #include <X11/extensions/Xfixes.h>
39 #include <X11/extensions/extutil.h>
40 #include <X11/extensions/dri2tokens.h>
41 #include <X11/Xregion.h>
42 #include <drm.h>
43
44 typedef struct
45 {
46    unsigned int attachment;
47    unsigned int names[3];    /* unused entries set to zero.. non-planar formats only use names[0] */
48    unsigned int pitch[3];    /* unused entries set to zero.. non-planar formats only use pitch[0] */
49    unsigned int cpp;
50    unsigned int flags;
51 } DRI2Buffer;
52
53 typedef struct
54 {
55         Bool (*WireToEvent)(Display *dpy, XExtDisplayInfo *info, XEvent *event, xEvent *wire);
56         Status (*EventToWire)(Display *dpy, XExtDisplayInfo *info, XEvent *event, xEvent *wire);
57         int (*Error)(Display *dpy, xError *err, XExtCodes *codes, int *ret_code);
58 } DRI2EventOps;
59
60 /* Call this once per display to register event handling code.. if needed */
61 extern Bool
62 DRI2InitDisplay(Display * display, const DRI2EventOps * ops);
63
64 extern Bool
65 DRI2QueryExtension(Display * display, int *eventBase, int *errorBase);
66
67 extern Bool
68 DRI2QueryVersion(Display * display, int *major, int *minor);
69
70 extern Bool
71 DRI2Connect(Display * dpy, XID window,
72                 int driverType, char **driverName, char **deviceName);
73
74 extern Bool
75 DRI2Authenticate(Display * display, XID window, drm_magic_t magic);
76
77 extern void
78 DRI2CreateDrawable(Display * display, XID drawable);
79
80 extern void
81 DRI2DestroyDrawable(Display * display, XID handle);
82
83 extern DRI2Buffer*
84 DRI2GetBuffers(Display * dpy, XID drawable,
85                int *width, int *height,
86                unsigned int *attachments, int count,
87                int *outCount);
88
89 /**
90  * \note
91  * This function is only supported with DRI2 version 1.1 or later.
92  */
93 extern DRI2Buffer*
94 DRI2GetBuffersWithFormat(Display * dpy, XID drawable,
95                          int *width, int *height,
96                          unsigned int *attachments,
97                          int count, int *outCount);
98
99 /**
100  * \note
101  * This function is only supported with DRI2 version 1.4 or later.
102  * The 'attachments' array is same as with DRI2GetBuffersWithFormat()
103  */
104 DRI2Buffer *
105 DRI2GetBuffersVid(Display * dpy, XID drawable,
106                int width, int height,
107                unsigned int *attachments, int count, int *outCount);
108
109 extern void
110 DRI2CopyRegion(Display * dpy, XID drawable,
111                XserverRegion region,
112                CARD32 dest, CARD32 src);
113
114 extern void
115 DRI2SwapBuffers(Display *dpy, XID drawable, CARD64 target_msc, CARD64 divisor,
116                 CARD64 remainder, CARD64 *count);
117
118 /**
119  * \note
120  * This function is only supported with DRI2 version 1.4 or later.
121  */
122 extern void
123 DRI2SwapBuffersVid(Display *dpy, XID drawable, CARD64 target_msc,
124                 CARD64 divisor, CARD64 remainder, CARD64 *count,
125                 unsigned int source, BoxPtr b);
126
127 extern Bool
128 DRI2GetMSC(Display *dpy, XID drawable, CARD64 *ust, CARD64 *msc, CARD64 *sbc);
129
130 extern Bool
131 DRI2WaitMSC(Display *dpy, XID drawable, CARD64 target_msc, CARD64 divisor,
132             CARD64 remainder, CARD64 *ust, CARD64 *msc, CARD64 *sbc);
133
134 extern Bool
135 DRI2WaitSBC(Display *dpy, XID drawable, CARD64 target_sbc, CARD64 *ust,
136             CARD64 *msc, CARD64 *sbc);
137
138 extern void
139 DRI2SwapInterval(Display *dpy, XID drawable, int interval);
140
141 /**
142  * \note
143  * This function is only supported with DRI2 version 1.4 or later.
144  * length in multiple of CARD32's
145  */
146 extern void
147 DRI2SetAttribute(Display * dpy, XID drawable, Atom attribute,
148                 int len, const CARD32 *val);
149
150 /**
151  * \note
152  * This function is only supported with DRI2 version 1.4 or later.
153  * The returned attribute should be free'd by caller.. length in
154  * multiple of CARD32's
155  */
156 extern Bool
157 DRI2GetAttribute(Display * dpy, XID drawable, Atom attribute,
158                 int *len, CARD32 **val);
159
160 /**
161  * \note
162  * This function is only supported with DRI2 version 1.4 or later.
163  * returned formats should be freed by caller
164  */
165 extern Bool
166 DRI2GetFormats(Display * dpy, XID drawable, unsigned int *pnformats,
167                 unsigned int **pformats);
168
169 #endif