include/SDL_hints.h
author Marius Gripsgard <marius@ubports.com>
Sat, 13 Jan 2018 01:58:11 +0100
changeset 11826 13d922b387db
parent 11811 5d94cb6b24d3
permissions -rw-r--r--
Mir: Handle close window events
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  *  \file SDL_hints.h
    24  *
    25  *  Official documentation for SDL configuration variables
    26  *
    27  *  This file contains functions to set and get configuration hints,
    28  *  as well as listing each of them alphabetically.
    29  *
    30  *  The convention for naming hints is SDL_HINT_X, where "SDL_X" is
    31  *  the environment variable that can be used to override the default.
    32  *
    33  *  In general these hints are just that - they may or may not be
    34  *  supported or applicable on any given platform, but they provide
    35  *  a way for an application or user to give the library a hint as
    36  *  to how they would like the library to work.
    37  */
    38 
    39 #ifndef SDL_hints_h_
    40 #define SDL_hints_h_
    41 
    42 #include "SDL_stdinc.h"
    43 
    44 #include "begin_code.h"
    45 /* Set up for C function definitions, even when using C++ */
    46 #ifdef __cplusplus
    47 extern "C" {
    48 #endif
    49 
    50 /**
    51  *  \brief  A variable controlling how 3D acceleration is used to accelerate the SDL screen surface.
    52  *
    53  *  SDL can try to accelerate the SDL screen surface by using streaming
    54  *  textures with a 3D rendering engine.  This variable controls whether and
    55  *  how this is done.
    56  *
    57  *  This variable can be set to the following values:
    58  *    "0"       - Disable 3D acceleration
    59  *    "1"       - Enable 3D acceleration, using the default renderer.
    60  *    "X"       - Enable 3D acceleration, using X where X is one of the valid rendering drivers.  (e.g. "direct3d", "opengl", etc.)
    61  *
    62  *  By default SDL tries to make a best guess for each platform whether
    63  *  to use acceleration or not.
    64  */
    65 #define SDL_HINT_FRAMEBUFFER_ACCELERATION   "SDL_FRAMEBUFFER_ACCELERATION"
    66 
    67 /**
    68  *  \brief  A variable specifying which render driver to use.
    69  *
    70  *  If the application doesn't pick a specific renderer to use, this variable
    71  *  specifies the name of the preferred renderer.  If the preferred renderer
    72  *  can't be initialized, the normal default renderer is used.
    73  *
    74  *  This variable is case insensitive and can be set to the following values:
    75  *    "direct3d"
    76  *    "opengl"
    77  *    "opengles2"
    78  *    "opengles"
    79  *    "metal"
    80  *    "software"
    81  *
    82  *  The default varies by platform, but it's the first one in the list that
    83  *  is available on the current platform.
    84  */
    85 #define SDL_HINT_RENDER_DRIVER              "SDL_RENDER_DRIVER"
    86 
    87 /**
    88  *  \brief  A variable controlling whether the OpenGL render driver uses shaders if they are available.
    89  *
    90  *  This variable can be set to the following values:
    91  *    "0"       - Disable shaders
    92  *    "1"       - Enable shaders
    93  *
    94  *  By default shaders are used if OpenGL supports them.
    95  */
    96 #define SDL_HINT_RENDER_OPENGL_SHADERS      "SDL_RENDER_OPENGL_SHADERS"
    97 
    98 /**
    99  *  \brief  A variable controlling whether the Direct3D device is initialized for thread-safe operations.
   100  *
   101  *  This variable can be set to the following values:
   102  *    "0"       - Thread-safety is not enabled (faster)
   103  *    "1"       - Thread-safety is enabled
   104  *
   105  *  By default the Direct3D device is created with thread-safety disabled.
   106  */
   107 #define SDL_HINT_RENDER_DIRECT3D_THREADSAFE "SDL_RENDER_DIRECT3D_THREADSAFE"
   108 
   109 /**
   110  *  \brief  A variable controlling whether to enable Direct3D 11+'s Debug Layer.
   111  *
   112  *  This variable does not have any effect on the Direct3D 9 based renderer.
   113  *
   114  *  This variable can be set to the following values:
   115  *    "0"       - Disable Debug Layer use
   116  *    "1"       - Enable Debug Layer use
   117  *
   118  *  By default, SDL does not use Direct3D Debug Layer.
   119  */
   120 #define SDL_HINT_RENDER_DIRECT3D11_DEBUG    "SDL_RENDER_DIRECT3D11_DEBUG"
   121 
   122 /**
   123  *  \brief  A variable controlling the scaling policy for SDL_RenderSetLogicalSize.
   124  *
   125  *  This variable can be set to the following values:
   126  *    "0" or "letterbox" - Uses letterbox/sidebars to fit the entire rendering on screen
   127  *    "1" or "overscan"  - Will zoom the rendering so it fills the entire screen, allowing edges to be drawn offscreen
   128  *
   129  *  By default letterbox is used
   130  */
   131 #define SDL_HINT_RENDER_LOGICAL_SIZE_MODE       "SDL_RENDER_LOGICAL_SIZE_MODE"
   132 
   133 /**
   134  *  \brief  A variable controlling the scaling quality
   135  *
   136  *  This variable can be set to the following values:
   137  *    "0" or "nearest" - Nearest pixel sampling
   138  *    "1" or "linear"  - Linear filtering (supported by OpenGL and Direct3D)
   139  *    "2" or "best"    - Currently this is the same as "linear"
   140  *
   141  *  By default nearest pixel sampling is used
   142  */
   143 #define SDL_HINT_RENDER_SCALE_QUALITY       "SDL_RENDER_SCALE_QUALITY"
   144 
   145 /**
   146  *  \brief  A variable controlling whether updates to the SDL screen surface should be synchronized with the vertical refresh, to avoid tearing.
   147  *
   148  *  This variable can be set to the following values:
   149  *    "0"       - Disable vsync
   150  *    "1"       - Enable vsync
   151  *
   152  *  By default SDL does not sync screen surface updates with vertical refresh.
   153  */
   154 #define SDL_HINT_RENDER_VSYNC               "SDL_RENDER_VSYNC"
   155 
   156 /**
   157  *  \brief  A variable controlling whether the screensaver is enabled. 
   158  *
   159  *  This variable can be set to the following values:
   160  *    "0"       - Disable screensaver
   161  *    "1"       - Enable screensaver
   162  *
   163  *  By default SDL will disable the screensaver.
   164  */
   165 #define SDL_HINT_VIDEO_ALLOW_SCREENSAVER    "SDL_VIDEO_ALLOW_SCREENSAVER"
   166 
   167 /**
   168  *  \brief  A variable controlling whether the X11 VidMode extension should be used.
   169  *
   170  *  This variable can be set to the following values:
   171  *    "0"       - Disable XVidMode
   172  *    "1"       - Enable XVidMode
   173  *
   174  *  By default SDL will use XVidMode if it is available.
   175  */
   176 #define SDL_HINT_VIDEO_X11_XVIDMODE         "SDL_VIDEO_X11_XVIDMODE"
   177 
   178 /**
   179  *  \brief  A variable controlling whether the X11 Xinerama extension should be used.
   180  *
   181  *  This variable can be set to the following values:
   182  *    "0"       - Disable Xinerama
   183  *    "1"       - Enable Xinerama
   184  *
   185  *  By default SDL will use Xinerama if it is available.
   186  */
   187 #define SDL_HINT_VIDEO_X11_XINERAMA         "SDL_VIDEO_X11_XINERAMA"
   188 
   189 /**
   190  *  \brief  A variable controlling whether the X11 XRandR extension should be used.
   191  *
   192  *  This variable can be set to the following values:
   193  *    "0"       - Disable XRandR
   194  *    "1"       - Enable XRandR
   195  *
   196  *  By default SDL will not use XRandR because of window manager issues.
   197  */
   198 #define SDL_HINT_VIDEO_X11_XRANDR           "SDL_VIDEO_X11_XRANDR"
   199 
   200 /**
   201  *  \brief  A variable controlling whether the X11 _NET_WM_PING protocol should be supported.
   202  *
   203  *  This variable can be set to the following values:
   204  *    "0"       - Disable _NET_WM_PING
   205  *    "1"       - Enable _NET_WM_PING
   206  *
   207  *  By default SDL will use _NET_WM_PING, but for applications that know they
   208  *  will not always be able to respond to ping requests in a timely manner they can
   209  *  turn it off to avoid the window manager thinking the app is hung.
   210  *  The hint is checked in CreateWindow.
   211  */
   212 #define SDL_HINT_VIDEO_X11_NET_WM_PING      "SDL_VIDEO_X11_NET_WM_PING"
   213 
   214 /**
   215  *  \brief  A variable controlling whether the window frame and title bar are interactive when the cursor is hidden 
   216  *
   217  *  This variable can be set to the following values:
   218  *    "0"       - The window frame is not interactive when the cursor is hidden (no move, resize, etc)
   219  *    "1"       - The window frame is interactive when the cursor is hidden
   220  *
   221  *  By default SDL will allow interaction with the window frame when the cursor is hidden
   222  */
   223 #define SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN    "SDL_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN"
   224 
   225 /**
   226  * \brief A variable to specify custom icon resource id from RC file on Windows platform 
   227  */
   228 #define SDL_HINT_WINDOWS_INTRESOURCE_ICON       "SDL_WINDOWS_INTRESOURCE_ICON"
   229 #define SDL_HINT_WINDOWS_INTRESOURCE_ICON_SMALL "SDL_WINDOWS_INTRESOURCE_ICON_SMALL"
   230 
   231 /**
   232  *  \brief  A variable controlling whether the windows message loop is processed by SDL 
   233  *
   234  *  This variable can be set to the following values:
   235  *    "0"       - The window message loop is not run
   236  *    "1"       - The window message loop is processed in SDL_PumpEvents()
   237  *
   238  *  By default SDL will process the windows message loop
   239  */
   240 #define SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP "SDL_WINDOWS_ENABLE_MESSAGELOOP"
   241 
   242 /**
   243  *  \brief  A variable controlling whether grabbing input grabs the keyboard
   244  *
   245  *  This variable can be set to the following values:
   246  *    "0"       - Grab will affect only the mouse
   247  *    "1"       - Grab will affect mouse and keyboard
   248  *
   249  *  By default SDL will not grab the keyboard so system shortcuts still work.
   250  */
   251 #define SDL_HINT_GRAB_KEYBOARD              "SDL_GRAB_KEYBOARD"
   252 
   253 /**
   254  *  \brief  A variable setting the speed scale for mouse motion, in floating point, when the mouse is not in relative mode
   255  */
   256 #define SDL_HINT_MOUSE_NORMAL_SPEED_SCALE    "SDL_MOUSE_NORMAL_SPEED_SCALE"
   257 
   258 /**
   259  *  \brief  A variable setting the scale for mouse motion, in floating point, when the mouse is in relative mode
   260  */
   261 #define SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE    "SDL_MOUSE_RELATIVE_SPEED_SCALE"
   262 
   263 /**
   264  *  \brief  A variable controlling whether relative mouse mode is implemented using mouse warping
   265  *
   266  *  This variable can be set to the following values:
   267  *    "0"       - Relative mouse mode uses raw input
   268  *    "1"       - Relative mouse mode uses mouse warping
   269  *
   270  *  By default SDL will use raw input for relative mouse mode
   271  */
   272 #define SDL_HINT_MOUSE_RELATIVE_MODE_WARP    "SDL_MOUSE_RELATIVE_MODE_WARP"
   273 
   274 /**
   275  *  \brief Allow mouse click events when clicking to focus an SDL window
   276  *
   277  *  This variable can be set to the following values:
   278  *    "0"       - Ignore mouse clicks that activate a window
   279  *    "1"       - Generate events for mouse clicks that activate a window
   280  *
   281  *  By default SDL will ignore mouse clicks that activate a window
   282  */
   283 #define SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH "SDL_MOUSE_FOCUS_CLICKTHROUGH"
   284 
   285 /**
   286  *  \brief  A variable controlling whether touch events should generate synthetic mouse events
   287  *
   288  *  This variable can be set to the following values:
   289  *    "0"       - Touch events will not generate mouse events
   290  *    "1"       - Touch events will generate mouse events
   291  *
   292  *  By default SDL will generate mouse events for touch events
   293  */
   294 #define SDL_HINT_TOUCH_MOUSE_EVENTS    "SDL_TOUCH_MOUSE_EVENTS"
   295 
   296 /**
   297  *  \brief Minimize your SDL_Window if it loses key focus when in fullscreen mode. Defaults to true.
   298  *
   299  */
   300 #define SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS   "SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS"
   301 
   302 /**
   303  *  \brief  A variable controlling whether the idle timer is disabled on iOS.
   304  *
   305  *  When an iOS app does not receive touches for some time, the screen is
   306  *  dimmed automatically. For games where the accelerometer is the only input
   307  *  this is problematic. This functionality can be disabled by setting this
   308  *  hint.
   309  *
   310  *  As of SDL 2.0.4, SDL_EnableScreenSaver() and SDL_DisableScreenSaver()
   311  *  accomplish the same thing on iOS. They should be preferred over this hint.
   312  *
   313  *  This variable can be set to the following values:
   314  *    "0"       - Enable idle timer
   315  *    "1"       - Disable idle timer
   316  */
   317 #define SDL_HINT_IDLE_TIMER_DISABLED "SDL_IOS_IDLE_TIMER_DISABLED"
   318 
   319 /**
   320  *  \brief  A variable controlling which orientations are allowed on iOS.
   321  *
   322  *  In some circumstances it is necessary to be able to explicitly control
   323  *  which UI orientations are allowed.
   324  *
   325  *  This variable is a space delimited list of the following values:
   326  *    "LandscapeLeft", "LandscapeRight", "Portrait" "PortraitUpsideDown"
   327  */
   328 #define SDL_HINT_ORIENTATIONS "SDL_IOS_ORIENTATIONS"
   329 
   330 /**
   331  *  \brief  A variable controlling whether controllers used with the Apple TV
   332  *  generate UI events.
   333  *
   334  * When UI events are generated by controller input, the app will be
   335  * backgrounded when the Apple TV remote's menu button is pressed, and when the
   336  * pause or B buttons on gamepads are pressed.
   337  *
   338  * More information about properly making use of controllers for the Apple TV
   339  * can be found here:
   340  * https://developer.apple.com/tvos/human-interface-guidelines/remote-and-controllers/
   341  *
   342  *  This variable can be set to the following values:
   343  *    "0"       - Controller input does not generate UI events (the default).
   344  *    "1"       - Controller input generates UI events.
   345  */
   346 #define SDL_HINT_APPLE_TV_CONTROLLER_UI_EVENTS "SDL_APPLE_TV_CONTROLLER_UI_EVENTS"
   347 
   348 /**
   349  * \brief  A variable controlling whether the Apple TV remote's joystick axes
   350  *         will automatically match the rotation of the remote.
   351  *
   352  *  This variable can be set to the following values:
   353  *    "0"       - Remote orientation does not affect joystick axes (the default).
   354  *    "1"       - Joystick axes are based on the orientation of the remote.
   355  */
   356 #define SDL_HINT_APPLE_TV_REMOTE_ALLOW_ROTATION "SDL_APPLE_TV_REMOTE_ALLOW_ROTATION"
   357 
   358 /**
   359  *  \brief  A variable controlling whether the Android / iOS built-in
   360  *  accelerometer should be listed as a joystick device, rather than listing
   361  *  actual joysticks only.
   362  *
   363  *  This variable can be set to the following values:
   364  *    "0"       - List only real joysticks and accept input from them
   365  *    "1"       - List real joysticks along with the accelerometer as if it were a 3 axis joystick (the default).
   366  */
   367 #define SDL_HINT_ACCELEROMETER_AS_JOYSTICK "SDL_ACCELEROMETER_AS_JOYSTICK"
   368 
   369 /**
   370  *  \brief  A variable that lets you disable the detection and use of Xinput gamepad devices
   371  *
   372  *  The variable can be set to the following values:
   373  *    "0"       - Disable XInput detection (only uses direct input)
   374  *    "1"       - Enable XInput detection (the default)
   375  */
   376 #define SDL_HINT_XINPUT_ENABLED "SDL_XINPUT_ENABLED"
   377 
   378 /**
   379  *  \brief  A variable that causes SDL to use the old axis and button mapping for XInput devices.
   380  *
   381  *  This hint is for backwards compatibility only and will be removed in SDL 2.1
   382  *
   383  *  The default value is "0".  This hint must be set before SDL_Init()
   384  */
   385 #define SDL_HINT_XINPUT_USE_OLD_JOYSTICK_MAPPING "SDL_XINPUT_USE_OLD_JOYSTICK_MAPPING"
   386 
   387 /**
   388  *  \brief  A variable that lets you manually hint extra gamecontroller db entries.
   389  *
   390  *  The variable should be newline delimited rows of gamecontroller config data, see SDL_gamecontroller.h
   391  *
   392  *  This hint must be set before calling SDL_Init(SDL_INIT_GAMECONTROLLER)
   393  *  You can update mappings after the system is initialized with SDL_GameControllerMappingForGUID() and SDL_GameControllerAddMapping()
   394  */
   395 #define SDL_HINT_GAMECONTROLLERCONFIG "SDL_GAMECONTROLLERCONFIG"
   396 
   397 /**
   398  *  \brief  A variable containing a list of devices to skip when scanning for game controllers.
   399  *
   400  *  The format of the string is a comma separated list of USB VID/PID pairs
   401  *  in hexadecimal form, e.g.
   402  *
   403  *      0xAAAA/0xBBBB,0xCCCC/0xDDDD
   404  *
   405  *  The variable can also take the form of @file, in which case the named
   406  *  file will be loaded and interpreted as the value of the variable.
   407  */
   408 #define SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES "SDL_GAMECONTROLLER_IGNORE_DEVICES"
   409 
   410 /**
   411  *  \brief  If set, all devices will be skipped when scanning for game controllers except for the ones listed in this variable.
   412  *
   413  *  The format of the string is a comma separated list of USB VID/PID pairs
   414  *  in hexadecimal form, e.g.
   415  *
   416  *      0xAAAA/0xBBBB,0xCCCC/0xDDDD
   417  *
   418  *  The variable can also take the form of @file, in which case the named
   419  *  file will be loaded and interpreted as the value of the variable.
   420  */
   421 #define SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT "SDL_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT"
   422 
   423 /**
   424  *  \brief  A variable that lets you enable joystick (and gamecontroller) events even when your app is in the background.
   425  *
   426  *  The variable can be set to the following values:
   427  *    "0"       - Disable joystick & gamecontroller input events when the
   428  *                application is in the background.
   429  *    "1"       - Enable joystick & gamecontroller input events when the
   430  *                application is in the background.
   431  *
   432  *  The default value is "0".  This hint may be set at any time.
   433  */
   434 #define SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS "SDL_JOYSTICK_ALLOW_BACKGROUND_EVENTS"
   435 
   436 /**
   437  *  \brief If set to "0" then never set the top most bit on a SDL Window, even if the video mode expects it.
   438  *      This is a debugging aid for developers and not expected to be used by end users. The default is "1"
   439  *
   440  *  This variable can be set to the following values:
   441  *    "0"       - don't allow topmost
   442  *    "1"       - allow topmost
   443  */
   444 #define SDL_HINT_ALLOW_TOPMOST "SDL_ALLOW_TOPMOST"
   445 
   446 /**
   447  *  \brief A variable that controls the timer resolution, in milliseconds.
   448  *
   449  *  The higher resolution the timer, the more frequently the CPU services
   450  *  timer interrupts, and the more precise delays are, but this takes up
   451  *  power and CPU time.  This hint is only used on Windows 7 and earlier.
   452  *
   453  *  See this blog post for more information:
   454  *  http://randomascii.wordpress.com/2013/07/08/windows-timer-resolution-megawatts-wasted/
   455  *
   456  *  If this variable is set to "0", the system timer resolution is not set.
   457  *
   458  *  The default value is "1". This hint may be set at any time.
   459  */
   460 #define SDL_HINT_TIMER_RESOLUTION "SDL_TIMER_RESOLUTION"
   461 
   462 
   463 /**
   464  *  \brief  A variable describing the content orientation on QtWayland-based platforms.
   465  *
   466  *  On QtWayland platforms, windows are rotated client-side to allow for custom
   467  *  transitions. In order to correctly position overlays (e.g. volume bar) and
   468  *  gestures (e.g. events view, close/minimize gestures), the system needs to
   469  *  know in which orientation the application is currently drawing its contents.
   470  *
   471  *  This does not cause the window to be rotated or resized, the application
   472  *  needs to take care of drawing the content in the right orientation (the
   473  *  framebuffer is always in portrait mode).
   474  *
   475  *  This variable can be one of the following values:
   476  *    "primary" (default), "portrait", "landscape", "inverted-portrait", "inverted-landscape"
   477  */
   478 #define SDL_HINT_QTWAYLAND_CONTENT_ORIENTATION "SDL_QTWAYLAND_CONTENT_ORIENTATION"
   479 
   480 /**
   481  *  \brief  Flags to set on QtWayland windows to integrate with the native window manager.
   482  *
   483  *  On QtWayland platforms, this hint controls the flags to set on the windows.
   484  *  For example, on Sailfish OS "OverridesSystemGestures" disables swipe gestures.
   485  *
   486  *  This variable is a space-separated list of the following values (empty = no flags):
   487  *    "OverridesSystemGestures", "StaysOnTop", "BypassWindowManager"
   488  */
   489 #define SDL_HINT_QTWAYLAND_WINDOW_FLAGS "SDL_QTWAYLAND_WINDOW_FLAGS"
   490 
   491 /**
   492 *  \brief  A string specifying SDL's threads stack size in bytes or "0" for the backend's default size
   493 *
   494 *  Use this hint in case you need to set SDL's threads stack size to other than the default.
   495 *  This is specially useful if you build SDL against a non glibc libc library (such as musl) which
   496 *  provides a relatively small default thread stack size (a few kilobytes versus the default 8MB glibc uses).
   497 *  Support for this hint is currently available only in the pthread, Windows, and PSP backend.
   498 */
   499 #define SDL_HINT_THREAD_STACK_SIZE              "SDL_THREAD_STACK_SIZE"
   500 
   501 /**
   502  *  \brief If set to 1, then do not allow high-DPI windows. ("Retina" on Mac and iOS)
   503  */
   504 #define SDL_HINT_VIDEO_HIGHDPI_DISABLED "SDL_VIDEO_HIGHDPI_DISABLED"
   505 
   506 /**
   507  *  \brief A variable that determines whether ctrl+click should generate a right-click event on Mac
   508  *
   509  *  If present, holding ctrl while left clicking will generate a right click
   510  *  event when on Mac.
   511  */
   512 #define SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK "SDL_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK"
   513 
   514 /**
   515 *  \brief  A variable specifying which shader compiler to preload when using the Chrome ANGLE binaries
   516 *
   517 *  SDL has EGL and OpenGL ES2 support on Windows via the ANGLE project. It
   518 *  can use two different sets of binaries, those compiled by the user from source
   519 *  or those provided by the Chrome browser. In the later case, these binaries require
   520 *  that SDL loads a DLL providing the shader compiler.
   521 *
   522 *  This variable can be set to the following values:
   523 *    "d3dcompiler_46.dll" - default, best for Vista or later.
   524 *    "d3dcompiler_43.dll" - for XP support.
   525 *    "none" - do not load any library, useful if you compiled ANGLE from source and included the compiler in your binaries.
   526 *
   527 */
   528 #define SDL_HINT_VIDEO_WIN_D3DCOMPILER              "SDL_VIDEO_WIN_D3DCOMPILER"
   529 
   530 /**
   531 *  \brief  A variable that is the address of another SDL_Window* (as a hex string formatted with "%p").
   532 *  
   533 *  If this hint is set before SDL_CreateWindowFrom() and the SDL_Window* it is set to has
   534 *  SDL_WINDOW_OPENGL set (and running on WGL only, currently), then two things will occur on the newly 
   535 *  created SDL_Window:
   536 *
   537 *  1. Its pixel format will be set to the same pixel format as this SDL_Window.  This is
   538 *  needed for example when sharing an OpenGL context across multiple windows.
   539 *
   540 *  2. The flag SDL_WINDOW_OPENGL will be set on the new window so it can be used for
   541 *  OpenGL rendering.
   542 *
   543 *  This variable can be set to the following values:
   544 *    The address (as a string "%p") of the SDL_Window* that new windows created with SDL_CreateWindowFrom() should
   545 *    share a pixel format with.
   546 */
   547 #define SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT    "SDL_VIDEO_WINDOW_SHARE_PIXEL_FORMAT"
   548 
   549 /**
   550  *  \brief A URL to a WinRT app's privacy policy
   551  *
   552  *  All network-enabled WinRT apps must make a privacy policy available to its
   553  *  users.  On Windows 8, 8.1, and RT, Microsoft mandates that this policy be
   554  *  be available in the Windows Settings charm, as accessed from within the app.
   555  *  SDL provides code to add a URL-based link there, which can point to the app's
   556  *  privacy policy.
   557  *
   558  *  To setup a URL to an app's privacy policy, set SDL_HINT_WINRT_PRIVACY_POLICY_URL
   559  *  before calling any SDL_Init() functions.  The contents of the hint should
   560  *  be a valid URL.  For example, "http://www.example.com".
   561  *
   562  *  The default value is "", which will prevent SDL from adding a privacy policy
   563  *  link to the Settings charm.  This hint should only be set during app init.
   564  *
   565  *  The label text of an app's "Privacy Policy" link may be customized via another
   566  *  hint, SDL_HINT_WINRT_PRIVACY_POLICY_LABEL.
   567  *
   568  *  Please note that on Windows Phone, Microsoft does not provide standard UI
   569  *  for displaying a privacy policy link, and as such, SDL_HINT_WINRT_PRIVACY_POLICY_URL
   570  *  will not get used on that platform.  Network-enabled phone apps should display
   571  *  their privacy policy through some other, in-app means.
   572  */
   573 #define SDL_HINT_WINRT_PRIVACY_POLICY_URL "SDL_WINRT_PRIVACY_POLICY_URL"
   574 
   575 /** \brief Label text for a WinRT app's privacy policy link
   576  *
   577  *  Network-enabled WinRT apps must include a privacy policy.  On Windows 8, 8.1, and RT,
   578  *  Microsoft mandates that this policy be available via the Windows Settings charm.
   579  *  SDL provides code to add a link there, with its label text being set via the
   580  *  optional hint, SDL_HINT_WINRT_PRIVACY_POLICY_LABEL.
   581  *
   582  *  Please note that a privacy policy's contents are not set via this hint.  A separate
   583  *  hint, SDL_HINT_WINRT_PRIVACY_POLICY_URL, is used to link to the actual text of the
   584  *  policy.
   585  *
   586  *  The contents of this hint should be encoded as a UTF8 string.
   587  *
   588  *  The default value is "Privacy Policy".  This hint should only be set during app
   589  *  initialization, preferably before any calls to SDL_Init().
   590  *
   591  *  For additional information on linking to a privacy policy, see the documentation for
   592  *  SDL_HINT_WINRT_PRIVACY_POLICY_URL.
   593  */
   594 #define SDL_HINT_WINRT_PRIVACY_POLICY_LABEL "SDL_WINRT_PRIVACY_POLICY_LABEL"
   595 
   596 /** \brief Allows back-button-press events on Windows Phone to be marked as handled
   597  *
   598  *  Windows Phone devices typically feature a Back button.  When pressed,
   599  *  the OS will emit back-button-press events, which apps are expected to
   600  *  handle in an appropriate manner.  If apps do not explicitly mark these
   601  *  events as 'Handled', then the OS will invoke its default behavior for
   602  *  unhandled back-button-press events, which on Windows Phone 8 and 8.1 is to
   603  *  terminate the app (and attempt to switch to the previous app, or to the
   604  *  device's home screen).
   605  *
   606  *  Setting the SDL_HINT_WINRT_HANDLE_BACK_BUTTON hint to "1" will cause SDL
   607  *  to mark back-button-press events as Handled, if and when one is sent to
   608  *  the app.
   609  *
   610  *  Internally, Windows Phone sends back button events as parameters to
   611  *  special back-button-press callback functions.  Apps that need to respond
   612  *  to back-button-press events are expected to register one or more
   613  *  callback functions for such, shortly after being launched (during the
   614  *  app's initialization phase).  After the back button is pressed, the OS
   615  *  will invoke these callbacks.  If the app's callback(s) do not explicitly
   616  *  mark the event as handled by the time they return, or if the app never
   617  *  registers one of these callback, the OS will consider the event
   618  *  un-handled, and it will apply its default back button behavior (terminate
   619  *  the app).
   620  *
   621  *  SDL registers its own back-button-press callback with the Windows Phone
   622  *  OS.  This callback will emit a pair of SDL key-press events (SDL_KEYDOWN
   623  *  and SDL_KEYUP), each with a scancode of SDL_SCANCODE_AC_BACK, after which
   624  *  it will check the contents of the hint, SDL_HINT_WINRT_HANDLE_BACK_BUTTON.
   625  *  If the hint's value is set to "1", the back button event's Handled
   626  *  property will get set to 'true'.  If the hint's value is set to something
   627  *  else, or if it is unset, SDL will leave the event's Handled property
   628  *  alone.  (By default, the OS sets this property to 'false', to note.)
   629  *
   630  *  SDL apps can either set SDL_HINT_WINRT_HANDLE_BACK_BUTTON well before a
   631  *  back button is pressed, or can set it in direct-response to a back button
   632  *  being pressed.
   633  *
   634  *  In order to get notified when a back button is pressed, SDL apps should
   635  *  register a callback function with SDL_AddEventWatch(), and have it listen
   636  *  for SDL_KEYDOWN events that have a scancode of SDL_SCANCODE_AC_BACK.
   637  *  (Alternatively, SDL_KEYUP events can be listened-for.  Listening for
   638  *  either event type is suitable.)  Any value of SDL_HINT_WINRT_HANDLE_BACK_BUTTON
   639  *  set by such a callback, will be applied to the OS' current
   640  *  back-button-press event.
   641  *
   642  *  More details on back button behavior in Windows Phone apps can be found
   643  *  at the following page, on Microsoft's developer site:
   644  *  http://msdn.microsoft.com/en-us/library/windowsphone/develop/jj247550(v=vs.105).aspx
   645  */
   646 #define SDL_HINT_WINRT_HANDLE_BACK_BUTTON "SDL_WINRT_HANDLE_BACK_BUTTON"
   647 
   648 /**
   649  *  \brief  A variable that dictates policy for fullscreen Spaces on Mac OS X.
   650  *
   651  *  This hint only applies to Mac OS X.
   652  *
   653  *  The variable can be set to the following values:
   654  *    "0"       - Disable Spaces support (FULLSCREEN_DESKTOP won't use them and
   655  *                SDL_WINDOW_RESIZABLE windows won't offer the "fullscreen"
   656  *                button on their titlebars).
   657  *    "1"       - Enable Spaces support (FULLSCREEN_DESKTOP will use them and
   658  *                SDL_WINDOW_RESIZABLE windows will offer the "fullscreen"
   659  *                button on their titlebars).
   660  *
   661  *  The default value is "1". Spaces are disabled regardless of this hint if
   662  *   the OS isn't at least Mac OS X Lion (10.7). This hint must be set before
   663  *   any windows are created.
   664  */
   665 #define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES    "SDL_VIDEO_MAC_FULLSCREEN_SPACES"
   666 
   667 /**
   668 *  \brief  When set don't force the SDL app to become a foreground process
   669 *
   670 *  This hint only applies to Mac OS X.
   671 *
   672 */
   673 #define SDL_HINT_MAC_BACKGROUND_APP    "SDL_MAC_BACKGROUND_APP"
   674 
   675 /**
   676  * \brief Android APK expansion main file version. Should be a string number like "1", "2" etc.
   677  *
   678  * Must be set together with SDL_HINT_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION.
   679  *
   680  * If both hints were set then SDL_RWFromFile() will look into expansion files
   681  * after a given relative path was not found in the internal storage and assets.
   682  *
   683  * By default this hint is not set and the APK expansion files are not searched.
   684  */
   685 #define SDL_HINT_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION "SDL_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION"
   686  
   687 /**
   688  * \brief Android APK expansion patch file version. Should be a string number like "1", "2" etc.
   689  *
   690  * Must be set together with SDL_HINT_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION.
   691  *
   692  * If both hints were set then SDL_RWFromFile() will look into expansion files
   693  * after a given relative path was not found in the internal storage and assets.
   694  *
   695  * By default this hint is not set and the APK expansion files are not searched.
   696  */
   697 #define SDL_HINT_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION "SDL_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION"
   698 
   699 /**
   700  * \brief A variable to control whether certain IMEs should handle text editing internally instead of sending SDL_TEXTEDITING events.
   701  *
   702  * The variable can be set to the following values:
   703  *   "0"       - SDL_TEXTEDITING events are sent, and it is the application's
   704  *               responsibility to render the text from these events and 
   705  *               differentiate it somehow from committed text. (default)
   706  *   "1"       - If supported by the IME then SDL_TEXTEDITING events are not sent, 
   707  *               and text that is being composed will be rendered in its own UI.
   708  */
   709 #define SDL_HINT_IME_INTERNAL_EDITING "SDL_IME_INTERNAL_EDITING"
   710 
   711  /**
   712  * \brief A variable to control whether mouse and touch events are to be treated together or separately
   713  *
   714  * The variable can be set to the following values:
   715  *   "0"       - Mouse events will be handled as touch events, and touch will raise fake mouse
   716  *               events. This is the behaviour of SDL <= 2.0.3. (default)
   717  *   "1"       - Mouse events will be handled separately from pure touch events.
   718  *
   719  * The value of this hint is used at runtime, so it can be changed at any time.
   720  */
   721 #define SDL_HINT_ANDROID_SEPARATE_MOUSE_AND_TOUCH "SDL_ANDROID_SEPARATE_MOUSE_AND_TOUCH"
   722 
   723  /**
   724  * \brief A variable to control whether the return key on the soft keyboard
   725  *        should hide the soft keyboard on Android and iOS.
   726  *
   727  * The variable can be set to the following values:
   728  *   "0"       - The return key will be handled as a key event. This is the behaviour of SDL <= 2.0.3. (default)
   729  *   "1"       - The return key will hide the keyboard.
   730  *
   731  * The value of this hint is used at runtime, so it can be changed at any time.
   732  */
   733 #define SDL_HINT_RETURN_KEY_HIDES_IME "SDL_RETURN_KEY_HIDES_IME"
   734 
   735 /**
   736  *  \brief override the binding element for keyboard inputs for Emscripten builds
   737  *
   738  * This hint only applies to the emscripten platform
   739  *
   740  * The variable can be one of
   741  *    "#window"      - The javascript window object (this is the default)
   742  *    "#document"    - The javascript document object
   743  *    "#screen"      - the javascript window.screen object
   744  *    "#canvas"      - the WebGL canvas element
   745  *    any other string without a leading # sign applies to the element on the page with that ID.
   746  */
   747 #define SDL_HINT_EMSCRIPTEN_KEYBOARD_ELEMENT   "SDL_EMSCRIPTEN_KEYBOARD_ELEMENT"
   748 
   749 /**
   750  *  \brief Tell SDL not to catch the SIGINT or SIGTERM signals.
   751  *
   752  * This hint only applies to Unix-like platforms.
   753  *
   754  * The variable can be set to the following values:
   755  *   "0"       - SDL will install a SIGINT and SIGTERM handler, and when it
   756  *               catches a signal, convert it into an SDL_QUIT event.
   757  *   "1"       - SDL will not install a signal handler at all.
   758  */
   759 #define SDL_HINT_NO_SIGNAL_HANDLERS   "SDL_NO_SIGNAL_HANDLERS"
   760 
   761 /**
   762  *  \brief Tell SDL not to generate window-close events for Alt+F4 on Windows.
   763  *
   764  * The variable can be set to the following values:
   765  *   "0"       - SDL will generate a window-close event when it sees Alt+F4.
   766  *   "1"       - SDL will only do normal key handling for Alt+F4.
   767  */
   768 #define SDL_HINT_WINDOWS_NO_CLOSE_ON_ALT_F4	"SDL_WINDOWS_NO_CLOSE_ON_ALT_F4"
   769 
   770 /**
   771  *  \brief Prevent SDL from using version 4 of the bitmap header when saving BMPs.
   772  *
   773  * The bitmap header version 4 is required for proper alpha channel support and
   774  * SDL will use it when required. Should this not be desired, this hint can
   775  * force the use of the 40 byte header version which is supported everywhere.
   776  *
   777  * The variable can be set to the following values:
   778  *   "0"       - Surfaces with a colorkey or an alpha channel are saved to a
   779  *               32-bit BMP file with an alpha mask. SDL will use the bitmap
   780  *               header version 4 and set the alpha mask accordingly.
   781  *   "1"       - Surfaces with a colorkey or an alpha channel are saved to a
   782  *               32-bit BMP file without an alpha mask. The alpha channel data
   783  *               will be in the file, but applications are going to ignore it.
   784  *
   785  * The default value is "0".
   786  */
   787 #define SDL_HINT_BMP_SAVE_LEGACY_FORMAT "SDL_BMP_SAVE_LEGACY_FORMAT"
   788 
   789 /**
   790  * \brief Tell SDL not to name threads on Windows with the 0x406D1388 Exception.
   791  *        The 0x406D1388 Exception is a trick used to inform Visual Studio of a
   792  *        thread's name, but it tends to cause problems with other debuggers,
   793  *        and the .NET runtime. Note that SDL 2.0.6 and later will still use
   794  *        the (safer) SetThreadDescription API, introduced in the Windows 10
   795  *        Creators Update, if available.
   796  *
   797  * The variable can be set to the following values:
   798  *   "0"       - SDL will raise the 0x406D1388 Exception to name threads.
   799  *               This is the default behavior of SDL <= 2.0.4.
   800  *   "1"       - SDL will not raise this exception, and threads will be unnamed. (default)
   801  *               This is necessary with .NET languages or debuggers that aren't Visual Studio.
   802  */
   803 #define SDL_HINT_WINDOWS_DISABLE_THREAD_NAMING "SDL_WINDOWS_DISABLE_THREAD_NAMING"
   804 
   805 /**
   806  * \brief Tell SDL which Dispmanx layer to use on a Raspberry PI
   807  *
   808  * Also known as Z-order. The variable can take a negative or positive value.
   809  * The default is 10000.
   810  */
   811 #define SDL_HINT_RPI_VIDEO_LAYER           "SDL_RPI_VIDEO_LAYER"
   812 
   813 /**
   814  * \brief Tell the video driver that we only want a double buffer.
   815  *
   816  * By default, most lowlevel 2D APIs will use a triple buffer scheme that 
   817  * wastes no CPU time on waiting for vsync after issuing a flip, but
   818  * introduces a frame of latency. On the other hand, using a double buffer
   819  * scheme instead is recommended for cases where low latency is an important
   820  * factor because we save a whole frame of latency.
   821  * We do so by waiting for vsync immediately after issuing a flip, usually just
   822  * after eglSwapBuffers call in the backend's *_SwapWindow function.
   823  *
   824  * Since it's driver-specific, it's only supported where possible and
   825  * implemented. Currently supported the following drivers:
   826  * - KMSDRM (kmsdrm)
   827  * - Raspberry Pi (raspberrypi)
   828  */
   829 #define SDL_HINT_VIDEO_DOUBLE_BUFFER      "SDL_VIDEO_DOUBLE_BUFFER"
   830 
   831 /**
   832  *  \brief  A variable controlling what driver to use for OpenGL ES contexts.
   833  *
   834  *  On some platforms, currently Windows and X11, OpenGL drivers may support
   835  *  creating contexts with an OpenGL ES profile. By default SDL uses these
   836  *  profiles, when available, otherwise it attempts to load an OpenGL ES
   837  *  library, e.g. that provided by the ANGLE project. This variable controls
   838  *  whether SDL follows this default behaviour or will always load an
   839  *  OpenGL ES library.
   840  *
   841  *  Circumstances where this is useful include
   842  *  - Testing an app with a particular OpenGL ES implementation, e.g ANGLE,
   843  *    or emulator, e.g. those from ARM, Imagination or Qualcomm.
   844  *  - Resolving OpenGL ES function addresses at link time by linking with
   845  *    the OpenGL ES library instead of querying them at run time with
   846  *    SDL_GL_GetProcAddress().
   847  *
   848  *  Caution: for an application to work with the default behaviour across
   849  *  different OpenGL drivers it must query the OpenGL ES function
   850  *  addresses at run time using SDL_GL_GetProcAddress().
   851  *
   852  *  This variable is ignored on most platforms because OpenGL ES is native
   853  *  or not supported.
   854  *
   855  *  This variable can be set to the following values:
   856  *    "0"       - Use ES profile of OpenGL, if available. (Default when not set.)
   857  *    "1"       - Load OpenGL ES library using the default library names.
   858  *
   859  */
   860 #define SDL_HINT_OPENGL_ES_DRIVER   "SDL_OPENGL_ES_DRIVER"
   861 
   862 /**
   863  *  \brief  A variable controlling speed/quality tradeoff of audio resampling.
   864  *
   865  *  If available, SDL can use libsamplerate ( http://www.mega-nerd.com/SRC/ )
   866  *  to handle audio resampling. There are different resampling modes available
   867  *  that produce different levels of quality, using more CPU.
   868  *
   869  *  If this hint isn't specified to a valid setting, or libsamplerate isn't
   870  *  available, SDL will use the default, internal resampling algorithm.
   871  *
   872  *  Note that this is currently only applicable to resampling audio that is
   873  *  being written to a device for playback or audio being read from a device
   874  *  for capture. SDL_AudioCVT always uses the default resampler (although this
   875  *  might change for SDL 2.1).
   876  *
   877  *  This hint is currently only checked at audio subsystem initialization.
   878  *
   879  *  This variable can be set to the following values:
   880  *
   881  *    "0" or "default" - Use SDL's internal resampling (Default when not set - low quality, fast)
   882  *    "1" or "fast"    - Use fast, slightly higher quality resampling, if available
   883  *    "2" or "medium"  - Use medium quality resampling, if available
   884  *    "3" or "best"    - Use high quality resampling, if available
   885  */
   886 #define SDL_HINT_AUDIO_RESAMPLING_MODE   "SDL_AUDIO_RESAMPLING_MODE"
   887 
   888 /**
   889  *  \brief  A variable controlling the audio category on iOS and Mac OS X
   890  *
   891  *  This variable can be set to the following values:
   892  *
   893  *    "ambient"     - Use the AVAudioSessionCategoryAmbient audio category, will be muted by the phone mute switch (default)
   894  *    "playback"    - Use the AVAudioSessionCategoryPlayback category
   895  *
   896  *  For more information, see Apple's documentation:
   897  *  https://developer.apple.com/library/content/documentation/Audio/Conceptual/AudioSessionProgrammingGuide/AudioSessionCategoriesandModes/AudioSessionCategoriesandModes.html
   898  */
   899 #define SDL_HINT_AUDIO_CATEGORY   "SDL_AUDIO_CATEGORY"
   900 
   901 /**
   902  *  \brief  An enumeration of hint priorities
   903  */
   904 typedef enum
   905 {
   906     SDL_HINT_DEFAULT,
   907     SDL_HINT_NORMAL,
   908     SDL_HINT_OVERRIDE
   909 } SDL_HintPriority;
   910 
   911 
   912 /**
   913  *  \brief Set a hint with a specific priority
   914  *
   915  *  The priority controls the behavior when setting a hint that already
   916  *  has a value.  Hints will replace existing hints of their priority and
   917  *  lower.  Environment variables are considered to have override priority.
   918  *
   919  *  \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
   920  */
   921 extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name,
   922                                                          const char *value,
   923                                                          SDL_HintPriority priority);
   924 
   925 /**
   926  *  \brief Set a hint with normal priority
   927  *
   928  *  \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
   929  */
   930 extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name,
   931                                              const char *value);
   932 
   933 /**
   934  *  \brief Get a hint
   935  *
   936  *  \return The string value of a hint variable.
   937  */
   938 extern DECLSPEC const char * SDLCALL SDL_GetHint(const char *name);
   939 
   940 /**
   941  *  \brief Get a hint
   942  *
   943  *  \return The boolean value of a hint variable.
   944  */
   945 extern DECLSPEC SDL_bool SDLCALL SDL_GetHintBoolean(const char *name, SDL_bool default_value);
   946 
   947 /**
   948  * \brief type definition of the hint callback function.
   949  */
   950 typedef void (SDLCALL *SDL_HintCallback)(void *userdata, const char *name, const char *oldValue, const char *newValue);
   951 
   952 /**
   953  *  \brief Add a function to watch a particular hint
   954  *
   955  *  \param name The hint to watch
   956  *  \param callback The function to call when the hint value changes
   957  *  \param userdata A pointer to pass to the callback function
   958  */
   959 extern DECLSPEC void SDLCALL SDL_AddHintCallback(const char *name,
   960                                                  SDL_HintCallback callback,
   961                                                  void *userdata);
   962 
   963 /**
   964  *  \brief Remove a function watching a particular hint
   965  *
   966  *  \param name The hint being watched
   967  *  \param callback The function being called when the hint value changes
   968  *  \param userdata A pointer being passed to the callback function
   969  */
   970 extern DECLSPEC void SDLCALL SDL_DelHintCallback(const char *name,
   971                                                  SDL_HintCallback callback,
   972                                                  void *userdata);
   973 
   974 /**
   975  *  \brief  Clear all hints
   976  *
   977  *  This function is called during SDL_Quit() to free stored hints.
   978  */
   979 extern DECLSPEC void SDLCALL SDL_ClearHints(void);
   980 
   981 
   982 /* Ends C function definitions when using C++ */
   983 #ifdef __cplusplus
   984 }
   985 #endif
   986 #include "close_code.h"
   987 
   988 #endif /* SDL_hints_h_ */
   989 
   990 /* vi: set ts=4 sw=4 expandtab: */