include/SDL_hints.h
author stopiccot <alexey.petruchik@gmail.com>
Wed, 23 Apr 2014 03:42:32 +0300
branchapk
changeset 8897 fff9c0b9f1fb
parent 8896 d931167c375a
child 8900 537445b25e4e
permissions -rw-r--r--
Fixing issues discovered by Philipp Wiesemann
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2014 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 grabbing input grabs the keyboard
   190  *
   191  *  This variable can be set to the following values:
   192  *    "0"       - Grab will affect only the mouse
   193  *    "1"       - Grab will affect mouse and keyboard
   194  *
   195  *  By default SDL will not grab the keyboard so system shortcuts still work.
   196  */
   197 #define SDL_HINT_GRAB_KEYBOARD              "SDL_GRAB_KEYBOARD"
   198 
   199 /**
   200 *  \brief  A variable controlling whether relative mouse mode is implemented using mouse warping
   201 *
   202 *  This variable can be set to the following values:
   203 *    "0"       - Relative mouse mode uses raw input
   204 *    "1"       - Relative mouse mode uses mouse warping
   205 *
   206 *  By default SDL will use raw input for relative mouse mode
   207 */
   208 #define SDL_HINT_MOUSE_RELATIVE_MODE_WARP    "SDL_MOUSE_RELATIVE_MODE_WARP"
   209 
   210 /**
   211  *  \brief Minimize your SDL_Window if it loses key focus when in fullscreen mode. Defaults to true.
   212  *
   213  */
   214 #define SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS   "SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS"
   215 
   216 /**
   217  *  \brief  A variable controlling whether the idle timer is disabled on iOS.
   218  *
   219  *  When an iOS app does not receive touches for some time, the screen is
   220  *  dimmed automatically. For games where the accelerometer is the only input
   221  *  this is problematic. This functionality can be disabled by setting this
   222  *  hint.
   223  *
   224  *  This variable can be set to the following values:
   225  *    "0"       - Enable idle timer
   226  *    "1"       - Disable idle timer
   227  */
   228 #define SDL_HINT_IDLE_TIMER_DISABLED "SDL_IOS_IDLE_TIMER_DISABLED"
   229 
   230 /**
   231  *  \brief  A variable controlling which orientations are allowed on iOS.
   232  *
   233  *  In some circumstances it is necessary to be able to explicitly control
   234  *  which UI orientations are allowed.
   235  *
   236  *  This variable is a space delimited list of the following values:
   237  *    "LandscapeLeft", "LandscapeRight", "Portrait" "PortraitUpsideDown"
   238  */
   239 #define SDL_HINT_ORIENTATIONS "SDL_IOS_ORIENTATIONS"
   240     
   241 /**
   242  *  \brief  A variable controlling whether an Android built-in accelerometer should be
   243  *  listed as a joystick device, rather than listing actual joysticks only.
   244  *
   245  *  This variable can be set to the following values:
   246  *    "0"       - List only real joysticks and accept input from them
   247  *    "1"       - List real joysticks along with the accelerometer as if it were a 3 axis joystick (the default).
   248  */
   249 #define SDL_HINT_ACCELEROMETER_AS_JOYSTICK "SDL_ACCELEROMETER_AS_JOYSTICK"
   250 
   251 
   252 /**
   253  *  \brief  A variable that lets you disable the detection and use of Xinput gamepad devices
   254  *
   255  *  The variable can be set to the following values:
   256  *    "0"       - Disable XInput detection (only uses direct input)
   257  *    "1"       - Enable XInput detection (the default)
   258  */
   259 #define SDL_HINT_XINPUT_ENABLED "SDL_XINPUT_ENABLED"
   260 
   261 
   262 /**
   263  *  \brief  A variable that lets you manually hint extra gamecontroller db entries
   264  *
   265  *  The variable should be newline delimited rows of gamecontroller config data, see SDL_gamecontroller.h
   266  *
   267  *  This hint must be set before calling SDL_Init(SDL_INIT_GAMECONTROLLER)
   268  *  You can update mappings after the system is initialized with SDL_GameControllerMappingForGUID() and SDL_GameControllerAddMapping()
   269  */
   270 #define SDL_HINT_GAMECONTROLLERCONFIG "SDL_GAMECONTROLLERCONFIG"
   271 
   272 
   273 /**
   274  *  \brief  A variable that lets you enable joystick (and gamecontroller) events even when your app is in the background.
   275  *
   276  *  The variable can be set to the following values:
   277  *    "0"       - Disable joystick & gamecontroller input events when the
   278  *                application is in the background.
   279  *    "1"       - Enable joystick & gamecontroller input events when the
   280  *                application is in the background.
   281  *
   282  *  The default value is "0".  This hint may be set at any time.
   283  */
   284 #define SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS "SDL_JOYSTICK_ALLOW_BACKGROUND_EVENTS"
   285 
   286 
   287 /**
   288  *  \brief If set to "0" then never set the top most bit on a SDL Window, even if the video mode expects it.
   289  *      This is a debugging aid for developers and not expected to be used by end users. The default is "1"
   290  *
   291  *  This variable can be set to the following values:
   292  *    "0"       - don't allow topmost
   293  *    "1"       - allow topmost
   294  */
   295 #define SDL_HINT_ALLOW_TOPMOST "SDL_ALLOW_TOPMOST"
   296 
   297 
   298 /**
   299  *  \brief A variable that controls the timer resolution, in milliseconds.
   300  *
   301  *  The higher resolution the timer, the more frequently the CPU services
   302  *  timer interrupts, and the more precise delays are, but this takes up
   303  *  power and CPU time.  This hint is only used on Windows 7 and earlier.
   304  *
   305  *  See this blog post for more information:
   306  *  http://randomascii.wordpress.com/2013/07/08/windows-timer-resolution-megawatts-wasted/
   307  *
   308  *  If this variable is set to "0", the system timer resolution is not set.
   309  *
   310  *  The default value is "1". This hint may be set at any time.
   311  */
   312 #define SDL_HINT_TIMER_RESOLUTION "SDL_TIMER_RESOLUTION"
   313 
   314 
   315 /**
   316  *  \brief If set to 1, then do not allow high-DPI windows. ("Retina" on Mac)
   317  */
   318 #define SDL_HINT_VIDEO_HIGHDPI_DISABLED "SDL_VIDEO_HIGHDPI_DISABLED"
   319 
   320 /**
   321  *  \brief A variable that determines whether ctrl+click should generate a right-click event on Mac
   322  *
   323  *  If present, holding ctrl while left clicking will generate a right click
   324  *  event when on Mac.
   325  */
   326 #define SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK "SDL_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK"
   327 
   328 /**
   329 *  \brief  A variable specifying which shader compiler to preload when using the Chrome ANGLE binaries
   330 *
   331 *  SDL has EGL and OpenGL ES2 support on Windows via the ANGLE project. It
   332 *  can use two different sets of binaries, those compiled by the user from source
   333 *  or those provided by the Chrome browser. In the later case, these binaries require
   334 *  that SDL loads a DLL providing the shader compiler.
   335 *
   336 *  This variable can be set to the following values:
   337 *    "d3dcompiler_46.dll" - default, best for Vista or later.
   338 *    "d3dcompiler_43.dll" - for XP support.
   339 *    "none" - do not load any library, useful if you compiled ANGLE from source and included the compiler in your binaries.
   340 *
   341 */
   342 #define SDL_HINT_VIDEO_WIN_D3DCOMPILER              "SDL_VIDEO_WIN_D3DCOMPILER"
   343 
   344 /**
   345 *  \brief  A variable that is the address of another SDL_Window* (as a hex string formatted with "%p").
   346 *  
   347 *  If this hint is set before SDL_CreateWindowFrom() and the SDL_Window* it is set to has
   348 *  SDL_WINDOW_OPENGL set (and running on WGL only, currently), then two things will occur on the newly 
   349 *  created SDL_Window:
   350 *
   351 *  1. Its pixel format will be set to the same pixel format as this SDL_Window.  This is
   352 *  needed for example when sharing an OpenGL context across multiple windows.
   353 *
   354 *  2. The flag SDL_WINDOW_OPENGL will be set on the new window so it can be used for
   355 *  OpenGL rendering.
   356 *
   357 *  This variable can be set to the following values:
   358 *    The address (as a string "%p") of the SDL_Window* that new windows created with SDL_CreateWindowFrom() should
   359 *    share a pixel format with.
   360 */
   361 #define SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT    "SDL_VIDEO_WINDOW_SHARE_PIXEL_FORMAT"
   362 
   363 /**
   364  *  \brief A URL to a WinRT app's privacy policy
   365  *
   366  *  All network-enabled WinRT apps must make a privacy policy available to its
   367  *  users.  On Windows 8, 8.1, and RT, Microsoft mandates that this policy be
   368  *  be available in the Windows Settings charm, as accessed from within the app.
   369  *  SDL provides code to add a URL-based link there, which can point to the app's
   370  *  privacy policy.
   371  *
   372  *  To setup a URL to an app's privacy policy, set SDL_HINT_WINRT_PRIVACY_POLICY_URL
   373  *  before calling any SDL_Init functions.  The contents of the hint should
   374  *  be a valid URL.  For example, "http://www.example.com".
   375  *
   376  *  The default value is "", which will prevent SDL from adding a privacy policy
   377  *  link to the Settings charm.  This hint should only be set during app init.
   378  *
   379  *  The label text of an app's "Privacy Policy" link may be customized via another
   380  *  hint, SDL_HINT_WINRT_PRIVACY_POLICY_LABEL.
   381  *
   382  *  Please note that on Windows Phone, Microsoft does not provide standard UI
   383  *  for displaying a privacy policy link, and as such, SDL_HINT_WINRT_PRIVACY_POLICY_URL
   384  *  will not get used on that platform.  Network-enabled phone apps should display
   385  *  their privacy policy through some other, in-app means.
   386  */
   387 #define SDL_HINT_WINRT_PRIVACY_POLICY_URL "SDL_WINRT_PRIVACY_POLICY_URL"
   388 
   389 /** \brief Label text for a WinRT app's privacy policy link
   390  *
   391  *  Network-enabled WinRT apps must include a privacy policy.  On Windows 8, 8.1, and RT,
   392  *  Microsoft mandates that this policy be available via the Windows Settings charm.
   393  *  SDL provides code to add a link there, with its label text being set via the
   394  *  optional hint, SDL_HINT_WINRT_PRIVACY_POLICY_LABEL.
   395  *
   396  *  Please note that a privacy policy's contents are not set via this hint.  A separate
   397  *  hint, SDL_HINT_WINRT_PRIVACY_POLICY_URL, is used to link to the actual text of the
   398  *  policy.
   399  *
   400  *  The contents of this hint should be encoded as a UTF8 string.
   401  *
   402  *  The default value is "Privacy Policy".  This hint should only be set during app
   403  *  initialization, preferably before any calls to SDL_Init.
   404  *
   405  *  For additional information on linking to a privacy policy, see the documentation for
   406  *  SDL_HINT_WINRT_PRIVACY_POLICY_URL.
   407  */
   408 #define SDL_HINT_WINRT_PRIVACY_POLICY_LABEL "SDL_WINRT_PRIVACY_POLICY_LABEL"
   409 
   410 /** \brief If set to "1", back button press events on Windows Phone 8+ will be marked as handled.
   411  *
   412  *  TODO, WinRT: document SDL_HINT_WINRT_HANDLE_BACK_BUTTON need and use
   413  *  For now, more details on why this is needed can be found at the
   414  *  beginning of the following web page:
   415  *  http://msdn.microsoft.com/en-us/library/windowsphone/develop/jj247550(v=vs.105).aspx
   416  */
   417 #define SDL_HINT_WINRT_HANDLE_BACK_BUTTON "SDL_WINRT_HANDLE_BACK_BUTTON"
   418 
   419 /**
   420  *  \brief  A variable that dictates policy for fullscreen Spaces on Mac OS X.
   421  *
   422  *  This hint only applies to Mac OS X.
   423  *
   424  *  The variable can be set to the following values:
   425  *    "0"       - Disable Spaces support (FULLSCREEN_DESKTOP won't use them and
   426  *                SDL_WINDOW_RESIZABLE windows won't offer the "fullscreen"
   427  *                button on their titlebars).
   428  *    "1"       - Enable Spaces support (FULLSCREEN_DESKTOP will use them and
   429  *                SDL_WINDOW_RESIZABLE windows will offer the "fullscreen"
   430  *                button on their titlebars).
   431  *
   432  *  The default value is "1". Spaces are disabled regardless of this hint if
   433  *   the OS isn't at least Mac OS X Lion (10.7). This hint must be set before
   434  *   any windows are created.
   435  */
   436 #define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES    "SDL_VIDEO_MAC_FULLSCREEN_SPACES"
   437 
   438 /**
   439  * \brief Android APK expansion main file version. Should be a string number like "1", "2" etc.
   440  */
   441 #define SDL_HINT_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION "SDL_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION"
   442  
   443 /**
   444  * \brief Android APK expansion patch file version. Should be a string number like "1", "2" etc.
   445  */
   446 #define SDL_HINT_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION "SDL_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION"
   447 
   448 
   449 /**
   450  *  \brief  An enumeration of hint priorities
   451  */
   452 typedef enum
   453 {
   454     SDL_HINT_DEFAULT,
   455     SDL_HINT_NORMAL,
   456     SDL_HINT_OVERRIDE
   457 } SDL_HintPriority;
   458 
   459 
   460 /**
   461  *  \brief Set a hint with a specific priority
   462  *
   463  *  The priority controls the behavior when setting a hint that already
   464  *  has a value.  Hints will replace existing hints of their priority and
   465  *  lower.  Environment variables are considered to have override priority.
   466  *
   467  *  \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
   468  */
   469 extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name,
   470                                                          const char *value,
   471                                                          SDL_HintPriority priority);
   472 
   473 /**
   474  *  \brief Set a hint with normal priority
   475  *
   476  *  \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
   477  */
   478 extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name,
   479                                              const char *value);
   480 
   481 /**
   482  *  \brief Get a hint
   483  *
   484  *  \return The string value of a hint variable.
   485  */
   486 extern DECLSPEC const char * SDLCALL SDL_GetHint(const char *name);
   487 
   488 /**
   489  *  \brief Add a function to watch a particular hint
   490  *
   491  *  \param name The hint to watch
   492  *  \param callback The function to call when the hint value changes
   493  *  \param userdata A pointer to pass to the callback function
   494  */
   495 typedef void (*SDL_HintCallback)(void *userdata, const char *name, const char *oldValue, const char *newValue);
   496 extern DECLSPEC void SDLCALL SDL_AddHintCallback(const char *name,
   497                                                  SDL_HintCallback callback,
   498                                                  void *userdata);
   499 
   500 /**
   501  *  \brief Remove a function watching a particular hint
   502  *
   503  *  \param name The hint being watched
   504  *  \param callback The function being called when the hint value changes
   505  *  \param userdata A pointer being passed to the callback function
   506  */
   507 extern DECLSPEC void SDLCALL SDL_DelHintCallback(const char *name,
   508                                                  SDL_HintCallback callback,
   509                                                  void *userdata);
   510 
   511 /**
   512  *  \brief  Clear all hints
   513  *
   514  *  This function is called during SDL_Quit() to free stored hints.
   515  */
   516 extern DECLSPEC void SDLCALL SDL_ClearHints(void);
   517 
   518 
   519 /* Ends C function definitions when using C++ */
   520 #ifdef __cplusplus
   521 }
   522 #endif
   523 #include "close_code.h"
   524 
   525 #endif /* _SDL_hints_h */
   526 
   527 /* vi: set ts=4 sw=4 expandtab: */