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