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