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