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