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