early-access version 2281
This commit is contained in:
132
externals/SDL/include/SDL_hints.h
vendored
132
externals/SDL/include/SDL_hints.h
vendored
@@ -145,6 +145,26 @@ extern "C" {
|
||||
*/
|
||||
#define SDL_HINT_ANDROID_TRAP_BACK_BUTTON "SDL_ANDROID_TRAP_BACK_BUTTON"
|
||||
|
||||
/**
|
||||
* \brief 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
|
||||
* audio streams, and in lists of applications which are inhibiting the
|
||||
* screensaver. You should use a string that describes your program ("My Game
|
||||
* 2: The Revenge")
|
||||
*
|
||||
* Setting this to "" or leaving it unset will have SDL use a reasonable
|
||||
* default: probably the application's name or "SDL Application" if SDL
|
||||
* doesn't have any better information.
|
||||
*
|
||||
* Note that, for audio streams, this can be overridden with
|
||||
* SDL_HINT_AUDIO_DEVICE_APP_NAME.
|
||||
*
|
||||
* On targets where this is not supported, this hint does nothing.
|
||||
*/
|
||||
#define SDL_HINT_APP_NAME "SDL_APP_NAME"
|
||||
|
||||
/**
|
||||
* \brief A variable controlling whether controllers used with the Apple TV
|
||||
* generate UI events.
|
||||
@@ -199,8 +219,9 @@ extern "C" {
|
||||
* that describes your program ("My Game 2: The Revenge")
|
||||
*
|
||||
* Setting this to "" or leaving it unset will have SDL use a reasonable
|
||||
* default: probably the application's name or "SDL Application" if SDL
|
||||
* doesn't have any better information.
|
||||
* default: this will be the name set with SDL_HINT_APP_NAME, if that hint is
|
||||
* set. Otherwise, it'll probably the application's name or "SDL Application"
|
||||
* if SDL doesn't have any better information.
|
||||
*
|
||||
* On targets where this is not supported, this hint does nothing.
|
||||
*/
|
||||
@@ -536,6 +557,15 @@ 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.
|
||||
*
|
||||
* The variable can be set to the following values:
|
||||
* "0" - Native UI components are not display. (default)
|
||||
* "1" - Native UI components are displayed.
|
||||
*/
|
||||
#define SDL_HINT_IME_SHOW_UI "SDL_IME_SHOW_UI"
|
||||
|
||||
/**
|
||||
* \brief A variable controlling whether the home indicator bar on iPhone X
|
||||
* should be hidden.
|
||||
@@ -690,9 +720,10 @@ extern "C" {
|
||||
*
|
||||
* This variable can be set to the following values:
|
||||
* "0" - HIDAPI driver is not used
|
||||
* "1" - HIDAPI driver is used
|
||||
* "1" - HIDAPI driver is used for Steam Controllers, which requires Bluetooth access
|
||||
* and may prompt the user for permission on iOS and Android.
|
||||
*
|
||||
* The default is the value of SDL_HINT_JOYSTICK_HIDAPI
|
||||
* The default is "0"
|
||||
*/
|
||||
#define SDL_HINT_JOYSTICK_HIDAPI_STEAM "SDL_JOYSTICK_HIDAPI_STEAM"
|
||||
|
||||
@@ -711,8 +742,10 @@ extern "C" {
|
||||
* \brief A variable controlling whether the Home button LED should be turned on when a Nintendo Switch controller is opened
|
||||
*
|
||||
* This variable can be set to the following values:
|
||||
* "0" - home button LED is left off
|
||||
* "1" - home button LED is turned on (the default)
|
||||
* "0" - home button LED is turned off
|
||||
* "1" - home button LED is turned on
|
||||
*
|
||||
* By default the Home button LED state is not changed.
|
||||
*/
|
||||
#define SDL_HINT_JOYSTICK_HIDAPI_SWITCH_HOME_LED "SDL_JOYSTICK_HIDAPI_SWITCH_HOME_LED"
|
||||
|
||||
@@ -784,6 +817,24 @@ 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
|
||||
*
|
||||
* This variable is currently only used by the Linux joystick driver.
|
||||
*/
|
||||
#define SDL_HINT_JOYSTICK_DEVICE "SDL_JOYSTICK_DEVICE"
|
||||
|
||||
/**
|
||||
* \brief 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*
|
||||
* "1" - Use /dev/input/js*
|
||||
*
|
||||
* By default the /dev/input/event* interfaces are used
|
||||
*/
|
||||
#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.
|
||||
*
|
||||
@@ -926,6 +977,22 @@ extern "C" {
|
||||
*/
|
||||
#define SDL_HINT_ORIENTATIONS "SDL_IOS_ORIENTATIONS"
|
||||
|
||||
/**
|
||||
* \brief 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
|
||||
* "1" - Enable poll sentinels
|
||||
*
|
||||
* When polling for events, SDL_PumpEvents is used to gather new events from devices.
|
||||
* If a device keeps producing new events between calls to SDL_PumpEvents, a poll loop will
|
||||
* become stuck until the new events stop.
|
||||
* This is most noticable when moving a high frequency mouse.
|
||||
*
|
||||
* By default, poll sentinels are enabled.
|
||||
*/
|
||||
#define SDL_HINT_POLL_SENTINEL "SDL_POLL_SENTINEL"
|
||||
|
||||
/**
|
||||
* \brief Override for SDL_GetPreferredLocales()
|
||||
*
|
||||
@@ -1101,6 +1168,26 @@ extern "C" {
|
||||
*/
|
||||
#define SDL_HINT_RPI_VIDEO_LAYER "SDL_RPI_VIDEO_LAYER"
|
||||
|
||||
/**
|
||||
* \brief 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.
|
||||
*
|
||||
* This hint lets you specify the "activity name" sent to the OS when
|
||||
* SDL_DisableScreenSaver() is used (or the screensaver is automatically
|
||||
* disabled). The contents of this hint are used when the screensaver is
|
||||
* disabled. You should use a string that describes what your program is doing
|
||||
* (and, therefore, why the screensaver is disabled). For example, "Playing a
|
||||
* game" or "Watching a video".
|
||||
*
|
||||
* Setting this to "" or leaving it unset will have SDL use a reasonable
|
||||
* default: "Playing a game" or something similar.
|
||||
*
|
||||
* On targets where this is not supported, this hint does nothing.
|
||||
*/
|
||||
#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.
|
||||
*
|
||||
@@ -1218,6 +1305,17 @@ extern "C" {
|
||||
*/
|
||||
#define SDL_HINT_VIDEO_DOUBLE_BUFFER "SDL_VIDEO_DOUBLE_BUFFER"
|
||||
|
||||
/**
|
||||
* \brief A variable controlling whether the EGL window is allowed to be
|
||||
* composited as transparent, rather than opaque.
|
||||
*
|
||||
* Most window systems will always render windows opaque, even if the surface
|
||||
* format has an alpha channel. This is not always true, however, so by default
|
||||
* SDL will try to enforce opaque composition. To override this behavior, you
|
||||
* can set this hint to "1".
|
||||
*/
|
||||
#define SDL_HINT_VIDEO_EGL_ALLOW_TRANSPARENCY "SDL_VIDEO_EGL_ALLOW_TRANSPARENCY"
|
||||
|
||||
/**
|
||||
* \brief A variable controlling whether the graphics context is externally managed.
|
||||
*
|
||||
@@ -1484,9 +1582,6 @@ extern "C" {
|
||||
* They offer better performance, allocate no kernel ressources and
|
||||
* use less memory. SDL will fall back to Critical Sections on older
|
||||
* OS versions or if forced to by this hint.
|
||||
* This also affects Condition Variables. When SRW mutexes are used,
|
||||
* SDL will use Windows Condition Variables as well. Else, a generic
|
||||
* SDL_cond implementation will be used that works with all mutexes.
|
||||
*
|
||||
* This variable can be set to the following values:
|
||||
* "0" - Use SRW Locks when available. If not, fall back to Critical Sections. (default)
|
||||
@@ -1557,6 +1652,17 @@ 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
|
||||
*
|
||||
* This variable can be set to the following values:
|
||||
* "0" - The window is activated when the SDL_ShowWindow function is called
|
||||
* "1" - The window is not activated when the SDL_ShowWindow function is called
|
||||
*
|
||||
* By default SDL will activate the window when the SDL_ShowWindow function is called
|
||||
*/
|
||||
#define SDL_HINT_WINDOW_NO_ACTIVATION_WHEN_SHOWN "SDL_WINDOW_NO_ACTIVATION_WHEN_SHOWN"
|
||||
|
||||
/** \brief Allows back-button-press events on Windows Phone to be marked as handled
|
||||
*
|
||||
* Windows Phone devices typically feature a Back button. When pressed,
|
||||
@@ -1729,6 +1835,8 @@ typedef enum
|
||||
* \param priority the SDL_HintPriority level for the hint
|
||||
* \returns SDL_TRUE if the hint was set, SDL_FALSE otherwise.
|
||||
*
|
||||
* \since This function is available since SDL 2.0.0.
|
||||
*
|
||||
* \sa SDL_GetHint
|
||||
* \sa SDL_SetHint
|
||||
*/
|
||||
@@ -1747,6 +1855,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name,
|
||||
* \param value the value of the hint variable
|
||||
* \returns SDL_TRUE if the hint was set, SDL_FALSE otherwise.
|
||||
*
|
||||
* \since This function is available since SDL 2.0.0.
|
||||
*
|
||||
* \sa SDL_GetHint
|
||||
* \sa SDL_SetHintWithPriority
|
||||
*/
|
||||
@@ -1759,6 +1869,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name,
|
||||
* \param name the hint to query
|
||||
* \returns the string value of a hint or NULL if the hint isn't set.
|
||||
*
|
||||
* \since This function is available since SDL 2.0.0.
|
||||
*
|
||||
* \sa SDL_SetHint
|
||||
* \sa SDL_SetHintWithPriority
|
||||
*/
|
||||
@@ -1825,6 +1937,8 @@ extern DECLSPEC void SDLCALL SDL_DelHintCallback(const char *name,
|
||||
* Clear all hints.
|
||||
*
|
||||
* This function is automatically called during SDL_Quit().
|
||||
*
|
||||
* \since This function is available since SDL 2.0.0.
|
||||
*/
|
||||
extern DECLSPEC void SDLCALL SDL_ClearHints(void);
|
||||
|
||||
|
Reference in New Issue
Block a user