sdl3-sys 0.6.3+SDL-3.4.4

Low level Rust bindings for SDL 3
Documentation 
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

//! Metadata for SDL types and constants

use core::ffi::{CStr, c_char, c_int};

pub use crate::properties::SDL_PropertyType as PropertyType;

/// Metadata for hint constants
#[derive(Clone, Copy)]
pub struct Hint {
    pub module: &'static str,
    pub name: &'static str,
    pub short_name: &'static str,
    pub value: *const c_char,
    pub doc: Option<&'static str>,
    pub available_since: Option<c_int>,
}

unsafe impl Send for Hint {}
unsafe impl Sync for Hint {}

impl Hint {
    #[inline(always)]
    pub const fn value_cstr(&self) -> &'static CStr {
        unsafe { CStr::from_ptr(self.value) }
    }

    #[inline(always)]
    pub const fn value_str(&self) -> &'static str {
        match self.value_cstr().to_str() {
            Ok(str) => str,
            Err(_) => unreachable!(),
        }
    }
}

/// Metadata for property constants
#[derive(Clone, Copy)]
pub struct Property {
    pub module: &'static str,
    pub name: &'static str,
    pub short_name: &'static str,
    pub value: *const c_char,
    pub ty: PropertyType,
    pub doc: Option<&'static str>,
    pub available_since: Option<c_int>,
}

unsafe impl Send for Property {}
unsafe impl Sync for Property {}

impl Property {
    #[inline(always)]
    pub const fn value_cstr(&self) -> &'static CStr {
        unsafe { CStr::from_ptr(self.value) }
    }

    #[inline(always)]
    pub const fn value_str(&self) -> &'static str {
        match self.value_cstr().to_str() {
            Ok(str) => str,
            Err(_) => unreachable!(),
        }
    }
}

/// Access metadata for typed groups of constants (c enums, flags, etc)
pub trait GroupMetadata: 'static + Sized {
    /// Metadata for this group
    const GROUP_METADATA: &'static Group;
}

#[non_exhaustive]
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum GroupKind {
    Enum,
    Flags,
    Id,
    Lock,
}

/// Metadata for typed groups of constants (c enums, flags, etc)
#[derive(Clone, Copy)]
pub struct Group {
    pub kind: GroupKind,
    pub module: &'static str,
    pub name: &'static str,
    pub short_name: &'static str,
    pub doc: Option<&'static str>,
    pub values: &'static [GroupValue],
    pub available_since: Option<c_int>,
}

/// Metadata for a single value in a group of constants
#[derive(Clone, Copy)]
pub struct GroupValue {
    pub name: &'static str,
    pub short_name: &'static str,
    pub doc: Option<&'static str>,
    pub available_since: Option<c_int>,
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub enum StructKind {
    Struct,
    Union,
}

/// Metadata for structs and unions
#[derive(Clone, Copy)]
pub struct Struct {
    pub kind: StructKind,
    pub module: &'static str,
    pub name: &'static str,
    pub doc: Option<&'static str>,
    pub available_since: Option<c_int>,
    pub fields: &'static [Field],
}

/// Metadata for fields of structs and unions
#[derive(Clone, Copy)]
pub struct Field {
    pub name: &'static str,
    pub doc: Option<&'static str>,
    pub available_since: Option<c_int>,
    pub ty: &'static str,
}

#[cfg(feature = "metadata")]
mod generated;

#[cfg(feature = "metadata")]
#[allow(unused_imports)] // false positive
pub use generated::*;