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

//! Metadata for items in the `crate::properties` module

use super::*;

pub const METADATA_SDL_PROP_NAME_STRING: Property = Property {
    module: "properties",
    name: "SDL_PROP_NAME_STRING",
    short_name: "NAME_STRING",
    value: crate::properties::SDL_PROP_NAME_STRING,
    ty: PropertyType::STRING,
    doc: Some(
        "A generic property for naming things.\n\nThis property is intended to be added to any [`SDL_PropertiesID`] that needs a\ngeneric name associated with the property set. It is not guaranteed that\nany property set will include this key, but it is convenient to have a\nstandard key that any piece of code could reasonably agree to use.\n\nFor example, the properties associated with an [`SDL_Texture`] might have a\nname string of \"player sprites\", or an [`SDL_AudioStream`] might have\n\"background music\", etc. This might also be useful for an [`SDL_IOStream`] to\nlist the path to its asset.\n\nThere is no format for the value set with this key; it is expected to be\nhuman-readable and informational in nature, possibly for logging or\ndebugging purposes.\n\nSDL does not currently set this property on any objects it creates, but\nthis may change in later versions; it is currently expected that apps and\nexternal libraries will take advantage of it, when appropriate.\n\n## Availability\nThis macro is available since SDL 3.4.0.\n",
    ),
    available_since: Some(SDL_VERSIONNUM(3, 4, 0)),
};
pub const METADATA_SDL_PropertiesID: Group = Group {
    module: "properties",
    kind: GroupKind::Id,
    name: "SDL_PropertiesID",
    short_name: "PropertiesID",
    doc: Some(
        "An ID that represents a properties set.\n\n## Availability\nThis datatype is available since SDL 3.2.0.\n",
    ),
    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
    values: &[],
};
pub const METADATA_SDL_PropertyType: Group = Group {
    module: "properties",
    kind: GroupKind::Enum,
    name: "SDL_PropertyType",
    short_name: "PropertyType",
    doc: Some("SDL property type\n\n## Availability\nThis enum is available since SDL 3.2.0.\n"),
    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
    values: &[
        GroupValue {
            name: "SDL_PROPERTY_TYPE_INVALID",
            short_name: "INVALID",
            doc: None,
            available_since: None,
        },
        GroupValue {
            name: "SDL_PROPERTY_TYPE_POINTER",
            short_name: "POINTER",
            doc: None,
            available_since: None,
        },
        GroupValue {
            name: "SDL_PROPERTY_TYPE_STRING",
            short_name: "STRING",
            doc: None,
            available_since: None,
        },
        GroupValue {
            name: "SDL_PROPERTY_TYPE_NUMBER",
            short_name: "NUMBER",
            doc: None,
            available_since: None,
        },
        GroupValue {
            name: "SDL_PROPERTY_TYPE_FLOAT",
            short_name: "FLOAT",
            doc: None,
            available_since: None,
        },
        GroupValue {
            name: "SDL_PROPERTY_TYPE_BOOLEAN",
            short_name: "BOOLEAN",
            doc: None,
            available_since: None,
        },
    ],
};