sdl3_sys/metadata/generated/
surface.rs

1//! Metadata for items in the `crate::surface` module
2
3use super::*;
4
5pub const METADATA_SDL_PROP_SURFACE_SDR_WHITE_POINT_FLOAT: Property = Property {
6    module: "surface",
7    name: "SDL_PROP_SURFACE_SDR_WHITE_POINT_FLOAT",
8    short_name: "SURFACE_SDR_WHITE_POINT_FLOAT",
9    value: crate::surface::SDL_PROP_SURFACE_SDR_WHITE_POINT_FLOAT,
10    ty: PropertyType::FLOAT,
11    doc: None,
12    available_since: None,
13};
14pub const METADATA_SDL_PROP_SURFACE_HDR_HEADROOM_FLOAT: Property = Property {
15    module: "surface",
16    name: "SDL_PROP_SURFACE_HDR_HEADROOM_FLOAT",
17    short_name: "SURFACE_HDR_HEADROOM_FLOAT",
18    value: crate::surface::SDL_PROP_SURFACE_HDR_HEADROOM_FLOAT,
19    ty: PropertyType::FLOAT,
20    doc: None,
21    available_since: None,
22};
23pub const METADATA_SDL_PROP_SURFACE_TONEMAP_OPERATOR_STRING: Property = Property {
24    module: "surface",
25    name: "SDL_PROP_SURFACE_TONEMAP_OPERATOR_STRING",
26    short_name: "SURFACE_TONEMAP_OPERATOR_STRING",
27    value: crate::surface::SDL_PROP_SURFACE_TONEMAP_OPERATOR_STRING,
28    ty: PropertyType::STRING,
29    doc: None,
30    available_since: None,
31};
32pub const METADATA_SDL_PROP_SURFACE_HOTSPOT_X_NUMBER: Property = Property {
33    module: "surface",
34    name: "SDL_PROP_SURFACE_HOTSPOT_X_NUMBER",
35    short_name: "SURFACE_HOTSPOT_X_NUMBER",
36    value: crate::surface::SDL_PROP_SURFACE_HOTSPOT_X_NUMBER,
37    ty: PropertyType::NUMBER,
38    doc: None,
39    available_since: None,
40};
41pub const METADATA_SDL_PROP_SURFACE_HOTSPOT_Y_NUMBER: Property = Property {
42    module: "surface",
43    name: "SDL_PROP_SURFACE_HOTSPOT_Y_NUMBER",
44    short_name: "SURFACE_HOTSPOT_Y_NUMBER",
45    value: crate::surface::SDL_PROP_SURFACE_HOTSPOT_Y_NUMBER,
46    ty: PropertyType::NUMBER,
47    doc: None,
48    available_since: None,
49};
50pub const METADATA_SDL_PROP_SURFACE_ROTATION_FLOAT: Property = Property {
51    module: "surface",
52    name: "SDL_PROP_SURFACE_ROTATION_FLOAT",
53    short_name: "SURFACE_ROTATION_FLOAT",
54    value: crate::surface::SDL_PROP_SURFACE_ROTATION_FLOAT,
55    ty: PropertyType::FLOAT,
56    doc: None,
57    available_since: None,
58};
59pub const METADATA_SDL_SurfaceFlags: Group = Group {
60    module: "surface",
61    kind: GroupKind::Flags,
62    name: "SDL_SurfaceFlags",
63    short_name: "SurfaceFlags",
64    doc: Some(
65        "The flags on an [`SDL_Surface`].\n\nThese are generally considered read-only.\n\n## Availability\nThis datatype is available since SDL 3.2.0.\n",
66    ),
67    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
68    values: &[
69        GroupValue {
70            name: "SDL_SURFACE_PREALLOCATED",
71            short_name: "PREALLOCATED",
72            doc: Some("Surface uses preallocated pixel memory\n"),
73            available_since: None,
74        },
75        GroupValue {
76            name: "SDL_SURFACE_LOCK_NEEDED",
77            short_name: "LOCK_NEEDED",
78            doc: Some("Surface needs to be locked to access pixels\n"),
79            available_since: None,
80        },
81        GroupValue {
82            name: "SDL_SURFACE_LOCKED",
83            short_name: "LOCKED",
84            doc: Some("Surface is currently locked\n"),
85            available_since: None,
86        },
87        GroupValue {
88            name: "SDL_SURFACE_SIMD_ALIGNED",
89            short_name: "SIMD_ALIGNED",
90            doc: Some("Surface uses pixel memory allocated with [`SDL_aligned_alloc()`]\n"),
91            available_since: None,
92        },
93    ],
94};
95pub const METADATA_SDL_ScaleMode: Group = Group {
96    module: "surface",
97    kind: GroupKind::Enum,
98    name: "SDL_ScaleMode",
99    short_name: "ScaleMode",
100    doc: Some("The scaling mode.\n\n## Availability\nThis enum is available since SDL 3.2.0.\n"),
101    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
102    values: &[
103        GroupValue {
104            name: "SDL_SCALEMODE_INVALID",
105            short_name: "INVALID",
106            doc: None,
107            available_since: None,
108        },
109        GroupValue {
110            name: "SDL_SCALEMODE_NEAREST",
111            short_name: "NEAREST",
112            doc: Some("nearest pixel sampling\n"),
113            available_since: None,
114        },
115        GroupValue {
116            name: "SDL_SCALEMODE_LINEAR",
117            short_name: "LINEAR",
118            doc: Some("linear filtering\n"),
119            available_since: None,
120        },
121        GroupValue {
122            name: "SDL_SCALEMODE_PIXELART",
123            short_name: "PIXELART",
124            doc: Some(
125                "nearest pixel sampling with improved scaling for pixel art, available since SDL 3.4.0\n",
126            ),
127            available_since: None,
128        },
129    ],
130};
131pub const METADATA_SDL_FlipMode: Group = Group {
132    module: "surface",
133    kind: GroupKind::Flags,
134    name: "SDL_FlipMode",
135    short_name: "FlipMode",
136    doc: Some("The flip mode.\n\n## Availability\nThis enum is available since SDL 3.2.0.\n"),
137    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
138    values: &[
139        GroupValue {
140            name: "SDL_FLIP_NONE",
141            short_name: "NONE",
142            doc: Some("Do not flip\n"),
143            available_since: None,
144        },
145        GroupValue {
146            name: "SDL_FLIP_HORIZONTAL",
147            short_name: "HORIZONTAL",
148            doc: Some("flip horizontally\n"),
149            available_since: None,
150        },
151        GroupValue {
152            name: "SDL_FLIP_VERTICAL",
153            short_name: "VERTICAL",
154            doc: Some("flip vertically\n"),
155            available_since: None,
156        },
157        GroupValue {
158            name: "SDL_FLIP_HORIZONTAL_AND_VERTICAL",
159            short_name: "HORIZONTAL_AND_VERTICAL",
160            doc: Some("flip horizontally and vertically (not a diagonal flip)\n"),
161            available_since: None,
162        },
163    ],
164};