summaryrefslogtreecommitdiff
path: root/include/X11/extensions/Xpresent.h
blob: 84bce115641ebaf1912ea9ba7b57fd0fb2c18c62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/*
 * Copyright © 2013 Keith Packard
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting documentation, and
 * that the name of the copyright holders not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  The copyright holders make no representations
 * about the suitability of this software for any purpose.  It is provided "as
 * is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THIS SOFTWARE.
 */

#ifndef _XPRESENT_H_
#define _XPRESENT_H_

#include <stdint.h>
#include <X11/extensions/presenttokens.h>

#include <X11/Xfuncproto.h>
#include <X11/Xlib.h>
#include <X11/extensions/Xfixes.h>
#include <X11/extensions/Xrandr.h>
#include <X11/extensions/sync.h>

/*
 * This revision number also appears in configure.ac, they have
 * to be manually synchronized
 */
#define PRESENT_REVISION	0
#define PRESENT_VERSION	((PRESENT_MAJOR * 10000) + (PRESENT_MINOR * 100) + (PRESENT_REVISION))

/**
 * Generic Present event. All Present events have the same header.
 */

typedef struct {
    Window      window;
    uint32_t    serial;
} XPresentNotify;

typedef struct {
    int type;			/* event base */
    unsigned long serial;
    Bool send_event;
    Display *display;
    int extension;
    int evtype;
} XPresentEvent;

typedef struct {
    int type;			/* event base */
    unsigned long serial;
    Bool send_event;
    Display *display;
    int extension;
    int evtype;

    uint32_t eid;
    Window window;
    int x,y;
    unsigned width, height;
    int off_x, off_y;
    int pixmap_width, pixmap_height;
    long pixmap_flags;
} XPresentConfigureNotifyEvent;

typedef struct {
    int type;			/* event base */
    unsigned long serial;
    Bool send_event;
    Display *display;
    int extension;
    int evtype;

    uint32_t eid;
    Window window;
    uint32_t serial_number;
    uint64_t ust;
    uint64_t msc;
    uint8_t kind;
    uint8_t mode;
} XPresentCompleteNotifyEvent;

typedef struct {
    int type;			/* event base */
    unsigned long serial;
    Bool send_event;
    Display *display;
    int extension;
    int evtype;

    uint32_t eid;
    Window window;
    uint32_t serial_number;
    Pixmap pixmap;
    XSyncFence idle_fence;
} XPresentIdleNotifyEvent;

#if PRESENT_FUTURE_VERSION

typedef struct {
    int type;			/* event base */
    unsigned long serial;
    Bool send_event;
    Display *display;
    int extension;
    int evtype;

    uint32_t eid;
    Window event_window;

    Window window;
    Pixmap pixmap;
    uint32_t serial_number;

    XserverRegion valid_region;
    XserverRegion update_region;

    XRectangle valid_rect;
    XRectangle update_rect;

    int x_off, y_off;

    RRCrtc target_crtc;

    XSyncFence wait_fence;
    XSyncFence idle_fence;

    uint32_t options;

    uint64_t target_msc;
    uint64_t divisor;
    uint64_t remainder;
    XPresentNotify *notifies;
    int nnotifies;
} XPresentRedirectNotifyEvent;

#endif

_XFUNCPROTOBEGIN

Bool XPresentQueryExtension (Display *dpy,
                             int *major_opcode_return,
                             int *event_base_return,
                             int *error_base_return);

Status XPresentQueryVersion (Display *dpy,
			    int     *major_version_return,
			    int     *minor_version_return);

int XPresentVersion (void);

void
XPresentPixmap(Display *dpy,
               Window window,
               Pixmap pixmap,
               uint32_t serial,
               XserverRegion valid,
               XserverRegion update,
               int x_off,
               int y_off,
               RRCrtc target_crtc,
               XSyncFence wait_fence,
               XSyncFence idle_fence,
               uint32_t options,
               uint64_t target_msc,
               uint64_t divisor,
               uint64_t remainder,
               XPresentNotify *notifies,
               int nnotifies);

void
XPresentNotifyMSC(Display *dpy,
                  Window window,
                  uint32_t serial,
                  uint64_t target_msc,
                  uint64_t divisor,
                  uint64_t remainder);

XID
XPresentSelectInput(Display *dpy,
                    Window window,
                    unsigned event_mask);

void
XPresentFreeInput(Display *dpy,
                  Window window,
                  XID event_id);

uint32_t
XPresentQueryCapabilities(Display *dpy,
                          XID target);

_XFUNCPROTOEND

#endif /* _XPRESENT_H_ */