summaryrefslogtreecommitdiffstats
path: root/third_party/rust/raw-window-handle/src/web.rs
blob: 846d78c1e6672db6733abf9fb44c330bc3f87637 (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
/// Raw window handle for the web
///
/// ## Construction
/// ```
/// # use raw_window_handle::web::WebHandle;
/// let handle = WebHandle {
///     /* fields */
///     ..WebHandle::empty()
/// };
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct WebHandle {
    /// An ID value inserted into the data attributes of the canvas element as 'raw-handle'
    ///
    /// When accessing from JS, the attribute will automatically be called rawHandle
    ///
    /// Each canvas created by the windowing system should be assigned their own unique ID.
    /// 0 should be reserved for invalid / null IDs.
    pub id: u32,
    #[doc(hidden)]
    #[deprecated = "This field is used to ensure that this struct is non-exhaustive, so that it may be extended in the future. Do not refer to this field."]
    pub _non_exhaustive_do_not_use: crate::seal::Seal,
}

impl WebHandle {
    pub fn empty() -> WebHandle {
        #[allow(deprecated)]
        WebHandle {
            id: 0,
            _non_exhaustive_do_not_use: crate::seal::Seal,
        }
    }
}