include/SDL_hints.h
author David Ludwig <dludwig@pobox.com>
Sat, 04 Oct 2014 14:59:41 -0400
changeset 9154 3331d2f57704
parent 9118 8eeb0d759bc3
child 9242 f4d353bd5d16
child 9521 4c218c80b34d
permissions -rw-r--r--
WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     1
/*
5535
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
     2
  Simple DirectMedia Layer
8149
681eb46b8ac4 Fixed bug 2374 - Update copyright for 2014...
Sam Lantinga <slouken@libsdl.org>
parents: 8144
diff changeset
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     4
5535
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
     5
  This software is provided 'as-is', without any express or implied
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
     6
  warranty.  In no event will the authors be held liable for any damages
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
     7
  arising from the use of this software.
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     8
5535
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
     9
  Permission is granted to anyone to use this software for any purpose,
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
    10
  including commercial applications, and to alter it and redistribute it
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
    11
  freely, subject to the following restrictions:
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    12
5535
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
    13
  1. The origin of this software must not be misrepresented; you must not
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
    14
     claim that you wrote the original software. If you use this software
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
    15
     in a product, an acknowledgment in the product documentation would be
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
    16
     appreciated but is not required.
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
    17
  2. Altered source versions must be plainly marked as such, and must not be
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
    18
     misrepresented as being the original software.
96594ac5fd1a SDL 1.3 is now under the zlib license.
Sam Lantinga <slouken@libsdl.org>
parents: 5484
diff changeset
    19
  3. This notice may not be removed or altered from any source distribution.
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    20
*/
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    21
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    22
/**
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    23
 *  \file SDL_hints.h
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 6990
diff changeset
    24
 *
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    25
 *  Official documentation for SDL configuration variables
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    26
 *
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    27
 *  This file contains functions to set and get configuration hints,
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    28
 *  as well as listing each of them alphabetically.
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    29
 *
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    30
 *  The convention for naming hints is SDL_HINT_X, where "SDL_X" is
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    31
 *  the environment variable that can be used to override the default.
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    32
 *
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    33
 *  In general these hints are just that - they may or may not be
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    34
 *  supported or applicable on any given platform, but they provide
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    35
 *  a way for an application or user to give the library a hint as
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    36
 *  to how they would like the library to work.
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    37
 */
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    38
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    39
#ifndef _SDL_hints_h
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    40
#define _SDL_hints_h
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    41
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    42
#include "SDL_stdinc.h"
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    43
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    44
#include "begin_code.h"
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    45
/* Set up for C function definitions, even when using C++ */
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    46
#ifdef __cplusplus
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    47
extern "C" {
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    48
#endif
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    49
5190
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    50
/**
7328
bbfc72c803df Remove / update references to 1.2.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7279
diff changeset
    51
 *  \brief  A variable controlling how 3D acceleration is used to accelerate the SDL screen surface.
5190
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    52
 *
7328
bbfc72c803df Remove / update references to 1.2.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7279
diff changeset
    53
 *  SDL can try to accelerate the SDL screen surface by using streaming
5190
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    54
 *  textures with a 3D rendering engine.  This variable controls whether and
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    55
 *  how this is done.
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    56
 *
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    57
 *  This variable can be set to the following values:
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    58
 *    "0"       - Disable 3D acceleration
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    59
 *    "1"       - Enable 3D acceleration, using the default renderer.
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    60
 *    "X"       - Enable 3D acceleration, using X where X is one of the valid rendering drivers.  (e.g. "direct3d", "opengl", etc.)
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    61
 *
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    62
 *  By default SDL tries to make a best guess for each platform whether
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    63
 *  to use acceleration or not.
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    64
 */
82a48f4d65f6 Added a hint to determine whether framebuffer texture acceleration should be used, and added default behaviors for the various platforms.
Sam Lantinga <slouken@libsdl.org>
parents: 5189
diff changeset
    65
#define SDL_HINT_FRAMEBUFFER_ACCELERATION   "SDL_FRAMEBUFFER_ACCELERATION"
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    66
5192
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    67
/**
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    68
 *  \brief  A variable specifying which render driver to use.
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    69
 *
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    70
 *  If the application doesn't pick a specific renderer to use, this variable
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    71
 *  specifies the name of the preferred renderer.  If the preferred renderer
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    72
 *  can't be initialized, the normal default renderer is used.
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    73
 *
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    74
 *  This variable is case insensitive and can be set to the following values:
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    75
 *    "direct3d"
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    76
 *    "opengl"
5233
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    77
 *    "opengles2"
5192
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    78
 *    "opengles"
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    79
 *    "software"
5233
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    80
 *
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    81
 *  The default varies by platform, but it's the first one in the list that
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    82
 *  is available on the current platform.
5192
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    83
 */
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    84
#define SDL_HINT_RENDER_DRIVER              "SDL_RENDER_DRIVER"
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    85
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
    86
/**
5233
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    87
 *  \brief  A variable controlling whether the OpenGL render driver uses shaders if they are available.
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    88
 *
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    89
 *  This variable can be set to the following values:
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    90
 *    "0"       - Disable shaders
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    91
 *    "1"       - Enable shaders
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    92
 *
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    93
 *  By default shaders are used if OpenGL supports them.
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    94
 */
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    95
#define SDL_HINT_RENDER_OPENGL_SHADERS      "SDL_RENDER_OPENGL_SHADERS"
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    96
ce4f91138031 Added a hint to control whether the OpenGL driver uses shaders.
Sam Lantinga <slouken@libsdl.org>
parents: 5200
diff changeset
    97
/**
7764
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
    98
 *  \brief  A variable controlling whether the Direct3D device is initialized for thread-safe operations.
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
    99
 *
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
   100
 *  This variable can be set to the following values:
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
   101
 *    "0"       - Thread-safety is not enabled (faster)
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
   102
 *    "1"       - Thread-safety is enabled
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
   103
 *
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
   104
 *  By default the Direct3D device is created with thread-safety disabled.
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
   105
 */
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
   106
#define SDL_HINT_RENDER_DIRECT3D_THREADSAFE "SDL_RENDER_DIRECT3D_THREADSAFE"
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
   107
0f48b5f28668 Added a hint to create the D3D device in thread-safe mode: SDL_HINT_RENDER_DIRECT3D_THREADSAFE
Sam Lantinga <slouken@libsdl.org>
parents: 7747
diff changeset
   108
/**
8583
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   109
 *  \brief  A variable controlling whether to enable Direct3D 11+'s Debug Layer.
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   110
 *
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   111
 *  This variable does not have any effect on the Direct3D 9 based renderer.
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   112
 *
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   113
 *  This variable can be set to the following values:
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   114
 *    "0"       - Disable Debug Layer use
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   115
 *    "1"       - Enable Debug Layer use
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   116
 *
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   117
 *  By default, SDL does not use Direct3D Debug Layer.
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   118
 */
8695
a672c01a4ab7 Fixed names of four hint environment variables.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8693
diff changeset
   119
#define SDL_HINT_RENDER_DIRECT3D11_DEBUG    "SDL_RENDER_DIRECT3D11_DEBUG"
8583
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   120
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   121
/**
5484
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   122
 *  \brief  A variable controlling the scaling quality
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   123
 *
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   124
 *  This variable can be set to the following values:
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   125
 *    "0" or "nearest" - Nearest pixel sampling
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   126
 *    "1" or "linear"  - Linear filtering (supported by OpenGL and Direct3D)
7577
709056f2580a Removed anisotropic option from SDL_HINT_RENDER_SCALE_QUALITY.
Ryan C. Gordon <icculus@icculus.org>
parents: 7432
diff changeset
   127
 *    "2" or "best"    - Currently this is the same as "linear"
5484
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   128
 *
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   129
 *  By default nearest pixel sampling is used
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   130
 */
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   131
#define SDL_HINT_RENDER_SCALE_QUALITY       "SDL_RENDER_SCALE_QUALITY"
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   132
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   133
/**
7328
bbfc72c803df Remove / update references to 1.2.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7279
diff changeset
   134
 *  \brief  A variable controlling whether updates to the SDL screen surface should be synchronized with the vertical refresh, to avoid tearing.
5192
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   135
 *
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   136
 *  This variable can be set to the following values:
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   137
 *    "0"       - Disable vsync
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   138
 *    "1"       - Enable vsync
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   139
 *
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   140
 *  By default SDL does not sync screen surface updates with vertical refresh.
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   141
 */
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   142
#define SDL_HINT_RENDER_VSYNC               "SDL_RENDER_VSYNC"
6472
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   143
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   144
/**
8266
d123fc5d02bc Added a hint to enable the screensaver by default
Sam Lantinga <slouken@libsdl.org>
parents: 8221
diff changeset
   145
 *  \brief  A variable controlling whether the screensaver is enabled. 
8533
89cf2a2635d1 WinRT: made the Direct3D 11.x 'Debug Layer' be enable-able in any app via a hint
David Ludwig <dludwig@pobox.com>
parents: 7577
diff changeset
   146
 *
89cf2a2635d1 WinRT: made the Direct3D 11.x 'Debug Layer' be enable-able in any app via a hint
David Ludwig <dludwig@pobox.com>
parents: 7577
diff changeset
   147
 *  This variable can be set to the following values:
8266
d123fc5d02bc Added a hint to enable the screensaver by default
Sam Lantinga <slouken@libsdl.org>
parents: 8221
diff changeset
   148
 *    "0"       - Disable screensaver
d123fc5d02bc Added a hint to enable the screensaver by default
Sam Lantinga <slouken@libsdl.org>
parents: 8221
diff changeset
   149
 *    "1"       - Enable screensaver
8533
89cf2a2635d1 WinRT: made the Direct3D 11.x 'Debug Layer' be enable-able in any app via a hint
David Ludwig <dludwig@pobox.com>
parents: 7577
diff changeset
   150
 *
8266
d123fc5d02bc Added a hint to enable the screensaver by default
Sam Lantinga <slouken@libsdl.org>
parents: 8221
diff changeset
   151
 *  By default SDL will disable the screensaver.
8533
89cf2a2635d1 WinRT: made the Direct3D 11.x 'Debug Layer' be enable-able in any app via a hint
David Ludwig <dludwig@pobox.com>
parents: 7577
diff changeset
   152
 */
8266
d123fc5d02bc Added a hint to enable the screensaver by default
Sam Lantinga <slouken@libsdl.org>
parents: 8221
diff changeset
   153
#define SDL_HINT_VIDEO_ALLOW_SCREENSAVER    "SDL_VIDEO_ALLOW_SCREENSAVER"
8533
89cf2a2635d1 WinRT: made the Direct3D 11.x 'Debug Layer' be enable-able in any app via a hint
David Ludwig <dludwig@pobox.com>
parents: 7577
diff changeset
   154
89cf2a2635d1 WinRT: made the Direct3D 11.x 'Debug Layer' be enable-able in any app via a hint
David Ludwig <dludwig@pobox.com>
parents: 7577
diff changeset
   155
/**
6472
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   156
 *  \brief  A variable controlling whether the X11 VidMode extension should be used.
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   157
 *
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   158
 *  This variable can be set to the following values:
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   159
 *    "0"       - Disable XVidMode
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   160
 *    "1"       - Enable XVidMode
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   161
 *
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   162
 *  By default SDL will use XVidMode if it is available.
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   163
 */
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   164
#define SDL_HINT_VIDEO_X11_XVIDMODE         "SDL_VIDEO_X11_XVIDMODE"
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   165
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   166
/**
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   167
 *  \brief  A variable controlling whether the X11 Xinerama extension should be used.
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   168
 *
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   169
 *  This variable can be set to the following values:
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   170
 *    "0"       - Disable Xinerama
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   171
 *    "1"       - Enable Xinerama
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   172
 *
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   173
 *  By default SDL will use Xinerama if it is available.
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   174
 */
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   175
#define SDL_HINT_VIDEO_X11_XINERAMA         "SDL_VIDEO_X11_XINERAMA"
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   176
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   177
/**
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   178
 *  \brief  A variable controlling whether the X11 XRandR extension should be used.
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   179
 *
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   180
 *  This variable can be set to the following values:
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   181
 *    "0"       - Disable XRandR
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   182
 *    "1"       - Enable XRandR
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   183
 *
6558
90f231aa77b9 I'm becoming more and more convinced that the application should never use XRandR, and it's the window manager's responsibility to track and manage display modes for fullscreen windows.
Sam Lantinga <slouken@libsdl.org>
parents: 6472
diff changeset
   184
 *  By default SDL will not use XRandR because of window manager issues.
6472
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   185
 */
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   186
#define SDL_HINT_VIDEO_X11_XRANDR           "SDL_VIDEO_X11_XRANDR"
d4623b7209db Turned the X11 mode extension environment variables into hints so they can be more easily set from applications.
Sam Lantinga <slouken@libsdl.org>
parents: 6138
diff changeset
   187
5554
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   188
/**
8813
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   189
 *  \brief  A variable controlling whether the window frame and title bar are interactive when the cursor is hidden 
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   190
 *
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   191
 *  This variable can be set to the following values:
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   192
 *    "0"       - The window frame is not interactive when the cursor is hidden (no move, resize, etc)
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   193
 *    "1"       - The window frame is interactive when the cursor is hidden
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   194
 *
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   195
 *  By default SDL will allow interaction with the window frame when the cursor is hidden
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   196
 */
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   197
#define SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN    "SDL_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN"
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   198
beae556efafc Added a hint to disable window frame and title bar interaction when the cursor is hidden
Sam Lantinga <slouken@libsdl.org>
parents: 8695
diff changeset
   199
/**
8814
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   200
 *  \brief  A variable controlling whether the windows message loop is processed by SDL 
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   201
 *
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   202
 *  This variable can be set to the following values:
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   203
 *    "0"       - The window message loop is not run
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   204
 *    "1"       - The window message loop is processed in SDL_PumpEvents()
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   205
 *
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   206
 *  By default SDL will process the windows message loop
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   207
 */
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   208
#define SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP "SDL_WINDOWS_ENABLE_MESSAGELOOP"
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   209
8a6a21356035 Added a hint to disable windows message processing in SDL_PumpEvents()
Sam Lantinga <slouken@libsdl.org>
parents: 8813
diff changeset
   210
/**
6662
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   211
 *  \brief  A variable controlling whether grabbing input grabs the keyboard
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   212
 *
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   213
 *  This variable can be set to the following values:
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   214
 *    "0"       - Grab will affect only the mouse
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   215
 *    "1"       - Grab will affect mouse and keyboard
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   216
 *
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   217
 *  By default SDL will not grab the keyboard so system shortcuts still work.
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   218
 */
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   219
#define SDL_HINT_GRAB_KEYBOARD              "SDL_GRAB_KEYBOARD"
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   220
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   221
/**
8071
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   222
*  \brief  A variable controlling whether relative mouse mode is implemented using mouse warping
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   223
*
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   224
*  This variable can be set to the following values:
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   225
*    "0"       - Relative mouse mode uses raw input
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   226
*    "1"       - Relative mouse mode uses mouse warping
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   227
*
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   228
*  By default SDL will use raw input for relative mouse mode
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   229
*/
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   230
#define SDL_HINT_MOUSE_RELATIVE_MODE_WARP    "SDL_MOUSE_RELATIVE_MODE_WARP"
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   231
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   232
/**
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   233
 *  \brief Minimize your SDL_Window if it loses key focus when in fullscreen mode. Defaults to true.
6755
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   234
 *
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   235
 */
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   236
#define SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS   "SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS"
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   237
7968
8c0afe77a1b2 Added a hint SDL_HINT_VIDEO_FULLSCREEN_SPACES to specify that windows go fullscreen into their own spaces on Mac OS X.
Sam Lantinga <slouken@libsdl.org>
parents: 7915
diff changeset
   238
/**
5555
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   239
 *  \brief  A variable controlling whether the idle timer is disabled on iOS.
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   240
 *
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   241
 *  When an iOS app does not receive touches for some time, the screen is
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   242
 *  dimmed automatically. For games where the accelerometer is the only input
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   243
 *  this is problematic. This functionality can be disabled by setting this
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   244
 *  hint.
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   245
 *
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   246
 *  This variable can be set to the following values:
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   247
 *    "0"       - Enable idle timer
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   248
 *    "1"       - Disable idle timer
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   249
 */
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   250
#define SDL_HINT_IDLE_TIMER_DISABLED "SDL_IOS_IDLE_TIMER_DISABLED"
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 6990
diff changeset
   251
5555
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   252
/**
5554
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   253
 *  \brief  A variable controlling which orientations are allowed on iOS.
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   254
 *
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   255
 *  In some circumstances it is necessary to be able to explicitly control
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   256
 *  which UI orientations are allowed.
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   257
 *
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   258
 *  This variable is a space delimited list of the following values:
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   259
 *    "LandscapeLeft", "LandscapeRight", "Portrait" "PortraitUpsideDown"
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   260
 */
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   261
#define SDL_HINT_ORIENTATIONS "SDL_IOS_ORIENTATIONS"
7907
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   262
    
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   263
/**
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   264
 *  \brief  A variable controlling whether an Android built-in accelerometer should be
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   265
 *  listed as a joystick device, rather than listing actual joysticks only.
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   266
 *
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   267
 *  This variable can be set to the following values:
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   268
 *    "0"       - List only real joysticks and accept input from them
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   269
 *    "1"       - List real joysticks along with the accelerometer as if it were a 3 axis joystick (the default).
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   270
 */
8274
8b1f8feb42a6 Changed SDL_HINT_ACCEL_AS_JOY to SDL_HINT_ACCELEROMETER_AS_JOYSTICK to be more clear.
Sam Lantinga <slouken@libsdl.org>
parents: 8266
diff changeset
   271
#define SDL_HINT_ACCELEROMETER_AS_JOYSTICK "SDL_ACCELEROMETER_AS_JOYSTICK"
5192
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   272
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   273
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   274
/**
6965
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   275
 *  \brief  A variable that lets you disable the detection and use of Xinput gamepad devices
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   276
 *
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   277
 *  The variable can be set to the following values:
8221
6ded2087e346 Fixed documentation comments in SDL_hints.h file.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8149
diff changeset
   278
 *    "0"       - Disable XInput detection (only uses direct input)
6ded2087e346 Fixed documentation comments in SDL_hints.h file.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8149
diff changeset
   279
 *    "1"       - Enable XInput detection (the default)
6965
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   280
 */
6990
2514368c2aaf First shot at Windows XInput haptics.
Ryan C. Gordon <icculus@icculus.org>
parents: 6982
diff changeset
   281
#define SDL_HINT_XINPUT_ENABLED "SDL_XINPUT_ENABLED"
6965
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   282
6982
9987a9daefb6 Updated SDL_HINT_GAMECONTROLLERCONFIG documentation to reflect that it only takes effect before init.
Sam Lantinga <slouken@libsdl.org>
parents: 6980
diff changeset
   283
6965
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   284
/**
8920
21ccd40c778a Fixed bug 2553 - Add support to all XInput devices
Sam Lantinga <slouken@libsdl.org>
parents: 8900
diff changeset
   285
 *  \brief  A variable that causes SDL to use the old axis and button mapping for XInput devices.
21ccd40c778a Fixed bug 2553 - Add support to all XInput devices
Sam Lantinga <slouken@libsdl.org>
parents: 8900
diff changeset
   286
 *
21ccd40c778a Fixed bug 2553 - Add support to all XInput devices
Sam Lantinga <slouken@libsdl.org>
parents: 8900
diff changeset
   287
 *  This hint is for backwards compatibility only and will be removed in SDL 2.1
21ccd40c778a Fixed bug 2553 - Add support to all XInput devices
Sam Lantinga <slouken@libsdl.org>
parents: 8900
diff changeset
   288
 *
21ccd40c778a Fixed bug 2553 - Add support to all XInput devices
Sam Lantinga <slouken@libsdl.org>
parents: 8900
diff changeset
   289
 *  The default value is "0".  This hint must be set before SDL_Init()
21ccd40c778a Fixed bug 2553 - Add support to all XInput devices
Sam Lantinga <slouken@libsdl.org>
parents: 8900
diff changeset
   290
 */
21ccd40c778a Fixed bug 2553 - Add support to all XInput devices
Sam Lantinga <slouken@libsdl.org>
parents: 8900
diff changeset
   291
#define SDL_HINT_XINPUT_USE_OLD_JOYSTICK_MAPPING "SDL_XINPUT_USE_OLD_JOYSTICK_MAPPING"
21ccd40c778a Fixed bug 2553 - Add support to all XInput devices
Sam Lantinga <slouken@libsdl.org>
parents: 8900
diff changeset
   292
21ccd40c778a Fixed bug 2553 - Add support to all XInput devices
Sam Lantinga <slouken@libsdl.org>
parents: 8900
diff changeset
   293
21ccd40c778a Fixed bug 2553 - Add support to all XInput devices
Sam Lantinga <slouken@libsdl.org>
parents: 8900
diff changeset
   294
/**
6690
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   295
 *  \brief  A variable that lets you manually hint extra gamecontroller db entries
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 6990
diff changeset
   296
 *
6982
9987a9daefb6 Updated SDL_HINT_GAMECONTROLLERCONFIG documentation to reflect that it only takes effect before init.
Sam Lantinga <slouken@libsdl.org>
parents: 6980
diff changeset
   297
 *  The variable should be newline delimited rows of gamecontroller config data, see SDL_gamecontroller.h
6980
1d3565d686f1 Don't re-read the hints when opening the game controller. Instead use SDL_GameControllerAddMapping() to add hints after initialization.
Sam Lantinga <slouken@libsdl.org>
parents: 6965
diff changeset
   298
 *
1d3565d686f1 Don't re-read the hints when opening the game controller. Instead use SDL_GameControllerAddMapping() to add hints after initialization.
Sam Lantinga <slouken@libsdl.org>
parents: 6965
diff changeset
   299
 *  This hint must be set before calling SDL_Init(SDL_INIT_GAMECONTROLLER)
6982
9987a9daefb6 Updated SDL_HINT_GAMECONTROLLERCONFIG documentation to reflect that it only takes effect before init.
Sam Lantinga <slouken@libsdl.org>
parents: 6980
diff changeset
   300
 *  You can update mappings after the system is initialized with SDL_GameControllerMappingForGUID() and SDL_GameControllerAddMapping()
6690
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   301
 */
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   302
#define SDL_HINT_GAMECONTROLLERCONFIG "SDL_GAMECONTROLLERCONFIG"
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   303
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   304
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   305
/**
7279
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   306
 *  \brief  A variable that lets you enable joystick (and gamecontroller) events even when your app is in the background.
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   307
 *
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   308
 *  The variable can be set to the following values:
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   309
 *    "0"       - Disable joystick & gamecontroller input events when the
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   310
 *                application is in the background.
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   311
 *    "1"       - Enable joystick & gamecontroller input events when the
8221
6ded2087e346 Fixed documentation comments in SDL_hints.h file.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8149
diff changeset
   312
 *                application is in the background.
7432
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   313
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   314
 *  The default value is "0".  This hint may be set at any time.
7279
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   315
 */
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   316
#define SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS "SDL_JOYSTICK_ALLOW_BACKGROUND_EVENTS"
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   317
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   318
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   319
/**
8693
3307abdb7fe2 Fixed typos in header comments.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8691
diff changeset
   320
 *  \brief If set to "0" then never set the top most bit on a SDL Window, even if the video mode expects it.
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 6990
diff changeset
   321
 *      This is a debugging aid for developers and not expected to be used by end users. The default is "1"
6782
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   322
 *
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   323
 *  This variable can be set to the following values:
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   324
 *    "0"       - don't allow topmost
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   325
 *    "1"       - allow topmost
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   326
 */
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   327
#define SDL_HINT_ALLOW_TOPMOST "SDL_ALLOW_TOPMOST"
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   328
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   329
7432
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   330
/**
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   331
 *  \brief A variable that controls the timer resolution, in milliseconds.
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   332
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   333
 *  The higher resolution the timer, the more frequently the CPU services
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   334
 *  timer interrupts, and the more precise delays are, but this takes up
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   335
 *  power and CPU time.  This hint is only used on Windows 7 and earlier.
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   336
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   337
 *  See this blog post for more information:
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   338
 *  http://randomascii.wordpress.com/2013/07/08/windows-timer-resolution-megawatts-wasted/
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   339
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   340
 *  If this variable is set to "0", the system timer resolution is not set.
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   341
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   342
 *  The default value is "1". This hint may be set at any time.
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   343
 */
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   344
#define SDL_HINT_TIMER_RESOLUTION "SDL_TIMER_RESOLUTION"
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   345
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   346
7746
6a05d7352575 add in High DPI support (aka Retina)
Edward Rudd <urkle@outoforder.cc>
parents: 7577
diff changeset
   347
/**
6a05d7352575 add in High DPI support (aka Retina)
Edward Rudd <urkle@outoforder.cc>
parents: 7577
diff changeset
   348
 *  \brief If set to 1, then do not allow high-DPI windows. ("Retina" on Mac)
6a05d7352575 add in High DPI support (aka Retina)
Edward Rudd <urkle@outoforder.cc>
parents: 7577
diff changeset
   349
 */
7747
0ebf642117f4 Fixed the name of the environment variable to match the name of the hint.
Sam Lantinga <slouken@libsdl.org>
parents: 7746
diff changeset
   350
#define SDL_HINT_VIDEO_HIGHDPI_DISABLED "SDL_VIDEO_HIGHDPI_DISABLED"
7746
6a05d7352575 add in High DPI support (aka Retina)
Edward Rudd <urkle@outoforder.cc>
parents: 7577
diff changeset
   351
7915
86ad156a82ab Added SDL_HINT_CTRL_CLICK_EMULATE_RIGHT_CLICK hint which controls whether ctrl+click should emulate a right click on OSX.
Sam Lantinga <slouken@libsdl.org>
parents: 7907
diff changeset
   352
/**
86ad156a82ab Added SDL_HINT_CTRL_CLICK_EMULATE_RIGHT_CLICK hint which controls whether ctrl+click should emulate a right click on OSX.
Sam Lantinga <slouken@libsdl.org>
parents: 7907
diff changeset
   353
 *  \brief A variable that determines whether ctrl+click should generate a right-click event on Mac
8693
3307abdb7fe2 Fixed typos in header comments.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8691
diff changeset
   354
 *
7915
86ad156a82ab Added SDL_HINT_CTRL_CLICK_EMULATE_RIGHT_CLICK hint which controls whether ctrl+click should emulate a right click on OSX.
Sam Lantinga <slouken@libsdl.org>
parents: 7907
diff changeset
   355
 *  If present, holding ctrl while left clicking will generate a right click
86ad156a82ab Added SDL_HINT_CTRL_CLICK_EMULATE_RIGHT_CLICK hint which controls whether ctrl+click should emulate a right click on OSX.
Sam Lantinga <slouken@libsdl.org>
parents: 7907
diff changeset
   356
 *  event when on Mac.
86ad156a82ab Added SDL_HINT_CTRL_CLICK_EMULATE_RIGHT_CLICK hint which controls whether ctrl+click should emulate a right click on OSX.
Sam Lantinga <slouken@libsdl.org>
parents: 7907
diff changeset
   357
 */
86ad156a82ab Added SDL_HINT_CTRL_CLICK_EMULATE_RIGHT_CLICK hint which controls whether ctrl+click should emulate a right click on OSX.
Sam Lantinga <slouken@libsdl.org>
parents: 7907
diff changeset
   358
#define SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK "SDL_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK"
86ad156a82ab Added SDL_HINT_CTRL_CLICK_EMULATE_RIGHT_CLICK hint which controls whether ctrl+click should emulate a right click on OSX.
Sam Lantinga <slouken@libsdl.org>
parents: 7907
diff changeset
   359
8021
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   360
/**
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   361
*  \brief  A variable specifying which shader compiler to preload when using the Chrome ANGLE binaries
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   362
*
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   363
*  SDL has EGL and OpenGL ES2 support on Windows via the ANGLE project. It
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   364
*  can use two different sets of binaries, those compiled by the user from source
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   365
*  or those provided by the Chrome browser. In the later case, these binaries require
8221
6ded2087e346 Fixed documentation comments in SDL_hints.h file.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8149
diff changeset
   366
*  that SDL loads a DLL providing the shader compiler.
8021
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   367
*
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   368
*  This variable can be set to the following values:
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   369
*    "d3dcompiler_46.dll" - default, best for Vista or later.
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   370
*    "d3dcompiler_43.dll" - for XP support.
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   371
*    "none" - do not load any library, useful if you compiled ANGLE from source and included the compiler in your binaries.
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   372
*
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   373
*/
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   374
#define SDL_HINT_VIDEO_WIN_D3DCOMPILER              "SDL_VIDEO_WIN_D3DCOMPILER"
6782
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   375
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   376
/**
8144
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   377
*  \brief  A variable that is the address of another SDL_Window* (as a hex string formatted with "%p").
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   378
*  
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   379
*  If this hint is set before SDL_CreateWindowFrom() and the SDL_Window* it is set to has
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   380
*  SDL_WINDOW_OPENGL set (and running on WGL only, currently), then two things will occur on the newly 
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   381
*  created SDL_Window:
8583
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   382
*
8144
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   383
*  1. Its pixel format will be set to the same pixel format as this SDL_Window.  This is
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   384
*  needed for example when sharing an OpenGL context across multiple windows.
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   385
*
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   386
*  2. The flag SDL_WINDOW_OPENGL will be set on the new window so it can be used for
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   387
*  OpenGL rendering.
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   388
*
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   389
*  This variable can be set to the following values:
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   390
*    The address (as a string "%p") of the SDL_Window* that new windows created with SDL_CreateWindowFrom() should
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   391
*    share a pixel format with.
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   392
*/
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   393
#define SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT    "SDL_VIDEO_WINDOW_SHARE_PIXEL_FORMAT"
855b1d6d7d8e Add a new hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that allows SDL_CreateWindowFrom() to set the pixel format of another SDL_Window (and also will set the SDL_WINDOW_OPENGL flag on the window created with SDL_CreateWindowFrom()).
Sam Lantinga <slouken@libsdl.org>
parents: 8071
diff changeset
   394
8691
41a55b86b980 Fixed doxygen comment in header.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8583
diff changeset
   395
/**
8576
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   396
 *  \brief A URL to a WinRT app's privacy policy
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   397
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   398
 *  All network-enabled WinRT apps must make a privacy policy available to its
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   399
 *  users.  On Windows 8, 8.1, and RT, Microsoft mandates that this policy be
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   400
 *  be available in the Windows Settings charm, as accessed from within the app.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   401
 *  SDL provides code to add a URL-based link there, which can point to the app's
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   402
 *  privacy policy.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   403
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   404
 *  To setup a URL to an app's privacy policy, set SDL_HINT_WINRT_PRIVACY_POLICY_URL
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   405
 *  before calling any SDL_Init functions.  The contents of the hint should
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   406
 *  be a valid URL.  For example, "http://www.example.com".
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   407
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   408
 *  The default value is "", which will prevent SDL from adding a privacy policy
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   409
 *  link to the Settings charm.  This hint should only be set during app init.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   410
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   411
 *  The label text of an app's "Privacy Policy" link may be customized via another
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   412
 *  hint, SDL_HINT_WINRT_PRIVACY_POLICY_LABEL.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   413
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   414
 *  Please note that on Windows Phone, Microsoft does not provide standard UI
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   415
 *  for displaying a privacy policy link, and as such, SDL_HINT_WINRT_PRIVACY_POLICY_URL
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   416
 *  will not get used on that platform.  Network-enabled phone apps should display
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   417
 *  their privacy policy through some other, in-app means.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   418
 */
8695
a672c01a4ab7 Fixed names of four hint environment variables.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8693
diff changeset
   419
#define SDL_HINT_WINRT_PRIVACY_POLICY_URL "SDL_WINRT_PRIVACY_POLICY_URL"
8576
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   420
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   421
/** \brief Label text for a WinRT app's privacy policy link
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   422
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   423
 *  Network-enabled WinRT apps must include a privacy policy.  On Windows 8, 8.1, and RT,
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   424
 *  Microsoft mandates that this policy be available via the Windows Settings charm.
8693
3307abdb7fe2 Fixed typos in header comments.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8691
diff changeset
   425
 *  SDL provides code to add a link there, with its label text being set via the
8576
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   426
 *  optional hint, SDL_HINT_WINRT_PRIVACY_POLICY_LABEL.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   427
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   428
 *  Please note that a privacy policy's contents are not set via this hint.  A separate
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   429
 *  hint, SDL_HINT_WINRT_PRIVACY_POLICY_URL, is used to link to the actual text of the
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   430
 *  policy.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   431
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   432
 *  The contents of this hint should be encoded as a UTF8 string.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   433
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   434
 *  The default value is "Privacy Policy".  This hint should only be set during app
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   435
 *  initialization, preferably before any calls to SDL_Init.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   436
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   437
 *  For additional information on linking to a privacy policy, see the documentation for
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   438
 *  SDL_HINT_WINRT_PRIVACY_POLICY_URL.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   439
 */
8695
a672c01a4ab7 Fixed names of four hint environment variables.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8693
diff changeset
   440
#define SDL_HINT_WINRT_PRIVACY_POLICY_LABEL "SDL_WINRT_PRIVACY_POLICY_LABEL"
8576
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   441
9154
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   442
/** \brief Allows back-button-press events on Windows Phone to be marked as handled
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   443
 *
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   444
 *  Windows Phone devices typically feature a Back button.  When pressed,
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   445
 *  the OS will emit back-button-press events, which apps are expected to
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   446
 *  handle in an appropriate manner.  If apps do not explicitly mark these
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   447
 *  events as 'Handled', then the OS will invoke its default behavior for
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   448
 *  unhandled back-button-press events, which on Windows Phone 8 and 8.1 is to
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   449
 *  terminate the app (and attempt to switch to the previous app, or to the
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   450
 *  device's home screen).
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   451
 *
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   452
 *  Setting the SDL_HINT_WINRT_HANDLE_BACK_BUTTON hint to "1" will cause SDL
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   453
 *  to mark back-button-press events as Handled, if and when one is sent to
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   454
 *  the app.
8577
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   455
 *
9154
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   456
 *  Internally, Windows Phone sends back button events as parameters to
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   457
 *  special back-button-press callback functions.  Apps that need to respond
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   458
 *  to back-button-press events are expected to register one or more
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   459
 *  callback functions for such, shortly after being launched (during the
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   460
 *  app's initialization phase).  After the back button is pressed, the OS
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   461
 *  will invoke these callbacks.  If the app's callback(s) do not explicitly
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   462
 *  mark the event as handled by the time they return, or if the app never
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   463
 *  registers one of these callback, the OS will consider the event
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   464
 *  un-handled, and it will apply its default back button behavior (terminate
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   465
 *  the app).
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   466
 *
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   467
 *  SDL registers its own back-button-press callback with the Windows Phone
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   468
 *  OS.  This callback will emit a pair of SDL key-press events (SDL_KEYDOWN
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   469
 *  and SDL_KEYUP), each with a scancode of SDL_SCANCODE_AC_BACK, after which
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   470
 *  it will check the contents of the hint, SDL_HINT_WINRT_HANDLE_BACK_BUTTON.
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   471
 *  If the hint's value is set to "1", the back button event's Handled
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   472
 *  property will get set to 'true'.  If the hint's value is set to something
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   473
 *  else, or if it is unset, SDL will leave the event's Handled property
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   474
 *  alone.  (By default, the OS sets this property to 'false', to note.)
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   475
 *
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   476
 *  SDL apps can either set SDL_HINT_WINRT_HANDLE_BACK_BUTTON well before a
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   477
 *  back button is pressed, or can set it in direct-response to a back button
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   478
 *  being pressed.
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   479
 *
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   480
 *  In order to get notified when a back button is pressed, SDL apps should
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   481
 *  register a callback function with SDL_AddEventWatch(), and have it listen
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   482
 *  for SDL_KEYDOWN events that have a scancode of SDL_SCANCODE_AC_BACK.
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   483
 *  (Alternatively, SDL_KEYUP events can be listened-for.  Listening for
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   484
 *  either event type is suitable.)  Any value of SDL_HINT_WINRT_HANDLE_BACK_BUTTON
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   485
 *  set by such a callback, will be applied to the OS' current
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   486
 *  back-button-press event.
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   487
 *
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   488
 *  More details on back button behavior in Windows Phone apps can be found
3331d2f57704 WinRT: expanded the documentation on SDL_HINT_WINRT_HANDLE_BACK_BUTTON
David Ludwig <dludwig@pobox.com>
parents: 9118
diff changeset
   489
 *  at the following page, on Microsoft's developer site:
8577
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   490
 *  http://msdn.microsoft.com/en-us/library/windowsphone/develop/jj247550(v=vs.105).aspx
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   491
 */
8695
a672c01a4ab7 Fixed names of four hint environment variables.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8693
diff changeset
   492
#define SDL_HINT_WINRT_HANDLE_BACK_BUTTON "SDL_WINRT_HANDLE_BACK_BUTTON"
8577
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   493
8576
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   494
/**
8295
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   495
 *  \brief  A variable that dictates policy for fullscreen Spaces on Mac OS X.
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   496
 *
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   497
 *  This hint only applies to Mac OS X.
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   498
 *
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   499
 *  The variable can be set to the following values:
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   500
 *    "0"       - Disable Spaces support (FULLSCREEN_DESKTOP won't use them and
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   501
 *                SDL_WINDOW_RESIZABLE windows won't offer the "fullscreen"
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   502
 *                button on their titlebars).
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   503
 *    "1"       - Enable Spaces support (FULLSCREEN_DESKTOP will use them and
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   504
 *                SDL_WINDOW_RESIZABLE windows will offer the "fullscreen"
8693
3307abdb7fe2 Fixed typos in header comments.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 8691
diff changeset
   505
 *                button on their titlebars).
8295
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   506
 *
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   507
 *  The default value is "1". Spaces are disabled regardless of this hint if
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   508
 *   the OS isn't at least Mac OS X Lion (10.7). This hint must be set before
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   509
 *   any windows are created.
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   510
 */
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   511
#define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES    "SDL_VIDEO_MAC_FULLSCREEN_SPACES"
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   512
8896
d931167c375a inital apk extension support
stopiccot <alexey.petruchik@gmail.com>
parents: 8695
diff changeset
   513
/**
d931167c375a inital apk extension support
stopiccot <alexey.petruchik@gmail.com>
parents: 8695
diff changeset
   514
 * \brief Android APK expansion main file version. Should be a string number like "1", "2" etc.
d931167c375a inital apk extension support
stopiccot <alexey.petruchik@gmail.com>
parents: 8695
diff changeset
   515
 */
d931167c375a inital apk extension support
stopiccot <alexey.petruchik@gmail.com>
parents: 8695
diff changeset
   516
#define SDL_HINT_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION "SDL_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION"
d931167c375a inital apk extension support
stopiccot <alexey.petruchik@gmail.com>
parents: 8695
diff changeset
   517
 
d931167c375a inital apk extension support
stopiccot <alexey.petruchik@gmail.com>
parents: 8695
diff changeset
   518
/**
d931167c375a inital apk extension support
stopiccot <alexey.petruchik@gmail.com>
parents: 8695
diff changeset
   519
 * \brief Android APK expansion patch file version. Should be a string number like "1", "2" etc.
d931167c375a inital apk extension support
stopiccot <alexey.petruchik@gmail.com>
parents: 8695
diff changeset
   520
 */
8897
fff9c0b9f1fb Fixing issues discovered by Philipp Wiesemann
stopiccot <alexey.petruchik@gmail.com>
parents: 8896
diff changeset
   521
#define SDL_HINT_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION "SDL_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION"
8896
d931167c375a inital apk extension support
stopiccot <alexey.petruchik@gmail.com>
parents: 8695
diff changeset
   522
9097
56d712662a82 Add a SDL_IM_INTERNAL_EDITING event to make IMs like iBus render editing text in its own UI instead of sending TEXTEDITING events.
Alex Baines <alex@abaines.me.uk>
parents: 8920
diff changeset
   523
/**
9118
8eeb0d759bc3 Corrected hint documentation.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9098
diff changeset
   524
 * \brief A variable to control whether certain IMEs should handle text editing internally instead of sending SDL_TEXTEDITING events.
9097
56d712662a82 Add a SDL_IM_INTERNAL_EDITING event to make IMs like iBus render editing text in its own UI instead of sending TEXTEDITING events.
Alex Baines <alex@abaines.me.uk>
parents: 8920
diff changeset
   525
 *
56d712662a82 Add a SDL_IM_INTERNAL_EDITING event to make IMs like iBus render editing text in its own UI instead of sending TEXTEDITING events.
Alex Baines <alex@abaines.me.uk>
parents: 8920
diff changeset
   526
 * The variable can be set to the following values:
9118
8eeb0d759bc3 Corrected hint documentation.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9098
diff changeset
   527
 *   "0"       - SDL_TEXTEDITING events are sent, and it is the application's
9097
56d712662a82 Add a SDL_IM_INTERNAL_EDITING event to make IMs like iBus render editing text in its own UI instead of sending TEXTEDITING events.
Alex Baines <alex@abaines.me.uk>
parents: 8920
diff changeset
   528
 *               responsibility to render the text from these events and 
56d712662a82 Add a SDL_IM_INTERNAL_EDITING event to make IMs like iBus render editing text in its own UI instead of sending TEXTEDITING events.
Alex Baines <alex@abaines.me.uk>
parents: 8920
diff changeset
   529
 *               differentiate it somehow from committed text. (default)
9118
8eeb0d759bc3 Corrected hint documentation.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 9098
diff changeset
   530
 *   "1"       - If supported by the IME then SDL_TEXTEDITING events are not sent, 
9097
56d712662a82 Add a SDL_IM_INTERNAL_EDITING event to make IMs like iBus render editing text in its own UI instead of sending TEXTEDITING events.
Alex Baines <alex@abaines.me.uk>
parents: 8920
diff changeset
   531
 *               and text that is being composed will be rendered in its own UI.
56d712662a82 Add a SDL_IM_INTERNAL_EDITING event to make IMs like iBus render editing text in its own UI instead of sending TEXTEDITING events.
Alex Baines <alex@abaines.me.uk>
parents: 8920
diff changeset
   532
 */
9098
064ea0b1275c Changed the name of the IME hint to match the naming convention in SDL
Sam Lantinga <slouken@libsdl.org>
parents: 9097
diff changeset
   533
#define SDL_HINT_IME_INTERNAL_EDITING "SDL_IME_INTERNAL_EDITING"
8295
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   534
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   535
/**
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   536
 *  \brief  An enumeration of hint priorities
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   537
 */
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   538
typedef enum
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   539
{
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   540
    SDL_HINT_DEFAULT,
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   541
    SDL_HINT_NORMAL,
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   542
    SDL_HINT_OVERRIDE
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   543
} SDL_HintPriority;
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   544
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   545
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   546
/**
5200
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   547
 *  \brief Set a hint with a specific priority
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   548
 *
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   549
 *  The priority controls the behavior when setting a hint that already
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   550
 *  has a value.  Hints will replace existing hints of their priority and
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   551
 *  lower.  Environment variables are considered to have override priority.
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 6990
diff changeset
   552
 *
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   553
 *  \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   554
 */
5200
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   555
extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name,
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   556
                                                         const char *value,
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   557
                                                         SDL_HintPriority priority);
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   558
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   559
/**
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   560
 *  \brief Set a hint with normal priority
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 6990
diff changeset
   561
 *
5200
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   562
 *  \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   563
 */
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   564
extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name,
5200
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   565
                                             const char *value);
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   566
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   567
/**
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   568
 *  \brief Get a hint
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 6990
diff changeset
   569
 *
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   570
 *  \return The string value of a hint variable.
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   571
 */
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   572
extern DECLSPEC const char * SDLCALL SDL_GetHint(const char *name);
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   573
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   574
/**
7432
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   575
 *  \brief Add a function to watch a particular hint
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   576
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   577
 *  \param name The hint to watch
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   578
 *  \param callback The function to call when the hint value changes
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   579
 *  \param userdata A pointer to pass to the callback function
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   580
 */
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   581
typedef void (*SDL_HintCallback)(void *userdata, const char *name, const char *oldValue, const char *newValue);
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   582
extern DECLSPEC void SDLCALL SDL_AddHintCallback(const char *name,
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   583
                                                 SDL_HintCallback callback,
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   584
                                                 void *userdata);
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   585
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   586
/**
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   587
 *  \brief Remove a function watching a particular hint
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   588
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   589
 *  \param name The hint being watched
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   590
 *  \param callback The function being called when the hint value changes
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   591
 *  \param userdata A pointer being passed to the callback function
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   592
 */
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   593
extern DECLSPEC void SDLCALL SDL_DelHintCallback(const char *name,
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   594
                                                 SDL_HintCallback callback,
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   595
                                                 void *userdata);
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   596
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   597
/**
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   598
 *  \brief  Clear all hints
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   599
 *
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   600
 *  This function is called during SDL_Quit() to free stored hints.
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   601
 */
5272
3c94c559f5c2 changeset: 5272:cb08ef104ac4
Sam Lantinga <slouken@libsdl.org>
parents: 5262
diff changeset
   602
extern DECLSPEC void SDLCALL SDL_ClearHints(void);
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   603
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   604
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   605
/* Ends C function definitions when using C++ */
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   606
#ifdef __cplusplus
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   607
}
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   608
#endif
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   609
#include "close_code.h"
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   610
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   611
#endif /* _SDL_hints_h */
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   612
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   613
/* vi: set ts=4 sw=4 expandtab: */