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