Atlas - SDL_hints.h
Home / ext / SDL / include / SDL3
Lines: 1 | Size: 162611 bytes
[Download] [Show on GitHub] [Search similar files] [Raw] [Raw (proxy)] 
[FILE BEGIN]
1/*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2025 Sam Lantinga <[email protected]>
4
5  This software is provided 'as-is', without any express or implied
6  warranty.  In no event will the authors be held liable for any damages
7  arising from the use of this software.
8
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12
13  1. The origin of this software must not be misrepresented; you must not
14     claim that you wrote the original software. If you use this software
15     in a product, an acknowledgment in the product documentation would be
16     appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18     misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20*/
21
22/**
23 * # CategoryHints
24 *
25 * This file contains functions to set and get configuration hints, as well as
26 * listing each of them alphabetically.
27 *
28 * The convention for naming hints is SDL_HINT_X, where "SDL_X" is the
29 * environment variable that can be used to override the default.
30 *
31 * In general these hints are just that - they may or may not be supported or
32 * applicable on any given platform, but they provide a way for an application
33 * or user to give the library a hint as to how they would like the library to
34 * work.
35 */
36
37#ifndef SDL_hints_h_
38#define SDL_hints_h_
39
40#include <SDL3/SDL_error.h>
41#include <SDL3/SDL_stdinc.h>
42
43#include <SDL3/SDL_begin_code.h>
44/* Set up for C function definitions, even when using C++ */
45#ifdef __cplusplus
46extern "C" {
47#endif
48
49/**
50 * Specify the behavior of Alt+Tab while the keyboard is grabbed.
51 *
52 * By default, SDL emulates Alt+Tab functionality while the keyboard is
53 * grabbed and your window is full-screen. This prevents the user from getting
54 * stuck in your application if you've enabled keyboard grab.
55 *
56 * The variable can be set to the following values:
57 *
58 * - "0": SDL will not handle Alt+Tab. Your application is responsible for
59 *   handling Alt+Tab while the keyboard is grabbed.
60 * - "1": SDL will minimize your window when Alt+Tab is pressed (default)
61 *
62 * This hint can be set anytime.
63 *
64 * \since This hint is available since SDL 3.2.0.
65 */
66#define SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED "SDL_ALLOW_ALT_TAB_WHILE_GRABBED"
67
68/**
69 * A variable to control whether the SDL activity is allowed to be re-created.
70 *
71 * If this hint is true, the activity can be recreated on demand by the OS,
72 * and Java static data and C++ static data remain with their current values.
73 * If this hint is false, then SDL will call exit() when you return from your
74 * main function and the application will be terminated and then started fresh
75 * each time.
76 *
77 * The variable can be set to the following values:
78 *
79 * - "0": The application starts fresh at each launch. (default)
80 * - "1": The application activity can be recreated by the OS.
81 *
82 * This hint can be set anytime.
83 *
84 * \since This hint is available since SDL 3.2.0.
85 */
86#define SDL_HINT_ANDROID_ALLOW_RECREATE_ACTIVITY "SDL_ANDROID_ALLOW_RECREATE_ACTIVITY"
87
88/**
89 * A variable to control whether the event loop will block itself when the app
90 * is paused.
91 *
92 * The variable can be set to the following values:
93 *
94 * - "0": Non blocking.
95 * - "1": Blocking. (default)
96 *
97 * This hint should be set before SDL is initialized.
98 *
99 * \since This hint is available since SDL 3.2.0.
100 */
101#define SDL_HINT_ANDROID_BLOCK_ON_PAUSE "SDL_ANDROID_BLOCK_ON_PAUSE"
102
103/**
104 * A variable to control whether low latency audio should be enabled.
105 *
106 * Some devices have poor quality output when this is enabled, but this is
107 * usually an improvement in audio latency.
108 *
109 * The variable can be set to the following values:
110 *
111 * - "0": Low latency audio is not enabled.
112 * - "1": Low latency audio is enabled. (default)
113 *
114 * This hint should be set before SDL audio is initialized.
115 *
116 * \since This hint is available since SDL 3.2.0.
117 */
118#define SDL_HINT_ANDROID_LOW_LATENCY_AUDIO "SDL_ANDROID_LOW_LATENCY_AUDIO"
119
120/**
121 * A variable to control whether we trap the Android back button to handle it
122 * manually.
123 *
124 * This is necessary for the right mouse button to work on some Android
125 * devices, or to be able to trap the back button for use in your code
126 * reliably. If this hint is true, the back button will show up as an
127 * SDL_EVENT_KEY_DOWN / SDL_EVENT_KEY_UP pair with a keycode of
128 * SDL_SCANCODE_AC_BACK.
129 *
130 * The variable can be set to the following values:
131 *
132 * - "0": Back button will be handled as usual for system. (default)
133 * - "1": Back button will be trapped, allowing you to handle the key press
134 *   manually. (This will also let right mouse click work on systems where the
135 *   right mouse button functions as back.)
136 *
137 * This hint can be set anytime.
138 *
139 * \since This hint is available since SDL 3.2.0.
140 */
141#define SDL_HINT_ANDROID_TRAP_BACK_BUTTON "SDL_ANDROID_TRAP_BACK_BUTTON"
142
143/**
144 * A variable setting the app ID string.
145 *
146 * This string is used by desktop compositors to identify and group windows
147 * together, as well as match applications with associated desktop settings
148 * and icons.
149 *
150 * This will override SDL_PROP_APP_METADATA_IDENTIFIER_STRING, if set by the
151 * application.
152 *
153 * This hint should be set before SDL is initialized.
154 *
155 * \since This hint is available since SDL 3.2.0.
156 */
157#define SDL_HINT_APP_ID "SDL_APP_ID"
158
159/**
160 * A variable setting the application name.
161 *
162 * This hint lets you specify the application name sent to the OS when
163 * required. For example, this will often appear in volume control applets for
164 * audio streams, and in lists of applications which are inhibiting the
165 * screensaver. You should use a string that describes your program ("My Game
166 * 2: The Revenge")
167 *
168 * This will override SDL_PROP_APP_METADATA_NAME_STRING, if set by the
169 * application.
170 *
171 * This hint should be set before SDL is initialized.
172 *
173 * \since This hint is available since SDL 3.2.0.
174 */
175#define SDL_HINT_APP_NAME "SDL_APP_NAME"
176
177/**
178 * A variable controlling whether controllers used with the Apple TV generate
179 * UI events.
180 *
181 * When UI events are generated by controller input, the app will be
182 * backgrounded when the Apple TV remote's menu button is pressed, and when
183 * the pause or B buttons on gamepads are pressed.
184 *
185 * More information about properly making use of controllers for the Apple TV
186 * can be found here:
187 * https://developer.apple.com/tvos/human-interface-guidelines/remote-and-controllers/
188 *
189 * The variable can be set to the following values:
190 *
191 * - "0": Controller input does not generate UI events. (default)
192 * - "1": Controller input generates UI events.
193 *
194 * This hint can be set anytime.
195 *
196 * \since This hint is available since SDL 3.2.0.
197 */
198#define SDL_HINT_APPLE_TV_CONTROLLER_UI_EVENTS "SDL_APPLE_TV_CONTROLLER_UI_EVENTS"
199
200/**
201 * A variable controlling whether the Apple TV remote's joystick axes will
202 * automatically match the rotation of the remote.
203 *
204 * The variable can be set to the following values:
205 *
206 * - "0": Remote orientation does not affect joystick axes. (default)
207 * - "1": Joystick axes are based on the orientation of the remote.
208 *
209 * This hint can be set anytime.
210 *
211 * \since This hint is available since SDL 3.2.0.
212 */
213#define SDL_HINT_APPLE_TV_REMOTE_ALLOW_ROTATION "SDL_APPLE_TV_REMOTE_ALLOW_ROTATION"
214
215/**
216 * Specify the default ALSA audio device name.
217 *
218 * This variable is a specific audio device to open when the "default" audio
219 * device is used.
220 *
221 * This hint will be ignored when opening the default playback device if
222 * SDL_HINT_AUDIO_ALSA_DEFAULT_PLAYBACK_DEVICE is set, or when opening the
223 * default recording device if SDL_HINT_AUDIO_ALSA_DEFAULT_RECORDING_DEVICE is
224 * set.
225 *
226 * This hint should be set before an audio device is opened.
227 *
228 * \since This hint is available since SDL 3.2.0.
229 *
230 * \sa SDL_HINT_AUDIO_ALSA_DEFAULT_PLAYBACK_DEVICE
231 * \sa SDL_HINT_AUDIO_ALSA_DEFAULT_RECORDING_DEVICE
232 */
233#define SDL_HINT_AUDIO_ALSA_DEFAULT_DEVICE "SDL_AUDIO_ALSA_DEFAULT_DEVICE"
234
235/**
236 * Specify the default ALSA audio playback device name.
237 *
238 * This variable is a specific audio device to open for playback, when the
239 * "default" audio device is used.
240 *
241 * If this hint isn't set, SDL will check SDL_HINT_AUDIO_ALSA_DEFAULT_DEVICE
242 * before choosing a reasonable default.
243 *
244 * This hint should be set before an audio device is opened.
245 *
246 * \since This hint is available since SDL 3.2.0.
247 *
248 * \sa SDL_HINT_AUDIO_ALSA_DEFAULT_RECORDING_DEVICE
249 * \sa SDL_HINT_AUDIO_ALSA_DEFAULT_DEVICE
250 */
251#define SDL_HINT_AUDIO_ALSA_DEFAULT_PLAYBACK_DEVICE "SDL_AUDIO_ALSA_DEFAULT_PLAYBACK_DEVICE"
252
253/**
254 * Specify the default ALSA audio recording device name.
255 *
256 * This variable is a specific audio device to open for recording, when the
257 * "default" audio device is used.
258 *
259 * If this hint isn't set, SDL will check SDL_HINT_AUDIO_ALSA_DEFAULT_DEVICE
260 * before choosing a reasonable default.
261 *
262 * This hint should be set before an audio device is opened.
263 *
264 * \since This hint is available since SDL 3.2.0.
265 *
266 * \sa SDL_HINT_AUDIO_ALSA_DEFAULT_PLAYBACK_DEVICE
267 * \sa SDL_HINT_AUDIO_ALSA_DEFAULT_DEVICE
268 */
269#define SDL_HINT_AUDIO_ALSA_DEFAULT_RECORDING_DEVICE "SDL_AUDIO_ALSA_DEFAULT_RECORDING_DEVICE"
270
271/**
272 * A variable controlling the audio category on iOS and macOS.
273 *
274 * The variable can be set to the following values:
275 *
276 * - "ambient": Use the AVAudioSessionCategoryAmbient audio category, will be
277 *   muted by the phone mute switch (default)
278 * - "playback": Use the AVAudioSessionCategoryPlayback category.
279 *
280 * For more information, see Apple's documentation:
281 * https://developer.apple.com/library/content/documentation/Audio/Conceptual/AudioSessionProgrammingGuide/AudioSessionCategoriesandModes/AudioSessionCategoriesandModes.html
282 *
283 * This hint should be set before an audio device is opened.
284 *
285 * \since This hint is available since SDL 3.2.0.
286 */
287#define SDL_HINT_AUDIO_CATEGORY "SDL_AUDIO_CATEGORY"
288
289/**
290 * A variable controlling the default audio channel count.
291 *
292 * If the application doesn't specify the audio channel count when opening the
293 * device, this hint can be used to specify a default channel count that will
294 * be used. This defaults to "1" for recording and "2" for playback devices.
295 *
296 * This hint should be set before an audio device is opened.
297 *
298 * \since This hint is available since SDL 3.2.0.
299 */
300#define SDL_HINT_AUDIO_CHANNELS "SDL_AUDIO_CHANNELS"
301
302/**
303 * Specify an application icon name for an audio device.
304 *
305 * Some audio backends (such as Pulseaudio and Pipewire) allow you to set an
306 * XDG icon name for your application. Among other things, this icon might
307 * show up in a system control panel that lets the user adjust the volume on
308 * specific audio streams instead of using one giant master volume slider.
309 * Note that this is unrelated to the icon used by the windowing system, which
310 * may be set with SDL_SetWindowIcon (or via desktop file on Wayland).
311 *
312 * Setting this to "" or leaving it unset will have SDL use a reasonable
313 * default, "applications-games", which is likely to be installed. See
314 * https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html
315 * and
316 * https://specifications.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
317 * for the relevant XDG icon specs.
318 *
319 * This hint should be set before an audio device is opened.
320 *
321 * \since This hint is available since SDL 3.2.0.
322 */
323#define SDL_HINT_AUDIO_DEVICE_APP_ICON_NAME "SDL_AUDIO_DEVICE_APP_ICON_NAME"
324
325/**
326 * A variable controlling device buffer size.
327 *
328 * This hint is an integer > 0, that represents the size of the device's
329 * buffer in sample frames (stereo audio data in 16-bit format is 4 bytes per
330 * sample frame, for example).
331 *
332 * SDL3 generally decides this value on behalf of the app, but if for some
333 * reason the app needs to dictate this (because they want either lower
334 * latency or higher throughput AND ARE WILLING TO DEAL WITH what that might
335 * require of the app), they can specify it.
336 *
337 * SDL will try to accommodate this value, but there is no promise you'll get
338 * the buffer size requested. Many platforms won't honor this request at all,
339 * or might adjust it.
340 *
341 * This hint should be set before an audio device is opened.
342 *
343 * \since This hint is available since SDL 3.2.0.
344 */
345#define SDL_HINT_AUDIO_DEVICE_SAMPLE_FRAMES "SDL_AUDIO_DEVICE_SAMPLE_FRAMES"
346
347/**
348 * Specify an audio stream name for an audio device.
349 *
350 * Some audio backends (such as PulseAudio) allow you to describe your audio
351 * stream. Among other things, this description might show up in a system
352 * control panel that lets the user adjust the volume on specific audio
353 * streams instead of using one giant master volume slider.
354 *
355 * This hints lets you transmit that information to the OS. The contents of
356 * this hint are used while opening an audio device. You should use a string
357 * that describes your what your program is playing ("audio stream" is
358 * probably sufficient in many cases, but this could be useful for something
359 * like "team chat" if you have a headset playing VoIP audio separately).
360 *
361 * Setting this to "" or leaving it unset will have SDL use a reasonable
362 * default: "audio stream" or something similar.
363 *
364 * Note that while this talks about audio streams, this is an OS-level
365 * concept, so it applies to a physical audio device in this case, and not an
366 * SDL_AudioStream, nor an SDL logical audio device.
367 *
368 * This hint should be set before an audio device is opened.
369 *
370 * \since This hint is available since SDL 3.2.0.
371 */
372#define SDL_HINT_AUDIO_DEVICE_STREAM_NAME "SDL_AUDIO_DEVICE_STREAM_NAME"
373
374/**
375 * Specify an application role for an audio device.
376 *
377 * Some audio backends (such as Pipewire) allow you to describe the role of
378 * your audio stream. Among other things, this description might show up in a
379 * system control panel or software for displaying and manipulating media
380 * playback/recording graphs.
381 *
382 * This hints lets you transmit that information to the OS. The contents of
383 * this hint are used while opening an audio device. You should use a string
384 * that describes your what your program is playing (Game, Music, Movie,
385 * etc...).
386 *
387 * Setting this to "" or leaving it unset will have SDL use a reasonable
388 * default: "Game" or something similar.
389 *
390 * Note that while this talks about audio streams, this is an OS-level
391 * concept, so it applies to a physical audio device in this case, and not an
392 * SDL_AudioStream, nor an SDL logical audio device.
393 *
394 * For Windows WASAPI audio, the following roles are supported, and map to
395 * `AUDIO_STREAM_CATEGORY`:
396 *
397 * - "Other" (default)
398 * - "Communications" - Real-time communications, such as VOIP or chat
399 * - "Game" - Game audio
400 * - "GameChat" - Game chat audio, similar to "Communications" except that
401 *   this will not attenuate other audio streams
402 * - "Movie" - Music or sound with dialog
403 * - "Media" - Music or sound without dialog
404 *
405 * If your application applies its own echo cancellation, gain control, and
406 * noise reduction it should also set SDL_HINT_AUDIO_DEVICE_RAW_STREAM.
407 *
408 * This hint should be set before an audio device is opened.
409 *
410 * \since This hint is available since SDL 3.2.0.
411 */
412#define SDL_HINT_AUDIO_DEVICE_STREAM_ROLE "SDL_AUDIO_DEVICE_STREAM_ROLE"
413
414/**
415 * Specify whether this audio device should do audio processing.
416 *
417 * Some operating systems perform echo cancellation, gain control, and noise
418 * reduction as needed. If your application already handles these, you can set
419 * this hint to prevent the OS from doing additional audio processing.
420 *
421 * This corresponds to the WASAPI audio option `AUDCLNT_STREAMOPTIONS_RAW`.
422 *
423 * The variable can be set to the following values:
424 *
425 * - "0": audio processing can be done by the OS. (default)
426 * - "1": audio processing is done by the application.
427 *
428 * This hint should be set before an audio device is opened.
429 *
430 * \since This hint is available since SDL 3.4.0.
431 */
432#define SDL_HINT_AUDIO_DEVICE_RAW_STREAM "SDL_AUDIO_DEVICE_RAW_STREAM"
433
434/**
435 * Specify the input file when recording audio using the disk audio driver.
436 *
437 * This defaults to "sdlaudio-in.raw"
438 *
439 * This hint should be set before an audio device is opened.
440 *
441 * \since This hint is available since SDL 3.2.0.
442 */
443#define SDL_HINT_AUDIO_DISK_INPUT_FILE "SDL_AUDIO_DISK_INPUT_FILE"
444
445/**
446 * Specify the output file when playing audio using the disk audio driver.
447 *
448 * This defaults to "sdlaudio.raw"
449 *
450 * This hint should be set before an audio device is opened.
451 *
452 * \since This hint is available since SDL 3.2.0.
453 */
454#define SDL_HINT_AUDIO_DISK_OUTPUT_FILE "SDL_AUDIO_DISK_OUTPUT_FILE"
455
456/**
457 * A variable controlling the audio rate when using the disk audio driver.
458 *
459 * The disk audio driver normally simulates real-time for the audio rate that
460 * was specified, but you can use this variable to adjust this rate higher or
461 * lower down to 0. The default value is "1.0".
462 *
463 * This hint should be set before an audio device is opened.
464 *
465 * \since This hint is available since SDL 3.2.0.
466 */
467#define SDL_HINT_AUDIO_DISK_TIMESCALE "SDL_AUDIO_DISK_TIMESCALE"
468
469/**
470 * A variable that specifies an audio backend to use.
471 *
472 * By default, SDL will try all available audio backends in a reasonable order
473 * until it finds one that can work, but this hint allows the app or user to
474 * force a specific driver, such as "pipewire" if, say, you are on PulseAudio
475 * but want to try talking to the lower level instead.
476 *
477 * This hint should be set before SDL is initialized.
478 *
479 * \since This hint is available since SDL 3.2.0.
480 */
481#define SDL_HINT_AUDIO_DRIVER "SDL_AUDIO_DRIVER"
482
483/**
484 * A variable controlling the audio rate when using the dummy audio driver.
485 *
486 * The dummy audio driver normally simulates real-time for the audio rate that
487 * was specified, but you can use this variable to adjust this rate higher or
488 * lower down to 0. The default value is "1.0".
489 *
490 * This hint should be set before an audio device is opened.
491 *
492 * \since This hint is available since SDL 3.2.0.
493 */
494#define SDL_HINT_AUDIO_DUMMY_TIMESCALE "SDL_AUDIO_DUMMY_TIMESCALE"
495
496/**
497 * A variable controlling the default audio format.
498 *
499 * If the application doesn't specify the audio format when opening the
500 * device, this hint can be used to specify a default format that will be
501 * used.
502 *
503 * The variable can be set to the following values:
504 *
505 * - "U8": Unsigned 8-bit audio
506 * - "S8": Signed 8-bit audio
507 * - "S16LE": Signed 16-bit little-endian audio
508 * - "S16BE": Signed 16-bit big-endian audio
509 * - "S16": Signed 16-bit native-endian audio (default)
510 * - "S32LE": Signed 32-bit little-endian audio
511 * - "S32BE": Signed 32-bit big-endian audio
512 * - "S32": Signed 32-bit native-endian audio
513 * - "F32LE": Floating point little-endian audio
514 * - "F32BE": Floating point big-endian audio
515 * - "F32": Floating point native-endian audio
516 *
517 * This hint should be set before an audio device is opened.
518 *
519 * \since This hint is available since SDL 3.2.0.
520 */
521#define SDL_HINT_AUDIO_FORMAT "SDL_AUDIO_FORMAT"
522
523/**
524 * A variable controlling the default audio frequency.
525 *
526 * If the application doesn't specify the audio frequency when opening the
527 * device, this hint can be used to specify a default frequency that will be
528 * used. This defaults to "44100".
529 *
530 * This hint should be set before an audio device is opened.
531 *
532 * \since This hint is available since SDL 3.2.0.
533 */
534#define SDL_HINT_AUDIO_FREQUENCY "SDL_AUDIO_FREQUENCY"
535
536/**
537 * A variable that causes SDL to not ignore audio "monitors".
538 *
539 * This is currently only used by the PulseAudio driver.
540 *
541 * By default, SDL ignores audio devices that aren't associated with physical
542 * hardware. Changing this hint to "1" will expose anything SDL sees that
543 * appears to be an audio source or sink. This will add "devices" to the list
544 * that the user probably doesn't want or need, but it can be useful in
545 * scenarios where you want to hook up SDL to some sort of virtual device,
546 * etc.
547 *
548 * The variable can be set to the following values:
549 *
550 * - "0": Audio monitor devices will be ignored. (default)
551 * - "1": Audio monitor devices will show up in the device list.
552 *
553 * This hint should be set before SDL is initialized.
554 *
555 * \since This hint is available since SDL 3.2.0.
556 */
557#define SDL_HINT_AUDIO_INCLUDE_MONITORS "SDL_AUDIO_INCLUDE_MONITORS"
558
559/**
560 * A variable controlling whether SDL updates joystick state when getting
561 * input events.
562 *
563 * The variable can be set to the following values:
564 *
565 * - "0": You'll call SDL_UpdateJoysticks() manually.
566 * - "1": SDL will automatically call SDL_UpdateJoysticks(). (default)
567 *
568 * This hint can be set anytime.
569 *
570 * \since This hint is available since SDL 3.2.0.
571 */
572#define SDL_HINT_AUTO_UPDATE_JOYSTICKS "SDL_AUTO_UPDATE_JOYSTICKS"
573
574/**
575 * A variable controlling whether SDL updates sensor state when getting input
576 * events.
577 *
578 * The variable can be set to the following values:
579 *
580 * - "0": You'll call SDL_UpdateSensors() manually.
581 * - "1": SDL will automatically call SDL_UpdateSensors(). (default)
582 *
583 * This hint can be set anytime.
584 *
585 * \since This hint is available since SDL 3.2.0.
586 */
587#define SDL_HINT_AUTO_UPDATE_SENSORS "SDL_AUTO_UPDATE_SENSORS"
588
589/**
590 * Prevent SDL from using version 4 of the bitmap header when saving BMPs.
591 *
592 * The bitmap header version 4 is required for proper alpha channel support
593 * and SDL will use it when required. Should this not be desired, this hint
594 * can force the use of the 40 byte header version which is supported
595 * everywhere.
596 *
597 * The variable can be set to the following values:
598 *
599 * - "0": Surfaces with a colorkey or an alpha channel are saved to a 32-bit
600 *   BMP file with an alpha mask. SDL will use the bitmap header version 4 and
601 *   set the alpha mask accordingly. (default)
602 * - "1": Surfaces with a colorkey or an alpha channel are saved to a 32-bit
603 *   BMP file without an alpha mask. The alpha channel data will be in the
604 *   file, but applications are going to ignore it.
605 *
606 * This hint can be set anytime.
607 *
608 * \since This hint is available since SDL 3.2.0.
609 */
610#define SDL_HINT_BMP_SAVE_LEGACY_FORMAT "SDL_BMP_SAVE_LEGACY_FORMAT"
611
612/**
613 * A variable that decides what camera backend to use.
614 *
615 * By default, SDL will try all available camera backends in a reasonable
616 * order until it finds one that can work, but this hint allows the app or
617 * user to force a specific target, such as "directshow" if, say, you are on
618 * Windows Media Foundations but want to try DirectShow instead.
619 *
620 * The default value is unset, in which case SDL will try to figure out the
621 * best camera backend on your behalf. This hint needs to be set before
622 * SDL_Init() is called to be useful.
623 *
624 * \since This hint is available since SDL 3.2.0.
625 */
626#define SDL_HINT_CAMERA_DRIVER "SDL_CAMERA_DRIVER"
627
628/**
629 * A variable that limits what CPU features are available.
630 *
631 * By default, SDL marks all features the current CPU supports as available.
632 * This hint allows the enabled features to be limited to a subset.
633 *
634 * When the hint is unset, or empty, SDL will enable all detected CPU
635 * features.
636 *
637 * The variable can be set to a comma separated list containing the following
638 * items:
639 *
640 * - "all"
641 * - "altivec"
642 * - "sse"
643 * - "sse2"
644 * - "sse3"
645 * - "sse41"
646 * - "sse42"
647 * - "avx"
648 * - "avx2"
649 * - "avx512f"
650 * - "arm-simd"
651 * - "neon"
652 * - "lsx"
653 * - "lasx"
654 *
655 * The items can be prefixed by '+'/'-' to add/remove features.
656 *
657 * \since This hint is available since SDL 3.2.0.
658 */
659#define SDL_HINT_CPU_FEATURE_MASK "SDL_CPU_FEATURE_MASK"
660
661/**
662 * A variable controlling whether DirectInput should be used for controllers.
663 *
664 * The variable can be set to the following values:
665 *
666 * - "0": Disable DirectInput detection.
667 * - "1": Enable DirectInput detection. (default)
668 *
669 * This hint should be set before SDL is initialized.
670 *
671 * \since This hint is available since SDL 3.2.0.
672 */
673#define SDL_HINT_JOYSTICK_DIRECTINPUT "SDL_JOYSTICK_DIRECTINPUT"
674
675/**
676 * A variable that specifies a dialog backend to use.
677 *
678 * By default, SDL will try all available dialog backends in a reasonable
679 * order until it finds one that can work, but this hint allows the app or
680 * user to force a specific target.
681 *
682 * If the specified target does not exist or is not available, the
683 * dialog-related function calls will fail.
684 *
685 * This hint currently only applies to platforms using the generic "Unix"
686 * dialog implementation, but may be extended to more platforms in the future.
687 * Note that some Unix and Unix-like platforms have their own implementation,
688 * such as macOS and Haiku.
689 *
690 * The variable can be set to the following values:
691 *
692 * - NULL: Select automatically (default, all platforms)
693 * - "portal": Use XDG Portals through DBus (Unix only)
694 * - "zenity": Use the Zenity program (Unix only)
695 *
696 * More options may be added in the future.
697 *
698 * This hint can be set anytime.
699 *
700 * \since This hint is available since SDL 3.2.0.
701 */
702#define SDL_HINT_FILE_DIALOG_DRIVER "SDL_FILE_DIALOG_DRIVER"
703
704/**
705 * Override for SDL_GetDisplayUsableBounds().
706 *
707 * If set, this hint will override the expected results for
708 * SDL_GetDisplayUsableBounds() for display index 0. Generally you don't want
709 * to do this, but this allows an embedded system to request that some of the
710 * screen be reserved for other uses when paired with a well-behaved
711 * application.
712 *
713 * The contents of this hint must be 4 comma-separated integers, the first is
714 * the bounds x, then y, width and height, in that order.
715 *
716 * This hint can be set anytime.
717 *
718 * \since This hint is available since SDL 3.2.0.
719 */
720#define SDL_HINT_DISPLAY_USABLE_BOUNDS "SDL_DISPLAY_USABLE_BOUNDS"
721
722/**
723 * Set the level of checking for invalid parameters passed to SDL functions.
724 *
725 * The variable can be set to the following values:
726 *
727 * - "1": Enable fast parameter error checking, e.g. quick NULL checks, etc.
728 * - "2": Enable full parameter error checking, e.g. validating objects are
729 *   the correct type, etc. (default)
730 *
731 * This hint can be set anytime.
732 *
733 * \since This hint is available since SDL 3.4.0.
734 */
735#define SDL_HINT_INVALID_PARAM_CHECKS "SDL_INVALID_PARAM_CHECKS"
736
737/**
738 * Disable giving back control to the browser automatically when running with
739 * asyncify.
740 *
741 * With -s ASYNCIFY, SDL calls emscripten_sleep during operations such as
742 * refreshing the screen or polling events.
743 *
744 * This hint only applies to the emscripten platform.
745 *
746 * The variable can be set to the following values:
747 *
748 * - "0": Disable emscripten_sleep calls (if you give back browser control
749 *   manually or use asyncify for other purposes).
750 * - "1": Enable emscripten_sleep calls. (default)
751 *
752 * This hint can be set anytime.
753 *
754 * \since This hint is available since SDL 3.2.0.
755 */
756#define SDL_HINT_EMSCRIPTEN_ASYNCIFY "SDL_EMSCRIPTEN_ASYNCIFY"
757
758/**
759 * Specify the CSS selector used for the "default" window/canvas.
760 *
761 * This hint only applies to the emscripten platform.
762 *
763 * This hint should be set before creating a window.
764 *
765 * \since This hint is available since SDL 3.2.0.
766 */
767#define SDL_HINT_EMSCRIPTEN_CANVAS_SELECTOR "SDL_EMSCRIPTEN_CANVAS_SELECTOR"
768
769/**
770 * Override the binding element for keyboard inputs for Emscripten builds.
771 *
772 * This hint only applies to the emscripten platform.
773 *
774 * The variable can be one of:
775 *
776 * - "#window": the javascript window object
777 * - "#document": the javascript document object
778 * - "#screen": the javascript window.screen object
779 * - "#canvas": the WebGL canvas element
780 * - "#none": Don't bind anything at all
781 * - any other string without a leading # sign applies to the element on the
782 *   page with that ID.
783 *
784 * This hint should be set before creating a window.
785 *
786 * \since This hint is available since SDL 3.2.0.
787 */
788#define SDL_HINT_EMSCRIPTEN_KEYBOARD_ELEMENT "SDL_EMSCRIPTEN_KEYBOARD_ELEMENT"
789
790/**
791 * A variable that controls whether the on-screen keyboard should be shown
792 * when text input is active.
793 *
794 * The variable can be set to the following values:
795 *
796 * - "auto": The on-screen keyboard will be shown if there is no physical
797 *   keyboard attached. (default)
798 * - "0": Do not show the on-screen keyboard.
799 * - "1": Show the on-screen keyboard, if available.
800 *
801 * This hint must be set before SDL_StartTextInput() is called
802 *
803 * \since This hint is available since SDL 3.2.0.
804 */
805#define SDL_HINT_ENABLE_SCREEN_KEYBOARD "SDL_ENABLE_SCREEN_KEYBOARD"
806
807/**
808 * A variable containing a list of evdev devices to use if udev is not
809 * available.
810 *
811 * The list of devices is in the form:
812 *
813 * deviceclass:path[,deviceclass:path[,...]]
814 *
815 * where device class is an integer representing the SDL_UDEV_deviceclass and
816 * path is the full path to the event device.
817 *
818 * This hint should be set before SDL is initialized.
819 *
820 * \since This hint is available since SDL 3.2.0.
821 */
822#define SDL_HINT_EVDEV_DEVICES "SDL_EVDEV_DEVICES"
823
824/**
825 * A variable controlling verbosity of the logging of SDL events pushed onto
826 * the internal queue.
827 *
828 * The variable can be set to the following values, from least to most
829 * verbose:
830 *
831 * - "0": Don't log any events. (default)
832 * - "1": Log most events (other than the really spammy ones).
833 * - "2": Include mouse and finger motion events.
834 *
835 * This is generally meant to be used to debug SDL itself, but can be useful
836 * for application developers that need better visibility into what is going
837 * on in the event queue. Logged events are sent through SDL_Log(), which
838 * means by default they appear on stdout on most platforms or maybe
839 * OutputDebugString() on Windows, and can be funneled by the app with
840 * SDL_SetLogOutputFunction(), etc.
841 *
842 * This hint can be set anytime.
843 *
844 * \since This hint is available since SDL 3.2.0.
845 */
846#define SDL_HINT_EVENT_LOGGING "SDL_EVENT_LOGGING"
847
848/**
849 * A variable controlling whether raising the window should be done more
850 * forcefully.
851 *
852 * The variable can be set to the following values:
853 *
854 * - "0": Honor the OS policy for raising windows. (default)
855 * - "1": Force the window to be raised, overriding any OS policy.
856 *
857 * At present, this is only an issue under MS Windows, which makes it nearly
858 * impossible to programmatically move a window to the foreground, for
859 * "security" reasons. See http://stackoverflow.com/a/34414846 for a
860 * discussion.
861 *
862 * This hint can be set anytime.
863 *
864 * \since This hint is available since SDL 3.2.0.
865 */
866#define SDL_HINT_FORCE_RAISEWINDOW "SDL_FORCE_RAISEWINDOW"
867
868/**
869 * A variable controlling how 3D acceleration is used to accelerate the SDL
870 * screen surface.
871 *
872 * SDL can try to accelerate the SDL screen surface by using streaming
873 * textures with a 3D rendering engine. This variable controls whether and how
874 * this is done.
875 *
876 * The variable can be set to the following values:
877 *
878 * - "0": Disable 3D acceleration
879 * - "1": Enable 3D acceleration, using the default renderer. (default)
880 * - "X": Enable 3D acceleration, using X where X is one of the valid
881 *   rendering drivers. (e.g. "direct3d", "opengl", etc.)
882 *
883 * This hint should be set before calling SDL_GetWindowSurface()
884 *
885 * \since This hint is available since SDL 3.2.0.
886 */
887#define SDL_HINT_FRAMEBUFFER_ACCELERATION "SDL_FRAMEBUFFER_ACCELERATION"
888
889/**
890 * A variable that lets you manually hint extra gamecontroller db entries.
891 *
892 * The variable should be newline delimited rows of gamecontroller config
893 * data, see SDL_gamepad.h
894 *
895 * You can update mappings after SDL is initialized with
896 * SDL_GetGamepadMappingForGUID() and SDL_AddGamepadMapping()
897 *
898 * This hint should be set before SDL is initialized.
899 *
900 * \since This hint is available since SDL 3.2.0.
901 */
902#define SDL_HINT_GAMECONTROLLERCONFIG "SDL_GAMECONTROLLERCONFIG"
903
904/**
905 * A variable that lets you provide a file with extra gamecontroller db
906 * entries.
907 *
908 * The file should contain lines of gamecontroller config data, see
909 * SDL_gamepad.h
910 *
911 * You can update mappings after SDL is initialized with
912 * SDL_GetGamepadMappingForGUID() and SDL_AddGamepadMapping()
913 *
914 * This hint should be set before SDL is initialized.
915 *
916 * \since This hint is available since SDL 3.2.0.
917 */
918#define SDL_HINT_GAMECONTROLLERCONFIG_FILE "SDL_GAMECONTROLLERCONFIG_FILE"
919
920/**
921 * A variable that overrides the automatic controller type detection.
922 *
923 * The variable should be comma separated entries, in the form: VID/PID=type
924 *
925 * The VID and PID should be hexadecimal with exactly 4 digits, e.g. 0x00fd
926 *
927 * This hint affects what low level protocol is used with the HIDAPI driver.
928 *
929 * The variable can be set to the following values:
930 *
931 * - "Xbox360"
932 * - "XboxOne"
933 * - "PS3"
934 * - "PS4"
935 * - "PS5"
936 * - "SwitchPro"
937 *
938 * This hint should be set before SDL is initialized.
939 *
940 * \since This hint is available since SDL 3.2.0.
941 */
942#define SDL_HINT_GAMECONTROLLERTYPE "SDL_GAMECONTROLLERTYPE"
943
944/**
945 * A variable containing a list of devices to skip when scanning for game
946 * controllers.
947 *
948 * The format of the string is a comma separated list of USB VID/PID pairs in
949 * hexadecimal form, e.g.
950 *
951 * 0xAAAA/0xBBBB,0xCCCC/0xDDDD
952 *
953 * The variable can also take the form of "@file", in which case the named
954 * file will be loaded and interpreted as the value of the variable.
955 *
956 * This hint can be set anytime.
957 *
958 * \since This hint is available since SDL 3.2.0.
959 */
960#define SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES "SDL_GAMECONTROLLER_IGNORE_DEVICES"
961
962/**
963 * If set, all devices will be skipped when scanning for game controllers
964 * except for the ones listed in this variable.
965 *
966 * The format of the string is a comma separated list of USB VID/PID pairs in
967 * hexadecimal form, e.g.
968 *
969 * 0xAAAA/0xBBBB,0xCCCC/0xDDDD
970 *
971 * The variable can also take the form of "@file", in which case the named
972 * file will be loaded and interpreted as the value of the variable.
973 *
974 * This hint can be set anytime.
975 *
976 * \since This hint is available since SDL 3.2.0.
977 */
978#define SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT "SDL_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT"
979
980/**
981 * A variable that controls whether the device's built-in accelerometer and
982 * gyro should be used as sensors for gamepads.
983 *
984 * The variable can be set to the following values:
985 *
986 * - "0": Sensor fusion is disabled
987 * - "1": Sensor fusion is enabled for all controllers that lack sensors
988 *
989 * Or the variable can be a comma separated list of USB VID/PID pairs in
990 * hexadecimal form, e.g.
991 *
992 * 0xAAAA/0xBBBB,0xCCCC/0xDDDD
993 *
994 * The variable can also take the form of "@file", in which case the named
995 * file will be loaded and interpreted as the value of the variable.
996 *
997 * This hint should be set before a gamepad is opened.
998 *
999 * \since This hint is available since SDL 3.2.0.
1000 */
1001#define SDL_HINT_GAMECONTROLLER_SENSOR_FUSION "SDL_GAMECONTROLLER_SENSOR_FUSION"
1002
1003/**
1004 * This variable sets the default text of the TextInput window on GDK
1005 * platforms.
1006 *
1007 * This hint is available only if SDL_GDK_TEXTINPUT defined.
1008 *
1009 * This hint should be set before calling SDL_StartTextInput()
1010 *
1011 * \since This hint is available since SDL 3.2.0.
1012 */
1013#define SDL_HINT_GDK_TEXTINPUT_DEFAULT_TEXT "SDL_GDK_TEXTINPUT_DEFAULT_TEXT"
1014
1015/**
1016 * This variable sets the description of the TextInput window on GDK
1017 * platforms.
1018 *
1019 * This hint is available only if SDL_GDK_TEXTINPUT defined.
1020 *
1021 * This hint should be set before calling SDL_StartTextInput()
1022 *
1023 * \since This hint is available since SDL 3.2.0.
1024 */
1025#define SDL_HINT_GDK_TEXTINPUT_DESCRIPTION "SDL_GDK_TEXTINPUT_DESCRIPTION"
1026
1027/**
1028 * This variable sets the maximum input length of the TextInput window on GDK
1029 * platforms.
1030 *
1031 * The value must be a stringified integer, for example "10" to allow for up
1032 * to 10 characters of text input.
1033 *
1034 * This hint is available only if SDL_GDK_TEXTINPUT defined.
1035 *
1036 * This hint should be set before calling SDL_StartTextInput()
1037 *
1038 * \since This hint is available since SDL 3.2.0.
1039 */
1040#define SDL_HINT_GDK_TEXTINPUT_MAX_LENGTH "SDL_GDK_TEXTINPUT_MAX_LENGTH"
1041
1042/**
1043 * This variable sets the input scope of the TextInput window on GDK
1044 * platforms.
1045 *
1046 * Set this hint to change the XGameUiTextEntryInputScope value that will be
1047 * passed to the window creation function. The value must be a stringified
1048 * integer, for example "0" for XGameUiTextEntryInputScope::Default.
1049 *
1050 * This hint is available only if SDL_GDK_TEXTINPUT defined.
1051 *
1052 * This hint should be set before calling SDL_StartTextInput()
1053 *
1054 * \since This hint is available since SDL 3.2.0.
1055 */
1056#define SDL_HINT_GDK_TEXTINPUT_SCOPE "SDL_GDK_TEXTINPUT_SCOPE"
1057
1058/**
1059 * This variable sets the title of the TextInput window on GDK platforms.
1060 *
1061 * This hint is available only if SDL_GDK_TEXTINPUT defined.
1062 *
1063 * This hint should be set before calling SDL_StartTextInput()
1064 *
1065 * \since This hint is available since SDL 3.2.0.
1066 */
1067#define SDL_HINT_GDK_TEXTINPUT_TITLE "SDL_GDK_TEXTINPUT_TITLE"
1068
1069/**
1070 * A variable to control whether HIDAPI uses libusb for device access.
1071 *
1072 * By default libusb will only be used for a few devices that require direct
1073 * USB access, and this can be controlled with
1074 * SDL_HINT_HIDAPI_LIBUSB_WHITELIST.
1075 *
1076 * The variable can be set to the following values:
1077 *
1078 * - "0": HIDAPI will not use libusb for device access.
1079 * - "1": HIDAPI will use libusb for device access if available. (default)
1080 *
1081 * This hint should be set before SDL is initialized.
1082 *
1083 * \since This hint is available since SDL 3.2.0.
1084 */
1085#define SDL_HINT_HIDAPI_LIBUSB "SDL_HIDAPI_LIBUSB"
1086
1087/**
1088 * A variable to control whether HIDAPI uses libusb only for whitelisted
1089 * devices.
1090 *
1091 * By default libusb will only be used for a few devices that require direct
1092 * USB access.
1093 *
1094 * The variable can be set to the following values:
1095 *
1096 * - "0": HIDAPI will use libusb for all device access.
1097 * - "1": HIDAPI will use libusb only for whitelisted devices. (default)
1098 *
1099 * This hint should be set before SDL is initialized.
1100 *
1101 * \since This hint is available since SDL 3.2.0.
1102 */
1103#define SDL_HINT_HIDAPI_LIBUSB_WHITELIST "SDL_HIDAPI_LIBUSB_WHITELIST"
1104
1105/**
1106 * A variable to control whether HIDAPI uses udev for device detection.
1107 *
1108 * The variable can be set to the following values:
1109 *
1110 * - "0": HIDAPI will poll for device changes.
1111 * - "1": HIDAPI will use udev for device detection. (default)
1112 *
1113 * This hint should be set before SDL is initialized.
1114 *
1115 * \since This hint is available since SDL 3.2.0.
1116 */
1117#define SDL_HINT_HIDAPI_UDEV "SDL_HIDAPI_UDEV"
1118
1119/**
1120 * A variable that specifies a GPU backend to use.
1121 *
1122 * By default, SDL will try all available GPU backends in a reasonable order
1123 * until it finds one that can work, but this hint allows the app or user to
1124 * force a specific target, such as "direct3d12" if, say, your hardware
1125 * supports Vulkan but you want to try using D3D12 instead.
1126 *
1127 * This hint should be set before any GPU functions are called.
1128 *
1129 * \since This hint is available since SDL 3.2.0.
1130 */
1131#define SDL_HINT_GPU_DRIVER "SDL_GPU_DRIVER"
1132
1133/**
1134 * A variable to control whether SDL_hid_enumerate() enumerates all HID
1135 * devices or only controllers.
1136 *
1137 * The variable can be set to the following values:
1138 *
1139 * - "0": SDL_hid_enumerate() will enumerate all HID devices.
1140 * - "1": SDL_hid_enumerate() will only enumerate controllers. (default)
1141 *
1142 * By default SDL will only enumerate controllers, to reduce risk of hanging
1143 * or crashing on devices with bad drivers and avoiding macOS keyboard capture
1144 * permission prompts.
1145 *
1146 * This hint can be set anytime.
1147 *
1148 * \since This hint is available since SDL 3.2.0.
1149 */
1150#define SDL_HINT_HIDAPI_ENUMERATE_ONLY_CONTROLLERS "SDL_HIDAPI_ENUMERATE_ONLY_CONTROLLERS"
1151
1152/**
1153 * A variable containing a list of devices to ignore in SDL_hid_enumerate().
1154 *
1155 * The format of the string is a comma separated list of USB VID/PID pairs in
1156 * hexadecimal form, e.g.
1157 *
1158 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
1159 *
1160 * For example, to ignore the Shanwan DS3 controller and any Valve controller,
1161 * you might use the string "0x2563/0x0523,0x28de/0x0000"
1162 *
1163 * This hint can be set anytime.
1164 *
1165 * \since This hint is available since SDL 3.2.0.
1166 */
1167#define SDL_HINT_HIDAPI_IGNORE_DEVICES "SDL_HIDAPI_IGNORE_DEVICES"
1168
1169/**
1170 * A variable describing what IME UI elements the application can display.
1171 *
1172 * By default IME UI is handled using native components by the OS where
1173 * possible, however this can interfere with or not be visible when exclusive
1174 * fullscreen mode is used.
1175 *
1176 * The variable can be set to a comma separated list containing the following
1177 * items:
1178 *
1179 * - "none" or "0": The application can't render any IME elements, and native
1180 *   UI should be used. (default)
1181 * - "composition": The application handles SDL_EVENT_TEXT_EDITING events and
1182 *   can render the composition text.
1183 * - "candidates": The application handles SDL_EVENT_TEXT_EDITING_CANDIDATES
1184 *   and can render the candidate list.
1185 *
1186 * This hint should be set before SDL is initialized.
1187 *
1188 * \since This hint is available since SDL 3.2.0.
1189 */
1190#define SDL_HINT_IME_IMPLEMENTED_UI "SDL_IME_IMPLEMENTED_UI"
1191
1192/**
1193 * A variable controlling whether the home indicator bar on iPhone X and later
1194 * should be hidden.
1195 *
1196 * The variable can be set to the following values:
1197 *
1198 * - "0": The indicator bar is not hidden. (default for windowed applications)
1199 * - "1": The indicator bar is hidden and is shown when the screen is touched
1200 *   (useful for movie playback applications).
1201 * - "2": The indicator bar is dim and the first swipe makes it visible and
1202 *   the second swipe performs the "home" action. (default for fullscreen
1203 *   applications)
1204 *
1205 * This hint can be set anytime.
1206 *
1207 * \since This hint is available since SDL 3.2.0.
1208 */
1209#define SDL_HINT_IOS_HIDE_HOME_INDICATOR "SDL_IOS_HIDE_HOME_INDICATOR"
1210
1211/**
1212 * A variable that lets you enable joystick (and gamecontroller) events even
1213 * when your app is in the background.
1214 *
1215 * The variable can be set to the following values:
1216 *
1217 * - "0": Disable joystick & gamecontroller input events when the application
1218 *   is in the background. (default)
1219 * - "1": Enable joystick & gamecontroller input events when the application
1220 *   is in the background.
1221 *
1222 * This hint can be set anytime.
1223 *
1224 * \since This hint is available since SDL 3.2.0.
1225 */
1226#define SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS "SDL_JOYSTICK_ALLOW_BACKGROUND_EVENTS"
1227
1228/**
1229 * A variable containing a list of arcade stick style controllers.
1230 *
1231 * The format of the string is a comma separated list of USB VID/PID pairs in
1232 * hexadecimal form, e.g.
1233 *
1234 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
1235 *
1236 * The variable can also take the form of "@file", in which case the named
1237 * file will be loaded and interpreted as the value of the variable.
1238 *
1239 * This hint can be set anytime.
1240 *
1241 * \since This hint is available since SDL 3.2.0.
1242 */
1243#define SDL_HINT_JOYSTICK_ARCADESTICK_DEVICES "SDL_JOYSTICK_ARCADESTICK_DEVICES"
1244
1245/**
1246 * A variable containing a list of devices that are not arcade stick style
1247 * controllers.
1248 *
1249 * This will override SDL_HINT_JOYSTICK_ARCADESTICK_DEVICES and the built in
1250 * device list.
1251 *
1252 * The format of the string is a comma separated list of USB VID/PID pairs in
1253 * hexadecimal form, e.g.
1254 *
1255 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
1256 *
1257 * The variable can also take the form of "@file", in which case the named
1258 * file will be loaded and interpreted as the value of the variable.
1259 *
1260 * This hint can be set anytime.
1261 *
1262 * \since This hint is available since SDL 3.2.0.
1263 */
1264#define SDL_HINT_JOYSTICK_ARCADESTICK_DEVICES_EXCLUDED "SDL_JOYSTICK_ARCADESTICK_DEVICES_EXCLUDED"
1265
1266/**
1267 * A variable containing a list of devices that should not be considered
1268 * joysticks.
1269 *
1270 * The format of the string is a comma separated list of USB VID/PID pairs in
1271 * hexadecimal form, e.g.
1272 *
1273 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
1274 *
1275 * The variable can also take the form of "@file", in which case the named
1276 * file will be loaded and interpreted as the value of the variable.
1277 *
1278 * This hint can be set anytime.
1279 *
1280 * \since This hint is available since SDL 3.2.0.
1281 */
1282#define SDL_HINT_JOYSTICK_BLACKLIST_DEVICES "SDL_JOYSTICK_BLACKLIST_DEVICES"
1283
1284/**
1285 * A variable containing a list of devices that should be considered
1286 * joysticks.
1287 *
1288 * This will override SDL_HINT_JOYSTICK_BLACKLIST_DEVICES and the built in
1289 * device list.
1290 *
1291 * The format of the string is a comma separated list of USB VID/PID pairs in
1292 * hexadecimal form, e.g.
1293 *
1294 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
1295 *
1296 * The variable can also take the form of "@file", in which case the named
1297 * file will be loaded and interpreted as the value of the variable.
1298 *
1299 * This hint can be set anytime.
1300 *
1301 * \since This hint is available since SDL 3.2.0.
1302 */
1303#define SDL_HINT_JOYSTICK_BLACKLIST_DEVICES_EXCLUDED "SDL_JOYSTICK_BLACKLIST_DEVICES_EXCLUDED"
1304
1305/**
1306 * A variable containing a comma separated list of devices to open as
1307 * joysticks.
1308 *
1309 * This variable is currently only used by the Linux joystick driver.
1310 *
1311 * \since This hint is available since SDL 3.2.0.
1312 */
1313#define SDL_HINT_JOYSTICK_DEVICE "SDL_JOYSTICK_DEVICE"
1314
1315/**
1316 * A variable controlling whether enhanced reports should be used for
1317 * controllers when using the HIDAPI driver.
1318 *
1319 * Enhanced reports allow rumble and effects on Bluetooth PlayStation
1320 * controllers and gyro on Nintendo Switch controllers, but break Windows
1321 * DirectInput for other applications that don't use SDL.
1322 *
1323 * Once enhanced reports are enabled, they can't be disabled on PlayStation
1324 * controllers without power cycling the controller.
1325 *
1326 * The variable can be set to the following values:
1327 *
1328 * - "0": enhanced reports are not enabled.
1329 * - "1": enhanced reports are enabled. (default)
1330 * - "auto": enhanced features are advertised to the application, but SDL
1331 *   doesn't change the controller report mode unless the application uses
1332 *   them.
1333 *
1334 * This hint can be enabled anytime.
1335 *
1336 * \since This hint is available since SDL 3.2.0.
1337 */
1338#define SDL_HINT_JOYSTICK_ENHANCED_REPORTS "SDL_JOYSTICK_ENHANCED_REPORTS"
1339
1340/**
1341 * A variable containing a list of flightstick style controllers.
1342 *
1343 * The format of the string is a comma separated list of USB VID/PID pairs in
1344 * hexadecimal form, e.g.
1345 *
1346 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
1347 *
1348 * The variable can also take the form of @file, in which case the named file
1349 * will be loaded and interpreted as the value of the variable.
1350 *
1351 * This hint can be set anytime.
1352 *
1353 * \since This hint is available since SDL 3.2.0.
1354 */
1355#define SDL_HINT_JOYSTICK_FLIGHTSTICK_DEVICES "SDL_JOYSTICK_FLIGHTSTICK_DEVICES"
1356
1357/**
1358 * A variable containing a list of devices that are not flightstick style
1359 * controllers.
1360 *
1361 * This will override SDL_HINT_JOYSTICK_FLIGHTSTICK_DEVICES and the built in
1362 * device list.
1363 *
1364 * The format of the string is a comma separated list of USB VID/PID pairs in
1365 * hexadecimal form, e.g.
1366 *
1367 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
1368 *
1369 * The variable can also take the form of "@file", in which case the named
1370 * file will be loaded and interpreted as the value of the variable.
1371 *
1372 * This hint can be set anytime.
1373 *
1374 * \since This hint is available since SDL 3.2.0.
1375 */
1376#define SDL_HINT_JOYSTICK_FLIGHTSTICK_DEVICES_EXCLUDED "SDL_JOYSTICK_FLIGHTSTICK_DEVICES_EXCLUDED"
1377
1378/**
1379 * A variable controlling whether GameInput should be used for controller
1380 * handling on Windows.
1381 *
1382 * The variable can be set to the following values:
1383 *
1384 * - "0": GameInput is not used.
1385 * - "1": GameInput is used.
1386 *
1387 * The default is "1" on GDK platforms, and "0" otherwise.
1388 *
1389 * This hint should be set before SDL is initialized.
1390 *
1391 * \since This hint is available since SDL 3.2.0.
1392 */
1393#define SDL_HINT_JOYSTICK_GAMEINPUT "SDL_JOYSTICK_GAMEINPUT"
1394
1395/**
1396 * A variable containing a list of devices known to have a GameCube form
1397 * factor.
1398 *
1399 * The format of the string is a comma separated list of USB VID/PID pairs in
1400 * hexadecimal form, e.g.
1401 *
1402 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
1403 *
1404 * The variable can also take the form of "@file", in which case the named
1405 * file will be loaded and interpreted as the value of the variable.
1406 *
1407 * This hint can be set anytime.
1408 *
1409 * \since This hint is available since SDL 3.2.0.
1410 */
1411#define SDL_HINT_JOYSTICK_GAMECUBE_DEVICES "SDL_JOYSTICK_GAMECUBE_DEVICES"
1412
1413/**
1414 * A variable containing a list of devices known not to have a GameCube form
1415 * factor.
1416 *
1417 * This will override SDL_HINT_JOYSTICK_GAMECUBE_DEVICES and the built in
1418 * device list.
1419 *
1420 * The format of the string is a comma separated list of USB VID/PID pairs in
1421 * hexadecimal form, e.g.
1422 *
1423 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
1424 *
1425 * The variable can also take the form of "@file", in which case the named
1426 * file will be loaded and interpreted as the value of the variable.
1427 *
1428 * This hint can be set anytime.
1429 *
1430 * \since This hint is available since SDL 3.2.0.
1431 */
1432#define SDL_HINT_JOYSTICK_GAMECUBE_DEVICES_EXCLUDED "SDL_JOYSTICK_GAMECUBE_DEVICES_EXCLUDED"
1433
1434/**
1435 * A variable controlling whether the HIDAPI joystick drivers should be used.
1436 *
1437 * The variable can be set to the following values:
1438 *
1439 * - "0": HIDAPI drivers are not used.
1440 * - "1": HIDAPI drivers are used. (default)
1441 *
1442 * This variable is the default for all drivers, but can be overridden by the
1443 * hints for specific drivers below.
1444 *
1445 * This hint should be set before initializing joysticks and gamepads.
1446 *
1447 * \since This hint is available since SDL 3.2.0.
1448 */
1449#define SDL_HINT_JOYSTICK_HIDAPI "SDL_JOYSTICK_HIDAPI"
1450
1451/**
1452 * A variable controlling whether Nintendo Switch Joy-Con controllers will be
1453 * combined into a single Pro-like controller when using the HIDAPI driver.
1454 *
1455 * The variable can be set to the following values:
1456 *
1457 * - "0": Left and right Joy-Con controllers will not be combined and each
1458 *   will be a mini-gamepad.
1459 * - "1": Left and right Joy-Con controllers will be combined into a single
1460 *   controller. (default)
1461 *
1462 * This hint should be set before initializing joysticks and gamepads.
1463 *
1464 * \since This hint is available since SDL 3.2.0.
1465 */
1466#define SDL_HINT_JOYSTICK_HIDAPI_COMBINE_JOY_CONS "SDL_JOYSTICK_HIDAPI_COMBINE_JOY_CONS"
1467
1468/**
1469 * A variable controlling whether the HIDAPI driver for Nintendo GameCube
1470 * controllers should be used.
1471 *
1472 * The variable can be set to the following values:
1473 *
1474 * - "0": HIDAPI driver is not used.
1475 * - "1": HIDAPI driver is used.
1476 *
1477 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI
1478 *
1479 * This hint should be set before initializing joysticks and gamepads.
1480 *
1481 * \since This hint is available since SDL 3.2.0.
1482 */
1483#define SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE "SDL_JOYSTICK_HIDAPI_GAMECUBE"
1484
1485/**
1486 * A variable controlling whether rumble is used to implement the GameCube
1487 * controller's 3 rumble modes, Stop(0), Rumble(1), and StopHard(2).
1488 *
1489 * This is useful for applications that need full compatibility for things
1490 * like ADSR envelopes. - Stop is implemented by setting low_frequency_rumble
1491 * to 0 and high_frequency_rumble >0 - Rumble is both at any arbitrary value -
1492 * StopHard is implemented by setting both low_frequency_rumble and
1493 * high_frequency_rumble to 0
1494 *
1495 * The variable can be set to the following values:
1496 *
1497 * - "0": Normal rumble behavior is behavior is used. (default)
1498 * - "1": Proper GameCube controller rumble behavior is used.
1499 *
1500 * This hint can be set anytime.
1501 *
1502 * \since This hint is available since SDL 3.2.0.
1503 */
1504#define SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE_RUMBLE_BRAKE "SDL_JOYSTICK_HIDAPI_GAMECUBE_RUMBLE_BRAKE"
1505
1506/**
1507 * A variable controlling whether the HIDAPI driver for Nintendo Switch
1508 * Joy-Cons should be used.
1509 *
1510 * The variable can be set to the following values:
1511 *
1512 * - "0": HIDAPI driver is not used.
1513 * - "1": HIDAPI driver is used.
1514 *
1515 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI.
1516 *
1517 * This hint should be set before initializing joysticks and gamepads.
1518 *
1519 * \since This hint is available since SDL 3.2.0.
1520 */
1521#define SDL_HINT_JOYSTICK_HIDAPI_JOY_CONS "SDL_JOYSTICK_HIDAPI_JOY_CONS"
1522
1523/**
1524 * A variable controlling whether the Home button LED should be turned on when
1525 * a Nintendo Switch Joy-Con controller is opened.
1526 *
1527 * The variable can be set to the following values:
1528 *
1529 * - "0": home button LED is turned off
1530 * - "1": home button LED is turned on
1531 *
1532 * By default the Home button LED state is not changed. This hint can also be
1533 * set to a floating point value between 0.0 and 1.0 which controls the
1534 * brightness of the Home button LED.
1535 *
1536 * This hint can be set anytime.
1537 *
1538 * \since This hint is available since SDL 3.2.0.
1539 */
1540#define SDL_HINT_JOYSTICK_HIDAPI_JOYCON_HOME_LED "SDL_JOYSTICK_HIDAPI_JOYCON_HOME_LED"
1541
1542/**
1543 * A variable controlling whether the HIDAPI driver for Amazon Luna
1544 * controllers connected via Bluetooth should be used.
1545 *
1546 * The variable can be set to the following values:
1547 *
1548 * - "0": HIDAPI driver is not used.
1549 * - "1": HIDAPI driver is used.
1550 *
1551 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI.
1552 *
1553 * This hint should be set before initializing joysticks and gamepads.
1554 *
1555 * \since This hint is available since SDL 3.2.0.
1556 */
1557#define SDL_HINT_JOYSTICK_HIDAPI_LUNA "SDL_JOYSTICK_HIDAPI_LUNA"
1558
1559/**
1560 * A variable controlling whether the HIDAPI driver for Nintendo Online
1561 * classic controllers should be used.
1562 *
1563 * The variable can be set to the following values:
1564 *
1565 * - "0": HIDAPI driver is not used.
1566 * - "1": HIDAPI driver is used.
1567 *
1568 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI.
1569 *
1570 * This hint should be set before initializing joysticks and gamepads.
1571 *
1572 * \since This hint is available since SDL 3.2.0.
1573 */
1574#define SDL_HINT_JOYSTICK_HIDAPI_NINTENDO_CLASSIC "SDL_JOYSTICK_HIDAPI_NINTENDO_CLASSIC"
1575
1576/**
1577 * A variable controlling whether the HIDAPI driver for PS3 controllers should
1578 * be used.
1579 *
1580 * The variable can be set to the following values:
1581 *
1582 * - "0": HIDAPI driver is not used.
1583 * - "1": HIDAPI driver is used.
1584 *
1585 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI on macOS, and "0" on
1586 * other platforms.
1587 *
1588 * For official Sony driver (sixaxis.sys) use
1589 * SDL_HINT_JOYSTICK_HIDAPI_PS3_SIXAXIS_DRIVER. See
1590 * https://github.com/ViGEm/DsHidMini for an alternative driver on Windows.
1591 *
1592 * This hint should be set before initializing joysticks and gamepads.
1593 *
1594 * \since This hint is available since SDL 3.2.0.
1595 */
1596#define SDL_HINT_JOYSTICK_HIDAPI_PS3 "SDL_JOYSTICK_HIDAPI_PS3"
1597
1598/**
1599 * A variable controlling whether the Sony driver (sixaxis.sys) for PS3
1600 * controllers (Sixaxis/DualShock 3) should be used.
1601 *
1602 * The variable can be set to the following values:
1603 *
1604 * - "0": Sony driver (sixaxis.sys) is not used.
1605 * - "1": Sony driver (sixaxis.sys) is used.
1606 *
1607 * The default value is 0.
1608 *
1609 * This hint should be set before initializing joysticks and gamepads.
1610 *
1611 * \since This hint is available since SDL 3.2.0.
1612 */
1613#define SDL_HINT_JOYSTICK_HIDAPI_PS3_SIXAXIS_DRIVER "SDL_JOYSTICK_HIDAPI_PS3_SIXAXIS_DRIVER"
1614
1615/**
1616 * A variable controlling whether the HIDAPI driver for PS4 controllers should
1617 * be used.
1618 *
1619 * The variable can be set to the following values:
1620 *
1621 * - "0": HIDAPI driver is not used.
1622 * - "1": HIDAPI driver is used.
1623 *
1624 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI.
1625 *
1626 * This hint should be set before initializing joysticks and gamepads.
1627 *
1628 * \since This hint is available since SDL 3.2.0.
1629 */
1630#define SDL_HINT_JOYSTICK_HIDAPI_PS4 "SDL_JOYSTICK_HIDAPI_PS4"
1631
1632/**
1633 * A variable controlling the update rate of the PS4 controller over Bluetooth
1634 * when using the HIDAPI driver.
1635 *
1636 * This defaults to 4 ms, to match the behavior over USB, and to be more
1637 * friendly to other Bluetooth devices and older Bluetooth hardware on the
1638 * computer. It can be set to "1" (1000Hz), "2" (500Hz) and "4" (250Hz)
1639 *
1640 * This hint can be set anytime, but only takes effect when extended input
1641 * reports are enabled.
1642 *
1643 * \since This hint is available since SDL 3.2.0.
1644 */
1645#define SDL_HINT_JOYSTICK_HIDAPI_PS4_REPORT_INTERVAL "SDL_JOYSTICK_HIDAPI_PS4_REPORT_INTERVAL"
1646
1647/**
1648 * A variable controlling whether the HIDAPI driver for PS5 controllers should
1649 * be used.
1650 *
1651 * The variable can be set to the following values:
1652 *
1653 * - "0": HIDAPI driver is not used.
1654 * - "1": HIDAPI driver is used.
1655 *
1656 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI.
1657 *
1658 * This hint should be set before initializing joysticks and gamepads.
1659 *
1660 * \since This hint is available since SDL 3.2.0.
1661 */
1662#define SDL_HINT_JOYSTICK_HIDAPI_PS5 "SDL_JOYSTICK_HIDAPI_PS5"
1663
1664/**
1665 * A variable controlling whether the player LEDs should be lit to indicate
1666 * which player is associated with a PS5 controller.
1667 *
1668 * The variable can be set to the following values:
1669 *
1670 * - "0": player LEDs are not enabled.
1671 * - "1": player LEDs are enabled. (default)
1672 *
1673 * \since This hint is available since SDL 3.2.0.
1674 */
1675#define SDL_HINT_JOYSTICK_HIDAPI_PS5_PLAYER_LED "SDL_JOYSTICK_HIDAPI_PS5_PLAYER_LED"
1676
1677/**
1678 * A variable controlling whether the HIDAPI driver for NVIDIA SHIELD
1679 * controllers should be used.
1680 *
1681 * The variable can be set to the following values:
1682 *
1683 * - "0": HIDAPI driver is not used.
1684 * - "1": HIDAPI driver is used.
1685 *
1686 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI.
1687 *
1688 * This hint should be set before initializing joysticks and gamepads.
1689 *
1690 * \since This hint is available since SDL 3.2.0.
1691 */
1692#define SDL_HINT_JOYSTICK_HIDAPI_SHIELD "SDL_JOYSTICK_HIDAPI_SHIELD"
1693
1694/**
1695 * A variable controlling whether the HIDAPI driver for Google Stadia
1696 * controllers should be used.
1697 *
1698 * The variable can be set to the following values:
1699 *
1700 * - "0": HIDAPI driver is not used.
1701 * - "1": HIDAPI driver is used.
1702 *
1703 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI.
1704 *
1705 * \since This hint is available since SDL 3.2.0.
1706 */
1707#define SDL_HINT_JOYSTICK_HIDAPI_STADIA "SDL_JOYSTICK_HIDAPI_STADIA"
1708
1709/**
1710 * A variable controlling whether the HIDAPI driver for Bluetooth Steam
1711 * Controllers should be used.
1712 *
1713 * The variable can be set to the following values:
1714 *
1715 * - "0": HIDAPI driver is not used. (default)
1716 * - "1": HIDAPI driver is used for Steam Controllers, which requires
1717 *   Bluetooth access and may prompt the user for permission on iOS and
1718 *   Android.
1719 *
1720 * This hint should be set before initializing joysticks and gamepads.
1721 *
1722 * \since This hint is available since SDL 3.2.0.
1723 */
1724#define SDL_HINT_JOYSTICK_HIDAPI_STEAM "SDL_JOYSTICK_HIDAPI_STEAM"
1725
1726/**
1727 * A variable controlling whether the Steam button LED should be turned on
1728 * when a Steam controller is opened.
1729 *
1730 * The variable can be set to the following values:
1731 *
1732 * - "0": Steam button LED is turned off.
1733 * - "1": Steam button LED is turned on.
1734 *
1735 * By default the Steam button LED state is not changed. This hint can also be
1736 * set to a floating point value between 0.0 and 1.0 which controls the
1737 * brightness of the Steam button LED.
1738 *
1739 * This hint can be set anytime.
1740 *
1741 * \since This hint is available since SDL 3.2.0.
1742 */
1743#define SDL_HINT_JOYSTICK_HIDAPI_STEAM_HOME_LED "SDL_JOYSTICK_HIDAPI_STEAM_HOME_LED"
1744
1745/**
1746 * A variable controlling whether the HIDAPI driver for the Steam Deck builtin
1747 * controller should be used.
1748 *
1749 * The variable can be set to the following values:
1750 *
1751 * - "0": HIDAPI driver is not used.
1752 * - "1": HIDAPI driver is used.
1753 *
1754 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI.
1755 *
1756 * This hint should be set before initializing joysticks and gamepads.
1757 *
1758 * \since This hint is available since SDL 3.2.0.
1759 */
1760#define SDL_HINT_JOYSTICK_HIDAPI_STEAMDECK "SDL_JOYSTICK_HIDAPI_STEAMDECK"
1761
1762/**
1763 * A variable controlling whether the HIDAPI driver for HORI licensed Steam
1764 * controllers should be used.
1765 *
1766 * This variable can be set to the following values: "0" - HIDAPI driver is
1767 * not used "1" - HIDAPI driver is used
1768 *
1769 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI
1770 */
1771#define SDL_HINT_JOYSTICK_HIDAPI_STEAM_HORI "SDL_JOYSTICK_HIDAPI_STEAM_HORI"
1772
1773/**
1774 * A variable controlling whether the HIDAPI driver for some Logitech wheels
1775 * should be used.
1776 *
1777 * This variable can be set to the following values:
1778 *
1779 * - "0": HIDAPI driver is not used
1780 * - "1": HIDAPI driver is used
1781 *
1782 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI
1783 */
1784#define SDL_HINT_JOYSTICK_HIDAPI_LG4FF "SDL_JOYSTICK_HIDAPI_LG4FF"
1785
1786/**
1787 * A variable controlling whether the HIDAPI driver for 8BitDo controllers
1788 * should be used.
1789 *
1790 * This variable can be set to the following values:
1791 *
1792 * "0" - HIDAPI driver is not used. "1" - HIDAPI driver is used.
1793 *
1794 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI
1795 */
1796#define SDL_HINT_JOYSTICK_HIDAPI_8BITDO "SDL_JOYSTICK_HIDAPI_8BITDO"
1797
1798/**
1799 * A variable controlling whether the HIDAPI driver for SInput controllers
1800 * should be used.
1801 *
1802 * More info - https://github.com/HandHeldLegend/SInput-HID
1803 *
1804 * This variable can be set to the following values:
1805 *
1806 * "0" - HIDAPI driver is not used. "1" - HIDAPI driver is used.
1807 *
1808 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI
1809 */
1810#define SDL_HINT_JOYSTICK_HIDAPI_SINPUT "SDL_JOYSTICK_HIDAPI_SINPUT"
1811
1812/**
1813 * A variable controlling whether the HIDAPI driver for ZUIKI controllers
1814 * should be used.
1815 *
1816 * This variable can be set to the following values:
1817 *
1818 * "0" - HIDAPI driver is not used. "1" - HIDAPI driver is used.
1819 *
1820 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI
1821 */
1822#define SDL_HINT_JOYSTICK_HIDAPI_ZUIKI "SDL_JOYSTICK_HIDAPI_ZUIKI"
1823
1824/**
1825 * A variable controlling whether the HIDAPI driver for Flydigi controllers
1826 * should be used.
1827 *
1828 * This variable can be set to the following values:
1829 *
1830 * "0" - HIDAPI driver is not used. "1" - HIDAPI driver is used.
1831 *
1832 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI
1833 */
1834#define SDL_HINT_JOYSTICK_HIDAPI_FLYDIGI "SDL_JOYSTICK_HIDAPI_FLYDIGI"
1835
1836/**
1837 * A variable controlling whether the HIDAPI driver for Nintendo Switch
1838 * controllers should be used.
1839 *
1840 * The variable can be set to the following values:
1841 *
1842 * - "0": HIDAPI driver is not used.
1843 * - "1": HIDAPI driver is used.
1844 *
1845 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI.
1846 *
1847 * This hint should be set before initializing joysticks and gamepads.
1848 *
1849 * \since This hint is available since SDL 3.2.0.
1850 */
1851#define SDL_HINT_JOYSTICK_HIDAPI_SWITCH "SDL_JOYSTICK_HIDAPI_SWITCH"
1852
1853/**
1854 * A variable controlling whether the Home button LED should be turned on when
1855 * a Nintendo Switch Pro controller is opened.
1856 *
1857 * The variable can be set to the following values:
1858 *
1859 * - "0": Home button LED is turned off.
1860 * - "1": Home button LED is turned on.
1861 *
1862 * By default the Home button LED state is not changed. This hint can also be
1863 * set to a floating point value between 0.0 and 1.0 which controls the
1864 * brightness of the Home button LED.
1865 *
1866 * This hint can be set anytime.
1867 *
1868 * \since This hint is available since SDL 3.2.0.
1869 */
1870#define SDL_HINT_JOYSTICK_HIDAPI_SWITCH_HOME_LED "SDL_JOYSTICK_HIDAPI_SWITCH_HOME_LED"
1871
1872/**
1873 * A variable controlling whether the player LEDs should be lit to indicate
1874 * which player is associated with a Nintendo Switch controller.
1875 *
1876 * The variable can be set to the following values:
1877 *
1878 * - "0": Player LEDs are not enabled.
1879 * - "1": Player LEDs are enabled. (default)
1880 *
1881 * This hint can be set anytime.
1882 *
1883 * \since This hint is available since SDL 3.2.0.
1884 */
1885#define SDL_HINT_JOYSTICK_HIDAPI_SWITCH_PLAYER_LED "SDL_JOYSTICK_HIDAPI_SWITCH_PLAYER_LED"
1886
1887/**
1888 * A variable controlling whether the HIDAPI driver for Nintendo Switch 2
1889 * controllers should be used.
1890 *
1891 * The variable can be set to the following values:
1892 *
1893 * - "0": HIDAPI driver is not used.
1894 * - "1": HIDAPI driver is used.
1895 *
1896 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI.
1897 *
1898 * This hint should be set before initializing joysticks and gamepads.
1899 *
1900 * \since This hint is available since SDL 3.4.0.
1901 */
1902#define SDL_HINT_JOYSTICK_HIDAPI_SWITCH2 "SDL_JOYSTICK_HIDAPI_SWITCH2"
1903
1904/**
1905 * A variable controlling whether Nintendo Switch Joy-Con controllers will be
1906 * in vertical mode when using the HIDAPI driver.
1907 *
1908 * The variable can be set to the following values:
1909 *
1910 * - "0": Left and right Joy-Con controllers will not be in vertical mode.
1911 *   (default)
1912 * - "1": Left and right Joy-Con controllers will be in vertical mode.
1913 *
1914 * This hint should be set before opening a Joy-Con controller.
1915 *
1916 * \since This hint is available since SDL 3.2.0.
1917 */
1918#define SDL_HINT_JOYSTICK_HIDAPI_VERTICAL_JOY_CONS "SDL_JOYSTICK_HIDAPI_VERTICAL_JOY_CONS"
1919
1920/**
1921 * A variable controlling whether the HIDAPI driver for Nintendo Wii and Wii U
1922 * controllers should be used.
1923 *
1924 * The variable can be set to the following values:
1925 *
1926 * - "0": HIDAPI driver is not used.
1927 * - "1": HIDAPI driver is used.
1928 *
1929 * This driver doesn't work with the dolphinbar, so the default is false for
1930 * now.
1931 *
1932 * This hint should be set before initializing joysticks and gamepads.
1933 *
1934 * \since This hint is available since SDL 3.2.0.
1935 */
1936#define SDL_HINT_JOYSTICK_HIDAPI_WII "SDL_JOYSTICK_HIDAPI_WII"
1937
1938/**
1939 * A variable controlling whether the player LEDs should be lit to indicate
1940 * which player is associated with a Wii controller.
1941 *
1942 * The variable can be set to the following values:
1943 *
1944 * - "0": Player LEDs are not enabled.
1945 * - "1": Player LEDs are enabled. (default)
1946 *
1947 * This hint can be set anytime.
1948 *
1949 * \since This hint is available since SDL 3.2.0.
1950 */
1951#define SDL_HINT_JOYSTICK_HIDAPI_WII_PLAYER_LED "SDL_JOYSTICK_HIDAPI_WII_PLAYER_LED"
1952
1953/**
1954 * A variable controlling whether the HIDAPI driver for XBox controllers
1955 * should be used.
1956 *
1957 * The variable can be set to the following values:
1958 *
1959 * - "0": HIDAPI driver is not used.
1960 * - "1": HIDAPI driver is used.
1961 *
1962 * The default is "0" on Windows, otherwise the value of
1963 * SDL_HINT_JOYSTICK_HIDAPI
1964 *
1965 * This hint should be set before initializing joysticks and gamepads.
1966 *
1967 * \since This hint is available since SDL 3.2.0.
1968 */
1969#define SDL_HINT_JOYSTICK_HIDAPI_XBOX "SDL_JOYSTICK_HIDAPI_XBOX"
1970
1971/**
1972 * A variable controlling whether the HIDAPI driver for XBox 360 controllers
1973 * should be used.
1974 *
1975 * The variable can be set to the following values:
1976 *
1977 * - "0": HIDAPI driver is not used.
1978 * - "1": HIDAPI driver is used.
1979 *
1980 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI_XBOX
1981 *
1982 * This hint should be set before initializing joysticks and gamepads.
1983 *
1984 * \since This hint is available since SDL 3.2.0.
1985 */
1986#define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360 "SDL_JOYSTICK_HIDAPI_XBOX_360"
1987
1988/**
1989 * A variable controlling whether the player LEDs should be lit to indicate
1990 * which player is associated with an Xbox 360 controller.
1991 *
1992 * The variable can be set to the following values:
1993 *
1994 * - "0": Player LEDs are not enabled.
1995 * - "1": Player LEDs are enabled. (default)
1996 *
1997 * This hint can be set anytime.
1998 *
1999 * \since This hint is available since SDL 3.2.0.
2000 */
2001#define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED "SDL_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED"
2002
2003/**
2004 * A variable controlling whether the HIDAPI driver for XBox 360 wireless
2005 * controllers should be used.
2006 *
2007 * The variable can be set to the following values:
2008 *
2009 * - "0": HIDAPI driver is not used.
2010 * - "1": HIDAPI driver is used.
2011 *
2012 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI_XBOX_360
2013 *
2014 * This hint should be set before initializing joysticks and gamepads.
2015 *
2016 * \since This hint is available since SDL 3.2.0.
2017 */
2018#define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_WIRELESS "SDL_JOYSTICK_HIDAPI_XBOX_360_WIRELESS"
2019
2020/**
2021 * A variable controlling whether the HIDAPI driver for XBox One controllers
2022 * should be used.
2023 *
2024 * The variable can be set to the following values:
2025 *
2026 * - "0": HIDAPI driver is not used.
2027 * - "1": HIDAPI driver is used.
2028 *
2029 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI_XBOX.
2030 *
2031 * This hint should be set before initializing joysticks and gamepads.
2032 *
2033 * \since This hint is available since SDL 3.2.0.
2034 */
2035#define SDL_HINT_JOYSTICK_HIDAPI_XBOX_ONE "SDL_JOYSTICK_HIDAPI_XBOX_ONE"
2036
2037/**
2038 * A variable controlling whether the Home button LED should be turned on when
2039 * an Xbox One controller is opened.
2040 *
2041 * The variable can be set to the following values:
2042 *
2043 * - "0": Home button LED is turned off.
2044 * - "1": Home button LED is turned on.
2045 *
2046 * By default the Home button LED state is not changed. This hint can also be
2047 * set to a floating point value between 0.0 and 1.0 which controls the
2048 * brightness of the Home button LED. The default brightness is 0.4.
2049 *
2050 * This hint can be set anytime.
2051 *
2052 * \since This hint is available since SDL 3.2.0.
2053 */
2054#define SDL_HINT_JOYSTICK_HIDAPI_XBOX_ONE_HOME_LED "SDL_JOYSTICK_HIDAPI_XBOX_ONE_HOME_LED"
2055
2056/**
2057 * A variable controlling whether the new HIDAPI driver for wired Xbox One
2058 * (GIP) controllers should be used.
2059 *
2060 * The variable can be set to the following values:
2061 *
2062 * - "0": HIDAPI driver is not used.
2063 * - "1": HIDAPI driver is used.
2064 *
2065 * The default is the value of SDL_HINT_JOYSTICK_HIDAPI_XBOX_ONE.
2066 *
2067 * This hint should be set before initializing joysticks and gamepads.
2068 *
2069 * \since This hint is available since SDL 3.4.0.
2070 */
2071#define SDL_HINT_JOYSTICK_HIDAPI_GIP "SDL_JOYSTICK_HIDAPI_GIP"
2072
2073/**
2074 * A variable controlling whether the new HIDAPI driver for wired Xbox One
2075 * (GIP) controllers should reset the controller if it can't get the metadata
2076 * from the controller.
2077 *
2078 * The variable can be set to the following values:
2079 *
2080 * - "0": Assume this is a generic controller.
2081 * - "1": Reset the controller to get metadata.
2082 *
2083 * By default the controller is not reset.
2084 *
2085 * This hint should be set before initializing joysticks and gamepads.
2086 *
2087 * \since This hint is available since SDL 3.4.0.
2088 */
2089#define SDL_HINT_JOYSTICK_HIDAPI_GIP_RESET_FOR_METADATA "SDL_JOYSTICK_HIDAPI_GIP_RESET_FOR_METADATA"
2090
2091/**
2092 * A variable controlling whether IOKit should be used for controller
2093 * handling.
2094 *
2095 * The variable can be set to the following values:
2096 *
2097 * - "0": IOKit is not used.
2098 * - "1": IOKit is used. (default)
2099 *
2100 * This hint should be set before SDL is initialized.
2101 *
2102 * \since This hint is available since SDL 3.2.0.
2103 */
2104#define SDL_HINT_JOYSTICK_IOKIT "SDL_JOYSTICK_IOKIT"
2105
2106/**
2107 * A variable controlling whether to use the classic /dev/input/js* joystick
2108 * interface or the newer /dev/input/event* joystick interface on Linux.
2109 *
2110 * The variable can be set to the following values:
2111 *
2112 * - "0": Use /dev/input/event* (default)
2113 * - "1": Use /dev/input/js*
2114 *
2115 * This hint should be set before SDL is initialized.
2116 *
2117 * \since This hint is available since SDL 3.2.0.
2118 */
2119#define SDL_HINT_JOYSTICK_LINUX_CLASSIC "SDL_JOYSTICK_LINUX_CLASSIC"
2120
2121/**
2122 * A variable controlling whether joysticks on Linux adhere to their
2123 * HID-defined deadzones or return unfiltered values.
2124 *
2125 * The variable can be set to the following values:
2126 *
2127 * - "0": Return unfiltered joystick axis values. (default)
2128 * - "1": Return axis values with deadzones taken into account.
2129 *
2130 * This hint should be set before a controller is opened.
2131 *
2132 * \since This hint is available since SDL 3.2.0.
2133 */
2134#define SDL_HINT_JOYSTICK_LINUX_DEADZONES "SDL_JOYSTICK_LINUX_DEADZONES"
2135
2136/**
2137 * A variable controlling whether joysticks on Linux will always treat 'hat'
2138 * axis inputs (ABS_HAT0X - ABS_HAT3Y) as 8-way digital hats without checking
2139 * whether they may be analog.
2140 *
2141 * The variable can be set to the following values:
2142 *
2143 * - "0": Only map hat axis inputs to digital hat outputs if the input axes
2144 *   appear to actually be digital. (default)
2145 * - "1": Always handle the input axes numbered ABS_HAT0X to ABS_HAT3Y as
2146 *   digital hats.
2147 *
2148 * This hint should be set before a controller is opened.
2149 *
2150 * \since This hint is available since SDL 3.2.0.
2151 */
2152#define SDL_HINT_JOYSTICK_LINUX_DIGITAL_HATS "SDL_JOYSTICK_LINUX_DIGITAL_HATS"
2153
2154/**
2155 * A variable controlling whether digital hats on Linux will apply deadzones
2156 * to their underlying input axes or use unfiltered values.
2157 *
2158 * The variable can be set to the following values:
2159 *
2160 * - "0": Return digital hat values based on unfiltered input axis values.
2161 * - "1": Return digital hat values with deadzones on the input axes taken
2162 *   into account. (default)
2163 *
2164 * This hint should be set before a controller is opened.
2165 *
2166 * \since This hint is available since SDL 3.2.0.
2167 */
2168#define SDL_HINT_JOYSTICK_LINUX_HAT_DEADZONES "SDL_JOYSTICK_LINUX_HAT_DEADZONES"
2169
2170/**
2171 * A variable controlling whether GCController should be used for controller
2172 * handling.
2173 *
2174 * The variable can be set to the following values:
2175 *
2176 * - "0": GCController is not used.
2177 * - "1": GCController is used. (default)
2178 *
2179 * This hint should be set before SDL is initialized.
2180 *
2181 * \since This hint is available since SDL 3.2.0.
2182 */
2183#define SDL_HINT_JOYSTICK_MFI "SDL_JOYSTICK_MFI"
2184
2185/**
2186 * A variable controlling whether the RAWINPUT joystick drivers should be used
2187 * for better handling XInput-capable devices.
2188 *
2189 * The variable can be set to the following values:
2190 *
2191 * - "0": RAWINPUT drivers are not used. (default)
2192 * - "1": RAWINPUT drivers are used.
2193 *
2194 * This hint should be set before SDL is initialized.
2195 *
2196 * \since This hint is available since SDL 3.2.0.
2197 */
2198#define SDL_HINT_JOYSTICK_RAWINPUT "SDL_JOYSTICK_RAWINPUT"
2199
2200/**
2201 * A variable controlling whether the RAWINPUT driver should pull correlated
2202 * data from XInput.
2203 *
2204 * The variable can be set to the following values:
2205 *
2206 * - "0": RAWINPUT driver will only use data from raw input APIs.
2207 * - "1": RAWINPUT driver will also pull data from XInput and
2208 *   Windows.Gaming.Input, providing better trigger axes, guide button
2209 *   presses, and rumble support for Xbox controllers. (default)
2210 *
2211 * This hint should be set before a gamepad is opened.
2212 *
2213 * \since This hint is available since SDL 3.2.0.
2214 */
2215#define SDL_HINT_JOYSTICK_RAWINPUT_CORRELATE_XINPUT "SDL_JOYSTICK_RAWINPUT_CORRELATE_XINPUT"
2216
2217/**
2218 * A variable controlling whether the ROG Chakram mice should show up as
2219 * joysticks.
2220 *
2221 * The variable can be set to the following values:
2222 *
2223 * - "0": ROG Chakram mice do not show up as joysticks. (default)
2224 * - "1": ROG Chakram mice show up as joysticks.
2225 *
2226 * This hint should be set before SDL is initialized.
2227 *
2228 * \since This hint is available since SDL 3.2.0.
2229 */
2230#define SDL_HINT_JOYSTICK_ROG_CHAKRAM "SDL_JOYSTICK_ROG_CHAKRAM"
2231
2232/**
2233 * A variable controlling whether a separate thread should be used for
2234 * handling joystick detection and raw input messages on Windows.
2235 *
2236 * The variable can be set to the following values:
2237 *
2238 * - "0": A separate thread is not used.
2239 * - "1": A separate thread is used for handling raw input messages. (default)
2240 *
2241 * This hint should be set before SDL is initialized.
2242 *
2243 * \since This hint is available since SDL 3.2.0.
2244 */
2245#define SDL_HINT_JOYSTICK_THREAD "SDL_JOYSTICK_THREAD"
2246
2247/**
2248 * A variable containing a list of throttle style controllers.
2249 *
2250 * The format of the string is a comma separated list of USB VID/PID pairs in
2251 * hexadecimal form, e.g.
2252 *
2253 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
2254 *
2255 * The variable can also take the form of "@file", in which case the named
2256 * file will be loaded and interpreted as the value of the variable.
2257 *
2258 * This hint can be set anytime.
2259 *
2260 * \since This hint is available since SDL 3.2.0.
2261 */
2262#define SDL_HINT_JOYSTICK_THROTTLE_DEVICES "SDL_JOYSTICK_THROTTLE_DEVICES"
2263
2264/**
2265 * A variable containing a list of devices that are not throttle style
2266 * controllers.
2267 *
2268 * This will override SDL_HINT_JOYSTICK_THROTTLE_DEVICES and the built in
2269 * device list.
2270 *
2271 * The format of the string is a comma separated list of USB VID/PID pairs in
2272 * hexadecimal form, e.g.
2273 *
2274 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
2275 *
2276 * The variable can also take the form of "@file", in which case the named
2277 * file will be loaded and interpreted as the value of the variable.
2278 *
2279 * This hint can be set anytime.
2280 *
2281 * \since This hint is available since SDL 3.2.0.
2282 */
2283#define SDL_HINT_JOYSTICK_THROTTLE_DEVICES_EXCLUDED "SDL_JOYSTICK_THROTTLE_DEVICES_EXCLUDED"
2284
2285/**
2286 * A variable controlling whether Windows.Gaming.Input should be used for
2287 * controller handling.
2288 *
2289 * The variable can be set to the following values:
2290 *
2291 * - "0": WGI is not used. (default)
2292 * - "1": WGI is used.
2293 *
2294 * This hint should be set before SDL is initialized.
2295 *
2296 * \since This hint is available since SDL 3.2.0.
2297 */
2298#define SDL_HINT_JOYSTICK_WGI "SDL_JOYSTICK_WGI"
2299
2300/**
2301 * A variable containing a list of wheel style controllers.
2302 *
2303 * The format of the string is a comma separated list of USB VID/PID pairs in
2304 * hexadecimal form, e.g.
2305 *
2306 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
2307 *
2308 * The variable can also take the form of "@file", in which case the named
2309 * file will be loaded and interpreted as the value of the variable.
2310 *
2311 * This hint can be set anytime.
2312 *
2313 * \since This hint is available since SDL 3.2.0.
2314 */
2315#define SDL_HINT_JOYSTICK_WHEEL_DEVICES "SDL_JOYSTICK_WHEEL_DEVICES"
2316
2317/**
2318 * A variable containing a list of devices that are not wheel style
2319 * controllers.
2320 *
2321 * This will override SDL_HINT_JOYSTICK_WHEEL_DEVICES and the built in device
2322 * list.
2323 *
2324 * The format of the string is a comma separated list of USB VID/PID pairs in
2325 * hexadecimal form, e.g.
2326 *
2327 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
2328 *
2329 * The variable can also take the form of "@file", in which case the named
2330 * file will be loaded and interpreted as the value of the variable.
2331 *
2332 * This hint can be set anytime.
2333 *
2334 * \since This hint is available since SDL 3.2.0.
2335 */
2336#define SDL_HINT_JOYSTICK_WHEEL_DEVICES_EXCLUDED "SDL_JOYSTICK_WHEEL_DEVICES_EXCLUDED"
2337
2338/**
2339 * A variable containing a list of devices known to have all axes centered at
2340 * zero.
2341 *
2342 * The format of the string is a comma separated list of USB VID/PID pairs in
2343 * hexadecimal form, e.g.
2344 *
2345 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
2346 *
2347 * The variable can also take the form of "@file", in which case the named
2348 * file will be loaded and interpreted as the value of the variable.
2349 *
2350 * This hint should be set before a controller is opened.
2351 *
2352 * \since This hint is available since SDL 3.2.0.
2353 */
2354#define SDL_HINT_JOYSTICK_ZERO_CENTERED_DEVICES "SDL_JOYSTICK_ZERO_CENTERED_DEVICES"
2355
2356/**
2357 * A variable containing a list of devices and their desired number of haptic
2358 * (force feedback) enabled axis.
2359 *
2360 * The format of the string is a comma separated list of USB VID/PID pairs in
2361 * hexadecimal form plus the number of desired axes, e.g.
2362 *
2363 * `0xAAAA/0xBBBB/1,0xCCCC/0xDDDD/3`
2364 *
2365 * This hint supports a "wildcard" device that will set the number of haptic
2366 * axes on all initialized haptic devices which were not defined explicitly in
2367 * this hint.
2368 *
2369 * `0xFFFF/0xFFFF/1`
2370 *
2371 * This hint should be set before a controller is opened. The number of haptic
2372 * axes won't exceed the number of real axes found on the device.
2373 *
2374 * \since This hint is available since SDL 3.2.5.
2375 */
2376#define SDL_HINT_JOYSTICK_HAPTIC_AXES "SDL_JOYSTICK_HAPTIC_AXES"
2377
2378/**
2379 * A variable that controls keycode representation in keyboard events.
2380 *
2381 * This variable is a comma separated set of options for translating keycodes
2382 * in events:
2383 *
2384 * - "none": Keycode options are cleared, this overrides other options.
2385 * - "hide_numpad": The numpad keysyms will be translated into their
2386 *   non-numpad versions based on the current NumLock state. For example,
2387 *   SDLK_KP_4 would become SDLK_4 if SDL_KMOD_NUM is set in the event
2388 *   modifiers, and SDLK_LEFT if it is unset.
2389 * - "french_numbers": The number row on French keyboards is inverted, so
2390 *   pressing the 1 key would yield the keycode SDLK_1, or '1', instead of
2391 *   SDLK_AMPERSAND, or '&'
2392 * - "latin_letters": For keyboards using non-Latin letters, such as Russian
2393 *   or Thai, the letter keys generate keycodes as though it had an English
2394 *   QWERTY layout. e.g. pressing the key associated with SDL_SCANCODE_A on a
2395 *   Russian keyboard would yield 'a' instead of a Cyrillic letter.
2396 *
2397 * The default value for this hint is "french_numbers,latin_letters"
2398 *
2399 * Some platforms like Emscripten only provide modified keycodes and the
2400 * options are not used.
2401 *
2402 * These options do not affect the return value of SDL_GetKeyFromScancode() or
2403 * SDL_GetScancodeFromKey(), they just apply to the keycode included in key
2404 * events.
2405 *
2406 * This hint can be set anytime.
2407 *
2408 * \since This hint is available since SDL 3.2.0.
2409 */
2410#define SDL_HINT_KEYCODE_OPTIONS "SDL_KEYCODE_OPTIONS"
2411
2412/**
2413 * A variable that controls what KMSDRM device to use.
2414 *
2415 * SDL might open something like "/dev/dri/cardNN" to access KMSDRM
2416 * functionality, where "NN" is a device index number. SDL makes a guess at
2417 * the best index to use (usually zero), but the app or user can set this hint
2418 * to a number between 0 and 99 to force selection.
2419 *
2420 * This hint should be set before SDL is initialized.
2421 *
2422 * \since This hint is available since SDL 3.2.0.
2423 */
2424#define SDL_HINT_KMSDRM_DEVICE_INDEX "SDL_KMSDRM_DEVICE_INDEX"
2425
2426/**
2427 * A variable that controls whether SDL requires DRM master access in order to
2428 * initialize the KMSDRM video backend.
2429 *
2430 * The DRM subsystem has a concept of a "DRM master" which is a DRM client
2431 * that has the ability to set planes, set cursor, etc. When SDL is DRM
2432 * master, it can draw to the screen using the SDL rendering APIs. Without DRM
2433 * master, SDL is still able to process input and query attributes of attached
2434 * displays, but it cannot change display state or draw to the screen
2435 * directly.
2436 *
2437 * In some cases, it can be useful to have the KMSDRM backend even if it
2438 * cannot be used for rendering. An app may want to use SDL for input
2439 * processing while using another rendering API (such as an MMAL overlay on
2440 * Raspberry Pi) or using its own code to render to DRM overlays that SDL
2441 * doesn't support.
2442 *
2443 * The variable can be set to the following values:
2444 *
2445 * - "0": SDL will allow usage of the KMSDRM backend without DRM master.
2446 * - "1": SDL Will require DRM master to use the KMSDRM backend. (default)
2447 *
2448 * This hint should be set before SDL is initialized.
2449 *
2450 * \since This hint is available since SDL 3.2.0.
2451 */
2452#define SDL_HINT_KMSDRM_REQUIRE_DRM_MASTER "SDL_KMSDRM_REQUIRE_DRM_MASTER"
2453
2454/**
2455 * A variable that controls whether KMSDRM will use "atomic" functionality.
2456 *
2457 * The KMSDRM backend can use atomic commits, if both DRM_CLIENT_CAP_ATOMIC
2458 * and DRM_CLIENT_CAP_UNIVERSAL_PLANES is supported by the system. As of SDL
2459 * 3.4.0, it will favor this functionality, but in case this doesn't work well
2460 * on a given system or other surprises, this hint can be used to disable it.
2461 *
2462 * This hint can not enable the functionality if it isn't available.
2463 *
2464 * The variable can be set to the following values:
2465 *
2466 * - "0": SDL will not use the KMSDRM "atomic" functionality.
2467 * - "1": SDL will allow usage of the KMSDRM "atomic" functionality. (default)
2468 *
2469 * This hint should be set before SDL is initialized.
2470 *
2471 * \since This hint is available since SDL 3.4.0.
2472 */
2473#define SDL_HINT_KMSDRM_ATOMIC "SDL_KMSDRM_ATOMIC"
2474
2475/**
2476 * A variable controlling the default SDL log levels.
2477 *
2478 * This variable is a comma separated set of category=level tokens that define
2479 * the default logging levels for SDL applications.
2480 *
2481 * The category can be a numeric category, one of "app", "error", "assert",
2482 * "system", "audio", "video", "render", "input", "test", or `*` for any
2483 * unspecified category.
2484 *
2485 * The level can be a numeric level, one of "verbose", "debug", "info",
2486 * "warn", "error", "critical", or "quiet" to disable that category.
2487 *
2488 * You can omit the category if you want to set the logging level for all
2489 * categories.
2490 *
2491 * If this hint isn't set, the default log levels are equivalent to:
2492 *
2493 * `app=info,assert=warn,test=verbose,*=error`
2494 *
2495 * If the `DEBUG_INVOCATION` environment variable is set to "1", the default
2496 * log levels are equivalent to:
2497 *
2498 * `assert=warn,test=verbose,*=debug`
2499 *
2500 * This hint can be set anytime.
2501 *
2502 * \since This hint is available since SDL 3.2.0.
2503 */
2504#define SDL_HINT_LOGGING "SDL_LOGGING"
2505
2506/**
2507 * A variable controlling whether to force the application to become the
2508 * foreground process when launched on macOS.
2509 *
2510 * The variable can be set to the following values:
2511 *
2512 * - "0": The application is brought to the foreground when launched.
2513 *   (default)
2514 * - "1": The application may remain in the background when launched.
2515 *
2516 * This hint needs to be set before SDL_Init().
2517 *
2518 * \since This hint is available since SDL 3.2.0.
2519 */
2520#define SDL_HINT_MAC_BACKGROUND_APP "SDL_MAC_BACKGROUND_APP"
2521
2522/**
2523 * A variable that determines whether Ctrl+Click should generate a right-click
2524 * event on macOS.
2525 *
2526 * The variable can be set to the following values:
2527 *
2528 * - "0": Ctrl+Click does not generate a right mouse button click event.
2529 *   (default)
2530 * - "1": Ctrl+Click generated a right mouse button click event.
2531 *
2532 * This hint can be set anytime.
2533 *
2534 * \since This hint is available since SDL 3.2.0.
2535 */
2536#define SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK "SDL_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK"
2537
2538/**
2539 * A variable controlling whether dispatching OpenGL context updates should
2540 * block the dispatching thread until the main thread finishes processing on
2541 * macOS.
2542 *
2543 * The variable can be set to the following values:
2544 *
2545 * - "0": Dispatching OpenGL context updates will block the dispatching thread
2546 *   until the main thread finishes processing. (default)
2547 * - "1": Dispatching OpenGL context updates will allow the dispatching thread
2548 *   to continue execution.
2549 *
2550 * Generally you want the default, but if you have OpenGL code in a background
2551 * thread on a Mac, and the main thread hangs because it's waiting for that
2552 * background thread, but that background thread is also hanging because it's
2553 * waiting for the main thread to do an update, this might fix your issue.
2554 *
2555 * This hint can be set anytime.
2556 *
2557 * \since This hint is available since SDL 3.2.0.
2558 */
2559#define SDL_HINT_MAC_OPENGL_ASYNC_DISPATCH "SDL_MAC_OPENGL_ASYNC_DISPATCH"
2560
2561/**
2562 * A variable controlling whether the Option key on macOS should be remapped
2563 * to act as the Alt key.
2564 *
2565 * The variable can be set to the following values:
2566 *
2567 * - "none": The Option key is not remapped to Alt. (default)
2568 * - "only_left": Only the left Option key is remapped to Alt.
2569 * - "only_right": Only the right Option key is remapped to Alt.
2570 * - "both": Both Option keys are remapped to Alt.
2571 *
2572 * This will prevent the triggering of key compositions that rely on the
2573 * Option key, but will still send the Alt modifier for keyboard events. In
2574 * the case that both Alt and Option are pressed, the Option key will be
2575 * ignored. This is particularly useful for applications like terminal
2576 * emulators and graphical user interfaces (GUIs) that rely on Alt key
2577 * functionality for shortcuts or navigation. This does not apply to
2578 * SDL_GetKeyFromScancode and only has an effect if IME is enabled.
2579 *
2580 * This hint can be set anytime.
2581 *
2582 * \since This hint is available since SDL 3.2.0.
2583 */
2584#define SDL_HINT_MAC_OPTION_AS_ALT "SDL_MAC_OPTION_AS_ALT"
2585
2586/**
2587 * A variable controlling whether SDL_EVENT_MOUSE_WHEEL event values will have
2588 * momentum on macOS.
2589 *
2590 * The variable can be set to the following values:
2591 *
2592 * - "0": The mouse wheel events will have no momentum. (default)
2593 * - "1": The mouse wheel events will have momentum.
2594 *
2595 * This hint needs to be set before SDL_Init().
2596 *
2597 * \since This hint is available since SDL 3.2.0.
2598 */
2599#define SDL_HINT_MAC_SCROLL_MOMENTUM "SDL_MAC_SCROLL_MOMENTUM"
2600
2601/**
2602 * A variable controlling whether holding down a key will repeat the pressed
2603 * key or open the accents menu on macOS.
2604 *
2605 * The variable can be set to the following values:
2606 *
2607 * - "0": Holding a key will open the accents menu for that key.
2608 * - "1": Holding a key will repeat the pressed key. (default)
2609 *
2610 * This hint needs to be set before SDL_Init().
2611 *
2612 * \since This hint is available since SDL 3.4.0.
2613 */
2614#define SDL_HINT_MAC_PRESS_AND_HOLD "SDL_MAC_PRESS_AND_HOLD"
2615
2616/**
2617 * Request SDL_AppIterate() be called at a specific rate.
2618 *
2619 * If this is set to a number, it represents Hz, so "60" means try to iterate
2620 * 60 times per second. "0" means to iterate as fast as possible. Negative
2621 * values are illegal, but reserved, in case they are useful in a future
2622 * revision of SDL.
2623 *
2624 * There are other strings that have special meaning. If set to "waitevent",
2625 * SDL_AppIterate will not be called until new event(s) have arrived (and been
2626 * processed by SDL_AppEvent). This can be useful for apps that are completely
2627 * idle except in response to input.
2628 *
2629 * On some platforms, or if you are using SDL_main instead of SDL_AppIterate,
2630 * this hint is ignored. When the hint can be used, it is allowed to be
2631 * changed at any time.
2632 *
2633 * This defaults to 0, and specifying NULL for the hint's value will restore
2634 * the default.
2635 *
2636 * This doesn't have to be an integer value. For example, "59.94" won't be
2637 * rounded to an integer rate; the digits after the decimal are actually
2638 * respected.
2639 *
2640 * This hint can be set anytime.
2641 *
2642 * \since This hint is available since SDL 3.2.0.
2643 */
2644#define SDL_HINT_MAIN_CALLBACK_RATE "SDL_MAIN_CALLBACK_RATE"
2645
2646/**
2647 * A variable controlling whether the mouse is captured while mouse buttons
2648 * are pressed.
2649 *
2650 * The variable can be set to the following values:
2651 *
2652 * - "0": The mouse is not captured while mouse buttons are pressed.
2653 * - "1": The mouse is captured while mouse buttons are pressed.
2654 *
2655 * By default the mouse is captured while mouse buttons are pressed so if the
2656 * mouse is dragged outside the window, the application continues to receive
2657 * mouse events until the button is released.
2658 *
2659 * This hint can be set anytime.
2660 *
2661 * \since This hint is available since SDL 3.2.0.
2662 */
2663#define SDL_HINT_MOUSE_AUTO_CAPTURE "SDL_MOUSE_AUTO_CAPTURE"
2664
2665/**
2666 * A variable setting the double click radius, in pixels.
2667 *
2668 * This hint can be set anytime.
2669 *
2670 * \since This hint is available since SDL 3.2.0.
2671 */
2672#define SDL_HINT_MOUSE_DOUBLE_CLICK_RADIUS "SDL_MOUSE_DOUBLE_CLICK_RADIUS"
2673
2674/**
2675 * A variable setting the double click time, in milliseconds.
2676 *
2677 * This hint can be set anytime.
2678 *
2679 * \since This hint is available since SDL 3.2.0.
2680 */
2681#define SDL_HINT_MOUSE_DOUBLE_CLICK_TIME "SDL_MOUSE_DOUBLE_CLICK_TIME"
2682
2683/**
2684 * A variable setting which system cursor to use as the default cursor.
2685 *
2686 * This should be an integer corresponding to the SDL_SystemCursor enum. The
2687 * default value is zero (SDL_SYSTEM_CURSOR_DEFAULT).
2688 *
2689 * This hint needs to be set before SDL_Init().
2690 *
2691 * \since This hint is available since SDL 3.2.0.
2692 */
2693#define SDL_HINT_MOUSE_DEFAULT_SYSTEM_CURSOR "SDL_MOUSE_DEFAULT_SYSTEM_CURSOR"
2694
2695/**
2696 * A variable setting whether we should scale cursors by the current display
2697 * scale.
2698 *
2699 * The variable can be set to the following values:
2700 *
2701 * - "0": Cursors will not change size based on the display content scale.
2702 *   (default)
2703 * - "1": Cursors will automatically match the display content scale (e.g. a
2704 *   2x sized cursor will be used when the window is on a monitor with 200%
2705 *   scale). This is currently implemented on Windows and Wayland.
2706 *
2707 * This hint needs to be set before creating cursors.
2708 *
2709 * \since This hint is available since SDL 3.4.0.
2710 */
2711#define SDL_HINT_MOUSE_DPI_SCALE_CURSORS "SDL_MOUSE_DPI_SCALE_CURSORS"
2712
2713/**
2714 * A variable controlling whether warping a hidden mouse cursor will activate
2715 * relative mouse mode.
2716 *
2717 * When this hint is set, the mouse cursor is hidden, and multiple warps to
2718 * the window center occur within a short time period, SDL will emulate mouse
2719 * warps using relative mouse mode. This can provide smoother and more
2720 * reliable mouse motion for some older games, which continuously calculate
2721 * the distance traveled by the mouse pointer and warp it back to the center
2722 * of the window, rather than using relative mouse motion.
2723 *
2724 * Note that relative mouse mode may have different mouse acceleration
2725 * behavior than pointer warps.
2726 *
2727 * If your application needs to repeatedly warp the hidden mouse cursor at a
2728 * high-frequency for other purposes, it should disable this hint.
2729 *
2730 * The variable can be set to the following values:
2731 *
2732 * - "0": Attempts to warp the mouse will always be made.
2733 * - "1": Some mouse warps will be emulated by forcing relative mouse mode.
2734 *   (default)
2735 *
2736 * If not set, this is automatically enabled unless an application uses
2737 * relative mouse mode directly.
2738 *
2739 * This hint can be set anytime.
2740 *
2741 * \since This hint is available since SDL 3.2.0.
2742 */
2743#define SDL_HINT_MOUSE_EMULATE_WARP_WITH_RELATIVE "SDL_MOUSE_EMULATE_WARP_WITH_RELATIVE"
2744
2745/**
2746 * Allow mouse click events when clicking to focus an SDL window.
2747 *
2748 * The variable can be set to the following values:
2749 *
2750 * - "0": Ignore mouse clicks that activate a window. (default)
2751 * - "1": Generate events for mouse clicks that activate a window.
2752 *
2753 * This hint can be set anytime.
2754 *
2755 * \since This hint is available since SDL 3.2.0.
2756 */
2757#define SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH "SDL_MOUSE_FOCUS_CLICKTHROUGH"
2758
2759/**
2760 * A variable setting the speed scale for mouse motion, in floating point,
2761 * when the mouse is not in relative mode.
2762 *
2763 * This hint can be set anytime.
2764 *
2765 * \since This hint is available since SDL 3.2.0.
2766 */
2767#define SDL_HINT_MOUSE_NORMAL_SPEED_SCALE "SDL_MOUSE_NORMAL_SPEED_SCALE"
2768
2769/**
2770 * A variable controlling whether relative mouse mode constrains the mouse to
2771 * the center of the window.
2772 *
2773 * Constraining to the center of the window works better for FPS games and
2774 * when the application is running over RDP. Constraining to the whole window
2775 * works better for 2D games and increases the chance that the mouse will be
2776 * in the correct position when using high DPI mice.
2777 *
2778 * The variable can be set to the following values:
2779 *
2780 * - "0": Relative mouse mode constrains the mouse to the window.
2781 * - "1": Relative mouse mode constrains the mouse to the center of the
2782 *   window. (default)
2783 *
2784 * This hint can be set anytime.
2785 *
2786 * \since This hint is available since SDL 3.2.0.
2787 */
2788#define SDL_HINT_MOUSE_RELATIVE_MODE_CENTER "SDL_MOUSE_RELATIVE_MODE_CENTER"
2789
2790/**
2791 * A variable setting the scale for mouse motion, in floating point, when the
2792 * mouse is in relative mode.
2793 *
2794 * This hint can be set anytime.
2795 *
2796 * \since This hint is available since SDL 3.2.0.
2797 */
2798#define SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE "SDL_MOUSE_RELATIVE_SPEED_SCALE"
2799
2800/**
2801 * A variable controlling whether the system mouse acceleration curve is used
2802 * for relative mouse motion.
2803 *
2804 * The variable can be set to the following values:
2805 *
2806 * - "0": Relative mouse motion will be unscaled. (default)
2807 * - "1": Relative mouse motion will be scaled using the system mouse
2808 *   acceleration curve.
2809 *
2810 * If SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE is set, that will be applied after
2811 * system speed scale.
2812 *
2813 * This hint can be set anytime.
2814 *
2815 * \since This hint is available since SDL 3.2.0.
2816 */
2817#define SDL_HINT_MOUSE_RELATIVE_SYSTEM_SCALE "SDL_MOUSE_RELATIVE_SYSTEM_SCALE"
2818
2819/**
2820 * A variable controlling whether a motion event should be generated for mouse
2821 * warping in relative mode.
2822 *
2823 * The variable can be set to the following values:
2824 *
2825 * - "0": Warping the mouse will not generate a motion event in relative mode
2826 * - "1": Warping the mouse will generate a motion event in relative mode
2827 *
2828 * By default warping the mouse will not generate motion events in relative
2829 * mode. This avoids the application having to filter out large relative
2830 * motion due to warping.
2831 *
2832 * This hint can be set anytime.
2833 *
2834 * \since This hint is available since SDL 3.2.0.
2835 */
2836#define SDL_HINT_MOUSE_RELATIVE_WARP_MOTION "SDL_MOUSE_RELATIVE_WARP_MOTION"
2837
2838/**
2839 * A variable controlling whether the hardware cursor stays visible when
2840 * relative mode is active.
2841 *
2842 * This variable can be set to the following values:
2843 *
2844 * - "0": The cursor will be hidden while relative mode is active (default)
2845 * - "1": The cursor will remain visible while relative mode is active
2846 *
2847 * Note that for systems without raw hardware inputs, relative mode is
2848 * implemented using warping, so the hardware cursor will visibly warp between
2849 * frames if this is enabled on those systems.
2850 *
2851 * This hint can be set anytime.
2852 *
2853 * \since This hint is available since SDL 3.2.0.
2854 */
2855#define SDL_HINT_MOUSE_RELATIVE_CURSOR_VISIBLE "SDL_MOUSE_RELATIVE_CURSOR_VISIBLE"
2856
2857/**
2858 * A variable controlling whether mouse events should generate synthetic touch
2859 * events.
2860 *
2861 * The variable can be set to the following values:
2862 *
2863 * - "0": Mouse events will not generate touch events. (default for desktop
2864 *   platforms)
2865 * - "1": Mouse events will generate touch events. (default for mobile
2866 *   platforms, such as Android and iOS)
2867 *
2868 * This hint can be set anytime.
2869 *
2870 * \since This hint is available since SDL 3.2.0.
2871 */
2872#define SDL_HINT_MOUSE_TOUCH_EVENTS "SDL_MOUSE_TOUCH_EVENTS"
2873
2874/**
2875 * A variable controlling whether the keyboard should be muted on the console.
2876 *
2877 * Normally the keyboard is muted while SDL applications are running so that
2878 * keyboard input doesn't show up as key strokes on the console. This hint
2879 * allows you to turn that off for debugging purposes.
2880 *
2881 * The variable can be set to the following values:
2882 *
2883 * - "0": Allow keystrokes to go through to the console.
2884 * - "1": Mute keyboard input so it doesn't show up on the console. (default)
2885 *
2886 * This hint should be set before SDL is initialized.
2887 *
2888 * \since This hint is available since SDL 3.2.0.
2889 */
2890#define SDL_HINT_MUTE_CONSOLE_KEYBOARD "SDL_MUTE_CONSOLE_KEYBOARD"
2891
2892/**
2893 * Tell SDL not to catch the SIGINT or SIGTERM signals on POSIX platforms.
2894 *
2895 * The variable can be set to the following values:
2896 *
2897 * - "0": SDL will install a SIGINT and SIGTERM handler, and when it catches a
2898 *   signal, convert it into an SDL_EVENT_QUIT event. (default)
2899 * - "1": SDL will not install a signal handler at all.
2900 *
2901 * This hint should be set before SDL is initialized.
2902 *
2903 * \since This hint is available since SDL 3.2.0.
2904 */
2905#define SDL_HINT_NO_SIGNAL_HANDLERS "SDL_NO_SIGNAL_HANDLERS"
2906
2907/**
2908 * Specify the OpenGL library to load.
2909 *
2910 * This hint should be set before creating an OpenGL window or creating an
2911 * OpenGL context. If this hint isn't set, SDL will choose a reasonable
2912 * default.
2913 *
2914 * \since This hint is available since SDL 3.2.0.
2915 */
2916#define SDL_HINT_OPENGL_LIBRARY "SDL_OPENGL_LIBRARY"
2917
2918/**
2919 * Specify the EGL library to load.
2920 *
2921 * This hint should be set before creating an OpenGL window or creating an
2922 * OpenGL context. This hint is only considered if SDL is using EGL to manage
2923 * OpenGL contexts. If this hint isn't set, SDL will choose a reasonable
2924 * default.
2925 *
2926 * \since This hint is available since SDL 3.2.0.
2927 */
2928#define SDL_HINT_EGL_LIBRARY "SDL_EGL_LIBRARY"
2929
2930/**
2931 * A variable controlling what driver to use for OpenGL ES contexts.
2932 *
2933 * On some platforms, currently Windows and X11, OpenGL drivers may support
2934 * creating contexts with an OpenGL ES profile. By default SDL uses these
2935 * profiles, when available, otherwise it attempts to load an OpenGL ES
2936 * library, e.g. that provided by the ANGLE project. This variable controls
2937 * whether SDL follows this default behaviour or will always load an OpenGL ES
2938 * library.
2939 *
2940 * Circumstances where this is useful include - Testing an app with a
2941 * particular OpenGL ES implementation, e.g ANGLE, or emulator, e.g. those
2942 * from ARM, Imagination or Qualcomm. - Resolving OpenGL ES function addresses
2943 * at link time by linking with the OpenGL ES library instead of querying them
2944 * at run time with SDL_GL_GetProcAddress().
2945 *
2946 * Caution: for an application to work with the default behaviour across
2947 * different OpenGL drivers it must query the OpenGL ES function addresses at
2948 * run time using SDL_GL_GetProcAddress().
2949 *
2950 * This variable is ignored on most platforms because OpenGL ES is native or
2951 * not supported.
2952 *
2953 * The variable can be set to the following values:
2954 *
2955 * - "0": Use ES profile of OpenGL, if available. (default)
2956 * - "1": Load OpenGL ES library using the default library names.
2957 *
2958 * This hint should be set before SDL is initialized.
2959 *
2960 * \since This hint is available since SDL 3.2.0.
2961 */
2962#define SDL_HINT_OPENGL_ES_DRIVER "SDL_OPENGL_ES_DRIVER"
2963
2964/**
2965 * Mechanism to specify openvr_api library location
2966 *
2967 * By default, when using the OpenVR driver, it will search for the API
2968 * library in the current folder. But, if you wish to use a system API you can
2969 * specify that by using this hint. This should be the full or relative path
2970 * to a .dll on Windows or .so on Linux.
2971 *
2972 * \since This hint is available since SDL 3.2.0.
2973 */
2974#define SDL_HINT_OPENVR_LIBRARY              "SDL_OPENVR_LIBRARY"
2975
2976/**
2977 * A variable controlling which orientations are allowed on iOS/Android.
2978 *
2979 * In some circumstances it is necessary to be able to explicitly control
2980 * which UI orientations are allowed.
2981 *
2982 * This variable is a space delimited list of the following values:
2983 *
2984 * - "LandscapeLeft"
2985 * - "LandscapeRight"
2986 * - "Portrait"
2987 * - "PortraitUpsideDown"
2988 *
2989 * This hint should be set before SDL is initialized.
2990 *
2991 * \since This hint is available since SDL 3.2.0.
2992 */
2993#define SDL_HINT_ORIENTATIONS "SDL_ORIENTATIONS"
2994
2995/**
2996 * A variable controlling the use of a sentinel event when polling the event
2997 * queue.
2998 *
2999 * When polling for events, SDL_PumpEvents is used to gather new events from
3000 * devices. If a device keeps producing new events between calls to
3001 * SDL_PumpEvents, a poll loop will become stuck until the new events stop.
3002 * This is most noticeable when moving a high frequency mouse.
3003 *
3004 * The variable can be set to the following values:
3005 *
3006 * - "0": Disable poll sentinels.
3007 * - "1": Enable poll sentinels. (default)
3008 *
3009 * This hint can be set anytime.
3010 *
3011 * \since This hint is available since SDL 3.2.0.
3012 */
3013#define SDL_HINT_POLL_SENTINEL "SDL_POLL_SENTINEL"
3014
3015/**
3016 * Override for SDL_GetPreferredLocales().
3017 *
3018 * If set, this will be favored over anything the OS might report for the
3019 * user's preferred locales. Changing this hint at runtime will not generate a
3020 * SDL_EVENT_LOCALE_CHANGED event (but if you can change the hint, you can
3021 * push your own event, if you want).
3022 *
3023 * The format of this hint is a comma-separated list of language and locale,
3024 * combined with an underscore, as is a common format: "en_GB". Locale is
3025 * optional: "en". So you might have a list like this: "en_GB,jp,es_PT"
3026 *
3027 * This hint can be set anytime.
3028 *
3029 * \since This hint is available since SDL 3.2.0.
3030 */
3031#define SDL_HINT_PREFERRED_LOCALES "SDL_PREFERRED_LOCALES"
3032
3033/**
3034 * A variable that decides whether to send SDL_EVENT_QUIT when closing the
3035 * last window.
3036 *
3037 * The variable can be set to the following values:
3038 *
3039 * - "0": SDL will not send an SDL_EVENT_QUIT event when the last window is
3040 *   requesting to close. Note that in this case, there are still other
3041 *   legitimate reasons one might get an SDL_EVENT_QUIT event: choosing "Quit"
3042 *   from the macOS menu bar, sending a SIGINT (ctrl-c) on Unix, etc.
3043 * - "1": SDL will send a quit event when the last window is requesting to
3044 *   close. (default)
3045 *
3046 * If there is at least one active system tray icon, SDL_EVENT_QUIT will
3047 * instead be sent when both the last window will be closed and the last tray
3048 * icon will be destroyed.
3049 *
3050 * This hint can be set anytime.
3051 *
3052 * \since This hint is available since SDL 3.2.0.
3053 */
3054#define SDL_HINT_QUIT_ON_LAST_WINDOW_CLOSE "SDL_QUIT_ON_LAST_WINDOW_CLOSE"
3055
3056/**
3057 * A variable controlling whether the Direct3D device is initialized for
3058 * thread-safe operations.
3059 *
3060 * The variable can be set to the following values:
3061 *
3062 * - "0": Thread-safety is not enabled. (default)
3063 * - "1": Thread-safety is enabled.
3064 *
3065 * This hint should be set before creating a renderer.
3066 *
3067 * \since This hint is available since SDL 3.2.0.
3068 */
3069#define SDL_HINT_RENDER_DIRECT3D_THREADSAFE "SDL_RENDER_DIRECT3D_THREADSAFE"
3070
3071/**
3072 * A variable controlling whether to enable Direct3D 11+'s Debug Layer.
3073 *
3074 * This variable does not have any effect on the Direct3D 9 based renderer.
3075 *
3076 * The variable can be set to the following values:
3077 *
3078 * - "0": Disable Debug Layer use. (default)
3079 * - "1": Enable Debug Layer use.
3080 *
3081 * This hint should be set before creating a renderer.
3082 *
3083 * \since This hint is available since SDL 3.2.0.
3084 */
3085#define SDL_HINT_RENDER_DIRECT3D11_DEBUG "SDL_RENDER_DIRECT3D11_DEBUG"
3086
3087/**
3088 * A variable controlling whether to use the Direct3D 11 WARP software
3089 * rasterizer.
3090 *
3091 * For more information, see:
3092 * https://learn.microsoft.com/en-us/windows/win32/direct3darticles/directx-warp
3093 *
3094 * The variable can be set to the following values:
3095 *
3096 * - "0": Disable WARP rasterizer. (default)
3097 * - "1": Enable WARP rasterizer.
3098 *
3099 * This hint should be set before creating a renderer.
3100 *
3101 * \since This hint is available since SDL 3.4.0.
3102 */
3103#define SDL_HINT_RENDER_DIRECT3D11_WARP "SDL_RENDER_DIRECT3D11_WARP"
3104
3105/**
3106 * A variable controlling whether to enable Vulkan Validation Layers.
3107 *
3108 * This variable can be set to the following values:
3109 *
3110 * - "0": Disable Validation Layer use
3111 * - "1": Enable Validation Layer use
3112 *
3113 * By default, SDL does not use Vulkan Validation Layers.
3114 *
3115 * \since This hint is available since SDL 3.2.0.
3116 */
3117#define SDL_HINT_RENDER_VULKAN_DEBUG "SDL_RENDER_VULKAN_DEBUG"
3118
3119/**
3120 * A variable controlling whether to create the GPU device in debug mode.
3121 *
3122 * This variable can be set to the following values:
3123 *
3124 * - "0": Disable debug mode use (default)
3125 * - "1": Enable debug mode use
3126 *
3127 * This hint should be set before creating a renderer.
3128 *
3129 * \since This hint is available since SDL 3.2.0.
3130 */
3131#define SDL_HINT_RENDER_GPU_DEBUG "SDL_RENDER_GPU_DEBUG"
3132
3133/**
3134 * A variable controlling whether to prefer a low-power GPU on multi-GPU
3135 * systems.
3136 *
3137 * This variable can be set to the following values:
3138 *
3139 * - "0": Prefer high-performance GPU (default)
3140 * - "1": Prefer low-power GPU
3141 *
3142 * This hint should be set before creating a renderer.
3143 *
3144 * \since This hint is available since SDL 3.2.0.
3145 */
3146#define SDL_HINT_RENDER_GPU_LOW_POWER "SDL_RENDER_GPU_LOW_POWER"
3147
3148/**
3149 * A variable specifying which render driver to use.
3150 *
3151 * If the application doesn't pick a specific renderer to use, this variable
3152 * specifies the name of the preferred renderer. If the preferred renderer
3153 * can't be initialized, creating a renderer will fail.
3154 *
3155 * This variable is case insensitive and can be set to the following values:
3156 *
3157 * - "direct3d"
3158 * - "direct3d11"
3159 * - "direct3d12"
3160 * - "opengl"
3161 * - "opengles2"
3162 * - "opengles"
3163 * - "metal"
3164 * - "vulkan"
3165 * - "gpu"
3166 * - "software"
3167 *
3168 * This hint accepts a comma-separated list of driver names, and each will be
3169 * tried in the order listed when creating a renderer until one succeeds or
3170 * all of them fail.
3171 *
3172 * The default varies by platform, but it's the first one in the list that is
3173 * available on the current platform.
3174 *
3175 * This hint should be set before creating a renderer.
3176 *
3177 * \since This hint is available since SDL 3.2.0.
3178 */
3179#define SDL_HINT_RENDER_DRIVER "SDL_RENDER_DRIVER"
3180
3181/**
3182 * A variable controlling how the 2D render API renders lines.
3183 *
3184 * The variable can be set to the following values:
3185 *
3186 * - "0": Use the default line drawing method (Bresenham's line algorithm)
3187 * - "1": Use the driver point API using Bresenham's line algorithm (correct,
3188 *   draws many points)
3189 * - "2": Use the driver line API (occasionally misses line endpoints based on
3190 *   hardware driver quirks
3191 * - "3": Use the driver geometry API (correct, draws thicker diagonal lines)
3192 *
3193 * This hint should be set before creating a renderer.
3194 *
3195 * \since This hint is available since SDL 3.2.0.
3196 */
3197#define SDL_HINT_RENDER_LINE_METHOD "SDL_RENDER_LINE_METHOD"
3198
3199/**
3200 * A variable controlling whether the Metal render driver select low power
3201 * device over default one.
3202 *
3203 * The variable can be set to the following values:
3204 *
3205 * - "0": Use the preferred OS device. (default)
3206 * - "1": Select a low power device.
3207 *
3208 * This hint should be set before creating a renderer.
3209 *
3210 * \since This hint is available since SDL 3.2.0.
3211 */
3212#define SDL_HINT_RENDER_METAL_PREFER_LOW_POWER_DEVICE "SDL_RENDER_METAL_PREFER_LOW_POWER_DEVICE"
3213
3214/**
3215 * A variable controlling whether updates to the SDL screen surface should be
3216 * synchronized with the vertical refresh, to avoid tearing.
3217 *
3218 * This hint overrides the application preference when creating a renderer.
3219 *
3220 * The variable can be set to the following values:
3221 *
3222 * - "0": Disable vsync. (default)
3223 * - "1": Enable vsync.
3224 *
3225 * This hint should be set before creating a renderer.
3226 *
3227 * \since This hint is available since SDL 3.2.0.
3228 */
3229#define SDL_HINT_RENDER_VSYNC "SDL_RENDER_VSYNC"
3230
3231/**
3232 * A variable to control whether the return key on the soft keyboard should
3233 * hide the soft keyboard on Android and iOS.
3234 *
3235 * This hint sets the default value of SDL_PROP_TEXTINPUT_MULTILINE_BOOLEAN.
3236 *
3237 * The variable can be set to the following values:
3238 *
3239 * - "0": The return key will be handled as a key event. (default)
3240 * - "1": The return key will hide the keyboard.
3241 *
3242 * This hint can be set anytime.
3243 *
3244 * \since This hint is available since SDL 3.2.0.
3245 */
3246#define SDL_HINT_RETURN_KEY_HIDES_IME "SDL_RETURN_KEY_HIDES_IME"
3247
3248/**
3249 * A variable containing a list of ROG gamepad capable mice.
3250 *
3251 * The format of the string is a comma separated list of USB VID/PID pairs in
3252 * hexadecimal form, e.g.
3253 *
3254 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
3255 *
3256 * The variable can also take the form of "@file", in which case the named
3257 * file will be loaded and interpreted as the value of the variable.
3258 *
3259 * This hint should be set before SDL is initialized.
3260 *
3261 * \since This hint is available since SDL 3.2.0.
3262 *
3263 * \sa SDL_HINT_ROG_GAMEPAD_MICE_EXCLUDED
3264 */
3265#define SDL_HINT_ROG_GAMEPAD_MICE "SDL_ROG_GAMEPAD_MICE"
3266
3267/**
3268 * A variable containing a list of devices that are not ROG gamepad capable
3269 * mice.
3270 *
3271 * This will override SDL_HINT_ROG_GAMEPAD_MICE and the built in device list.
3272 *
3273 * The format of the string is a comma separated list of USB VID/PID pairs in
3274 * hexadecimal form, e.g.
3275 *
3276 * `0xAAAA/0xBBBB,0xCCCC/0xDDDD`
3277 *
3278 * The variable can also take the form of "@file", in which case the named
3279 * file will be loaded and interpreted as the value of the variable.
3280 *
3281 * This hint should be set before SDL is initialized.
3282 *
3283 * \since This hint is available since SDL 3.2.0.
3284 */
3285#define SDL_HINT_ROG_GAMEPAD_MICE_EXCLUDED "SDL_ROG_GAMEPAD_MICE_EXCLUDED"
3286
3287/**
3288 * Variable controlling the width of the PS2's framebuffer in pixels
3289 *
3290 * By default, this variable is "640"
3291 */
3292#define SDL_HINT_PS2_GS_WIDTH    "SDL_PS2_GS_WIDTH"
3293
3294/**
3295 * Variable controlling the height of the PS2's framebuffer in pixels
3296 *
3297 * By default, this variable is "448"
3298 */
3299#define SDL_HINT_PS2_GS_HEIGHT    "SDL_PS2_GS_HEIGHT"
3300
3301/**
3302 * Variable controlling whether the signal is interlaced or progressive
3303 *
3304 * - "0": Image is interlaced. (default)
3305 * - "1": Image is progressive
3306 */
3307#define SDL_HINT_PS2_GS_PROGRESSIVE    "SDL_PS2_GS_PROGRESSIVE"
3308
3309/**
3310 * Variable controlling the video mode of the console
3311 *
3312 * - "": Console-native. (default)
3313 * - "NTSC": 60hz region
3314 * - "PAL": 50hz region
3315 */
3316#define SDL_HINT_PS2_GS_MODE    "SDL_PS2_GS_MODE"
3317
3318/**
3319 * A variable controlling which Dispmanx layer to use on a Raspberry PI.
3320 *
3321 * Also known as Z-order. The variable can take a negative or positive value.
3322 * The default is 10000.
3323 *
3324 * This hint should be set before SDL is initialized.
3325 *
3326 * \since This hint is available since SDL 3.2.0.
3327 */
3328#define SDL_HINT_RPI_VIDEO_LAYER "SDL_RPI_VIDEO_LAYER"
3329
3330/**
3331 * Specify an "activity name" for screensaver inhibition.
3332 *
3333 * Some platforms, notably Linux desktops, list the applications which are
3334 * inhibiting the screensaver or other power-saving features.
3335 *
3336 * This hint lets you specify the "activity name" sent to the OS when
3337 * SDL_DisableScreenSaver() is used (or the screensaver is automatically
3338 * disabled). The contents of this hint are used when the screensaver is
3339 * disabled. You should use a string that describes what your program is doing
3340 * (and, therefore, why the screensaver is disabled). For example, "Playing a
3341 * game" or "Watching a video".
3342 *
3343 * Setting this to "" or leaving it unset will have SDL use a reasonable
3344 * default: "Playing a game" or something similar.
3345 *
3346 * This hint should be set before calling SDL_DisableScreenSaver()
3347 *
3348 * \since This hint is available since SDL 3.2.0.
3349 */
3350#define SDL_HINT_SCREENSAVER_INHIBIT_ACTIVITY_NAME "SDL_SCREENSAVER_INHIBIT_ACTIVITY_NAME"
3351
3352/**
3353 * A variable controlling whether SDL calls dbus_shutdown() on quit.
3354 *
3355 * This is useful as a debug tool to validate memory leaks, but shouldn't ever
3356 * be set in production applications, as other libraries used by the
3357 * application might use dbus under the hood and this can cause crashes if
3358 * they continue after SDL_Quit().
3359 *
3360 * The variable can be set to the following values:
3361 *
3362 * - "0": SDL will not call dbus_shutdown() on quit. (default)
3363 * - "1": SDL will call dbus_shutdown() on quit.
3364 *
3365 * This hint can be set anytime.
3366 *
3367 * \since This hint is available since SDL 3.2.0.
3368 */
3369#define SDL_HINT_SHUTDOWN_DBUS_ON_QUIT "SDL_SHUTDOWN_DBUS_ON_QUIT"
3370
3371/**
3372 * A variable that specifies a backend to use for title storage.
3373 *
3374 * By default, SDL will try all available storage backends in a reasonable
3375 * order until it finds one that can work, but this hint allows the app or
3376 * user to force a specific target, such as "pc" if, say, you are on Steam but
3377 * want to avoid SteamRemoteStorage for title data.
3378 *
3379 * This hint should be set before SDL is initialized.
3380 *
3381 * \since This hint is available since SDL 3.2.0.
3382 */
3383#define SDL_HINT_STORAGE_TITLE_DRIVER "SDL_STORAGE_TITLE_DRIVER"
3384
3385/**
3386 * A variable that specifies a backend to use for user storage.
3387 *
3388 * By default, SDL will try all available storage backends in a reasonable
3389 * order until it finds one that can work, but this hint allows the app or
3390 * user to force a specific target, such as "pc" if, say, you are on Steam but
3391 * want to avoid SteamRemoteStorage for user data.
3392 *
3393 * This hint should be set before SDL is initialized.
3394 *
3395 * \since This hint is available since SDL 3.2.0.
3396 */
3397#define SDL_HINT_STORAGE_USER_DRIVER "SDL_STORAGE_USER_DRIVER"
3398
3399/**
3400 * Specifies whether SDL_THREAD_PRIORITY_TIME_CRITICAL should be treated as
3401 * realtime.
3402 *
3403 * On some platforms, like Linux, a realtime priority thread may be subject to
3404 * restrictions that require special handling by the application. This hint
3405 * exists to let SDL know that the app is prepared to handle said
3406 * restrictions.
3407 *
3408 * On Linux, SDL will apply the following configuration to any thread that
3409 * becomes realtime:
3410 *
3411 * - The SCHED_RESET_ON_FORK bit will be set on the scheduling policy,
3412 * - An RLIMIT_RTTIME budget will be configured to the rtkit specified limit.
3413 * - Exceeding this limit will result in the kernel sending SIGKILL to the
3414 *   app, refer to the man pages for more information.
3415 *
3416 * The variable can be set to the following values:
3417 *
3418 * - "0": default platform specific behaviour
3419 * - "1": Force SDL_THREAD_PRIORITY_TIME_CRITICAL to a realtime scheduling
3420 *   policy
3421 *
3422 * This hint should be set before calling SDL_SetCurrentThreadPriority()
3423 *
3424 * \since This hint is available since SDL 3.2.0.
3425 */
3426#define SDL_HINT_THREAD_FORCE_REALTIME_TIME_CRITICAL "SDL_THREAD_FORCE_REALTIME_TIME_CRITICAL"
3427
3428/**
3429 * A string specifying additional information to use with
3430 * SDL_SetCurrentThreadPriority.
3431 *
3432 * By default SDL_SetCurrentThreadPriority will make appropriate system
3433 * changes in order to apply a thread priority. For example on systems using
3434 * pthreads the scheduler policy is changed automatically to a policy that
3435 * works well with a given priority. Code which has specific requirements can
3436 * override SDL's default behavior with this hint.
3437 *
3438 * pthread hint values are "current", "other", "fifo" and "rr". Currently no
3439 * other platform hint values are defined but may be in the future.
3440 *
3441 * On Linux, the kernel may send SIGKILL to realtime tasks which exceed the
3442 * distro configured execution budget for rtkit. This budget can be queried
3443 * through RLIMIT_RTTIME after calling SDL_SetCurrentThreadPriority().
3444 *
3445 * This hint should be set before calling SDL_SetCurrentThreadPriority()
3446 *
3447 * \since This hint is available since SDL 3.2.0.
3448 */
3449#define SDL_HINT_THREAD_PRIORITY_POLICY "SDL_THREAD_PRIORITY_POLICY"
3450
3451/**
3452 * A variable that controls the timer resolution, in milliseconds.
3453 *
3454 * The higher resolution the timer, the more frequently the CPU services timer
3455 * interrupts, and the more precise delays are, but this takes up power and
3456 * CPU time. This hint is only used on Windows.
3457 *
3458 * See this blog post for more information:
3459 * http://randomascii.wordpress.com/2013/07/08/windows-timer-resolution-megawatts-wasted/
3460 *
3461 * The default value is "1".
3462 *
3463 * If this variable is set to "0", the system timer resolution is not set.
3464 *
3465 * This hint can be set anytime.
3466 *
3467 * \since This hint is available since SDL 3.2.0.
3468 */
3469#define SDL_HINT_TIMER_RESOLUTION "SDL_TIMER_RESOLUTION"
3470
3471/**
3472 * A variable controlling whether touch events should generate synthetic mouse
3473 * events.
3474 *
3475 * The variable can be set to the following values:
3476 *
3477 * - "0": Touch events will not generate mouse events.
3478 * - "1": Touch events will generate mouse events. (default)
3479 *
3480 * This hint can be set anytime.
3481 *
3482 * \since This hint is available since SDL 3.2.0.
3483 */
3484#define SDL_HINT_TOUCH_MOUSE_EVENTS "SDL_TOUCH_MOUSE_EVENTS"
3485
3486/**
3487 * A variable controlling whether trackpads should be treated as touch
3488 * devices.
3489 *
3490 * On macOS (and possibly other platforms in the future), SDL will report
3491 * touches on a trackpad as mouse input, which is generally what users expect
3492 * from this device; however, these are often actually full multitouch-capable
3493 * touch devices, so it might be preferable to some apps to treat them as
3494 * such.
3495 *
3496 * The variable can be set to the following values:
3497 *
3498 * - "0": Trackpad will send mouse events. (default)
3499 * - "1": Trackpad will send touch events.
3500 *
3501 * This hint should be set before SDL is initialized.
3502 *
3503 * \since This hint is available since SDL 3.2.0.
3504 */
3505#define SDL_HINT_TRACKPAD_IS_TOUCH_ONLY "SDL_TRACKPAD_IS_TOUCH_ONLY"
3506
3507/**
3508 * A variable controlling whether the Android / tvOS remotes should be listed
3509 * as joystick devices, instead of sending keyboard events.
3510 *
3511 * The variable can be set to the following values:
3512 *
3513 * - "0": Remotes send enter/escape/arrow key events.
3514 * - "1": Remotes are available as 2 axis, 2 button joysticks. (default)
3515 *
3516 * This hint should be set before SDL is initialized.
3517 *
3518 * \since This hint is available since SDL 3.2.0.
3519 */
3520#define SDL_HINT_TV_REMOTE_AS_JOYSTICK "SDL_TV_REMOTE_AS_JOYSTICK"
3521
3522/**
3523 * A variable controlling whether the screensaver is enabled.
3524 *
3525 * The variable can be set to the following values:
3526 *
3527 * - "0": Disable screensaver. (default)
3528 * - "1": Enable screensaver.
3529 *
3530 * This hint should be set before SDL is initialized.
3531 *
3532 * \since This hint is available since SDL 3.2.0.
3533 */
3534#define SDL_HINT_VIDEO_ALLOW_SCREENSAVER "SDL_VIDEO_ALLOW_SCREENSAVER"
3535
3536/**
3537 * A comma separated list containing the names of the displays that SDL should
3538 * sort to the front of the display list.
3539 *
3540 * When this hint is set, displays with matching name strings will be
3541 * prioritized in the list of displays, as exposed by calling
3542 * SDL_GetDisplays(), with the first listed becoming the primary display. The
3543 * naming convention can vary depending on the environment, but it is usually
3544 * a connector name (e.g. 'DP-1', 'DP-2', 'HDMI-A-1',etc...).
3545 *
3546 * On Wayland and X11 desktops, the connector names associated with displays
3547 * can typically be found by using the `xrandr` utility.
3548 *
3549 * This hint is currently supported on the following drivers:
3550 *
3551 * - KMSDRM (kmsdrm)
3552 * - Wayland (wayland)
3553 * - X11 (x11)
3554 *
3555 * This hint should be set before SDL is initialized.
3556 *
3557 * \since This hint is available since SDL 3.2.0.
3558 */
3559#define SDL_HINT_VIDEO_DISPLAY_PRIORITY "SDL_VIDEO_DISPLAY_PRIORITY"
3560
3561/**
3562 * Tell the video driver that we only want a double buffer.
3563 *
3564 * By default, most lowlevel 2D APIs will use a triple buffer scheme that
3565 * wastes no CPU time on waiting for vsync after issuing a flip, but
3566 * introduces a frame of latency. On the other hand, using a double buffer
3567 * scheme instead is recommended for cases where low latency is an important
3568 * factor because we save a whole frame of latency.
3569 *
3570 * We do so by waiting for vsync immediately after issuing a flip, usually
3571 * just after eglSwapBuffers call in the backend's *_SwapWindow function.
3572 *
3573 * This hint is currently supported on the following drivers:
3574 *
3575 * - Raspberry Pi (raspberrypi)
3576 * - Wayland (wayland)
3577 *
3578 * This hint should be set before SDL is initialized.
3579 *
3580 * \since This hint is available since SDL 3.2.0.
3581 */
3582#define SDL_HINT_VIDEO_DOUBLE_BUFFER "SDL_VIDEO_DOUBLE_BUFFER"
3583
3584/**
3585 * A variable that specifies a video backend to use.
3586 *
3587 * By default, SDL will try all available video backends in a reasonable order
3588 * until it finds one that can work, but this hint allows the app or user to
3589 * force a specific target, such as "x11" if, say, you are on Wayland but want
3590 * to try talking to the X server instead.
3591 *
3592 * This hint accepts a comma-separated list of driver names, and each will be
3593 * tried in the order listed during init, until one succeeds or all of them
3594 * fail.
3595 *
3596 * This hint should be set before SDL is initialized.
3597 *
3598 * \since This hint is available since SDL 3.2.0.
3599 */
3600#define SDL_HINT_VIDEO_DRIVER "SDL_VIDEO_DRIVER"
3601
3602/**
3603 * A variable controlling whether the dummy video driver saves output frames.
3604 *
3605 * - "0": Video frames are not saved to disk. (default)
3606 * - "1": Video frames are saved to files in the format "SDL_windowX-Y.bmp",
3607 *   where X is the window ID, and Y is the frame number.
3608 *
3609 * This hint can be set anytime.
3610 *
3611 * \since This hint is available since SDL 3.2.0.
3612 */
3613#define SDL_HINT_VIDEO_DUMMY_SAVE_FRAMES "SDL_VIDEO_DUMMY_SAVE_FRAMES"
3614
3615/**
3616 * If eglGetPlatformDisplay fails, fall back to calling eglGetDisplay.
3617 *
3618 * The variable can be set to one of the following values:
3619 *
3620 * - "0": Do not fall back to eglGetDisplay.
3621 * - "1": Fall back to eglGetDisplay if eglGetPlatformDisplay fails. (default)
3622 *
3623 * This hint should be set before SDL is initialized.
3624 *
3625 * \since This hint is available since SDL 3.2.0.
3626 */
3627#define SDL_HINT_VIDEO_EGL_ALLOW_GETDISPLAY_FALLBACK "SDL_VIDEO_EGL_ALLOW_GETDISPLAY_FALLBACK"
3628
3629/**
3630 * A variable controlling whether the OpenGL context should be created with
3631 * EGL.
3632 *
3633 * The variable can be set to the following values:
3634 *
3635 * - "0": Use platform-specific GL context creation API (GLX, WGL, CGL, etc).
3636 *   (default)
3637 * - "1": Use EGL
3638 *
3639 * This hint should be set before SDL is initialized.
3640 *
3641 * \since This hint is available since SDL 3.2.0.
3642 */
3643#define SDL_HINT_VIDEO_FORCE_EGL "SDL_VIDEO_FORCE_EGL"
3644
3645/**
3646 * A variable that specifies the policy for fullscreen Spaces on macOS.
3647 *
3648 * The variable can be set to the following values:
3649 *
3650 * - "0": Disable Spaces support (FULLSCREEN_DESKTOP won't use them and
3651 *   SDL_WINDOW_RESIZABLE windows won't offer the "fullscreen" button on their
3652 *   titlebars).
3653 * - "1": Enable Spaces support (FULLSCREEN_DESKTOP will use them and
3654 *   SDL_WINDOW_RESIZABLE windows will offer the "fullscreen" button on their
3655 *   titlebars). (default)
3656 *
3657 * This hint should be set before creating a window.
3658 *
3659 * \since This hint is available since SDL 3.2.0.
3660 */
3661#define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES "SDL_VIDEO_MAC_FULLSCREEN_SPACES"
3662
3663/**
3664 * A variable that specifies the menu visibility when a window is fullscreen
3665 * in Spaces on macOS.
3666 *
3667 * The variable can be set to the following values:
3668 *
3669 * - "0": The menu will be hidden when the window is in a fullscreen space,
3670 *   and not accessible by moving the mouse to the top of the screen.
3671 * - "1": The menu will be accessible when the window is in a fullscreen
3672 *   space.
3673 * - "auto": The menu will be hidden if fullscreen mode was toggled on
3674 *   programmatically via `SDL_SetWindowFullscreen()`, and accessible if
3675 *   fullscreen was entered via the "fullscreen" button on the window title
3676 *   bar. (default)
3677 *
3678 * This hint can be set anytime.
3679 *
3680 * \since This hint is available since SDL 3.2.0.
3681 */
3682#define SDL_HINT_VIDEO_MAC_FULLSCREEN_MENU_VISIBILITY "SDL_VIDEO_MAC_FULLSCREEN_MENU_VISIBILITY"
3683
3684/**
3685 * A variable indicating whether the metal layer drawable size should be
3686 * updated for the SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event on macOS.
3687 *
3688 * The variable can be set to the following values:
3689 *
3690 * - "0": the metal layer drawable size will not be updated on the
3691 *   SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event.
3692 * - "1": the metal layer drawable size will be updated on the
3693 *   SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event. (default)
3694 *
3695 * This hint should be set before SDL_Metal_CreateView called.
3696 *
3697 * \since This hint is available since SDL 3.4.0.
3698 */
3699#define SDL_HINT_VIDEO_METAL_AUTO_RESIZE_DRAWABLE "SDL_VIDEO_METAL_AUTO_RESIZE_DRAWABLE"
3700
3701/**
3702 * A variable controlling whether SDL will attempt to automatically set the
3703 * destination display to a mode most closely matching that of the previous
3704 * display if an exclusive fullscreen window is moved onto it.
3705 *
3706 * The variable can be set to the following values:
3707 *
3708 * - "0": SDL will not attempt to automatically set a matching mode on the
3709 *   destination display. If an exclusive fullscreen window is moved to a new
3710 *   display, the window will become fullscreen desktop.
3711 * - "1": SDL will attempt to automatically set a mode on the destination
3712 *   display that most closely matches the mode of the display that the
3713 *   exclusive fullscreen window was previously on. (default)
3714 *
3715 * This hint can be set anytime.
3716 *
3717 * \since This hint is available since SDL 3.4.0.
3718 */
3719#define SDL_HINT_VIDEO_MATCH_EXCLUSIVE_MODE_ON_MOVE "SDL_VIDEO_MATCH_EXCLUSIVE_MODE_ON_MOVE"
3720
3721/**
3722 * A variable controlling whether fullscreen windows are minimized when they
3723 * lose focus.
3724 *
3725 * The variable can be set to the following values:
3726 *
3727 * - "0": Fullscreen windows will not be minimized when they lose focus.
3728 * - "1": Fullscreen windows are minimized when they lose focus.
3729 * - "auto": Fullscreen windows are minimized when they lose focus if they use
3730 *   exclusive fullscreen modes, so the desktop video mode is restored.
3731 *   (default)
3732 *
3733 * This hint can be set anytime.
3734 *
3735 * \since This hint is available since SDL 3.2.0.
3736 */
3737#define SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS "SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS"
3738
3739/**
3740 * A variable controlling whether the offscreen video driver saves output
3741 * frames.
3742 *
3743 * This only saves frames that are generated using software rendering, not
3744 * accelerated OpenGL rendering.
3745 *
3746 * - "0": Video frames are not saved to disk. (default)
3747 * - "1": Video frames are saved to files in the format "SDL_windowX-Y.bmp",
3748 *   where X is the window ID, and Y is the frame number.
3749 *
3750 * This hint can be set anytime.
3751 *
3752 * \since This hint is available since SDL 3.2.0.
3753 */
3754#define SDL_HINT_VIDEO_OFFSCREEN_SAVE_FRAMES "SDL_VIDEO_OFFSCREEN_SAVE_FRAMES"
3755
3756/**
3757 * A variable controlling whether all window operations will block until
3758 * complete.
3759 *
3760 * Window systems that run asynchronously may not have the results of window
3761 * operations that resize or move the window applied immediately upon the
3762 * return of the requesting function. Setting this hint will cause such
3763 * operations to block after every call until the pending operation has
3764 * completed. Setting this to '1' is the equivalent of calling
3765 * SDL_SyncWindow() after every function call.
3766 *
3767 * Be aware that amount of time spent blocking while waiting for window
3768 * operations to complete can be quite lengthy, as animations may have to
3769 * complete, which can take upwards of multiple seconds in some cases.
3770 *
3771 * The variable can be set to the following values:
3772 *
3773 * - "0": Window operations are non-blocking. (default)
3774 * - "1": Window operations will block until completed.
3775 *
3776 * This hint can be set anytime.
3777 *
3778 * \since This hint is available since SDL 3.2.0.
3779 */
3780#define SDL_HINT_VIDEO_SYNC_WINDOW_OPERATIONS "SDL_VIDEO_SYNC_WINDOW_OPERATIONS"
3781
3782/**
3783 * A variable controlling whether the libdecor Wayland backend is allowed to
3784 * be used.
3785 *
3786 * libdecor is used over xdg-shell when xdg-decoration protocol is
3787 * unavailable.
3788 *
3789 * The variable can be set to the following values:
3790 *
3791 * - "0": libdecor use is disabled.
3792 * - "1": libdecor use is enabled. (default)
3793 *
3794 * This hint should be set before SDL is initialized.
3795 *
3796 * \since This hint is available since SDL 3.2.0.
3797 */
3798#define SDL_HINT_VIDEO_WAYLAND_ALLOW_LIBDECOR "SDL_VIDEO_WAYLAND_ALLOW_LIBDECOR"
3799
3800/**
3801 * A variable controlling whether video mode emulation is enabled under
3802 * Wayland.
3803 *
3804 * When this hint is set, a standard set of emulated CVT video modes will be
3805 * exposed for use by the application. If it is disabled, the only modes
3806 * exposed will be the logical desktop size and, in the case of a scaled
3807 * desktop, the native display resolution.
3808 *
3809 * The variable can be set to the following values:
3810 *
3811 * - "0": Video mode emulation is disabled.
3812 * - "1": Video mode emulation is enabled. (default)
3813 *
3814 * This hint should be set before SDL is initialized.
3815 *
3816 * \since This hint is available since SDL 3.2.0.
3817 */
3818#define SDL_HINT_VIDEO_WAYLAND_MODE_EMULATION "SDL_VIDEO_WAYLAND_MODE_EMULATION"
3819
3820/**
3821 * A variable controlling how modes with a non-native aspect ratio are
3822 * displayed under Wayland.
3823 *
3824 * When this hint is set, the requested scaling will be used when displaying
3825 * fullscreen video modes that don't match the display's native aspect ratio.
3826 * This is contingent on compositor viewport support.
3827 *
3828 * The variable can be set to the following values:
3829 *
3830 * - "aspect" - Video modes will be displayed scaled, in their proper aspect
3831 *   ratio, with black bars.
3832 * - "stretch" - Video modes will be scaled to fill the entire display.
3833 *   (default)
3834 * - "none" - Video modes will be displayed as 1:1 with no scaling.
3835 *
3836 * This hint should be set before creating a window.
3837 *
3838 * \since This hint is available since SDL 3.2.0.
3839 */
3840#define SDL_HINT_VIDEO_WAYLAND_MODE_SCALING "SDL_VIDEO_WAYLAND_MODE_SCALING"
3841
3842/**
3843 * A variable controlling whether the libdecor Wayland backend is preferred
3844 * over native decorations.
3845 *
3846 * When this hint is set, libdecor will be used to provide window decorations,
3847 * even if xdg-decoration is available. (Note that, by default, libdecor will
3848 * use xdg-decoration itself if available).
3849 *
3850 * The variable can be set to the following values:
3851 *
3852 * - "0": libdecor is enabled only if server-side decorations are unavailable.
3853 *   (default)
3854 * - "1": libdecor is always enabled if available.
3855 *
3856 * This hint should be set before SDL is initialized.
3857 *
3858 * \since This hint is available since SDL 3.2.0.
3859 */
3860#define SDL_HINT_VIDEO_WAYLAND_PREFER_LIBDECOR "SDL_VIDEO_WAYLAND_PREFER_LIBDECOR"
3861
3862/**
3863 * A variable forcing non-DPI-aware Wayland windows to output at 1:1 scaling.
3864 *
3865 * This must be set before initializing the video subsystem.
3866 *
3867 * When this hint is set, Wayland windows that are not flagged as being
3868 * DPI-aware will be output with scaling designed to force 1:1 pixel mapping.
3869 *
3870 * This is intended to allow legacy applications to be displayed without
3871 * desktop scaling being applied, and has issues with certain display
3872 * configurations, as this forces the window to behave in a way that Wayland
3873 * desktops were not designed to accommodate:
3874 *
3875 * - Rounding errors can result with odd window sizes and/or desktop scales,
3876 *   which can cause the window contents to appear slightly blurry.
3877 * - Positioning the window may be imprecise due to unit conversions and
3878 *   rounding.
3879 * - The window may be unusably small on scaled desktops.
3880 * - The window may jump in size when moving between displays of different
3881 *   scale factors.
3882 * - Displays may appear to overlap when using a multi-monitor setup with
3883 *   scaling enabled.
3884 * - Possible loss of cursor precision due to the logical size of the window
3885 *   being reduced.
3886 *
3887 * New applications should be designed with proper DPI awareness handling
3888 * instead of enabling this.
3889 *
3890 * The variable can be set to the following values:
3891 *
3892 * - "0": Windows will be scaled normally.
3893 * - "1": Windows will be forced to scale to achieve 1:1 output.
3894 *
3895 * This hint should be set before creating a window.
3896 *
3897 * \since This hint is available since SDL 3.2.0.
3898 */
3899#define SDL_HINT_VIDEO_WAYLAND_SCALE_TO_DISPLAY "SDL_VIDEO_WAYLAND_SCALE_TO_DISPLAY"
3900
3901/**
3902 * A variable specifying which shader compiler to preload when using the
3903 * Chrome ANGLE binaries.
3904 *
3905 * SDL has EGL and OpenGL ES2 support on Windows via the ANGLE project. It can
3906 * use two different sets of binaries, those compiled by the user from source
3907 * or those provided by the Chrome browser. In the later case, these binaries
3908 * require that SDL loads a DLL providing the shader compiler.
3909 *
3910 * The variable can be set to the following values:
3911 *
3912 * - "d3dcompiler_46.dll" - best for Vista or later. (default)
3913 * - "d3dcompiler_43.dll" - for XP support.
3914 * - "none" - do not load any library, useful if you compiled ANGLE from
3915 *   source and included the compiler in your binaries.
3916 *
3917 * This hint should be set before SDL is initialized.
3918 *
3919 * \since This hint is available since SDL 3.2.0.
3920 */
3921#define SDL_HINT_VIDEO_WIN_D3DCOMPILER "SDL_VIDEO_WIN_D3DCOMPILER"
3922
3923/**
3924 * A variable controlling whether SDL should call XSelectInput() to enable
3925 * input events on X11 windows wrapped by SDL windows.
3926 *
3927 * The variable can be set to the following values:
3928 *
3929 * - "0": Don't call XSelectInput(), assuming the native window code has done
3930 *   it already.
3931 * - "1": Call XSelectInput() to enable input events. (default)
3932 *
3933 * This hint should be set before creating a window.
3934 *
3935 * \since This hint is available since SDL 3.2.10.
3936 */
3937#define SDL_HINT_VIDEO_X11_EXTERNAL_WINDOW_INPUT "SDL_VIDEO_X11_EXTERNAL_WINDOW_INPUT"
3938
3939/**
3940 * A variable controlling whether the X11 _NET_WM_BYPASS_COMPOSITOR hint
3941 * should be used.
3942 *
3943 * The variable can be set to the following values:
3944 *
3945 * - "0": Disable _NET_WM_BYPASS_COMPOSITOR.
3946 * - "1": Enable _NET_WM_BYPASS_COMPOSITOR. (default)
3947 *
3948 * This hint should be set before creating a window.
3949 *
3950 * \since This hint is available since SDL 3.2.0.
3951 */
3952#define SDL_HINT_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR "SDL_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR"
3953
3954/**
3955 * A variable controlling whether the X11 _NET_WM_PING protocol should be
3956 * supported.
3957 *
3958 * By default SDL will use _NET_WM_PING, but for applications that know they
3959 * will not always be able to respond to ping requests in a timely manner they
3960 * can turn it off to avoid the window manager thinking the app is hung.
3961 *
3962 * The variable can be set to the following values:
3963 *
3964 * - "0": Disable _NET_WM_PING.
3965 * - "1": Enable _NET_WM_PING. (default)
3966 *
3967 * This hint should be set before creating a window.
3968 *
3969 * \since This hint is available since SDL 3.2.0.
3970 */
3971#define SDL_HINT_VIDEO_X11_NET_WM_PING "SDL_VIDEO_X11_NET_WM_PING"
3972
3973/**
3974 * A variable controlling whether SDL uses DirectColor visuals.
3975 *
3976 * The variable can be set to the following values:
3977 *
3978 * - "0": Disable DirectColor visuals.
3979 * - "1": Enable DirectColor visuals. (default)
3980 *
3981 * This hint should be set before initializing the video subsystem.
3982 *
3983 * \since This hint is available since SDL 3.2.0.
3984 */
3985#define SDL_HINT_VIDEO_X11_NODIRECTCOLOR "SDL_VIDEO_X11_NODIRECTCOLOR"
3986
3987/**
3988 * A variable forcing the content scaling factor for X11 displays.
3989 *
3990 * The variable can be set to a floating point value in the range 1.0-10.0f
3991 *
3992 * This hint should be set before SDL is initialized.
3993 *
3994 * \since This hint is available since SDL 3.2.0.
3995 */
3996#define SDL_HINT_VIDEO_X11_SCALING_FACTOR "SDL_VIDEO_X11_SCALING_FACTOR"
3997
3998/**
3999 * A variable forcing the visual ID used for X11 display modes.
4000 *
4001 * This hint should be set before initializing the video subsystem.
4002 *
4003 * \since This hint is available since SDL 3.2.0.
4004 */
4005#define SDL_HINT_VIDEO_X11_VISUALID "SDL_VIDEO_X11_VISUALID"
4006
4007/**
4008 * A variable forcing the visual ID chosen for new X11 windows.
4009 *
4010 * This hint should be set before creating a window.
4011 *
4012 * \since This hint is available since SDL 3.2.0.
4013 */
4014#define SDL_HINT_VIDEO_X11_WINDOW_VISUALID "SDL_VIDEO_X11_WINDOW_VISUALID"
4015
4016/**
4017 * A variable controlling whether the X11 XRandR extension should be used.
4018 *
4019 * The variable can be set to the following values:
4020 *
4021 * - "0": Disable XRandR.
4022 * - "1": Enable XRandR. (default)
4023 *
4024 * This hint should be set before SDL is initialized.
4025 *
4026 * \since This hint is available since SDL 3.2.0.
4027 */
4028#define SDL_HINT_VIDEO_X11_XRANDR "SDL_VIDEO_X11_XRANDR"
4029
4030/**
4031 * A variable controlling whether touch should be enabled on the back panel of
4032 * the PlayStation Vita.
4033 *
4034 * The variable can be set to the following values:
4035 *
4036 * - "0": Disable touch on the back panel.
4037 * - "1": Enable touch on the back panel. (default)
4038 *
4039 * This hint should be set before SDL is initialized.
4040 *
4041 * \since This hint is available since SDL 3.2.0.
4042 */
4043#define SDL_HINT_VITA_ENABLE_BACK_TOUCH "SDL_VITA_ENABLE_BACK_TOUCH"
4044
4045/**
4046 * A variable controlling whether touch should be enabled on the front panel
4047 * of the PlayStation Vita.
4048 *
4049 * The variable can be set to the following values:
4050 *
4051 * - "0": Disable touch on the front panel.
4052 * - "1": Enable touch on the front panel. (default)
4053 *
4054 * This hint should be set before SDL is initialized.
4055 *
4056 * \since This hint is available since SDL 3.2.0.
4057 */
4058#define SDL_HINT_VITA_ENABLE_FRONT_TOUCH "SDL_VITA_ENABLE_FRONT_TOUCH"
4059
4060/**
4061 * A variable controlling the module path on the PlayStation Vita.
4062 *
4063 * This hint defaults to "app0:module"
4064 *
4065 * This hint should be set before SDL is initialized.
4066 *
4067 * \since This hint is available since SDL 3.2.0.
4068 */
4069#define SDL_HINT_VITA_MODULE_PATH "SDL_VITA_MODULE_PATH"
4070
4071/**
4072 * A variable controlling whether to perform PVR initialization on the
4073 * PlayStation Vita.
4074 *
4075 * - "0": Skip PVR initialization.
4076 * - "1": Perform the normal PVR initialization. (default)
4077 *
4078 * This hint should be set before SDL is initialized.
4079 *
4080 * \since This hint is available since SDL 3.2.0.
4081 */
4082#define SDL_HINT_VITA_PVR_INIT "SDL_VITA_PVR_INIT"
4083
4084/**
4085 * A variable overriding the resolution reported on the PlayStation Vita.
4086 *
4087 * The variable can be set to the following values:
4088 *
4089 * - "544": 544p (default)
4090 * - "720": 725p for PSTV
4091 * - "1080": 1088i for PSTV
4092 *
4093 * This hint should be set before SDL is initialized.
4094 *
4095 * \since This hint is available since SDL 3.2.0.
4096 */
4097#define SDL_HINT_VITA_RESOLUTION "SDL_VITA_RESOLUTION"
4098
4099/**
4100 * A variable controlling whether OpenGL should be used instead of OpenGL ES
4101 * on the PlayStation Vita.
4102 *
4103 * The variable can be set to the following values:
4104 *
4105 * - "0": Use OpenGL ES. (default)
4106 * - "1": Use OpenGL.
4107 *
4108 * This hint should be set before SDL is initialized.
4109 *
4110 * \since This hint is available since SDL 3.2.0.
4111 */
4112#define SDL_HINT_VITA_PVR_OPENGL "SDL_VITA_PVR_OPENGL"
4113
4114/**
4115 * A variable controlling which touchpad should generate synthetic mouse
4116 * events.
4117 *
4118 * The variable can be set to the following values:
4119 *
4120 * - "0": Only front touchpad should generate mouse events. (default)
4121 * - "1": Only back touchpad should generate mouse events.
4122 * - "2": Both touchpads should generate mouse events.
4123 *
4124 * This hint can be set anytime.
4125 *
4126 * \since This hint is available since SDL 3.2.0.
4127 */
4128#define SDL_HINT_VITA_TOUCH_MOUSE_DEVICE "SDL_VITA_TOUCH_MOUSE_DEVICE"
4129
4130/**
4131 * A variable overriding the display index used in SDL_Vulkan_CreateSurface()
4132 *
4133 * The display index starts at 0, which is the default.
4134 *
4135 * This hint should be set before calling SDL_Vulkan_CreateSurface()
4136 *
4137 * \since This hint is available since SDL 3.2.0.
4138 */
4139#define SDL_HINT_VULKAN_DISPLAY "SDL_VULKAN_DISPLAY"
4140
4141/**
4142 * Specify the Vulkan library to load.
4143 *
4144 * This hint should be set before creating a Vulkan window or calling
4145 * SDL_Vulkan_LoadLibrary().
4146 *
4147 * \since This hint is available since SDL 3.2.0.
4148 */
4149#define SDL_HINT_VULKAN_LIBRARY "SDL_VULKAN_LIBRARY"
4150
4151/**
4152 * A variable controlling how the fact chunk affects the loading of a WAVE
4153 * file.
4154 *
4155 * The fact chunk stores information about the number of samples of a WAVE
4156 * file. The Standards Update from Microsoft notes that this value can be used
4157 * to 'determine the length of the data in seconds'. This is especially useful
4158 * for compressed formats (for which this is a mandatory chunk) if they
4159 * produce multiple sample frames per block and truncating the block is not
4160 * allowed. The fact chunk can exactly specify how many sample frames there
4161 * should be in this case.
4162 *
4163 * Unfortunately, most application seem to ignore the fact chunk and so SDL
4164 * ignores it by default as well.
4165 *
4166 * The variable can be set to the following values:
4167 *
4168 * - "truncate" - Use the number of samples to truncate the wave data if the
4169 *   fact chunk is present and valid.
4170 * - "strict" - Like "truncate", but raise an error if the fact chunk is
4171 *   invalid, not present for non-PCM formats, or if the data chunk doesn't
4172 *   have that many samples.
4173 * - "ignorezero" - Like "truncate", but ignore fact chunk if the number of
4174 *   samples is zero.
4175 * - "ignore" - Ignore fact chunk entirely. (default)
4176 *
4177 * This hint should be set before calling SDL_LoadWAV() or SDL_LoadWAV_IO()
4178 *
4179 * \since This hint is available since SDL 3.2.0.
4180 */
4181#define SDL_HINT_WAVE_FACT_CHUNK "SDL_WAVE_FACT_CHUNK"
4182
4183/**
4184 * A variable controlling the maximum number of chunks in a WAVE file.
4185 *
4186 * This sets an upper bound on the number of chunks in a WAVE file to avoid
4187 * wasting time on malformed or corrupt WAVE files. This defaults to "10000".
4188 *
4189 * This hint should be set before calling SDL_LoadWAV() or SDL_LoadWAV_IO()
4190 *
4191 * \since This hint is available since SDL 3.2.0.
4192 */
4193#define SDL_HINT_WAVE_CHUNK_LIMIT "SDL_WAVE_CHUNK_LIMIT"
4194
4195/**
4196 * A variable controlling how the size of the RIFF chunk affects the loading
4197 * of a WAVE file.
4198 *
4199 * The size of the RIFF chunk (which includes all the sub-chunks of the WAVE
4200 * file) is not always reliable. In case the size is wrong, it's possible to
4201 * just ignore it and step through the chunks until a fixed limit is reached.
4202 *
4203 * Note that files that have trailing data unrelated to the WAVE file or
4204 * corrupt files may slow down the loading process without a reliable
4205 * boundary. By default, SDL stops after 10000 chunks to prevent wasting time.
4206 * Use SDL_HINT_WAVE_CHUNK_LIMIT to adjust this value.
4207 *
4208 * The variable can be set to the following values:
4209 *
4210 * - "force" - Always use the RIFF chunk size as a boundary for the chunk
4211 *   search.
4212 * - "ignorezero" - Like "force", but a zero size searches up to 4 GiB.
4213 *   (default)
4214 * - "ignore" - Ignore the RIFF chunk size and always search up to 4 GiB.
4215 * - "maximum" - Search for chunks until the end of file. (not recommended)
4216 *
4217 * This hint should be set before calling SDL_LoadWAV() or SDL_LoadWAV_IO()
4218 *
4219 * \since This hint is available since SDL 3.2.0.
4220 */
4221#define SDL_HINT_WAVE_RIFF_CHUNK_SIZE "SDL_WAVE_RIFF_CHUNK_SIZE"
4222
4223/**
4224 * A variable controlling how a truncated WAVE file is handled.
4225 *
4226 * A WAVE file is considered truncated if any of the chunks are incomplete or
4227 * the data chunk size is not a multiple of the block size. By default, SDL
4228 * decodes until the first incomplete block, as most applications seem to do.
4229 *
4230 * The variable can be set to the following values:
4231 *
4232 * - "verystrict" - Raise an error if the file is truncated.
4233 * - "strict" - Like "verystrict", but the size of the RIFF chunk is ignored.
4234 * - "dropframe" - Decode until the first incomplete sample frame.
4235 * - "dropblock" - Decode until the first incomplete block. (default)
4236 *
4237 * This hint should be set before calling SDL_LoadWAV() or SDL_LoadWAV_IO()
4238 *
4239 * \since This hint is available since SDL 3.2.0.
4240 */
4241#define SDL_HINT_WAVE_TRUNCATION "SDL_WAVE_TRUNCATION"
4242
4243/**
4244 * A variable controlling whether the window is activated when the
4245 * SDL_RaiseWindow function is called.
4246 *
4247 * The variable can be set to the following values:
4248 *
4249 * - "0": The window is not activated when the SDL_RaiseWindow function is
4250 *   called.
4251 * - "1": The window is activated when the SDL_RaiseWindow function is called.
4252 *   (default)
4253 *
4254 * This hint can be set anytime.
4255 *
4256 * \since This hint is available since SDL 3.2.0.
4257 */
4258#define SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED "SDL_WINDOW_ACTIVATE_WHEN_RAISED"
4259
4260/**
4261 * A variable controlling whether the window is activated when the
4262 * SDL_ShowWindow function is called.
4263 *
4264 * The variable can be set to the following values:
4265 *
4266 * - "0": The window is not activated when the SDL_ShowWindow function is
4267 *   called.
4268 * - "1": The window is activated when the SDL_ShowWindow function is called.
4269 *   (default)
4270 *
4271 * This hint can be set anytime.
4272 *
4273 * \since This hint is available since SDL 3.2.0.
4274 */
4275#define SDL_HINT_WINDOW_ACTIVATE_WHEN_SHOWN "SDL_WINDOW_ACTIVATE_WHEN_SHOWN"
4276
4277/**
4278 * If set to "0" then never set the top-most flag on an SDL Window even if the
4279 * application requests it.
4280 *
4281 * This is a debugging aid for developers and not expected to be used by end
4282 * users.
4283 *
4284 * The variable can be set to the following values:
4285 *
4286 * - "0": don't allow topmost
4287 * - "1": allow topmost (default)
4288 *
4289 * This hint can be set anytime.
4290 *
4291 * \since This hint is available since SDL 3.2.0.
4292 */
4293#define SDL_HINT_WINDOW_ALLOW_TOPMOST "SDL_WINDOW_ALLOW_TOPMOST"
4294
4295/**
4296 * A variable controlling whether the window frame and title bar are
4297 * interactive when the cursor is hidden.
4298 *
4299 * The variable can be set to the following values:
4300 *
4301 * - "0": The window frame is not interactive when the cursor is hidden (no
4302 *   move, resize, etc).
4303 * - "1": The window frame is interactive when the cursor is hidden. (default)
4304 *
4305 * This hint can be set anytime.
4306 *
4307 * \since This hint is available since SDL 3.2.0.
4308 */
4309#define SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN "SDL_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN"
4310
4311/**
4312 * A variable controlling whether SDL generates window-close events for Alt+F4
4313 * on Windows.
4314 *
4315 * The variable can be set to the following values:
4316 *
4317 * - "0": SDL will only do normal key handling for Alt+F4.
4318 * - "1": SDL will generate a window-close event when it sees Alt+F4.
4319 *   (default)
4320 *
4321 * This hint can be set anytime.
4322 *
4323 * \since This hint is available since SDL 3.2.0.
4324 */
4325#define SDL_HINT_WINDOWS_CLOSE_ON_ALT_F4 "SDL_WINDOWS_CLOSE_ON_ALT_F4"
4326
4327/**
4328 * A variable controlling whether menus can be opened with their keyboard
4329 * shortcut (Alt+mnemonic).
4330 *
4331 * If the mnemonics are enabled, then menus can be opened by pressing the Alt
4332 * key and the corresponding mnemonic (for example, Alt+F opens the File
4333 * menu). However, in case an invalid mnemonic is pressed, Windows makes an
4334 * audible beep to convey that nothing happened. This is true even if the
4335 * window has no menu at all!
4336 *
4337 * Because most SDL applications don't have menus, and some want to use the
4338 * Alt key for other purposes, SDL disables mnemonics (and the beeping) by
4339 * default.
4340 *
4341 * Note: This also affects keyboard events: with mnemonics enabled, when a
4342 * menu is opened from the keyboard, you will not receive a KEYUP event for
4343 * the mnemonic key, and *might* not receive one for Alt.
4344 *
4345 * The variable can be set to the following values:
4346 *
4347 * - "0": Alt+mnemonic does nothing, no beeping. (default)
4348 * - "1": Alt+mnemonic opens menus, invalid mnemonics produce a beep.
4349 *
4350 * This hint can be set anytime.
4351 *
4352 * \since This hint is available since SDL 3.2.0.
4353 */
4354#define SDL_HINT_WINDOWS_ENABLE_MENU_MNEMONICS "SDL_WINDOWS_ENABLE_MENU_MNEMONICS"
4355
4356/**
4357 * A variable controlling whether the windows message loop is processed by
4358 * SDL.
4359 *
4360 * The variable can be set to the following values:
4361 *
4362 * - "0": The window message loop is not run.
4363 * - "1": The window message loop is processed in SDL_PumpEvents(). (default)
4364 *
4365 * This hint can be set anytime.
4366 *
4367 * \since This hint is available since SDL 3.2.0.
4368 */
4369#define SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP "SDL_WINDOWS_ENABLE_MESSAGELOOP"
4370
4371/**
4372 * A variable controlling whether GameInput is used for raw keyboard and mouse
4373 * on Windows.
4374 *
4375 * The variable can be set to the following values:
4376 *
4377 * - "0": GameInput is not used for raw keyboard and mouse events. (default)
4378 * - "1": GameInput is used for raw keyboard and mouse events, if available.
4379 *
4380 * This hint should be set before SDL is initialized.
4381 *
4382 * \since This hint is available since SDL 3.2.0.
4383 */
4384#define SDL_HINT_WINDOWS_GAMEINPUT "SDL_WINDOWS_GAMEINPUT"
4385
4386/**
4387 * A variable controlling whether raw keyboard events are used on Windows.
4388 *
4389 * The variable can be set to the following values:
4390 *
4391 * - "0": The Windows message loop is used for keyboard events. (default)
4392 * - "1": Low latency raw keyboard events are used.
4393 *
4394 * This hint can be set anytime.
4395 *
4396 * \since This hint is available since SDL 3.2.0.
4397 */
4398#define SDL_HINT_WINDOWS_RAW_KEYBOARD "SDL_WINDOWS_RAW_KEYBOARD"
4399
4400/**
4401 * A variable controlling whether or not the RIDEV_NOHOTKEYS flag is set when
4402 * enabling Windows raw keyboard events.
4403 *
4404 * This blocks any hotkeys that have been registered by applications from
4405 * having any effect beyond generating raw WM_INPUT events.
4406 *
4407 * This flag does not affect system-hotkeys like ALT-TAB or CTRL-ALT-DEL, but
4408 * does affect the Windows Logo key since it is a userland hotkey registered
4409 * by explorer.exe.
4410 *
4411 * The variable can be set to the following values:
4412 *
4413 * - "0": Hotkeys are not excluded. (default)
4414 * - "1": Hotkeys are excluded.
4415 *
4416 * This hint can be set anytime.
4417 *
4418 * \since This hint is available since SDL 3.4.0.
4419 */
4420#define SDL_HINT_WINDOWS_RAW_KEYBOARD_EXCLUDE_HOTKEYS "SDL_WINDOWS_RAW_KEYBOARD_EXCLUDE_HOTKEYS"
4421
4422/**
4423 * A variable controlling whether SDL uses Kernel Semaphores on Windows.
4424 *
4425 * Kernel Semaphores are inter-process and require a context switch on every
4426 * interaction. On Windows 8 and newer, the WaitOnAddress API is available.
4427 * Using that and atomics to implement semaphores increases performance. SDL
4428 * will fall back to Kernel Objects on older OS versions or if forced to by
4429 * this hint.
4430 *
4431 * The variable can be set to the following values:
4432 *
4433 * - "0": Use Atomics and WaitOnAddress API when available, otherwise fall
4434 *   back to Kernel Objects. (default)
4435 * - "1": Force the use of Kernel Objects in all cases.
4436 *
4437 * This hint should be set before SDL is initialized.
4438 *
4439 * \since This hint is available since SDL 3.2.0.
4440 */
4441#define SDL_HINT_WINDOWS_FORCE_SEMAPHORE_KERNEL "SDL_WINDOWS_FORCE_SEMAPHORE_KERNEL"
4442
4443/**
4444 * A variable to specify custom icon resource id from RC file on Windows
4445 * platform.
4446 *
4447 * This hint should be set before SDL is initialized.
4448 *
4449 * \since This hint is available since SDL 3.2.0.
4450 */
4451#define SDL_HINT_WINDOWS_INTRESOURCE_ICON "SDL_WINDOWS_INTRESOURCE_ICON"
4452
4453/**
4454 * A variable to specify custom icon resource id from RC file on Windows
4455 * platform.
4456 *
4457 * This hint should be set before SDL is initialized.
4458 *
4459 * \since This hint is available since SDL 3.2.0.
4460 */
4461#define SDL_HINT_WINDOWS_INTRESOURCE_ICON_SMALL "SDL_WINDOWS_INTRESOURCE_ICON_SMALL"
4462
4463/**
4464 * A variable controlling whether SDL uses the D3D9Ex API introduced in
4465 * Windows Vista, instead of normal D3D9.
4466 *
4467 * Direct3D 9Ex contains changes to state management that can eliminate device
4468 * loss errors during scenarios like Alt+Tab or UAC prompts. D3D9Ex may
4469 * require some changes to your application to cope with the new behavior, so
4470 * this is disabled by default.
4471 *
4472 * For more information on Direct3D 9Ex, see:
4473 *
4474 * - https://docs.microsoft.com/en-us/windows/win32/direct3darticles/graphics-apis-in-windows-vista#direct3d-9ex
4475 * - https://docs.microsoft.com/en-us/windows/win32/direct3darticles/direct3d-9ex-improvements
4476 *
4477 * The variable can be set to the following values:
4478 *
4479 * - "0": Use the original Direct3D 9 API. (default)
4480 * - "1": Use the Direct3D 9Ex API on Vista and later (and fall back if D3D9Ex
4481 *   is unavailable)
4482 *
4483 * This hint should be set before SDL is initialized.
4484 *
4485 * \since This hint is available since SDL 3.2.0.
4486 */
4487#define SDL_HINT_WINDOWS_USE_D3D9EX "SDL_WINDOWS_USE_D3D9EX"
4488
4489/**
4490 * A variable controlling whether SDL will clear the window contents when the
4491 * WM_ERASEBKGND message is received.
4492 *
4493 * The variable can be set to the following values:
4494 *
4495 * - "0"/"never": Never clear the window.
4496 * - "1"/"initial": Clear the window when the first WM_ERASEBKGND event fires.
4497 *   (default)
4498 * - "2"/"always": Clear the window on every WM_ERASEBKGND event.
4499 *
4500 * This hint should be set before creating a window.
4501 *
4502 * \since This hint is available since SDL 3.2.0.
4503 */
4504#define SDL_HINT_WINDOWS_ERASE_BACKGROUND_MODE "SDL_WINDOWS_ERASE_BACKGROUND_MODE"
4505
4506/**
4507 * A variable controlling whether X11 windows are marked as override-redirect.
4508 *
4509 * If set, this _might_ increase framerate at the expense of the desktop not
4510 * working as expected. Override-redirect windows aren't noticed by the window
4511 * manager at all.
4512 *
4513 * You should probably only use this for fullscreen windows, and you probably
4514 * shouldn't even use it for that. But it's here if you want to try!
4515 *
4516 * The variable can be set to the following values:
4517 *
4518 * - "0": Do not mark the window as override-redirect. (default)
4519 * - "1": Mark the window as override-redirect.
4520 *
4521 * This hint should be set before creating a window.
4522 *
4523 * \since This hint is available since SDL 3.2.0.
4524 */
4525#define SDL_HINT_X11_FORCE_OVERRIDE_REDIRECT "SDL_X11_FORCE_OVERRIDE_REDIRECT"
4526
4527/**
4528 * A variable specifying the type of an X11 window.
4529 *
4530 * During SDL_CreateWindow, SDL uses the _NET_WM_WINDOW_TYPE X11 property to
4531 * report to the window manager the type of window it wants to create. This
4532 * might be set to various things if SDL_WINDOW_TOOLTIP or
4533 * SDL_WINDOW_POPUP_MENU, etc, were specified. For "normal" windows that
4534 * haven't set a specific type, this hint can be used to specify a custom
4535 * type. For example, a dock window might set this to
4536 * "_NET_WM_WINDOW_TYPE_DOCK".
4537 *
4538 * This hint should be set before creating a window.
4539 *
4540 * \since This hint is available since SDL 3.2.0.
4541 */
4542#define SDL_HINT_X11_WINDOW_TYPE "SDL_X11_WINDOW_TYPE"
4543
4544/**
4545 * Specify the XCB library to load for the X11 driver.
4546 *
4547 * The default is platform-specific, often "libX11-xcb.so.1".
4548 *
4549 * This hint should be set before initializing the video subsystem.
4550 *
4551 * \since This hint is available since SDL 3.2.0.
4552 */
4553#define SDL_HINT_X11_XCB_LIBRARY "SDL_X11_XCB_LIBRARY"
4554
4555/**
4556 * A variable controlling whether XInput should be used for controller
4557 * handling.
4558 *
4559 * The variable can be set to the following values:
4560 *
4561 * - "0": XInput is not enabled.
4562 * - "1": XInput is enabled. (default)
4563 *
4564 * This hint should be set before SDL is initialized.
4565 *
4566 * \since This hint is available since SDL 3.2.0.
4567 */
4568#define SDL_HINT_XINPUT_ENABLED "SDL_XINPUT_ENABLED"
4569
4570/**
4571 * A variable controlling response to SDL_assert failures.
4572 *
4573 * The variable can be set to the following case-sensitive values:
4574 *
4575 * - "abort": Program terminates immediately.
4576 * - "break": Program triggers a debugger breakpoint.
4577 * - "retry": Program reruns the SDL_assert's test again.
4578 * - "ignore": Program continues on, ignoring this assertion failure this
4579 *   time.
4580 * - "always_ignore": Program continues on, ignoring this assertion failure
4581 *   for the rest of the run.
4582 *
4583 * Note that SDL_SetAssertionHandler offers a programmatic means to deal with
4584 * assertion failures through a callback, and this hint is largely intended to
4585 * be used via environment variables by end users and automated tools.
4586 *
4587 * This hint should be set before an assertion failure is triggered and can be
4588 * changed at any time.
4589 *
4590 * \since This hint is available since SDL 3.2.0.
4591 */
4592#define SDL_HINT_ASSERT "SDL_ASSERT"
4593
4594/**
4595 * A variable controlling whether pen events should generate synthetic mouse
4596 * events.
4597 *
4598 * The variable can be set to the following values:
4599 *
4600 * - "0": Pen events will not generate mouse events.
4601 * - "1": Pen events will generate mouse events. (default)
4602 *
4603 * This hint can be set anytime.
4604 *
4605 * \since This hint is available since SDL 3.2.0.
4606 */
4607#define SDL_HINT_PEN_MOUSE_EVENTS "SDL_PEN_MOUSE_EVENTS"
4608
4609/**
4610 * A variable controlling whether pen events should generate synthetic touch
4611 * events.
4612 *
4613 * The variable can be set to the following values:
4614 *
4615 * - "0": Pen events will not generate touch events.
4616 * - "1": Pen events will generate touch events. (default)
4617 *
4618 * This hint can be set anytime.
4619 *
4620 * \since This hint is available since SDL 3.2.0.
4621 */
4622#define SDL_HINT_PEN_TOUCH_EVENTS "SDL_PEN_TOUCH_EVENTS"
4623
4624/**
4625 * An enumeration of hint priorities.
4626 *
4627 * \since This enum is available since SDL 3.2.0.
4628 */
4629typedef enum SDL_HintPriority
4630{
4631    SDL_HINT_DEFAULT,
4632    SDL_HINT_NORMAL,
4633    SDL_HINT_OVERRIDE
4634} SDL_HintPriority;
4635
4636/**
4637 * Set a hint with a specific priority.
4638 *
4639 * The priority controls the behavior when setting a hint that already has a
4640 * value. Hints will replace existing hints of their priority and lower.
4641 * Environment variables are considered to have override priority.
4642 *
4643 * \param name the hint to set.
4644 * \param value the value of the hint variable.
4645 * \param priority the SDL_HintPriority level for the hint.
4646 * \returns true on success or false on failure; call SDL_GetError() for more
4647 *          information.
4648 *
4649 * \threadsafety It is safe to call this function from any thread.
4650 *
4651 * \since This function is available since SDL 3.2.0.
4652 *
4653 * \sa SDL_GetHint
4654 * \sa SDL_ResetHint
4655 * \sa SDL_SetHint
4656 */
4657extern SDL_DECLSPEC bool SDLCALL SDL_SetHintWithPriority(const char *name, const char *value, SDL_HintPriority priority);
4658
4659/**
4660 * Set a hint with normal priority.
4661 *
4662 * Hints will not be set if there is an existing override hint or environment
4663 * variable that takes precedence. You can use SDL_SetHintWithPriority() to
4664 * set the hint with override priority instead.
4665 *
4666 * \param name the hint to set.
4667 * \param value the value of the hint variable.
4668 * \returns true on success or false on failure; call SDL_GetError() for more
4669 *          information.
4670 *
4671 * \threadsafety It is safe to call this function from any thread.
4672 *
4673 * \since This function is available since SDL 3.2.0.
4674 *
4675 * \sa SDL_GetHint
4676 * \sa SDL_ResetHint
4677 * \sa SDL_SetHintWithPriority
4678 */
4679extern SDL_DECLSPEC bool SDLCALL SDL_SetHint(const char *name, const char *value);
4680
4681/**
4682 * Reset a hint to the default value.
4683 *
4684 * This will reset a hint to the value of the environment variable, or NULL if
4685 * the environment isn't set. Callbacks will be called normally with this
4686 * change.
4687 *
4688 * \param name the hint to set.
4689 * \returns true on success or false on failure; call SDL_GetError() for more
4690 *          information.
4691 *
4692 * \threadsafety It is safe to call this function from any thread.
4693 *
4694 * \since This function is available since SDL 3.2.0.
4695 *
4696 * \sa SDL_SetHint
4697 * \sa SDL_ResetHints
4698 */
4699extern SDL_DECLSPEC bool SDLCALL SDL_ResetHint(const char *name);
4700
4701/**
4702 * Reset all hints to the default values.
4703 *
4704 * This will reset all hints to the value of the associated environment
4705 * variable, or NULL if the environment isn't set. Callbacks will be called
4706 * normally with this change.
4707 *
4708 * \threadsafety It is safe to call this function from any thread.
4709 *
4710 * \since This function is available since SDL 3.2.0.
4711 *
4712 * \sa SDL_ResetHint
4713 */
4714extern SDL_DECLSPEC void SDLCALL SDL_ResetHints(void);
4715
4716/**
4717 * Get the value of a hint.
4718 *
4719 * \param name the hint to query.
4720 * \returns the string value of a hint or NULL if the hint isn't set.
4721 *
4722 * \threadsafety It is safe to call this function from any thread.
4723 *
4724 * \since This function is available since SDL 3.2.0.
4725 *
4726 * \sa SDL_SetHint
4727 * \sa SDL_SetHintWithPriority
4728 */
4729extern SDL_DECLSPEC const char *SDLCALL SDL_GetHint(const char *name);
4730
4731/**
4732 * Get the boolean value of a hint variable.
4733 *
4734 * \param name the name of the hint to get the boolean value from.
4735 * \param default_value the value to return if the hint does not exist.
4736 * \returns the boolean value of a hint or the provided default value if the
4737 *          hint does not exist.
4738 *
4739 * \threadsafety It is safe to call this function from any thread.
4740 *
4741 * \since This function is available since SDL 3.2.0.
4742 *
4743 * \sa SDL_GetHint
4744 * \sa SDL_SetHint
4745 */
4746extern SDL_DECLSPEC bool SDLCALL SDL_GetHintBoolean(const char *name, bool default_value);
4747
4748/**
4749 * A callback used to send notifications of hint value changes.
4750 *
4751 * This is called an initial time during SDL_AddHintCallback with the hint's
4752 * current value, and then again each time the hint's value changes.
4753 *
4754 * \param userdata what was passed as `userdata` to SDL_AddHintCallback().
4755 * \param name what was passed as `name` to SDL_AddHintCallback().
4756 * \param oldValue the previous hint value.
4757 * \param newValue the new value hint is to be set to.
4758 *
4759 * \threadsafety This callback is fired from whatever thread is setting a new
4760 *               hint value. SDL holds a lock on the hint subsystem when
4761 *               calling this callback.
4762 *
4763 * \since This datatype is available since SDL 3.2.0.
4764 *
4765 * \sa SDL_AddHintCallback
4766 */
4767typedef void(SDLCALL *SDL_HintCallback)(void *userdata, const char *name, const char *oldValue, const char *newValue);
4768
4769/**
4770 * Add a function to watch a particular hint.
4771 *
4772 * The callback function is called _during_ this function, to provide it an
4773 * initial value, and again each time the hint's value changes.
4774 *
4775 * \param name the hint to watch.
4776 * \param callback An SDL_HintCallback function that will be called when the
4777 *                 hint value changes.
4778 * \param userdata a pointer to pass to the callback function.
4779 * \returns true on success or false on failure; call SDL_GetError() for more
4780 *          information.
4781 *
4782 * \threadsafety It is safe to call this function from any thread.
4783 *
4784 * \since This function is available since SDL 3.2.0.
4785 *
4786 * \sa SDL_RemoveHintCallback
4787 */
4788extern SDL_DECLSPEC bool SDLCALL SDL_AddHintCallback(const char *name, SDL_HintCallback callback, void *userdata);
4789
4790/**
4791 * Remove a function watching a particular hint.
4792 *
4793 * \param name the hint being watched.
4794 * \param callback an SDL_HintCallback function that will be called when the
4795 *                 hint value changes.
4796 * \param userdata a pointer being passed to the callback function.
4797 *
4798 * \threadsafety It is safe to call this function from any thread.
4799 *
4800 * \since This function is available since SDL 3.2.0.
4801 *
4802 * \sa SDL_AddHintCallback
4803 */
4804extern SDL_DECLSPEC void SDLCALL SDL_RemoveHintCallback(const char *name,
4805                                                        SDL_HintCallback callback,
4806                                                        void *userdata);
4807
4808/* Ends C function definitions when using C++ */
4809#ifdef __cplusplus
4810}
4811#endif
4812#include <SDL3/SDL_close_code.h>
4813
4814#endif /* SDL_hints_h_ */
4815
[FILE END]
(C) 2025 0x4248
(C) 2025 4248 Media and 4248 Systems, All part of 0x4248
See LICENCE files for more information. Not all files are by 0x4248 always check Licencing.