include/SDL_hints.h
author Ryan C. Gordon <icculus@icculus.org>
Mon, 08 Sep 2014 01:36:22 -0400
changeset 9126 08f3b56969b1
parent 9118 8eeb0d759bc3
child 9154 3331d2f57704
child 9516 77867123589c
permissions -rw-r--r--
Deal with various .bmp file format variants in SDL_LoadBMP_RW().

This helps when modern versions of The Gimp (and lots of other things)
produces a 32-bit bitmap with an alpha channel, or anything with "BI_BITFIELDS"
format, since that data is now embedded in the bitmap info header instead of
directly following it and we would accidentally skip over embedded versions of
it.

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