|
@@ -22,7 +22,7 @@
|
|
|
/**
|
|
|
* \file SDL_hints.h
|
|
|
*
|
|
|
- * \brief Official documentation for SDL configuration variables
|
|
|
+ * Official documentation for SDL configuration variables
|
|
|
*
|
|
|
* This file contains functions to set and get configuration hints,
|
|
|
* as well as listing each of them alphabetically.
|
|
@@ -48,17 +48,16 @@ extern "C" {
|
|
|
#endif
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the Android / iOS built-in
|
|
|
- * accelerometer should be listed as a joystick device.
|
|
|
+ * Set if Android/iOS accelerometers should be listed as joystick devices.
|
|
|
*
|
|
|
- * This variable can be set to the following values:
|
|
|
+ * This variable can be set to the following values:
|
|
|
* "0" - The accelerometer is not listed as a joystick
|
|
|
* "1" - The accelerometer is available as a 3 axis joystick (the default).
|
|
|
*/
|
|
|
#define SDL_HINT_ACCELEROMETER_AS_JOYSTICK "SDL_ACCELEROMETER_AS_JOYSTICK"
|
|
|
|
|
|
/**
|
|
|
- * \brief Specify the behavior of Alt+Tab while the keyboard is grabbed.
|
|
|
+ * Specify the behavior of Alt+Tab while the keyboard is grabbed.
|
|
|
*
|
|
|
* By default, SDL emulates Alt+Tab functionality while the keyboard is grabbed
|
|
|
* and your window is full-screen. This prevents the user from getting stuck in
|
|
@@ -72,7 +71,7 @@ extern "C" {
|
|
|
#define SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED "SDL_ALLOW_ALT_TAB_WHILE_GRABBED"
|
|
|
|
|
|
/**
|
|
|
- * \brief If set to "0" then never set the top most bit on a SDL Window, even if the video mode expects it.
|
|
|
+ * If set to "0" then never set the top most bit on a SDL Window, even if the video mode expects it.
|
|
|
* This is a debugging aid for developers and not expected to be used by end users. The default is "1"
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
@@ -82,7 +81,7 @@ extern "C" {
|
|
|
#define SDL_HINT_ALLOW_TOPMOST "SDL_ALLOW_TOPMOST"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable to control whether the event loop will block itself when the app is paused.
|
|
|
+ * A variable to control whether the event loop will block itself when the app is paused.
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
|
* "0" - Non blocking.
|
|
@@ -93,7 +92,7 @@ extern "C" {
|
|
|
#define SDL_HINT_ANDROID_BLOCK_ON_PAUSE "SDL_ANDROID_BLOCK_ON_PAUSE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable to control whether SDL will pause audio in background
|
|
|
+ * A variable to control whether SDL will pause audio in background
|
|
|
* (Requires SDL_ANDROID_BLOCK_ON_PAUSE as "Non blocking")
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
@@ -105,7 +104,7 @@ extern "C" {
|
|
|
#define SDL_HINT_ANDROID_BLOCK_ON_PAUSE_PAUSEAUDIO "SDL_ANDROID_BLOCK_ON_PAUSE_PAUSEAUDIO"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable to control whether we trap the Android back button to handle it manually.
|
|
|
+ * A variable to control whether we trap the Android back button to handle it manually.
|
|
|
* This is necessary for the right mouse button to work on some Android devices, or
|
|
|
* to be able to trap the back button for use in your code reliably. If set to true,
|
|
|
* the back button will show up as an SDL_EVENT_KEY_DOWN / SDL_EVENT_KEY_UP pair with a keycode of
|
|
@@ -122,7 +121,7 @@ extern "C" {
|
|
|
#define SDL_HINT_ANDROID_TRAP_BACK_BUTTON "SDL_ANDROID_TRAP_BACK_BUTTON"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable to control whether SDL activity is allowed to be re-created.
|
|
|
+ * A variable to control whether SDL activity is allowed to be re-created.
|
|
|
* If so, java static datas and static datas from native libraries remain with their current values.
|
|
|
* When not allowed, the activity terminates with exit(0) to be fully re-initialized afterward.
|
|
|
*
|
|
@@ -135,7 +134,7 @@ extern "C" {
|
|
|
#define SDL_HINT_ANDROID_ALLOW_RECREATE_ACTIVITY "SDL_ANDROID_ALLOW_RECREATE_ACTIVITY"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable setting the app ID string.
|
|
|
+ * A variable setting the app ID string.
|
|
|
* This string is used by desktop compositors to identify and group windows
|
|
|
* together, as well as match applications with associated desktop settings
|
|
|
* and icons.
|
|
@@ -182,7 +181,7 @@ extern "C" {
|
|
|
#define SDL_HINT_APP_ID "SDL_APP_ID"
|
|
|
|
|
|
/**
|
|
|
- * \brief Specify an application name.
|
|
|
+ * Specify an application name.
|
|
|
*
|
|
|
* This hint lets you specify the application name sent to the OS when
|
|
|
* required. For example, this will often appear in volume control applets for
|
|
@@ -202,7 +201,7 @@ extern "C" {
|
|
|
#define SDL_HINT_APP_NAME "SDL_APP_NAME"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether controllers used with the Apple TV
|
|
|
+ * A variable controlling whether controllers used with the Apple TV
|
|
|
* generate UI events.
|
|
|
*
|
|
|
* When UI events are generated by controller input, the app will be
|
|
@@ -220,7 +219,7 @@ extern "C" {
|
|
|
#define SDL_HINT_APPLE_TV_CONTROLLER_UI_EVENTS "SDL_APPLE_TV_CONTROLLER_UI_EVENTS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the Apple TV remote's joystick axes
|
|
|
+ * A variable controlling whether the Apple TV remote's joystick axes
|
|
|
* will automatically match the rotation of the remote.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
@@ -230,7 +229,7 @@ extern "C" {
|
|
|
#define SDL_HINT_APPLE_TV_REMOTE_ALLOW_ROTATION "SDL_APPLE_TV_REMOTE_ALLOW_ROTATION"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling the audio category on iOS and macOS
|
|
|
+ * A variable controlling the audio category on iOS and macOS
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
*
|
|
@@ -243,7 +242,7 @@ extern "C" {
|
|
|
#define SDL_HINT_AUDIO_CATEGORY "SDL_AUDIO_CATEGORY"
|
|
|
|
|
|
/**
|
|
|
- * \brief Specify an application name for an audio device.
|
|
|
+ * Specify an application name for an audio device.
|
|
|
*
|
|
|
* Some audio backends (such as PulseAudio) allow you to describe your audio
|
|
|
* stream. Among other things, this description might show up in a system
|
|
@@ -264,7 +263,7 @@ extern "C" {
|
|
|
#define SDL_HINT_AUDIO_DEVICE_APP_NAME "SDL_AUDIO_DEVICE_APP_NAME"
|
|
|
|
|
|
/**
|
|
|
- * \brief Specify an application name for an audio device.
|
|
|
+ * Specify an application name for an audio device.
|
|
|
*
|
|
|
* Some audio backends (such as PulseAudio) allow you to describe your audio
|
|
|
* stream. Among other things, this description might show up in a system
|
|
@@ -285,7 +284,7 @@ extern "C" {
|
|
|
#define SDL_HINT_AUDIO_DEVICE_STREAM_NAME "SDL_AUDIO_DEVICE_STREAM_NAME"
|
|
|
|
|
|
/**
|
|
|
- * \brief Specify an application role for an audio device.
|
|
|
+ * Specify an application role for an audio device.
|
|
|
*
|
|
|
* Some audio backends (such as Pipewire) allow you to describe the role of
|
|
|
* your audio stream. Among other things, this description might show up in
|
|
@@ -305,7 +304,7 @@ extern "C" {
|
|
|
#define SDL_HINT_AUDIO_DEVICE_STREAM_ROLE "SDL_AUDIO_DEVICE_STREAM_ROLE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether SDL updates joystick state when getting input events
|
|
|
+ * A variable controlling whether SDL updates joystick state when getting input events
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
*
|
|
@@ -317,7 +316,7 @@ extern "C" {
|
|
|
#define SDL_HINT_AUTO_UPDATE_JOYSTICKS "SDL_AUTO_UPDATE_JOYSTICKS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether SDL updates sensor state when getting input events
|
|
|
+ * A variable controlling whether SDL updates sensor state when getting input events
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
*
|
|
@@ -329,7 +328,7 @@ extern "C" {
|
|
|
#define SDL_HINT_AUTO_UPDATE_SENSORS "SDL_AUTO_UPDATE_SENSORS"
|
|
|
|
|
|
/**
|
|
|
- * \brief Prevent SDL from using version 4 of the bitmap header when saving BMPs.
|
|
|
+ * Prevent SDL from using version 4 of the bitmap header when saving BMPs.
|
|
|
*
|
|
|
* The bitmap header version 4 is required for proper alpha channel support and
|
|
|
* SDL will use it when required. Should this not be desired, this hint can
|
|
@@ -348,7 +347,7 @@ extern "C" {
|
|
|
#define SDL_HINT_BMP_SAVE_LEGACY_FORMAT "SDL_BMP_SAVE_LEGACY_FORMAT"
|
|
|
|
|
|
/**
|
|
|
- * \brief Override for SDL_GetDisplayUsableBounds()
|
|
|
+ * Override for SDL_GetDisplayUsableBounds()
|
|
|
*
|
|
|
* If set, this hint will override the expected results for
|
|
|
* SDL_GetDisplayUsableBounds() for display index 0. Generally you don't want
|
|
@@ -362,7 +361,7 @@ extern "C" {
|
|
|
#define SDL_HINT_DISPLAY_USABLE_BOUNDS "SDL_DISPLAY_USABLE_BOUNDS"
|
|
|
|
|
|
/**
|
|
|
- * \brief Disable giving back control to the browser automatically
|
|
|
+ * Disable giving back control to the browser automatically
|
|
|
* when running with asyncify
|
|
|
*
|
|
|
* With -s ASYNCIFY, SDL calls emscripten_sleep during operations
|
|
@@ -377,7 +376,7 @@ extern "C" {
|
|
|
#define SDL_HINT_EMSCRIPTEN_ASYNCIFY "SDL_EMSCRIPTEN_ASYNCIFY"
|
|
|
|
|
|
/**
|
|
|
- * \brief Specify the CSS selector used for the "default" window/canvas
|
|
|
+ * Specify the CSS selector used for the "default" window/canvas
|
|
|
*
|
|
|
* This hint only applies to the emscripten platform
|
|
|
*
|
|
@@ -386,7 +385,7 @@ extern "C" {
|
|
|
#define SDL_HINT_EMSCRIPTEN_CANVAS_SELECTOR "SDL_EMSCRIPTEN_CANVAS_SELECTOR"
|
|
|
|
|
|
/**
|
|
|
- * \brief override the binding element for keyboard inputs for Emscripten builds
|
|
|
+ * override the binding element for keyboard inputs for Emscripten builds
|
|
|
*
|
|
|
* This hint only applies to the emscripten platform
|
|
|
*
|
|
@@ -400,7 +399,7 @@ extern "C" {
|
|
|
#define SDL_HINT_EMSCRIPTEN_KEYBOARD_ELEMENT "SDL_EMSCRIPTEN_KEYBOARD_ELEMENT"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that controls whether the on-screen keyboard should be shown when text input is active
|
|
|
+ * A variable that controls whether the on-screen keyboard should be shown when text input is active
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
|
* "0" - Do not show the on-screen keyboard
|
|
@@ -411,7 +410,7 @@ extern "C" {
|
|
|
#define SDL_HINT_ENABLE_SCREEN_KEYBOARD "SDL_ENABLE_SCREEN_KEYBOARD"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling verbosity of the logging of SDL events pushed onto the internal queue.
|
|
|
+ * A variable controlling verbosity of the logging of SDL events pushed onto the internal queue.
|
|
|
*
|
|
|
* This variable can be set to the following values, from least to most verbose:
|
|
|
*
|
|
@@ -433,7 +432,7 @@ extern "C" {
|
|
|
#define SDL_HINT_EVENT_LOGGING "SDL_EVENT_LOGGING"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether raising the window should be done more forcefully
|
|
|
+ * A variable controlling whether raising the window should be done more forcefully
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - No forcing (the default)
|
|
@@ -446,7 +445,7 @@ extern "C" {
|
|
|
#define SDL_HINT_FORCE_RAISEWINDOW "SDL_HINT_FORCE_RAISEWINDOW"
|
|
|
|
|
|
/**
|
|
|
-* \brief A variable controlling whether the window is activated when the SDL_RaiseWindow function is called
|
|
|
+* A variable controlling whether the window is activated when the SDL_RaiseWindow function is called
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - The window is not activated when the SDL_RaiseWindow function is called
|
|
@@ -458,7 +457,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED "SDL_WINDOW_ACTIVATE_WHEN_RAISED"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling how 3D acceleration is used to accelerate the SDL screen surface.
|
|
|
+ * A variable controlling how 3D acceleration is used to accelerate the SDL screen surface.
|
|
|
*
|
|
|
* SDL can try to accelerate the SDL screen surface by using streaming
|
|
|
* textures with a 3D rendering engine. This variable controls whether and
|
|
@@ -475,7 +474,7 @@ extern "C" {
|
|
|
#define SDL_HINT_FRAMEBUFFER_ACCELERATION "SDL_FRAMEBUFFER_ACCELERATION"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that lets you manually hint extra gamecontroller db entries.
|
|
|
+ * A variable that lets you manually hint extra gamecontroller db entries.
|
|
|
*
|
|
|
* The variable should be newline delimited rows of gamecontroller config data, see SDL_gamepad.h
|
|
|
*
|
|
@@ -485,7 +484,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GAMECONTROLLERCONFIG "SDL_GAMECONTROLLERCONFIG"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that lets you provide a file with extra gamecontroller db entries.
|
|
|
+ * A variable that lets you provide a file with extra gamecontroller db entries.
|
|
|
*
|
|
|
* The file should contain lines of gamecontroller config data, see SDL_gamepad.h
|
|
|
*
|
|
@@ -495,7 +494,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GAMECONTROLLERCONFIG_FILE "SDL_GAMECONTROLLERCONFIG_FILE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that overrides the automatic controller type detection
|
|
|
+ * A variable that overrides the automatic controller type detection
|
|
|
*
|
|
|
* The variable should be comma separated entries, in the form: VID/PID=type
|
|
|
*
|
|
@@ -514,7 +513,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GAMECONTROLLERTYPE "SDL_GAMECONTROLLERTYPE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable containing a list of devices to skip when scanning for game controllers.
|
|
|
+ * A variable containing a list of devices to skip when scanning for game controllers.
|
|
|
*
|
|
|
* The format of the string is a comma separated list of USB VID/PID pairs
|
|
|
* in hexadecimal form, e.g.
|
|
@@ -527,7 +526,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES "SDL_GAMECONTROLLER_IGNORE_DEVICES"
|
|
|
|
|
|
/**
|
|
|
- * \brief If set, all devices will be skipped when scanning for game controllers except for the ones listed in this variable.
|
|
|
+ * If set, all devices will be skipped when scanning for game controllers except for the ones listed in this variable.
|
|
|
*
|
|
|
* The format of the string is a comma separated list of USB VID/PID pairs
|
|
|
* in hexadecimal form, e.g.
|
|
@@ -540,7 +539,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT "SDL_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT"
|
|
|
|
|
|
/**
|
|
|
- * \brief If set, game controller face buttons report their values according to their labels instead of their positional layout.
|
|
|
+ * If set, game controller face buttons report their values according to their labels instead of their positional layout.
|
|
|
*
|
|
|
* For example, on Nintendo Switch controllers, normally you'd get:
|
|
|
*
|
|
@@ -563,7 +562,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GAMECONTROLLER_USE_BUTTON_LABELS "SDL_GAMECONTROLLER_USE_BUTTON_LABELS"
|
|
|
|
|
|
/**
|
|
|
- * \brief Controls whether the device's built-in accelerometer and gyro should be used as sensors for gamepads.
|
|
|
+ * Controls whether the device's built-in accelerometer and gyro should be used as sensors for gamepads.
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
|
* "0" - Sensor fusion is disabled
|
|
@@ -582,7 +581,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GAMECONTROLLER_SENSOR_FUSION "SDL_GAMECONTROLLER_SENSOR_FUSION"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether grabbing input grabs the keyboard
|
|
|
+ * A variable controlling whether grabbing input grabs the keyboard
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Grab will affect only the mouse
|
|
@@ -593,7 +592,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GRAB_KEYBOARD "SDL_GRAB_KEYBOARD"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable to control whether SDL_hid_enumerate() enumerates all HID devices or only controllers.
|
|
|
+ * A variable to control whether SDL_hid_enumerate() enumerates all HID devices or only controllers.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - SDL_hid_enumerate() will enumerate all HID devices
|
|
@@ -604,7 +603,7 @@ extern "C" {
|
|
|
#define SDL_HINT_HIDAPI_ENUMERATE_ONLY_CONTROLLERS "SDL_HIDAPI_ENUMERATE_ONLY_CONTROLLERS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable containing a list of devices to ignore in SDL_hid_enumerate()
|
|
|
+ * A variable containing a list of devices to ignore in SDL_hid_enumerate()
|
|
|
*
|
|
|
* For example, to ignore the Shanwan DS3 controller and any Valve controller, you might
|
|
|
* have the string "0x2563/0x0523,0x28de/0x0000"
|
|
@@ -612,7 +611,7 @@ extern "C" {
|
|
|
#define SDL_HINT_HIDAPI_IGNORE_DEVICES "SDL_HIDAPI_IGNORE_DEVICES"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable to control whether certain IMEs should handle text editing internally instead of sending SDL_EVENT_TEXT_EDITING events.
|
|
|
+ * A variable to control whether certain IMEs should handle text editing internally instead of sending SDL_EVENT_TEXT_EDITING events.
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
|
* "0" - SDL_EVENT_TEXT_EDITING events are sent, and it is the application's
|
|
@@ -624,7 +623,7 @@ extern "C" {
|
|
|
#define SDL_HINT_IME_INTERNAL_EDITING "SDL_IME_INTERNAL_EDITING"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable to control whether certain IMEs should show native UI components (such as the Candidate List) instead of suppressing them.
|
|
|
+ * A variable to control whether certain IMEs should show native UI components (such as the Candidate List) instead of suppressing them.
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
|
* "0" - Native UI components are not display. (default)
|
|
@@ -633,7 +632,7 @@ extern "C" {
|
|
|
#define SDL_HINT_IME_SHOW_UI "SDL_IME_SHOW_UI"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the home indicator bar on iPhone X
|
|
|
+ * A variable controlling whether the home indicator bar on iPhone X
|
|
|
* should be hidden.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
@@ -644,7 +643,7 @@ extern "C" {
|
|
|
#define SDL_HINT_IOS_HIDE_HOME_INDICATOR "SDL_IOS_HIDE_HOME_INDICATOR"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that lets you enable joystick (and gamecontroller) events even when your app is in the background.
|
|
|
+ * A variable that lets you enable joystick (and gamecontroller) events even when your app is in the background.
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
|
* "0" - Disable joystick & gamecontroller input events when the
|
|
@@ -657,7 +656,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS "SDL_JOYSTICK_ALLOW_BACKGROUND_EVENTS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI joystick drivers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI joystick drivers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI drivers are not used
|
|
@@ -668,7 +667,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI "SDL_JOYSTICK_HIDAPI"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for Nintendo GameCube controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for Nintendo GameCube controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -679,7 +678,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE "SDL_JOYSTICK_HIDAPI_GAMECUBE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether "low_frequency_rumble" and "high_frequency_rumble" is used to implement
|
|
|
+ * A variable controlling whether "low_frequency_rumble" and "high_frequency_rumble" is used to implement
|
|
|
* the GameCube controller's 3 rumble modes, Stop(0), Rumble(1), and StopHard(2)
|
|
|
* this is useful for applications that need full compatibility for things like ADSR envelopes.
|
|
|
* Stop is implemented by setting "low_frequency_rumble" to "0" and "high_frequency_rumble" ">0"
|
|
@@ -694,7 +693,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_GAMECUBE_RUMBLE_BRAKE "SDL_JOYSTICK_GAMECUBE_RUMBLE_BRAKE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for Nintendo Switch Joy-Cons should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for Nintendo Switch Joy-Cons should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -705,7 +704,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_JOY_CONS "SDL_JOYSTICK_HIDAPI_JOY_CONS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether Nintendo Switch Joy-Con controllers will be combined into a single Pro-like controller when using the HIDAPI driver
|
|
|
+ * A variable controlling whether Nintendo Switch Joy-Con controllers will be combined into a single Pro-like controller when using the HIDAPI driver
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Left and right Joy-Con controllers will not be combined and each will be a mini-gamepad
|
|
@@ -714,7 +713,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_COMBINE_JOY_CONS "SDL_JOYSTICK_HIDAPI_COMBINE_JOY_CONS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether Nintendo Switch Joy-Con controllers will be in vertical mode when using the HIDAPI driver
|
|
|
+ * A variable controlling whether Nintendo Switch Joy-Con controllers will be in vertical mode when using the HIDAPI driver
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Left and right Joy-Con controllers will not be in vertical mode (the default)
|
|
@@ -725,7 +724,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_VERTICAL_JOY_CONS "SDL_JOYSTICK_HIDAPI_VERTICAL_JOY_CONS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for Amazon Luna controllers connected via Bluetooth should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for Amazon Luna controllers connected via Bluetooth should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -736,7 +735,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_LUNA "SDL_JOYSTICK_HIDAPI_LUNA"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for Nintendo Online classic controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for Nintendo Online classic controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -747,7 +746,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_NINTENDO_CLASSIC "SDL_JOYSTICK_HIDAPI_NINTENDO_CLASSIC"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for NVIDIA SHIELD controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for NVIDIA SHIELD controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -758,7 +757,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_SHIELD "SDL_JOYSTICK_HIDAPI_SHIELD"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for PS3 controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for PS3 controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -772,7 +771,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_PS3 "SDL_JOYSTICK_HIDAPI_PS3"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for PS4 controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for PS4 controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -783,7 +782,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_PS4 "SDL_JOYSTICK_HIDAPI_PS4"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether extended input reports should be used for PS4 controllers when using the HIDAPI driver.
|
|
|
+ * A variable controlling whether extended input reports should be used for PS4 controllers when using the HIDAPI driver.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - extended reports are not enabled (the default)
|
|
@@ -803,7 +802,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_PS4_RUMBLE "SDL_JOYSTICK_HIDAPI_PS4_RUMBLE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for PS5 controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for PS5 controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -814,7 +813,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_PS5 "SDL_JOYSTICK_HIDAPI_PS5"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the player LEDs should be lit to indicate which player is associated with a PS5 controller.
|
|
|
+ * A variable controlling whether the player LEDs should be lit to indicate which player is associated with a PS5 controller.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - player LEDs are not enabled
|
|
@@ -823,7 +822,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_PS5_PLAYER_LED "SDL_JOYSTICK_HIDAPI_PS5_PLAYER_LED"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether extended input reports should be used for PS5 controllers when using the HIDAPI driver.
|
|
|
+ * A variable controlling whether extended input reports should be used for PS5 controllers when using the HIDAPI driver.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - extended reports are not enabled (the default)
|
|
@@ -842,7 +841,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_PS5_RUMBLE "SDL_JOYSTICK_HIDAPI_PS5_RUMBLE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for Google Stadia controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for Google Stadia controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -853,7 +852,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_STADIA "SDL_JOYSTICK_HIDAPI_STADIA"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for Bluetooth Steam Controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for Bluetooth Steam Controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -865,7 +864,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_STEAM "SDL_JOYSTICK_HIDAPI_STEAM"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for Nintendo Switch controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for Nintendo Switch controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -876,7 +875,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_SWITCH "SDL_JOYSTICK_HIDAPI_SWITCH"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the Home button LED should be turned on when a Nintendo Switch Pro controller is opened
|
|
|
+ * A variable controlling whether the Home button LED should be turned on when a Nintendo Switch Pro controller is opened
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - home button LED is turned off
|
|
@@ -887,7 +886,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_SWITCH_HOME_LED "SDL_JOYSTICK_HIDAPI_SWITCH_HOME_LED"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the Home button LED should be turned on when a Nintendo Switch Joy-Con controller is opened
|
|
|
+ * A variable controlling whether the Home button LED should be turned on when a Nintendo Switch Joy-Con controller is opened
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - home button LED is turned off
|
|
@@ -898,7 +897,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_JOYCON_HOME_LED "SDL_JOYSTICK_HIDAPI_JOYCON_HOME_LED"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the player LEDs should be lit to indicate which player is associated with a Nintendo Switch controller.
|
|
|
+ * A variable controlling whether the player LEDs should be lit to indicate which player is associated with a Nintendo Switch controller.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - player LEDs are not enabled
|
|
@@ -907,7 +906,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_SWITCH_PLAYER_LED "SDL_JOYSTICK_HIDAPI_SWITCH_PLAYER_LED"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for Nintendo Wii and Wii U controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for Nintendo Wii and Wii U controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -918,7 +917,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_WII "SDL_JOYSTICK_HIDAPI_WII"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the player LEDs should be lit to indicate which player is associated with a Wii controller.
|
|
|
+ * A variable controlling whether the player LEDs should be lit to indicate which player is associated with a Wii controller.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - player LEDs are not enabled
|
|
@@ -927,7 +926,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_WII_PLAYER_LED "SDL_JOYSTICK_HIDAPI_WII_PLAYER_LED"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for XBox controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for XBox controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -938,7 +937,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_XBOX "SDL_JOYSTICK_HIDAPI_XBOX"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for XBox 360 controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for XBox 360 controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -949,7 +948,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360 "SDL_JOYSTICK_HIDAPI_XBOX_360"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the player LEDs should be lit to indicate which player is associated with an Xbox 360 controller.
|
|
|
+ * A variable controlling whether the player LEDs should be lit to indicate which player is associated with an Xbox 360 controller.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - player LEDs are not enabled
|
|
@@ -958,7 +957,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED "SDL_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for XBox 360 wireless controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for XBox 360 wireless controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -969,7 +968,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_WIRELESS "SDL_JOYSTICK_HIDAPI_XBOX_360_WIRELESS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the HIDAPI driver for XBox One controllers should be used.
|
|
|
+ * A variable controlling whether the HIDAPI driver for XBox One controllers should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - HIDAPI driver is not used
|
|
@@ -980,7 +979,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_XBOX_ONE "SDL_JOYSTICK_HIDAPI_XBOX_ONE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the Home button LED should be turned on when an Xbox One controller is opened
|
|
|
+ * A variable controlling whether the Home button LED should be turned on when an Xbox One controller is opened
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - home button LED is turned off
|
|
@@ -991,7 +990,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_HIDAPI_XBOX_ONE_HOME_LED "SDL_JOYSTICK_HIDAPI_XBOX_ONE_HOME_LED"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the RAWINPUT joystick drivers should be used for better handling XInput-capable devices.
|
|
|
+ * A variable controlling whether the RAWINPUT joystick drivers should be used for better handling XInput-capable devices.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - RAWINPUT drivers are not used
|
|
@@ -1000,7 +999,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_RAWINPUT "SDL_JOYSTICK_RAWINPUT"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the RAWINPUT driver should pull correlated data from XInput.
|
|
|
+ * A variable controlling whether the RAWINPUT driver should pull correlated data from XInput.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - RAWINPUT driver will only use data from raw input APIs
|
|
@@ -1013,7 +1012,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_RAWINPUT_CORRELATE_XINPUT "SDL_JOYSTICK_RAWINPUT_CORRELATE_XINPUT"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the ROG Chakram mice should show up as joysticks
|
|
|
+ * A variable controlling whether the ROG Chakram mice should show up as joysticks
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - ROG Chakram mice do not show up as joysticks (the default)
|
|
@@ -1022,7 +1021,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_ROG_CHAKRAM "SDL_JOYSTICK_ROG_CHAKRAM"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether a separate thread should be used
|
|
|
+ * A variable controlling whether a separate thread should be used
|
|
|
* for handling joystick detection and raw input messages on Windows
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
@@ -1033,7 +1032,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_THREAD "SDL_JOYSTICK_THREAD"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether Windows.Gaming.Input should be used for controller handling.
|
|
|
+ * A variable controlling whether Windows.Gaming.Input should be used for controller handling.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - WGI is not used
|
|
@@ -1042,7 +1041,7 @@ extern "C" {
|
|
|
#define SDL_HINT_JOYSTICK_WGI "SDL_JOYSTICK_WGI"
|
|
|
|
|
|
/**
|
|
|
- * \brief Determines whether SDL enforces that DRM master is required in order
|
|
|
+ * Determines whether SDL enforces that DRM master is required in order
|
|
|
* to initialize the KMSDRM video backend.
|
|
|
*
|
|
|
* The DRM subsystem has a concept of a "DRM master" which is a DRM client that
|
|
@@ -1065,14 +1064,14 @@ extern "C" {
|
|
|
#define SDL_HINT_KMSDRM_REQUIRE_DRM_MASTER "SDL_KMSDRM_REQUIRE_DRM_MASTER"
|
|
|
|
|
|
/**
|
|
|
- * \brief A comma separated list of devices to open as joysticks
|
|
|
+ * A comma separated list of devices to open as joysticks
|
|
|
*
|
|
|
* This variable is currently only used by the Linux joystick driver.
|
|
|
*/
|
|
|
#define SDL_HINT_JOYSTICK_DEVICE "SDL_JOYSTICK_DEVICE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether joysticks on Linux will always treat 'hat' axis inputs (ABS_HAT0X - ABS_HAT3Y) as 8-way digital hats without checking whether they may be analog.
|
|
|
+ * A variable controlling whether joysticks on Linux will always treat 'hat' axis inputs (ABS_HAT0X - ABS_HAT3Y) as 8-way digital hats without checking whether they may be analog.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Only map hat axis inputs to digital hat outputs if the input axes appear to actually be digital (the default)
|
|
@@ -1081,7 +1080,7 @@ extern "C" {
|
|
|
#define SDL_HINT_LINUX_DIGITAL_HATS "SDL_LINUX_DIGITAL_HATS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether digital hats on Linux will apply deadzones to their underlying input axes or use unfiltered values.
|
|
|
+ * A variable controlling whether digital hats on Linux will apply deadzones to their underlying input axes or use unfiltered values.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Return digital hat values based on unfiltered input axis values
|
|
@@ -1090,7 +1089,7 @@ extern "C" {
|
|
|
#define SDL_HINT_LINUX_HAT_DEADZONES "SDL_LINUX_HAT_DEADZONES"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether to use the classic /dev/input/js* joystick interface or the newer /dev/input/event* joystick interface on Linux
|
|
|
+ * A variable controlling whether to use the classic /dev/input/js* joystick interface or the newer /dev/input/event* joystick interface on Linux
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Use /dev/input/event*
|
|
@@ -1101,7 +1100,7 @@ extern "C" {
|
|
|
#define SDL_HINT_LINUX_JOYSTICK_CLASSIC "SDL_LINUX_JOYSTICK_CLASSIC"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether joysticks on Linux adhere to their HID-defined deadzones or return unfiltered values.
|
|
|
+ * A variable controlling whether joysticks on Linux adhere to their HID-defined deadzones or return unfiltered values.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Return unfiltered joystick axis values (the default)
|
|
@@ -1110,7 +1109,7 @@ extern "C" {
|
|
|
#define SDL_HINT_LINUX_JOYSTICK_DEADZONES "SDL_LINUX_JOYSTICK_DEADZONES"
|
|
|
|
|
|
/**
|
|
|
-* \brief When set don't force the SDL app to become a foreground process
|
|
|
+* When set don't force the SDL app to become a foreground process
|
|
|
*
|
|
|
* This hint only applies to macOS.
|
|
|
*
|
|
@@ -1118,7 +1117,7 @@ extern "C" {
|
|
|
#define SDL_HINT_MAC_BACKGROUND_APP "SDL_MAC_BACKGROUND_APP"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that determines whether ctrl+click should generate a right-click event on Mac
|
|
|
+ * A variable that determines whether ctrl+click should generate a right-click event on Mac
|
|
|
*
|
|
|
* If present, holding ctrl while left clicking will generate a right click
|
|
|
* event when on Mac.
|
|
@@ -1126,7 +1125,7 @@ extern "C" {
|
|
|
#define SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK "SDL_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether dispatching OpenGL context updates should block the dispatching thread until the main thread finishes processing
|
|
|
+ * A variable controlling whether dispatching OpenGL context updates should block the dispatching thread until the main thread finishes processing
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Dispatching OpenGL context updates will block the dispatching thread until the main thread finishes processing (default).
|
|
@@ -1144,17 +1143,17 @@ extern "C" {
|
|
|
#define SDL_HINT_MAC_OPENGL_ASYNC_DISPATCH "SDL_MAC_OPENGL_ASYNC_DISPATCH"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable setting the double click radius, in pixels.
|
|
|
+ * A variable setting the double click radius, in pixels.
|
|
|
*/
|
|
|
#define SDL_HINT_MOUSE_DOUBLE_CLICK_RADIUS "SDL_MOUSE_DOUBLE_CLICK_RADIUS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable setting the double click time, in milliseconds.
|
|
|
+ * A variable setting the double click time, in milliseconds.
|
|
|
*/
|
|
|
#define SDL_HINT_MOUSE_DOUBLE_CLICK_TIME "SDL_MOUSE_DOUBLE_CLICK_TIME"
|
|
|
|
|
|
/**
|
|
|
- * \brief Allow mouse click events when clicking to focus an SDL window
|
|
|
+ * Allow mouse click events when clicking to focus an SDL window
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Ignore mouse clicks that activate a window
|
|
@@ -1165,12 +1164,12 @@ extern "C" {
|
|
|
#define SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH "SDL_MOUSE_FOCUS_CLICKTHROUGH"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable setting the speed scale for mouse motion, in floating point, when the mouse is not in relative mode
|
|
|
+ * A variable setting the speed scale for mouse motion, in floating point, when the mouse is not in relative mode
|
|
|
*/
|
|
|
#define SDL_HINT_MOUSE_NORMAL_SPEED_SCALE "SDL_MOUSE_NORMAL_SPEED_SCALE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether relative mouse mode constrains the mouse to the center of the window
|
|
|
+ * A variable controlling whether relative mouse mode constrains the mouse to the center of the window
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Relative mouse mode constrains the mouse to the window
|
|
@@ -1186,7 +1185,7 @@ extern "C" {
|
|
|
#define SDL_HINT_MOUSE_RELATIVE_MODE_CENTER "SDL_MOUSE_RELATIVE_MODE_CENTER"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether relative mouse mode is implemented using mouse warping
|
|
|
+ * A variable controlling whether relative mouse mode is implemented using mouse warping
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Relative mouse mode uses raw input
|
|
@@ -1197,12 +1196,12 @@ extern "C" {
|
|
|
#define SDL_HINT_MOUSE_RELATIVE_MODE_WARP "SDL_MOUSE_RELATIVE_MODE_WARP"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable setting the scale for mouse motion, in floating point, when the mouse is in relative mode
|
|
|
+ * A variable setting the scale for mouse motion, in floating point, when the mouse is in relative mode
|
|
|
*/
|
|
|
#define SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE "SDL_MOUSE_RELATIVE_SPEED_SCALE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the system mouse acceleration curve is used for relative mouse motion.
|
|
|
+ * A variable controlling whether the system mouse acceleration curve is used for relative mouse motion.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Relative mouse motion will be unscaled (the default)
|
|
@@ -1213,7 +1212,7 @@ extern "C" {
|
|
|
#define SDL_HINT_MOUSE_RELATIVE_SYSTEM_SCALE "SDL_MOUSE_RELATIVE_SYSTEM_SCALE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether a motion event should be generated for mouse warping in relative mode.
|
|
|
+ * A variable controlling whether a motion event should be generated for mouse warping in relative mode.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Warping the mouse will not generate a motion event in relative mode
|
|
@@ -1224,7 +1223,7 @@ extern "C" {
|
|
|
#define SDL_HINT_MOUSE_RELATIVE_WARP_MOTION "SDL_MOUSE_RELATIVE_WARP_MOTION"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether mouse events should generate synthetic touch events
|
|
|
+ * A variable controlling whether mouse events should generate synthetic touch events
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Mouse events will not generate touch events (default for desktop platforms)
|
|
@@ -1233,7 +1232,7 @@ extern "C" {
|
|
|
#define SDL_HINT_MOUSE_TOUCH_EVENTS "SDL_MOUSE_TOUCH_EVENTS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the mouse is captured while mouse buttons are pressed
|
|
|
+ * A variable controlling whether the mouse is captured while mouse buttons are pressed
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - The mouse is not captured while mouse buttons are pressed
|
|
@@ -1246,7 +1245,7 @@ extern "C" {
|
|
|
#define SDL_HINT_MOUSE_AUTO_CAPTURE "SDL_MOUSE_AUTO_CAPTURE"
|
|
|
|
|
|
/**
|
|
|
- * \brief Tell SDL not to catch the SIGINT or SIGTERM signals.
|
|
|
+ * Tell SDL not to catch the SIGINT or SIGTERM signals.
|
|
|
*
|
|
|
* This hint only applies to Unix-like platforms, and should set before
|
|
|
* any calls to SDL_Init()
|
|
@@ -1259,7 +1258,7 @@ extern "C" {
|
|
|
#define SDL_HINT_NO_SIGNAL_HANDLERS "SDL_NO_SIGNAL_HANDLERS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling what driver to use for OpenGL ES contexts.
|
|
|
+ * A variable controlling what driver to use for OpenGL ES contexts.
|
|
|
*
|
|
|
* On some platforms, currently Windows and X11, OpenGL drivers may support
|
|
|
* creating contexts with an OpenGL ES profile. By default SDL uses these
|
|
@@ -1290,7 +1289,7 @@ extern "C" {
|
|
|
#define SDL_HINT_OPENGL_ES_DRIVER "SDL_OPENGL_ES_DRIVER"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling which orientations are allowed on iOS/Android.
|
|
|
+ * A variable controlling which orientations are allowed on iOS/Android.
|
|
|
*
|
|
|
* In some circumstances it is necessary to be able to explicitly control
|
|
|
* which UI orientations are allowed.
|
|
@@ -1301,7 +1300,7 @@ extern "C" {
|
|
|
#define SDL_HINT_ORIENTATIONS "SDL_IOS_ORIENTATIONS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling the use of a sentinel event when polling the event queue
|
|
|
+ * A variable controlling the use of a sentinel event when polling the event queue
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Disable poll sentinels
|
|
@@ -1317,7 +1316,7 @@ extern "C" {
|
|
|
#define SDL_HINT_POLL_SENTINEL "SDL_POLL_SENTINEL"
|
|
|
|
|
|
/**
|
|
|
- * \brief Override for SDL_GetPreferredLocales()
|
|
|
+ * Override for SDL_GetPreferredLocales()
|
|
|
*
|
|
|
* If set, this will be favored over anything the OS might report for the
|
|
|
* user's preferred locales. Changing this hint at runtime will not generate
|
|
@@ -1331,7 +1330,7 @@ extern "C" {
|
|
|
#define SDL_HINT_PREFERRED_LOCALES "SDL_PREFERRED_LOCALES"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable describing the content orientation on QtWayland-based platforms.
|
|
|
+ * A variable describing the content orientation on QtWayland-based platforms.
|
|
|
*
|
|
|
* On QtWayland platforms, windows are rotated client-side to allow for custom
|
|
|
* transitions. In order to correctly position overlays (e.g. volume bar) and
|
|
@@ -1350,7 +1349,7 @@ extern "C" {
|
|
|
#define SDL_HINT_QTWAYLAND_CONTENT_ORIENTATION "SDL_QTWAYLAND_CONTENT_ORIENTATION"
|
|
|
|
|
|
/**
|
|
|
- * \brief Flags to set on QtWayland windows to integrate with the native window manager.
|
|
|
+ * Flags to set on QtWayland windows to integrate with the native window manager.
|
|
|
*
|
|
|
* On QtWayland platforms, this hint controls the flags to set on the windows.
|
|
|
* For example, on Sailfish OS "OverridesSystemGestures" disables swipe gestures.
|
|
@@ -1361,7 +1360,7 @@ extern "C" {
|
|
|
#define SDL_HINT_QTWAYLAND_WINDOW_FLAGS "SDL_QTWAYLAND_WINDOW_FLAGS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the 2D render API is compatible or efficient.
|
|
|
+ * A variable controlling whether the 2D render API is compatible or efficient.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
*
|
|
@@ -1385,7 +1384,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RENDER_BATCHING "SDL_RENDER_BATCHING"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling how the 2D render API renders lines
|
|
|
+ * A variable controlling how the 2D render API renders lines
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Use the default line drawing method (Bresenham's line algorithm as of SDL 2.0.20)
|
|
@@ -1398,7 +1397,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RENDER_LINE_METHOD "SDL_RENDER_LINE_METHOD"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether to enable Direct3D 11+'s Debug Layer.
|
|
|
+ * A variable controlling whether to enable Direct3D 11+'s Debug Layer.
|
|
|
*
|
|
|
* This variable does not have any effect on the Direct3D 9 based renderer.
|
|
|
*
|
|
@@ -1411,7 +1410,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RENDER_DIRECT3D11_DEBUG "SDL_RENDER_DIRECT3D11_DEBUG"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the Direct3D device is initialized for thread-safe operations.
|
|
|
+ * A variable controlling whether the Direct3D device is initialized for thread-safe operations.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Thread-safety is not enabled (faster)
|
|
@@ -1422,7 +1421,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RENDER_DIRECT3D_THREADSAFE "SDL_RENDER_DIRECT3D_THREADSAFE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable specifying which render driver to use.
|
|
|
+ * A variable specifying which render driver to use.
|
|
|
*
|
|
|
* If the application doesn't pick a specific renderer to use, this variable
|
|
|
* specifies the name of the preferred renderer. If the preferred renderer
|
|
@@ -1444,7 +1443,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RENDER_DRIVER "SDL_RENDER_DRIVER"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the OpenGL render driver uses shaders if they are available.
|
|
|
+ * A variable controlling whether the OpenGL render driver uses shaders if they are available.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Disable shaders
|
|
@@ -1455,7 +1454,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RENDER_OPENGL_SHADERS "SDL_RENDER_OPENGL_SHADERS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling the scaling quality
|
|
|
+ * A variable controlling the scaling quality
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" or "nearest" - Nearest pixel sampling
|
|
@@ -1467,7 +1466,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RENDER_SCALE_QUALITY "SDL_RENDER_SCALE_QUALITY"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether updates to the SDL screen surface should be synchronized with the vertical refresh, to avoid tearing.
|
|
|
+ * A variable controlling whether updates to the SDL screen surface should be synchronized with the vertical refresh, to avoid tearing.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Disable vsync
|
|
@@ -1478,7 +1477,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RENDER_VSYNC "SDL_RENDER_VSYNC"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the Metal render driver select low power device over default one
|
|
|
+ * A variable controlling whether the Metal render driver select low power device over default one
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Use the prefered OS device
|
|
@@ -1489,7 +1488,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RENDER_METAL_PREFER_LOW_POWER_DEVICE "SDL_RENDER_METAL_PREFER_LOW_POWER_DEVICE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling if VSYNC is automatically disable if doesn't reach the enough FPS
|
|
|
+ * A variable controlling if VSYNC is automatically disable if doesn't reach the enough FPS
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - It will be using VSYNC as defined in the main flag. Default
|
|
@@ -1500,7 +1499,7 @@ extern "C" {
|
|
|
#define SDL_HINT_PS2_DYNAMIC_VSYNC "SDL_PS2_DYNAMIC_VSYNC"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable to control whether the return key on the soft keyboard
|
|
|
+ * A variable to control whether the return key on the soft keyboard
|
|
|
* should hide the soft keyboard on Android and iOS.
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
@@ -1512,7 +1511,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RETURN_KEY_HIDES_IME "SDL_RETURN_KEY_HIDES_IME"
|
|
|
|
|
|
/**
|
|
|
- * \brief Tell SDL which Dispmanx layer to use on a Raspberry PI
|
|
|
+ * Tell SDL which Dispmanx layer to use on a Raspberry PI
|
|
|
*
|
|
|
* Also known as Z-order. The variable can take a negative or positive value.
|
|
|
* The default is 10000.
|
|
@@ -1520,7 +1519,7 @@ extern "C" {
|
|
|
#define SDL_HINT_RPI_VIDEO_LAYER "SDL_RPI_VIDEO_LAYER"
|
|
|
|
|
|
/**
|
|
|
- * \brief Specify an "activity name" for screensaver inhibition.
|
|
|
+ * Specify an "activity name" for screensaver inhibition.
|
|
|
*
|
|
|
* Some platforms, notably Linux desktops, list the applications which are
|
|
|
* inhibiting the screensaver or other power-saving features.
|
|
@@ -1540,7 +1539,7 @@ extern "C" {
|
|
|
#define SDL_HINT_SCREENSAVER_INHIBIT_ACTIVITY_NAME "SDL_SCREENSAVER_INHIBIT_ACTIVITY_NAME"
|
|
|
|
|
|
/**
|
|
|
- * \brief Specifies whether SDL_THREAD_PRIORITY_TIME_CRITICAL should be treated as realtime.
|
|
|
+ * Specifies whether SDL_THREAD_PRIORITY_TIME_CRITICAL should be treated as realtime.
|
|
|
*
|
|
|
* On some platforms, like Linux, a realtime priority thread may be subject to restrictions
|
|
|
* that require special handling by the application. This hint exists to let SDL know that
|
|
@@ -1559,7 +1558,7 @@ extern "C" {
|
|
|
#define SDL_HINT_THREAD_FORCE_REALTIME_TIME_CRITICAL "SDL_THREAD_FORCE_REALTIME_TIME_CRITICAL"
|
|
|
|
|
|
/**
|
|
|
-* \brief A string specifying additional information to use with SDL_SetThreadPriority.
|
|
|
+* A string specifying additional information to use with SDL_SetThreadPriority.
|
|
|
*
|
|
|
* By default SDL_SetThreadPriority will make appropriate system changes in order to
|
|
|
* apply a thread priority. For example on systems using pthreads the scheduler policy
|
|
@@ -1576,7 +1575,7 @@ extern "C" {
|
|
|
#define SDL_HINT_THREAD_PRIORITY_POLICY "SDL_THREAD_PRIORITY_POLICY"
|
|
|
|
|
|
/**
|
|
|
-* \brief A string specifying SDL's threads stack size in bytes or "0" for the backend's default size
|
|
|
+* A string specifying SDL's threads stack size in bytes or "0" for the backend's default size
|
|
|
*
|
|
|
* Use this hint in case you need to set SDL's threads stack size to other than the default.
|
|
|
* This is specially useful if you build SDL against a non glibc libc library (such as musl) which
|
|
@@ -1590,7 +1589,7 @@ extern "C" {
|
|
|
#define SDL_HINT_THREAD_STACK_SIZE "SDL_THREAD_STACK_SIZE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that controls the timer resolution, in milliseconds.
|
|
|
+ * A variable that controls the timer resolution, in milliseconds.
|
|
|
*
|
|
|
* The higher resolution the timer, the more frequently the CPU services
|
|
|
* timer interrupts, and the more precise delays are, but this takes up
|
|
@@ -1606,7 +1605,7 @@ extern "C" {
|
|
|
#define SDL_HINT_TIMER_RESOLUTION "SDL_TIMER_RESOLUTION"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether touch events should generate synthetic mouse events
|
|
|
+ * A variable controlling whether touch events should generate synthetic mouse events
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Touch events will not generate mouse events
|
|
@@ -1617,7 +1616,7 @@ extern "C" {
|
|
|
#define SDL_HINT_TOUCH_MOUSE_EVENTS "SDL_TOUCH_MOUSE_EVENTS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling which touchpad should generate synthetic mouse events
|
|
|
+ * A variable controlling which touchpad should generate synthetic mouse events
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Only front touchpad should generate mouse events. Default
|
|
@@ -1629,7 +1628,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VITA_TOUCH_MOUSE_DEVICE "SDL_HINT_VITA_TOUCH_MOUSE_DEVICE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the Android / tvOS remotes
|
|
|
+ * A variable controlling whether the Android / tvOS remotes
|
|
|
* should be listed as joystick devices, instead of sending keyboard events.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
@@ -1639,7 +1638,7 @@ extern "C" {
|
|
|
#define SDL_HINT_TV_REMOTE_AS_JOYSTICK "SDL_TV_REMOTE_AS_JOYSTICK"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the screensaver is enabled.
|
|
|
+ * A variable controlling whether the screensaver is enabled.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Disable screensaver
|
|
@@ -1650,7 +1649,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_ALLOW_SCREENSAVER "SDL_VIDEO_ALLOW_SCREENSAVER"
|
|
|
|
|
|
/**
|
|
|
- * \brief Tell the video driver that we only want a double buffer.
|
|
|
+ * Tell the video driver that we only want a double buffer.
|
|
|
*
|
|
|
* By default, most lowlevel 2D APIs will use a triple buffer scheme that
|
|
|
* wastes no CPU time on waiting for vsync after issuing a flip, but
|
|
@@ -1669,7 +1668,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_DOUBLE_BUFFER "SDL_VIDEO_DOUBLE_BUFFER"
|
|
|
|
|
|
/**
|
|
|
- * \brief If eglGetPlatformDisplay fails, fall back to calling eglGetDisplay.
|
|
|
+ * If eglGetPlatformDisplay fails, fall back to calling eglGetDisplay.
|
|
|
*
|
|
|
* This variable can be set to one of the following values:
|
|
|
* "0" - Do not fall back to eglGetDisplay
|
|
@@ -1681,7 +1680,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_EGL_ALLOW_GETDISPLAY_FALLBACK "SDL_VIDEO_EGL_GETDISPLAY_FALLBACK"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the graphics context is externally managed.
|
|
|
+ * A variable controlling whether the graphics context is externally managed.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - SDL will manage graphics contexts that are attached to windows.
|
|
@@ -1696,7 +1695,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_EXTERNAL_CONTEXT "SDL_VIDEO_EXTERNAL_CONTEXT"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that dictates policy for fullscreen Spaces on macOS.
|
|
|
+ * A variable that dictates policy for fullscreen Spaces on macOS.
|
|
|
*
|
|
|
* This hint only applies to macOS.
|
|
|
*
|
|
@@ -1713,7 +1712,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES "SDL_VIDEO_MAC_FULLSCREEN_SPACES"
|
|
|
|
|
|
/**
|
|
|
- * \brief Minimize your SDL_Window if it loses key focus when in fullscreen mode. Defaults to false.
|
|
|
+ * Minimize your SDL_Window if it loses key focus when in fullscreen mode. Defaults to false.
|
|
|
* \warning Before SDL 2.0.14, this defaulted to true! In 2.0.14, we're
|
|
|
* seeing if "true" causes more problems than it solves in modern times.
|
|
|
*
|
|
@@ -1721,7 +1720,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS "SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the libdecor Wayland backend is allowed to be used.
|
|
|
+ * A variable controlling whether the libdecor Wayland backend is allowed to be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - libdecor use is disabled.
|
|
@@ -1732,7 +1731,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_WAYLAND_ALLOW_LIBDECOR "SDL_VIDEO_WAYLAND_ALLOW_LIBDECOR"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the libdecor Wayland backend is preferred over native decrations.
|
|
|
+ * A variable controlling whether the libdecor Wayland backend is preferred over native decrations.
|
|
|
*
|
|
|
* When this hint is set, libdecor will be used to provide window decorations, even if xdg-decoration is
|
|
|
* available. (Note that, by default, libdecor will use xdg-decoration itself if available).
|
|
@@ -1746,7 +1745,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_WAYLAND_PREFER_LIBDECOR "SDL_VIDEO_WAYLAND_PREFER_LIBDECOR"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether video mode emulation is enabled under Wayland.
|
|
|
+ * A variable controlling whether video mode emulation is enabled under Wayland.
|
|
|
*
|
|
|
* When this hint is set, a standard set of emulated CVT video modes will be exposed for use by the application.
|
|
|
* If it is disabled, the only modes exposed will be the logical desktop size and, in the case of a scaled
|
|
@@ -1761,7 +1760,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_WAYLAND_MODE_EMULATION "SDL_VIDEO_WAYLAND_MODE_EMULATION"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling how modes with a non-native aspect ratio are displayed under Wayland.
|
|
|
+ * A variable controlling how modes with a non-native aspect ratio are displayed under Wayland.
|
|
|
*
|
|
|
* When this hint is set, the requested scaling will be used when displaying fullscreen video modes
|
|
|
* that don't match the display's native aspect ratio. This is contingent on compositor viewport support.
|
|
@@ -1776,7 +1775,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_WAYLAND_MODE_SCALING "SDL_VIDEO_WAYLAND_MODE_SCALING"
|
|
|
|
|
|
/**
|
|
|
- * \brief Enable or disable mouse pointer warp emulation, needed by some older games.
|
|
|
+ * Enable or disable mouse pointer warp emulation, needed by some older games.
|
|
|
*
|
|
|
* When this hint is set, any SDL will emulate mouse warps using relative mouse mode.
|
|
|
* This is required for some older games (such as Source engine games), which warp the
|
|
@@ -1793,7 +1792,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_WAYLAND_EMULATE_MOUSE_WARP "SDL_VIDEO_WAYLAND_EMULATE_MOUSE_WARP"
|
|
|
|
|
|
/**
|
|
|
-* \brief A variable that is the address of another SDL_Window* (as a hex string formatted with "%p").
|
|
|
+* A variable that is the address of another SDL_Window* (as a hex string formatted with "%p").
|
|
|
*
|
|
|
* If this hint is set before SDL_CreateWindowFrom() and the SDL_Window* it is set to has
|
|
|
* SDL_WINDOW_OPENGL set (and running on WGL only, currently), then two things will occur on the newly
|
|
@@ -1812,7 +1811,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT "SDL_VIDEO_WINDOW_SHARE_PIXEL_FORMAT"
|
|
|
|
|
|
/**
|
|
|
- * \brief When calling SDL_CreateWindowFrom(), make the window compatible with OpenGL.
|
|
|
+ * When calling SDL_CreateWindowFrom(), make the window compatible with OpenGL.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Don't add any graphics flags to the SDL_WindowFlags
|
|
@@ -1823,7 +1822,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_FOREIGN_WINDOW_OPENGL "SDL_VIDEO_FOREIGN_WINDOW_OPENGL"
|
|
|
|
|
|
/**
|
|
|
- * \brief When calling SDL_CreateWindowFrom(), make the window compatible with Vulkan.
|
|
|
+ * When calling SDL_CreateWindowFrom(), make the window compatible with Vulkan.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Don't add any graphics flags to the SDL_WindowFlags
|
|
@@ -1834,7 +1833,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_FOREIGN_WINDOW_VULKAN "SDL_VIDEO_FOREIGN_WINDOW_VULKAN"
|
|
|
|
|
|
/**
|
|
|
-* \brief A variable specifying which shader compiler to preload when using the Chrome ANGLE binaries
|
|
|
+* A variable specifying which shader compiler to preload when using the Chrome ANGLE binaries
|
|
|
*
|
|
|
* SDL has EGL and OpenGL ES2 support on Windows via the ANGLE project. It
|
|
|
* can use two different sets of binaries, those compiled by the user from source
|
|
@@ -1850,8 +1849,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_WIN_D3DCOMPILER "SDL_VIDEO_WIN_D3DCOMPILER"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the OpenGL context should be created
|
|
|
- * with EGL by default
|
|
|
+ * Set whether the OpenGL context should be created with EGL by default
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Use platform-specific GL context creation API (GLX, WGL, CGL, etc)
|
|
@@ -1862,7 +1860,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_FORCE_EGL "SDL_VIDEO_FORCE_EGL"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the X11 _NET_WM_BYPASS_COMPOSITOR hint should be used.
|
|
|
+ * A variable controlling whether the X11 _NET_WM_BYPASS_COMPOSITOR hint should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Disable _NET_WM_BYPASS_COMPOSITOR
|
|
@@ -1874,7 +1872,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR "SDL_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the X11 _NET_WM_PING protocol should be supported.
|
|
|
+ * A variable controlling whether the X11 _NET_WM_PING protocol should be supported.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Disable _NET_WM_PING
|
|
@@ -1888,20 +1886,20 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_X11_NET_WM_PING "SDL_VIDEO_X11_NET_WM_PING"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable forcing the visual ID chosen for new X11 windows
|
|
|
+ * A variable forcing the visual ID chosen for new X11 windows
|
|
|
*
|
|
|
*/
|
|
|
#define SDL_HINT_VIDEO_X11_WINDOW_VISUALID "SDL_VIDEO_X11_WINDOW_VISUALID"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable forcing the scaling factor for X11 windows
|
|
|
+ * A variable forcing the scaling factor for X11 windows
|
|
|
*
|
|
|
* This variable can be set to a floating point value in the range 1.0-10.0f
|
|
|
*/
|
|
|
#define SDL_HINT_VIDEO_X11_SCALING_FACTOR "SDL_VIDEO_X11_SCALING_FACTOR"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the X11 XRandR extension should be used.
|
|
|
+ * A variable controlling whether the X11 XRandR extension should be used.
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - Disable XRandR
|
|
@@ -1912,7 +1910,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_X11_XRANDR "SDL_VIDEO_X11_XRANDR"
|
|
|
|
|
|
/**
|
|
|
- * \brief Controls how the fact chunk affects the loading of a WAVE file.
|
|
|
+ * Controls how the fact chunk affects the loading of a WAVE file.
|
|
|
*
|
|
|
* The fact chunk stores information about the number of samples of a WAVE
|
|
|
* file. The Standards Update from Microsoft notes that this value can be used
|
|
@@ -1939,7 +1937,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WAVE_FACT_CHUNK "SDL_WAVE_FACT_CHUNK"
|
|
|
|
|
|
/**
|
|
|
- * \brief Controls how the size of the RIFF chunk affects the loading of a WAVE file.
|
|
|
+ * Controls how the size of the RIFF chunk affects the loading of a WAVE file.
|
|
|
*
|
|
|
* The size of the RIFF chunk (which includes all the sub-chunks of the WAVE
|
|
|
* file) is not always reliable. In case the size is wrong, it's possible to
|
|
@@ -1960,7 +1958,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WAVE_RIFF_CHUNK_SIZE "SDL_WAVE_RIFF_CHUNK_SIZE"
|
|
|
|
|
|
/**
|
|
|
- * \brief Controls how a truncated WAVE file is handled.
|
|
|
+ * Controls how a truncated WAVE file is handled.
|
|
|
*
|
|
|
* A WAVE file is considered truncated if any of the chunks are incomplete or
|
|
|
* the data chunk size is not a multiple of the block size. By default, SDL
|
|
@@ -1976,7 +1974,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WAVE_TRUNCATION "SDL_WAVE_TRUNCATION"
|
|
|
|
|
|
/**
|
|
|
- * \brief Tell SDL not to name threads on Windows with the 0x406D1388 Exception.
|
|
|
+ * Tell SDL not to name threads on Windows with the 0x406D1388 Exception.
|
|
|
* The 0x406D1388 Exception is a trick used to inform Visual Studio of a
|
|
|
* thread's name, but it tends to cause problems with other debuggers,
|
|
|
* and the .NET runtime. Note that SDL 2.0.6 and later will still use
|
|
@@ -1992,7 +1990,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WINDOWS_DISABLE_THREAD_NAMING "SDL_WINDOWS_DISABLE_THREAD_NAMING"
|
|
|
|
|
|
/**
|
|
|
- * \brief Controls whether menus can be opened with their keyboard shortcut (Alt+mnemonic).
|
|
|
+ * Controls whether menus can be opened with their keyboard shortcut (Alt+mnemonic).
|
|
|
*
|
|
|
* If the mnemonics are enabled, then menus can be opened by pressing the Alt
|
|
|
* key and the corresponding mnemonic (for example, Alt+F opens the File menu).
|
|
@@ -2014,7 +2012,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WINDOWS_ENABLE_MENU_MNEMONICS "SDL_WINDOWS_ENABLE_MENU_MNEMONICS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the windows message loop is processed by SDL
|
|
|
+ * A variable controlling whether the windows message loop is processed by SDL
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - The window message loop is not run
|
|
@@ -2025,7 +2023,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP "SDL_WINDOWS_ENABLE_MESSAGELOOP"
|
|
|
|
|
|
/**
|
|
|
- * \brief Force SDL to use Critical Sections for mutexes on Windows.
|
|
|
+ * Force SDL to use Critical Sections for mutexes on Windows.
|
|
|
* On Windows 7 and newer, Slim Reader/Writer Locks are available.
|
|
|
* They offer better performance, allocate no kernel resources and
|
|
|
* use less memory. SDL will fall back to Critical Sections on older
|
|
@@ -2039,7 +2037,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WINDOWS_FORCE_MUTEX_CRITICAL_SECTIONS "SDL_WINDOWS_FORCE_MUTEX_CRITICAL_SECTIONS"
|
|
|
|
|
|
/**
|
|
|
- * \brief Force SDL to use Kernel Semaphores on Windows.
|
|
|
+ * Force SDL to use Kernel Semaphores on Windows.
|
|
|
* Kernel Semaphores are inter-process and require a context
|
|
|
* switch on every interaction. On Windows 8 and newer, the
|
|
|
* WaitOnAddress API is available. Using that and atomics to
|
|
@@ -2055,13 +2053,13 @@ extern "C" {
|
|
|
#define SDL_HINT_WINDOWS_FORCE_SEMAPHORE_KERNEL "SDL_WINDOWS_FORCE_SEMAPHORE_KERNEL"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable to specify custom icon resource id from RC file on Windows platform
|
|
|
+ * A variable to specify custom icon resource id from RC file on Windows platform
|
|
|
*/
|
|
|
#define SDL_HINT_WINDOWS_INTRESOURCE_ICON "SDL_WINDOWS_INTRESOURCE_ICON"
|
|
|
#define SDL_HINT_WINDOWS_INTRESOURCE_ICON_SMALL "SDL_WINDOWS_INTRESOURCE_ICON_SMALL"
|
|
|
|
|
|
/**
|
|
|
- * \brief Tell SDL not to generate window-close events for Alt+F4 on Windows.
|
|
|
+ * Tell SDL not to generate window-close events for Alt+F4 on Windows.
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
|
* "0" - SDL will generate a window-close event when it sees Alt+F4.
|
|
@@ -2070,7 +2068,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WINDOWS_NO_CLOSE_ON_ALT_F4 "SDL_WINDOWS_NO_CLOSE_ON_ALT_F4"
|
|
|
|
|
|
/**
|
|
|
- * \brief Use the D3D9Ex API introduced in Windows Vista, instead of normal D3D9.
|
|
|
+ * Use the D3D9Ex API introduced in Windows Vista, instead of normal D3D9.
|
|
|
* Direct3D 9Ex contains changes to state management that can eliminate device
|
|
|
* loss errors during scenarios like Alt+Tab or UAC prompts. D3D9Ex may require
|
|
|
* some changes to your application to cope with the new behavior, so this
|
|
@@ -2090,7 +2088,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WINDOWS_USE_D3D9EX "SDL_WINDOWS_USE_D3D9EX"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable controlling whether the window frame and title bar are interactive when the cursor is hidden
|
|
|
+ * A variable controlling whether the window frame and title bar are interactive when the cursor is hidden
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - The window frame is not interactive when the cursor is hidden (no move, resize, etc)
|
|
@@ -2101,7 +2099,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN "SDL_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN"
|
|
|
|
|
|
/**
|
|
|
-* \brief A variable controlling whether the window is activated when the SDL_ShowWindow function is called
|
|
|
+* A variable controlling whether the window is activated when the SDL_ShowWindow function is called
|
|
|
*
|
|
|
* This variable can be set to the following values:
|
|
|
* "0" - The window is not activated when the SDL_ShowWindow function is called
|
|
@@ -2111,7 +2109,7 @@ extern "C" {
|
|
|
*/
|
|
|
#define SDL_HINT_WINDOW_ACTIVATE_WHEN_SHOWN "SDL_WINDOW_ACTIVATE_WHEN_SHOWN"
|
|
|
|
|
|
-/** \brief Allows back-button-press events on Windows Phone to be marked as handled
|
|
|
+/** Allows back-button-press events on Windows Phone to be marked as handled
|
|
|
*
|
|
|
* Windows Phone devices typically feature a Back button. When pressed,
|
|
|
* the OS will emit back-button-press events, which apps are expected to
|
|
@@ -2163,7 +2161,7 @@ extern "C" {
|
|
|
*/
|
|
|
#define SDL_HINT_WINRT_HANDLE_BACK_BUTTON "SDL_WINRT_HANDLE_BACK_BUTTON"
|
|
|
|
|
|
-/** \brief Label text for a WinRT app's privacy policy link
|
|
|
+/** Label text for a WinRT app's privacy policy link
|
|
|
*
|
|
|
* Network-enabled WinRT apps must include a privacy policy. On Windows 8, 8.1, and RT,
|
|
|
* Microsoft mandates that this policy be available via the Windows Settings charm.
|
|
@@ -2185,7 +2183,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WINRT_PRIVACY_POLICY_LABEL "SDL_WINRT_PRIVACY_POLICY_LABEL"
|
|
|
|
|
|
/**
|
|
|
- * \brief A URL to a WinRT app's privacy policy
|
|
|
+ * A URL to a WinRT app's privacy policy
|
|
|
*
|
|
|
* All network-enabled WinRT apps must make a privacy policy available to its
|
|
|
* users. On Windows 8, 8.1, and RT, Microsoft mandates that this policy be
|
|
@@ -2211,7 +2209,7 @@ extern "C" {
|
|
|
#define SDL_HINT_WINRT_PRIVACY_POLICY_URL "SDL_WINRT_PRIVACY_POLICY_URL"
|
|
|
|
|
|
/**
|
|
|
- * \brief Mark X11 windows as override-redirect.
|
|
|
+ * Mark X11 windows as override-redirect.
|
|
|
*
|
|
|
* If set, this _might_ increase framerate at the expense of the desktop
|
|
|
* not working as expected. Override-redirect windows aren't noticed by the
|
|
@@ -2223,7 +2221,7 @@ extern "C" {
|
|
|
#define SDL_HINT_X11_FORCE_OVERRIDE_REDIRECT "SDL_X11_FORCE_OVERRIDE_REDIRECT"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that lets you disable the detection and use of Xinput gamepad devices
|
|
|
+ * A variable that lets you disable the detection and use of Xinput gamepad devices
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
|
* "0" - Disable XInput detection (only uses direct input)
|
|
@@ -2232,7 +2230,7 @@ extern "C" {
|
|
|
#define SDL_HINT_XINPUT_ENABLED "SDL_XINPUT_ENABLED"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that lets you disable the detection and use of DirectInput gamepad devices
|
|
|
+ * A variable that lets you disable the detection and use of DirectInput gamepad devices
|
|
|
*
|
|
|
* The variable can be set to the following values:
|
|
|
* "0" - Disable DirectInput detection (only uses XInput)
|
|
@@ -2241,7 +2239,7 @@ extern "C" {
|
|
|
#define SDL_HINT_DIRECTINPUT_ENABLED "SDL_DIRECTINPUT_ENABLED"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that causes SDL to use the old axis and button mapping for XInput devices.
|
|
|
+ * A variable that causes SDL to use the old axis and button mapping for XInput devices.
|
|
|
*
|
|
|
* This hint is for backwards compatibility only and will be removed in SDL 2.1
|
|
|
*
|
|
@@ -2250,7 +2248,7 @@ extern "C" {
|
|
|
#define SDL_HINT_XINPUT_USE_OLD_JOYSTICK_MAPPING "SDL_XINPUT_USE_OLD_JOYSTICK_MAPPING"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that causes SDL to not ignore audio "monitors"
|
|
|
+ * A variable that causes SDL to not ignore audio "monitors"
|
|
|
*
|
|
|
* This is currently only used for PulseAudio and ignored elsewhere.
|
|
|
*
|
|
@@ -2269,7 +2267,7 @@ extern "C" {
|
|
|
#define SDL_HINT_AUDIO_INCLUDE_MONITORS "SDL_AUDIO_INCLUDE_MONITORS"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that forces X11 windows to create as a custom type.
|
|
|
+ * A variable that forces X11 windows to create as a custom type.
|
|
|
*
|
|
|
* This is currently only used for X11 and ignored elsewhere.
|
|
|
*
|
|
@@ -2289,7 +2287,7 @@ extern "C" {
|
|
|
#define SDL_HINT_X11_WINDOW_TYPE "SDL_X11_WINDOW_TYPE"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that decides whether to send SDL_EVENT_QUIT when closing the final window.
|
|
|
+ * A variable that decides whether to send SDL_EVENT_QUIT when closing the final window.
|
|
|
*
|
|
|
* By default, SDL sends an SDL_EVENT_QUIT event when there is only one window
|
|
|
* and it receives an SDL_EVENT_WINDOW_CLOSE_REQUESTED event, under the assumption most
|
|
@@ -2314,7 +2312,7 @@ extern "C" {
|
|
|
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that decides what video backend to use.
|
|
|
+ * A variable that decides what video backend to use.
|
|
|
*
|
|
|
* By default, SDL will try all available video backends in a reasonable
|
|
|
* order until it finds one that can work, but this hint allows the app
|
|
@@ -2337,7 +2335,7 @@ extern "C" {
|
|
|
#define SDL_HINT_VIDEO_DRIVER "SDL_VIDEO_DRIVER"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that decides what audio backend to use.
|
|
|
+ * A variable that decides what audio backend to use.
|
|
|
*
|
|
|
* By default, SDL will try all available audio backends in a reasonable
|
|
|
* order until it finds one that can work, but this hint allows the app
|
|
@@ -2360,7 +2358,7 @@ extern "C" {
|
|
|
#define SDL_HINT_AUDIO_DRIVER "SDL_AUDIO_DRIVER"
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that decides what KMSDRM device to use.
|
|
|
+ * A variable that decides what KMSDRM device to use.
|
|
|
*
|
|
|
* Internally, SDL might open something like "/dev/dri/cardNN" to
|
|
|
* access KMSDRM functionality, where "NN" is a device index number.
|
|
@@ -2375,7 +2373,7 @@ extern "C" {
|
|
|
|
|
|
|
|
|
/**
|
|
|
- * \brief A variable that treats trackpads as touch devices.
|
|
|
+ * A variable that treats trackpads as touch devices.
|
|
|
*
|
|
|
* On macOS (and possibly other platforms in the future), SDL will report
|
|
|
* touches on a trackpad as mouse input, which is generally what users
|
|
@@ -2397,7 +2395,7 @@ extern "C" {
|
|
|
|
|
|
|
|
|
/**
|
|
|
- * \brief Sets the title of the TextInput window on GDK platforms.
|
|
|
+ * Sets the title of the TextInput window on GDK platforms.
|
|
|
*
|
|
|
* On GDK, if SDL_GDK_TEXTINPUT is defined, you can use the
|
|
|
* standard SDL text input and virtual keyboard capabilities
|
|
@@ -2416,7 +2414,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GDK_TEXTINPUT_TITLE "SDL_GDK_TEXTINPUT_TITLE"
|
|
|
|
|
|
/**
|
|
|
- * \brief Sets the description of the TextInput window on GDK platforms.
|
|
|
+ * Sets the description of the TextInput window on GDK platforms.
|
|
|
*
|
|
|
* On GDK, if SDL_GDK_TEXTINPUT is defined, you can use the
|
|
|
* standard SDL text input and virtual keyboard capabilities
|
|
@@ -2435,7 +2433,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GDK_TEXTINPUT_DESCRIPTION "SDL_GDK_TEXTINPUT_DESCRIPTION"
|
|
|
|
|
|
/**
|
|
|
- * \brief Sets the default text of the TextInput window on GDK platforms.
|
|
|
+ * Sets the default text of the TextInput window on GDK platforms.
|
|
|
*
|
|
|
* On GDK, if SDL_GDK_TEXTINPUT is defined, you can use the
|
|
|
* standard SDL text input and virtual keyboard capabilities
|
|
@@ -2454,7 +2452,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GDK_TEXTINPUT_DEFAULT "SDL_GDK_TEXTINPUT_DEFAULT"
|
|
|
|
|
|
/**
|
|
|
- * \brief Sets the input scope of the TextInput window on GDK platforms.
|
|
|
+ * Sets the input scope of the TextInput window on GDK platforms.
|
|
|
*
|
|
|
* On GDK, if SDL_GDK_TEXTINPUT is defined, you can use the
|
|
|
* standard SDL text input and virtual keyboard capabilities
|
|
@@ -2477,7 +2475,7 @@ extern "C" {
|
|
|
#define SDL_HINT_GDK_TEXTINPUT_SCOPE "SDL_GDK_TEXTINPUT_SCOPE"
|
|
|
|
|
|
/**
|
|
|
- * \brief Sets the maximum input length of the TextInput window on GDK platforms.
|
|
|
+ * Sets the maximum input length of the TextInput window on GDK platforms.
|
|
|
*
|
|
|
* On GDK, if SDL_GDK_TEXTINPUT is defined, you can use the
|
|
|
* standard SDL text input and virtual keyboard capabilities
|
|
@@ -2537,7 +2535,7 @@ extern "C" {
|
|
|
|
|
|
|
|
|
/**
|
|
|
- * \brief An enumeration of hint priorities
|
|
|
+ * An enumeration of hint priorities
|
|
|
*/
|
|
|
typedef enum
|
|
|
{
|