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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
|
use core::ffi::{c_int, c_ulong, c_void};
use core::num::NonZeroU32;
use core::ptr::NonNull;
/// Raw display handle for Xlib.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct XlibDisplayHandle {
/// A pointer to an Xlib `Display`.
///
/// It is strongly recommended to set this value, however it may be set to
/// `None` to request the default display when using EGL.
pub display: Option<NonNull<c_void>>,
/// An X11 screen to use with this display handle.
///
/// Note, that X11 could have multiple screens, however
/// graphics APIs could work only with one screen at the time,
/// given that multiple screens usually reside on different GPUs.
pub screen: c_int,
}
impl XlibDisplayHandle {
/// Create a new handle to a display.
///
///
/// # Example
///
/// ```
/// # use core::ffi::c_void;
/// # use core::ptr::NonNull;
/// # use raw_window_handle::XlibDisplayHandle;
/// #
/// let display: NonNull<c_void>;
/// let screen;
/// # display = NonNull::from(&()).cast();
/// # screen = 0;
/// let handle = XlibDisplayHandle::new(Some(display), screen);
/// ```
pub fn new(display: Option<NonNull<c_void>>, screen: c_int) -> Self {
Self { display, screen }
}
}
/// Raw window handle for Xlib.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct XlibWindowHandle {
/// An Xlib `Window`.
pub window: c_ulong,
/// An Xlib visual ID, or 0 if unknown.
pub visual_id: c_ulong,
}
impl XlibWindowHandle {
/// Create a new handle to a window.
///
///
/// # Example
///
/// ```
/// # use core::ffi::c_ulong;
/// # use raw_window_handle::XlibWindowHandle;
/// #
/// let window: c_ulong;
/// # window = 0;
/// let mut handle = XlibWindowHandle::new(window);
/// // Optionally set the visual ID.
/// handle.visual_id = 0;
/// ```
pub fn new(window: c_ulong) -> Self {
Self {
window,
visual_id: 0,
}
}
}
/// Raw display handle for Xcb.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct XcbDisplayHandle {
/// A pointer to an X server `xcb_connection_t`.
///
/// It is strongly recommended to set this value, however it may be set to
/// `None` to request the default display when using EGL.
pub connection: Option<NonNull<c_void>>,
/// An X11 screen to use with this display handle.
///
/// Note, that X11 could have multiple screens, however
/// graphics APIs could work only with one screen at the time,
/// given that multiple screens usually reside on different GPUs.
pub screen: c_int,
}
impl XcbDisplayHandle {
/// Create a new handle to a connection and screen.
///
///
/// # Example
///
/// ```
/// # use core::ffi::c_void;
/// # use core::ptr::NonNull;
/// # use raw_window_handle::XcbDisplayHandle;
/// #
/// let connection: NonNull<c_void>;
/// let screen;
/// # connection = NonNull::from(&()).cast();
/// # screen = 0;
/// let handle = XcbDisplayHandle::new(Some(connection), screen);
/// ```
pub fn new(connection: Option<NonNull<c_void>>, screen: c_int) -> Self {
Self { connection, screen }
}
}
/// Raw window handle for Xcb.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct XcbWindowHandle {
/// An X11 `xcb_window_t`.
pub window: NonZeroU32, // Based on xproto.h
/// An X11 `xcb_visualid_t`.
pub visual_id: Option<NonZeroU32>,
}
impl XcbWindowHandle {
/// Create a new handle to a window.
///
///
/// # Example
///
/// ```
/// # use core::num::NonZeroU32;
/// # use raw_window_handle::XcbWindowHandle;
/// #
/// let window: NonZeroU32;
/// # window = NonZeroU32::new(1).unwrap();
/// let mut handle = XcbWindowHandle::new(window);
/// // Optionally set the visual ID.
/// handle.visual_id = None;
/// ```
pub fn new(window: NonZeroU32) -> Self {
Self {
window,
visual_id: None,
}
}
}
/// Raw display handle for Wayland.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct WaylandDisplayHandle {
/// A pointer to a `wl_display`.
pub display: NonNull<c_void>,
}
impl WaylandDisplayHandle {
/// Create a new display handle.
///
///
/// # Example
///
/// ```
/// # use core::ffi::c_void;
/// # use core::ptr::NonNull;
/// # use raw_window_handle::WaylandDisplayHandle;
/// #
/// let display: NonNull<c_void>;
/// # display = NonNull::from(&()).cast();
/// let handle = WaylandDisplayHandle::new(display);
/// ```
pub fn new(display: NonNull<c_void>) -> Self {
Self { display }
}
}
/// Raw window handle for Wayland.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct WaylandWindowHandle {
/// A pointer to a `wl_surface`.
pub surface: NonNull<c_void>,
}
impl WaylandWindowHandle {
/// Create a new handle to a surface.
///
///
/// # Example
///
/// ```
/// # use core::ffi::c_void;
/// # use core::ptr::NonNull;
/// # use raw_window_handle::WaylandWindowHandle;
/// #
/// let surface: NonNull<c_void>;
/// # surface = NonNull::from(&()).cast();
/// let handle = WaylandWindowHandle::new(surface);
/// ```
pub fn new(surface: NonNull<c_void>) -> Self {
Self { surface }
}
}
/// Raw display handle for the Linux Kernel Mode Set/Direct Rendering Manager.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct DrmDisplayHandle {
/// The drm file descriptor.
// TODO: Use `std::os::fd::RawFd`?
pub fd: i32,
}
impl DrmDisplayHandle {
/// Create a new handle to a file descriptor.
///
///
/// # Example
///
/// ```
/// # use raw_window_handle::DrmDisplayHandle;
/// #
/// let fd: i32;
/// # fd = 0;
/// let handle = DrmDisplayHandle::new(fd);
/// ```
pub fn new(fd: i32) -> Self {
Self { fd }
}
}
/// Raw window handle for the Linux Kernel Mode Set/Direct Rendering Manager.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct DrmWindowHandle {
/// The primary drm plane handle.
pub plane: u32,
}
impl DrmWindowHandle {
/// Create a new handle to a plane.
///
///
/// # Example
///
/// ```
/// # use raw_window_handle::DrmWindowHandle;
/// #
/// let plane: u32;
/// # plane = 0;
/// let handle = DrmWindowHandle::new(plane);
/// ```
pub fn new(plane: u32) -> Self {
Self { plane }
}
}
/// Raw display handle for the Linux Generic Buffer Manager.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct GbmDisplayHandle {
/// The gbm device.
pub gbm_device: NonNull<c_void>,
}
impl GbmDisplayHandle {
/// Create a new handle to a device.
///
///
/// # Example
///
/// ```
/// # use core::ffi::c_void;
/// # use core::ptr::NonNull;
/// # use raw_window_handle::GbmDisplayHandle;
/// #
/// let ptr: NonNull<c_void>;
/// # ptr = NonNull::from(&()).cast();
/// let handle = GbmDisplayHandle::new(ptr);
/// ```
pub fn new(gbm_device: NonNull<c_void>) -> Self {
Self { gbm_device }
}
}
/// Raw window handle for the Linux Generic Buffer Manager.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct GbmWindowHandle {
/// The gbm surface.
pub gbm_surface: NonNull<c_void>,
}
impl GbmWindowHandle {
/// Create a new handle to a surface.
///
///
/// # Example
///
/// ```
/// # use core::ffi::c_void;
/// # use core::ptr::NonNull;
/// # use raw_window_handle::GbmWindowHandle;
/// #
/// let ptr: NonNull<c_void>;
/// # ptr = NonNull::from(&()).cast();
/// let handle = GbmWindowHandle::new(ptr);
/// ```
pub fn new(gbm_surface: NonNull<c_void>) -> Self {
Self { gbm_surface }
}
}
|
