include/SDL_hints.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 09 Mar 2014 11:36:47 -0700
changeset 8583 fb2933ca805f
parent 8295 56f7e38ff0bc
parent 8577 462760a8b82e
child 8691 41a55b86b980
permissions -rw-r--r--
Integrated David Ludwig's support for Windows RT
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
 */
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   119
#define SDL_HINT_RENDER_DIRECT3D11_DEBUG    "SDL_HINT_RENDER_DIRECT3D11_DEBUG"
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
/**
6662
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   189
 *  \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
   190
 *
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   191
 *  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
   192
 *    "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
   193
 *    "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
   194
 *
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   195
 *  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
   196
 */
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   197
#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
   198
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   199
/**
8071
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   200
*  \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
   201
*
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   202
*  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
   203
*    "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
   204
*    "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
   205
*
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   206
*  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
   207
*/
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   208
#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
   209
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   210
/**
1ac2db4abe11 Added a relative mouse mode that uses mouse warping instead of raw input.
Sam Lantinga <slouken@libsdl.org>
parents: 8021
diff changeset
   211
 *  \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
   212
 *
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   213
 */
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   214
#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
   215
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
   216
/**
5555
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   217
 *  \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
   218
 *
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   219
 *  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
   220
 *  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
   221
 *  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
   222
 *  hint.
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   223
 *
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   224
 *  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
   225
 *    "0"       - Enable idle timer
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   226
 *    "1"       - Disable idle timer
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   227
 */
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   228
#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
   229
5555
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   230
/**
5554
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   231
 *  \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
   232
 *
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   233
 *  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
   234
 *  which UI orientations are allowed.
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   235
 *
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   236
 *  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
   237
 *    "LandscapeLeft", "LandscapeRight", "Portrait" "PortraitUpsideDown"
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   238
 */
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   239
#define SDL_HINT_ORIENTATIONS "SDL_IOS_ORIENTATIONS"
7907
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   240
    
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   241
/**
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   242
 *  \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
   243
 *  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
   244
 *
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   245
 *  This variable can be set to the following values:
24b4e98c6010 Adds Joystick support for Android
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7764
diff changeset
   246
 *    "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
   247
 *    "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
   248
 */
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
   249
#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
   250
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   251
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   252
/**
6965
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   253
 *  \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
   254
 *
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   255
 *  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
   256
 *    "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
   257
 *    "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
   258
 */
6990
2514368c2aaf First shot at Windows XInput haptics.
Ryan C. Gordon <icculus@icculus.org>
parents: 6982
diff changeset
   259
#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
   260
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
   261
6965
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   262
/**
6690
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   263
 *  \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
   264
 *
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
   265
 *  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
   266
 *
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
   267
 *  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
   268
 *  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
   269
 */
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   270
#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
   271
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   272
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   273
/**
7279
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   274
 *  \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
   275
 *
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   276
 *  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
   277
 *    "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
   278
 *                application is in the background.
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   279
 *    "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
   280
 *                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
   281
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   282
 *  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
   283
 */
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   284
#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
   285
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   286
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   287
/**
6782
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   288
 *  \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
   289
 *      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
   290
 *
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   291
 *  This variable can be set to the following values:
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   292
 *    "0"       - don't allow topmost
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   293
 *    "1"       - allow topmost
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   294
 */
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   295
#define SDL_HINT_ALLOW_TOPMOST "SDL_ALLOW_TOPMOST"
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   296
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   297
7432
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   298
/**
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   299
 *  \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
   300
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   301
 *  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
   302
 *  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
   303
 *  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
   304
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   305
 *  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
   306
 *  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
   307
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   308
 *  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
   309
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   310
 *  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
   311
 */
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   312
#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
   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
7746
6a05d7352575 add in High DPI support (aka Retina)
Edward Rudd <urkle@outoforder.cc>
parents: 7577
diff changeset
   315
/**
6a05d7352575 add in High DPI support (aka Retina)
Edward Rudd <urkle@outoforder.cc>
parents: 7577
diff changeset
   316
 *  \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
   317
 */
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
   318
#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
   319
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
   320
/**
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
   321
 *  \brief A variable that determines whether ctrl+click should generate a right-click event 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
   322
 *  
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
   323
 *  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
   324
 *  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
   325
 */
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
   326
#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
   327
8021
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   328
/**
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   329
*  \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
   330
*
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   331
*  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
   332
*  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
   333
*  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
   334
*  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
   335
*
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   336
*  This variable can be set to the following values:
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   337
*    "d3dcompiler_46.dll" - default, best for Vista or later.
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   338
*    "d3dcompiler_43.dll" - for XP support.
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   339
*    "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
   340
*
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   341
*/
f96e12e0ade9 OpenGL ES support for Windows
Gabriel Jacobo <gabomdq@gmail.com>
parents: 7968
diff changeset
   342
#define SDL_HINT_VIDEO_WIN_D3DCOMPILER              "SDL_VIDEO_WIN_D3DCOMPILER"
6782
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   343
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   344
/**
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
   345
*  \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
   346
*  
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
   347
*  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
   348
*  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
   349
*  created SDL_Window:
8583
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   350
*
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
   351
*  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
   352
*  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
   353
*
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
   354
*  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
   355
*  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
   356
*
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
   357
*  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
   358
*    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
   359
*    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
   360
*/
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
   361
#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
   362
8583
fb2933ca805f Integrated David Ludwig's support for Windows RT
Sam Lantinga <slouken@libsdl.org>
parents: 8295 8577
diff changeset
   363
/*
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
   364
 *  \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
   365
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   366
 *  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
   367
 *  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
   368
 *  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
   369
 *  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
   370
 *  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
   371
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   372
 *  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
   373
 *  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
   374
 *  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
   375
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   376
 *  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
   377
 *  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
   378
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   379
 *  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
   380
 *  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
   381
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   382
 *  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
   383
 *  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
   384
 *  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
   385
 *  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
   386
 */
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   387
#define SDL_HINT_WINRT_PRIVACY_POLICY_URL "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
   388
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   389
/** \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
   390
 *
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   391
 *  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
   392
 *  Microsoft mandates that this policy be available via the Windows Settings charm.
8dd593afe2d7 WinRT: added a means to display a privacy policy link via the Settings charm
David Ludwig <dludwig@pobox.com>
parents: 8543
diff changeset
   393
 *  SDL provides code to add a link there, with it's label text being set via 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
   394
 *  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
   395
 *
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
 *  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
   397
 *  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
   398
 *  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
   399
 *
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
 *  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
   401
 *
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
 *  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
   403
 *  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
   404
 *
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
 *  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
   406
 *  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
   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
#define SDL_HINT_WINRT_PRIVACY_POLICY_LABEL "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
   409
8577
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   410
/** \brief If set to 1, back button press events on Windows Phone 8+ will be marked as handled.
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   411
 *
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   412
 *  TODO, WinRT: document SDL_HINT_WINRT_HANDLE_BACK_BUTTON need and use
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   413
 *  For now, more details on why this is needed can be found at the
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   414
 *  beginning of the following web page:
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   415
 *  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
   416
 */
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   417
#define SDL_HINT_WINRT_HANDLE_BACK_BUTTON "SDL_HINT_WINRT_HANDLE_BACK_BUTTON"
462760a8b82e WinRT: simulate keyboard events on Windows Phone 8 back-button presses
David Ludwig <dludwig@pobox.com>
parents: 8576
diff changeset
   418
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
   419
/**
8295
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   420
 *  \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
   421
 *
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   422
 *  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
   423
 *
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   424
 *  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
   425
 *    "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
   426
 *                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
   427
 *                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
   428
 *    "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
   429
 *                SDL_WINDOW_RESIZABLE windows will 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
   430
 *                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
   431
 *
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   432
 *  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
   433
 *   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
   434
 *   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
   435
 */
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   436
#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
   437
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   438
56f7e38ff0bc Mac: Added a hint to opt-out of new Spaces code.
Ryan C. Gordon <icculus@icculus.org>
parents: 8284
diff changeset
   439
/**
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   440
 *  \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
   441
 */
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   442
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
   443
{
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   444
    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
   445
    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
   446
    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
   447
} 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
   448
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   449
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   450
/**
5200
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   451
 *  \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
   452
 *
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   453
 *  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
   454
 *  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
   455
 *  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
   456
 *
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   457
 *  \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
   458
 */
5200
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   459
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
   460
                                                         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
   461
                                                         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
   462
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   463
/**
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   464
 *  \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
   465
 *
5200
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   466
 *  \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
   467
 */
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   468
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
   469
                                             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
   470
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   471
/**
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   472
 *  \brief Get a hint
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 6990
diff changeset
   473
 *
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   474
 *  \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
   475
 */
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   476
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
   477
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   478
/**
7432
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   479
 *  \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
   480
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   481
 *  \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
   482
 *  \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
   483
 *  \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
   484
 */
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   485
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
   486
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
   487
                                                 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
   488
                                                 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
   489
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   490
/**
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   491
 *  \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
   492
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   493
 *  \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
   494
 *  \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
   495
 *  \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
   496
 */
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   497
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
   498
                                                 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
   499
                                                 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
   500
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   501
/**
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   502
 *  \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
   503
 *
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   504
 *  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
   505
 */
5272
3c94c559f5c2 changeset: 5272:cb08ef104ac4
Sam Lantinga <slouken@libsdl.org>
parents: 5262
diff changeset
   506
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
   507
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   508
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   509
/* 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
   510
#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
   511
}
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   512
#endif
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   513
#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
   514
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   515
#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
   516
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   517
/* vi: set ts=4 sw=4 expandtab: */