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