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