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