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