SDL Library
SDL_hints.h@0:7fb6877b5d7c, 2016-09-22 (annotated)
- Committer:
- miruga27
- Date:
- Thu Sep 22 00:03:09 2016 +0000
- Revision:
- 0:7fb6877b5d7c
SDL
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
miruga27 | 0:7fb6877b5d7c | 1 | /* |
miruga27 | 0:7fb6877b5d7c | 2 | Simple DirectMedia Layer |
miruga27 | 0:7fb6877b5d7c | 3 | Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org> |
miruga27 | 0:7fb6877b5d7c | 4 | |
miruga27 | 0:7fb6877b5d7c | 5 | This software is provided 'as-is', without any express or implied |
miruga27 | 0:7fb6877b5d7c | 6 | warranty. In no event will the authors be held liable for any damages |
miruga27 | 0:7fb6877b5d7c | 7 | arising from the use of this software. |
miruga27 | 0:7fb6877b5d7c | 8 | |
miruga27 | 0:7fb6877b5d7c | 9 | Permission is granted to anyone to use this software for any purpose, |
miruga27 | 0:7fb6877b5d7c | 10 | including commercial applications, and to alter it and redistribute it |
miruga27 | 0:7fb6877b5d7c | 11 | freely, subject to the following restrictions: |
miruga27 | 0:7fb6877b5d7c | 12 | |
miruga27 | 0:7fb6877b5d7c | 13 | 1. The origin of this software must not be misrepresented; you must not |
miruga27 | 0:7fb6877b5d7c | 14 | claim that you wrote the original software. If you use this software |
miruga27 | 0:7fb6877b5d7c | 15 | in a product, an acknowledgment in the product documentation would be |
miruga27 | 0:7fb6877b5d7c | 16 | appreciated but is not required. |
miruga27 | 0:7fb6877b5d7c | 17 | 2. Altered source versions must be plainly marked as such, and must not be |
miruga27 | 0:7fb6877b5d7c | 18 | misrepresented as being the original software. |
miruga27 | 0:7fb6877b5d7c | 19 | 3. This notice may not be removed or altered from any source distribution. |
miruga27 | 0:7fb6877b5d7c | 20 | */ |
miruga27 | 0:7fb6877b5d7c | 21 | |
miruga27 | 0:7fb6877b5d7c | 22 | /** |
miruga27 | 0:7fb6877b5d7c | 23 | * \file SDL_hints.h |
miruga27 | 0:7fb6877b5d7c | 24 | * |
miruga27 | 0:7fb6877b5d7c | 25 | * Official documentation for SDL configuration variables |
miruga27 | 0:7fb6877b5d7c | 26 | * |
miruga27 | 0:7fb6877b5d7c | 27 | * This file contains functions to set and get configuration hints, |
miruga27 | 0:7fb6877b5d7c | 28 | * as well as listing each of them alphabetically. |
miruga27 | 0:7fb6877b5d7c | 29 | * |
miruga27 | 0:7fb6877b5d7c | 30 | * The convention for naming hints is SDL_HINT_X, where "SDL_X" is |
miruga27 | 0:7fb6877b5d7c | 31 | * the environment variable that can be used to override the default. |
miruga27 | 0:7fb6877b5d7c | 32 | * |
miruga27 | 0:7fb6877b5d7c | 33 | * In general these hints are just that - they may or may not be |
miruga27 | 0:7fb6877b5d7c | 34 | * supported or applicable on any given platform, but they provide |
miruga27 | 0:7fb6877b5d7c | 35 | * a way for an application or user to give the library a hint as |
miruga27 | 0:7fb6877b5d7c | 36 | * to how they would like the library to work. |
miruga27 | 0:7fb6877b5d7c | 37 | */ |
miruga27 | 0:7fb6877b5d7c | 38 | |
miruga27 | 0:7fb6877b5d7c | 39 | #ifndef _SDL_hints_h |
miruga27 | 0:7fb6877b5d7c | 40 | #define _SDL_hints_h |
miruga27 | 0:7fb6877b5d7c | 41 | |
miruga27 | 0:7fb6877b5d7c | 42 | #include "SDL_stdinc.h" |
miruga27 | 0:7fb6877b5d7c | 43 | |
miruga27 | 0:7fb6877b5d7c | 44 | #include "begin_code.h" |
miruga27 | 0:7fb6877b5d7c | 45 | /* Set up for C function definitions, even when using C++ */ |
miruga27 | 0:7fb6877b5d7c | 46 | #ifdef __cplusplus |
miruga27 | 0:7fb6877b5d7c | 47 | extern "C" { |
miruga27 | 0:7fb6877b5d7c | 48 | #endif |
miruga27 | 0:7fb6877b5d7c | 49 | |
miruga27 | 0:7fb6877b5d7c | 50 | /** |
miruga27 | 0:7fb6877b5d7c | 51 | * \brief A variable controlling how 3D acceleration is used to accelerate the SDL screen surface. |
miruga27 | 0:7fb6877b5d7c | 52 | * |
miruga27 | 0:7fb6877b5d7c | 53 | * SDL can try to accelerate the SDL screen surface by using streaming |
miruga27 | 0:7fb6877b5d7c | 54 | * textures with a 3D rendering engine. This variable controls whether and |
miruga27 | 0:7fb6877b5d7c | 55 | * how this is done. |
miruga27 | 0:7fb6877b5d7c | 56 | * |
miruga27 | 0:7fb6877b5d7c | 57 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 58 | * "0" - Disable 3D acceleration |
miruga27 | 0:7fb6877b5d7c | 59 | * "1" - Enable 3D acceleration, using the default renderer. |
miruga27 | 0:7fb6877b5d7c | 60 | * "X" - Enable 3D acceleration, using X where X is one of the valid rendering drivers. (e.g. "direct3d", "opengl", etc.) |
miruga27 | 0:7fb6877b5d7c | 61 | * |
miruga27 | 0:7fb6877b5d7c | 62 | * By default SDL tries to make a best guess for each platform whether |
miruga27 | 0:7fb6877b5d7c | 63 | * to use acceleration or not. |
miruga27 | 0:7fb6877b5d7c | 64 | */ |
miruga27 | 0:7fb6877b5d7c | 65 | #define SDL_HINT_FRAMEBUFFER_ACCELERATION "SDL_FRAMEBUFFER_ACCELERATION" |
miruga27 | 0:7fb6877b5d7c | 66 | |
miruga27 | 0:7fb6877b5d7c | 67 | /** |
miruga27 | 0:7fb6877b5d7c | 68 | * \brief A variable specifying which render driver to use. |
miruga27 | 0:7fb6877b5d7c | 69 | * |
miruga27 | 0:7fb6877b5d7c | 70 | * If the application doesn't pick a specific renderer to use, this variable |
miruga27 | 0:7fb6877b5d7c | 71 | * specifies the name of the preferred renderer. If the preferred renderer |
miruga27 | 0:7fb6877b5d7c | 72 | * can't be initialized, the normal default renderer is used. |
miruga27 | 0:7fb6877b5d7c | 73 | * |
miruga27 | 0:7fb6877b5d7c | 74 | * This variable is case insensitive and can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 75 | * "direct3d" |
miruga27 | 0:7fb6877b5d7c | 76 | * "opengl" |
miruga27 | 0:7fb6877b5d7c | 77 | * "opengles2" |
miruga27 | 0:7fb6877b5d7c | 78 | * "opengles" |
miruga27 | 0:7fb6877b5d7c | 79 | * "software" |
miruga27 | 0:7fb6877b5d7c | 80 | * |
miruga27 | 0:7fb6877b5d7c | 81 | * The default varies by platform, but it's the first one in the list that |
miruga27 | 0:7fb6877b5d7c | 82 | * is available on the current platform. |
miruga27 | 0:7fb6877b5d7c | 83 | */ |
miruga27 | 0:7fb6877b5d7c | 84 | #define SDL_HINT_RENDER_DRIVER "SDL_RENDER_DRIVER" |
miruga27 | 0:7fb6877b5d7c | 85 | |
miruga27 | 0:7fb6877b5d7c | 86 | /** |
miruga27 | 0:7fb6877b5d7c | 87 | * \brief A variable controlling whether the OpenGL render driver uses shaders if they are available. |
miruga27 | 0:7fb6877b5d7c | 88 | * |
miruga27 | 0:7fb6877b5d7c | 89 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 90 | * "0" - Disable shaders |
miruga27 | 0:7fb6877b5d7c | 91 | * "1" - Enable shaders |
miruga27 | 0:7fb6877b5d7c | 92 | * |
miruga27 | 0:7fb6877b5d7c | 93 | * By default shaders are used if OpenGL supports them. |
miruga27 | 0:7fb6877b5d7c | 94 | */ |
miruga27 | 0:7fb6877b5d7c | 95 | #define SDL_HINT_RENDER_OPENGL_SHADERS "SDL_RENDER_OPENGL_SHADERS" |
miruga27 | 0:7fb6877b5d7c | 96 | |
miruga27 | 0:7fb6877b5d7c | 97 | /** |
miruga27 | 0:7fb6877b5d7c | 98 | * \brief A variable controlling whether the Direct3D device is initialized for thread-safe operations. |
miruga27 | 0:7fb6877b5d7c | 99 | * |
miruga27 | 0:7fb6877b5d7c | 100 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 101 | * "0" - Thread-safety is not enabled (faster) |
miruga27 | 0:7fb6877b5d7c | 102 | * "1" - Thread-safety is enabled |
miruga27 | 0:7fb6877b5d7c | 103 | * |
miruga27 | 0:7fb6877b5d7c | 104 | * By default the Direct3D device is created with thread-safety disabled. |
miruga27 | 0:7fb6877b5d7c | 105 | */ |
miruga27 | 0:7fb6877b5d7c | 106 | #define SDL_HINT_RENDER_DIRECT3D_THREADSAFE "SDL_RENDER_DIRECT3D_THREADSAFE" |
miruga27 | 0:7fb6877b5d7c | 107 | |
miruga27 | 0:7fb6877b5d7c | 108 | /** |
miruga27 | 0:7fb6877b5d7c | 109 | * \brief A variable controlling the scaling quality |
miruga27 | 0:7fb6877b5d7c | 110 | * |
miruga27 | 0:7fb6877b5d7c | 111 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 112 | * "0" or "nearest" - Nearest pixel sampling |
miruga27 | 0:7fb6877b5d7c | 113 | * "1" or "linear" - Linear filtering (supported by OpenGL and Direct3D) |
miruga27 | 0:7fb6877b5d7c | 114 | * "2" or "best" - Currently this is the same as "linear" |
miruga27 | 0:7fb6877b5d7c | 115 | * |
miruga27 | 0:7fb6877b5d7c | 116 | * By default nearest pixel sampling is used |
miruga27 | 0:7fb6877b5d7c | 117 | */ |
miruga27 | 0:7fb6877b5d7c | 118 | #define SDL_HINT_RENDER_SCALE_QUALITY "SDL_RENDER_SCALE_QUALITY" |
miruga27 | 0:7fb6877b5d7c | 119 | |
miruga27 | 0:7fb6877b5d7c | 120 | /** |
miruga27 | 0:7fb6877b5d7c | 121 | * \brief A variable controlling whether updates to the SDL screen surface should be synchronized with the vertical refresh, to avoid tearing. |
miruga27 | 0:7fb6877b5d7c | 122 | * |
miruga27 | 0:7fb6877b5d7c | 123 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 124 | * "0" - Disable vsync |
miruga27 | 0:7fb6877b5d7c | 125 | * "1" - Enable vsync |
miruga27 | 0:7fb6877b5d7c | 126 | * |
miruga27 | 0:7fb6877b5d7c | 127 | * By default SDL does not sync screen surface updates with vertical refresh. |
miruga27 | 0:7fb6877b5d7c | 128 | */ |
miruga27 | 0:7fb6877b5d7c | 129 | #define SDL_HINT_RENDER_VSYNC "SDL_RENDER_VSYNC" |
miruga27 | 0:7fb6877b5d7c | 130 | |
miruga27 | 0:7fb6877b5d7c | 131 | /** |
miruga27 | 0:7fb6877b5d7c | 132 | * \brief A variable controlling whether the screensaver is enabled. |
miruga27 | 0:7fb6877b5d7c | 133 | * |
miruga27 | 0:7fb6877b5d7c | 134 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 135 | * "0" - Disable screensaver |
miruga27 | 0:7fb6877b5d7c | 136 | * "1" - Enable screensaver |
miruga27 | 0:7fb6877b5d7c | 137 | * |
miruga27 | 0:7fb6877b5d7c | 138 | * By default SDL will disable the screensaver. |
miruga27 | 0:7fb6877b5d7c | 139 | */ |
miruga27 | 0:7fb6877b5d7c | 140 | #define SDL_HINT_VIDEO_ALLOW_SCREENSAVER "SDL_VIDEO_ALLOW_SCREENSAVER" |
miruga27 | 0:7fb6877b5d7c | 141 | |
miruga27 | 0:7fb6877b5d7c | 142 | /** |
miruga27 | 0:7fb6877b5d7c | 143 | * \brief A variable controlling whether the X11 VidMode extension should be used. |
miruga27 | 0:7fb6877b5d7c | 144 | * |
miruga27 | 0:7fb6877b5d7c | 145 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 146 | * "0" - Disable XVidMode |
miruga27 | 0:7fb6877b5d7c | 147 | * "1" - Enable XVidMode |
miruga27 | 0:7fb6877b5d7c | 148 | * |
miruga27 | 0:7fb6877b5d7c | 149 | * By default SDL will use XVidMode if it is available. |
miruga27 | 0:7fb6877b5d7c | 150 | */ |
miruga27 | 0:7fb6877b5d7c | 151 | #define SDL_HINT_VIDEO_X11_XVIDMODE "SDL_VIDEO_X11_XVIDMODE" |
miruga27 | 0:7fb6877b5d7c | 152 | |
miruga27 | 0:7fb6877b5d7c | 153 | /** |
miruga27 | 0:7fb6877b5d7c | 154 | * \brief A variable controlling whether the X11 Xinerama extension should be used. |
miruga27 | 0:7fb6877b5d7c | 155 | * |
miruga27 | 0:7fb6877b5d7c | 156 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 157 | * "0" - Disable Xinerama |
miruga27 | 0:7fb6877b5d7c | 158 | * "1" - Enable Xinerama |
miruga27 | 0:7fb6877b5d7c | 159 | * |
miruga27 | 0:7fb6877b5d7c | 160 | * By default SDL will use Xinerama if it is available. |
miruga27 | 0:7fb6877b5d7c | 161 | */ |
miruga27 | 0:7fb6877b5d7c | 162 | #define SDL_HINT_VIDEO_X11_XINERAMA "SDL_VIDEO_X11_XINERAMA" |
miruga27 | 0:7fb6877b5d7c | 163 | |
miruga27 | 0:7fb6877b5d7c | 164 | /** |
miruga27 | 0:7fb6877b5d7c | 165 | * \brief A variable controlling whether the X11 XRandR extension should be used. |
miruga27 | 0:7fb6877b5d7c | 166 | * |
miruga27 | 0:7fb6877b5d7c | 167 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 168 | * "0" - Disable XRandR |
miruga27 | 0:7fb6877b5d7c | 169 | * "1" - Enable XRandR |
miruga27 | 0:7fb6877b5d7c | 170 | * |
miruga27 | 0:7fb6877b5d7c | 171 | * By default SDL will not use XRandR because of window manager issues. |
miruga27 | 0:7fb6877b5d7c | 172 | */ |
miruga27 | 0:7fb6877b5d7c | 173 | #define SDL_HINT_VIDEO_X11_XRANDR "SDL_VIDEO_X11_XRANDR" |
miruga27 | 0:7fb6877b5d7c | 174 | |
miruga27 | 0:7fb6877b5d7c | 175 | /** |
miruga27 | 0:7fb6877b5d7c | 176 | * \brief A variable controlling whether grabbing input grabs the keyboard |
miruga27 | 0:7fb6877b5d7c | 177 | * |
miruga27 | 0:7fb6877b5d7c | 178 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 179 | * "0" - Grab will affect only the mouse |
miruga27 | 0:7fb6877b5d7c | 180 | * "1" - Grab will affect mouse and keyboard |
miruga27 | 0:7fb6877b5d7c | 181 | * |
miruga27 | 0:7fb6877b5d7c | 182 | * By default SDL will not grab the keyboard so system shortcuts still work. |
miruga27 | 0:7fb6877b5d7c | 183 | */ |
miruga27 | 0:7fb6877b5d7c | 184 | #define SDL_HINT_GRAB_KEYBOARD "SDL_GRAB_KEYBOARD" |
miruga27 | 0:7fb6877b5d7c | 185 | |
miruga27 | 0:7fb6877b5d7c | 186 | /** |
miruga27 | 0:7fb6877b5d7c | 187 | * \brief A variable controlling whether relative mouse mode is implemented using mouse warping |
miruga27 | 0:7fb6877b5d7c | 188 | * |
miruga27 | 0:7fb6877b5d7c | 189 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 190 | * "0" - Relative mouse mode uses raw input |
miruga27 | 0:7fb6877b5d7c | 191 | * "1" - Relative mouse mode uses mouse warping |
miruga27 | 0:7fb6877b5d7c | 192 | * |
miruga27 | 0:7fb6877b5d7c | 193 | * By default SDL will use raw input for relative mouse mode |
miruga27 | 0:7fb6877b5d7c | 194 | */ |
miruga27 | 0:7fb6877b5d7c | 195 | #define SDL_HINT_MOUSE_RELATIVE_MODE_WARP "SDL_MOUSE_RELATIVE_MODE_WARP" |
miruga27 | 0:7fb6877b5d7c | 196 | |
miruga27 | 0:7fb6877b5d7c | 197 | /** |
miruga27 | 0:7fb6877b5d7c | 198 | * \brief Minimize your SDL_Window if it loses key focus when in fullscreen mode. Defaults to true. |
miruga27 | 0:7fb6877b5d7c | 199 | * |
miruga27 | 0:7fb6877b5d7c | 200 | */ |
miruga27 | 0:7fb6877b5d7c | 201 | #define SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS "SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS" |
miruga27 | 0:7fb6877b5d7c | 202 | |
miruga27 | 0:7fb6877b5d7c | 203 | /** |
miruga27 | 0:7fb6877b5d7c | 204 | * \brief A variable controlling whether the idle timer is disabled on iOS. |
miruga27 | 0:7fb6877b5d7c | 205 | * |
miruga27 | 0:7fb6877b5d7c | 206 | * When an iOS app does not receive touches for some time, the screen is |
miruga27 | 0:7fb6877b5d7c | 207 | * dimmed automatically. For games where the accelerometer is the only input |
miruga27 | 0:7fb6877b5d7c | 208 | * this is problematic. This functionality can be disabled by setting this |
miruga27 | 0:7fb6877b5d7c | 209 | * hint. |
miruga27 | 0:7fb6877b5d7c | 210 | * |
miruga27 | 0:7fb6877b5d7c | 211 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 212 | * "0" - Enable idle timer |
miruga27 | 0:7fb6877b5d7c | 213 | * "1" - Disable idle timer |
miruga27 | 0:7fb6877b5d7c | 214 | */ |
miruga27 | 0:7fb6877b5d7c | 215 | #define SDL_HINT_IDLE_TIMER_DISABLED "SDL_IOS_IDLE_TIMER_DISABLED" |
miruga27 | 0:7fb6877b5d7c | 216 | |
miruga27 | 0:7fb6877b5d7c | 217 | /** |
miruga27 | 0:7fb6877b5d7c | 218 | * \brief A variable controlling which orientations are allowed on iOS. |
miruga27 | 0:7fb6877b5d7c | 219 | * |
miruga27 | 0:7fb6877b5d7c | 220 | * In some circumstances it is necessary to be able to explicitly control |
miruga27 | 0:7fb6877b5d7c | 221 | * which UI orientations are allowed. |
miruga27 | 0:7fb6877b5d7c | 222 | * |
miruga27 | 0:7fb6877b5d7c | 223 | * This variable is a space delimited list of the following values: |
miruga27 | 0:7fb6877b5d7c | 224 | * "LandscapeLeft", "LandscapeRight", "Portrait" "PortraitUpsideDown" |
miruga27 | 0:7fb6877b5d7c | 225 | */ |
miruga27 | 0:7fb6877b5d7c | 226 | #define SDL_HINT_ORIENTATIONS "SDL_IOS_ORIENTATIONS" |
miruga27 | 0:7fb6877b5d7c | 227 | |
miruga27 | 0:7fb6877b5d7c | 228 | /** |
miruga27 | 0:7fb6877b5d7c | 229 | * \brief A variable controlling whether an Android built-in accelerometer should be |
miruga27 | 0:7fb6877b5d7c | 230 | * listed as a joystick device, rather than listing actual joysticks only. |
miruga27 | 0:7fb6877b5d7c | 231 | * |
miruga27 | 0:7fb6877b5d7c | 232 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 233 | * "0" - List only real joysticks and accept input from them |
miruga27 | 0:7fb6877b5d7c | 234 | * "1" - List real joysticks along with the accelerometer as if it were a 3 axis joystick (the default). |
miruga27 | 0:7fb6877b5d7c | 235 | */ |
miruga27 | 0:7fb6877b5d7c | 236 | #define SDL_HINT_ACCELEROMETER_AS_JOYSTICK "SDL_ACCELEROMETER_AS_JOYSTICK" |
miruga27 | 0:7fb6877b5d7c | 237 | |
miruga27 | 0:7fb6877b5d7c | 238 | |
miruga27 | 0:7fb6877b5d7c | 239 | /** |
miruga27 | 0:7fb6877b5d7c | 240 | * \brief A variable that lets you disable the detection and use of Xinput gamepad devices |
miruga27 | 0:7fb6877b5d7c | 241 | * |
miruga27 | 0:7fb6877b5d7c | 242 | * The variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 243 | * "0" - Disable XInput detection (only uses direct input) |
miruga27 | 0:7fb6877b5d7c | 244 | * "1" - Enable XInput detection (the default) |
miruga27 | 0:7fb6877b5d7c | 245 | */ |
miruga27 | 0:7fb6877b5d7c | 246 | #define SDL_HINT_XINPUT_ENABLED "SDL_XINPUT_ENABLED" |
miruga27 | 0:7fb6877b5d7c | 247 | |
miruga27 | 0:7fb6877b5d7c | 248 | |
miruga27 | 0:7fb6877b5d7c | 249 | /** |
miruga27 | 0:7fb6877b5d7c | 250 | * \brief A variable that lets you manually hint extra gamecontroller db entries |
miruga27 | 0:7fb6877b5d7c | 251 | * |
miruga27 | 0:7fb6877b5d7c | 252 | * The variable should be newline delimited rows of gamecontroller config data, see SDL_gamecontroller.h |
miruga27 | 0:7fb6877b5d7c | 253 | * |
miruga27 | 0:7fb6877b5d7c | 254 | * This hint must be set before calling SDL_Init(SDL_INIT_GAMECONTROLLER) |
miruga27 | 0:7fb6877b5d7c | 255 | * You can update mappings after the system is initialized with SDL_GameControllerMappingForGUID() and SDL_GameControllerAddMapping() |
miruga27 | 0:7fb6877b5d7c | 256 | */ |
miruga27 | 0:7fb6877b5d7c | 257 | #define SDL_HINT_GAMECONTROLLERCONFIG "SDL_GAMECONTROLLERCONFIG" |
miruga27 | 0:7fb6877b5d7c | 258 | |
miruga27 | 0:7fb6877b5d7c | 259 | |
miruga27 | 0:7fb6877b5d7c | 260 | /** |
miruga27 | 0:7fb6877b5d7c | 261 | * \brief A variable that lets you enable joystick (and gamecontroller) events even when your app is in the background. |
miruga27 | 0:7fb6877b5d7c | 262 | * |
miruga27 | 0:7fb6877b5d7c | 263 | * The variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 264 | * "0" - Disable joystick & gamecontroller input events when the |
miruga27 | 0:7fb6877b5d7c | 265 | * application is in the background. |
miruga27 | 0:7fb6877b5d7c | 266 | * "1" - Enable joystick & gamecontroller input events when the |
miruga27 | 0:7fb6877b5d7c | 267 | * application is in the background. |
miruga27 | 0:7fb6877b5d7c | 268 | * |
miruga27 | 0:7fb6877b5d7c | 269 | * The default value is "0". This hint may be set at any time. |
miruga27 | 0:7fb6877b5d7c | 270 | */ |
miruga27 | 0:7fb6877b5d7c | 271 | #define SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS "SDL_JOYSTICK_ALLOW_BACKGROUND_EVENTS" |
miruga27 | 0:7fb6877b5d7c | 272 | |
miruga27 | 0:7fb6877b5d7c | 273 | |
miruga27 | 0:7fb6877b5d7c | 274 | /** |
miruga27 | 0:7fb6877b5d7c | 275 | * \brief If set to 0 then never set the top most bit on a SDL Window, even if the video mode expects it. |
miruga27 | 0:7fb6877b5d7c | 276 | * This is a debugging aid for developers and not expected to be used by end users. The default is "1" |
miruga27 | 0:7fb6877b5d7c | 277 | * |
miruga27 | 0:7fb6877b5d7c | 278 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 279 | * "0" - don't allow topmost |
miruga27 | 0:7fb6877b5d7c | 280 | * "1" - allow topmost |
miruga27 | 0:7fb6877b5d7c | 281 | */ |
miruga27 | 0:7fb6877b5d7c | 282 | #define SDL_HINT_ALLOW_TOPMOST "SDL_ALLOW_TOPMOST" |
miruga27 | 0:7fb6877b5d7c | 283 | |
miruga27 | 0:7fb6877b5d7c | 284 | |
miruga27 | 0:7fb6877b5d7c | 285 | /** |
miruga27 | 0:7fb6877b5d7c | 286 | * \brief A variable that controls the timer resolution, in milliseconds. |
miruga27 | 0:7fb6877b5d7c | 287 | * |
miruga27 | 0:7fb6877b5d7c | 288 | * The higher resolution the timer, the more frequently the CPU services |
miruga27 | 0:7fb6877b5d7c | 289 | * timer interrupts, and the more precise delays are, but this takes up |
miruga27 | 0:7fb6877b5d7c | 290 | * power and CPU time. This hint is only used on Windows 7 and earlier. |
miruga27 | 0:7fb6877b5d7c | 291 | * |
miruga27 | 0:7fb6877b5d7c | 292 | * See this blog post for more information: |
miruga27 | 0:7fb6877b5d7c | 293 | * http://randomascii.wordpress.com/2013/07/08/windows-timer-resolution-megawatts-wasted/ |
miruga27 | 0:7fb6877b5d7c | 294 | * |
miruga27 | 0:7fb6877b5d7c | 295 | * If this variable is set to "0", the system timer resolution is not set. |
miruga27 | 0:7fb6877b5d7c | 296 | * |
miruga27 | 0:7fb6877b5d7c | 297 | * The default value is "1". This hint may be set at any time. |
miruga27 | 0:7fb6877b5d7c | 298 | */ |
miruga27 | 0:7fb6877b5d7c | 299 | #define SDL_HINT_TIMER_RESOLUTION "SDL_TIMER_RESOLUTION" |
miruga27 | 0:7fb6877b5d7c | 300 | |
miruga27 | 0:7fb6877b5d7c | 301 | |
miruga27 | 0:7fb6877b5d7c | 302 | /** |
miruga27 | 0:7fb6877b5d7c | 303 | * \brief If set to 1, then do not allow high-DPI windows. ("Retina" on Mac) |
miruga27 | 0:7fb6877b5d7c | 304 | */ |
miruga27 | 0:7fb6877b5d7c | 305 | #define SDL_HINT_VIDEO_HIGHDPI_DISABLED "SDL_VIDEO_HIGHDPI_DISABLED" |
miruga27 | 0:7fb6877b5d7c | 306 | |
miruga27 | 0:7fb6877b5d7c | 307 | /** |
miruga27 | 0:7fb6877b5d7c | 308 | * \brief A variable that determines whether ctrl+click should generate a right-click event on Mac |
miruga27 | 0:7fb6877b5d7c | 309 | * |
miruga27 | 0:7fb6877b5d7c | 310 | * If present, holding ctrl while left clicking will generate a right click |
miruga27 | 0:7fb6877b5d7c | 311 | * event when on Mac. |
miruga27 | 0:7fb6877b5d7c | 312 | */ |
miruga27 | 0:7fb6877b5d7c | 313 | #define SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK "SDL_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK" |
miruga27 | 0:7fb6877b5d7c | 314 | |
miruga27 | 0:7fb6877b5d7c | 315 | /** |
miruga27 | 0:7fb6877b5d7c | 316 | * \brief A variable specifying which shader compiler to preload when using the Chrome ANGLE binaries |
miruga27 | 0:7fb6877b5d7c | 317 | * |
miruga27 | 0:7fb6877b5d7c | 318 | * SDL has EGL and OpenGL ES2 support on Windows via the ANGLE project. It |
miruga27 | 0:7fb6877b5d7c | 319 | * can use two different sets of binaries, those compiled by the user from source |
miruga27 | 0:7fb6877b5d7c | 320 | * or those provided by the Chrome browser. In the later case, these binaries require |
miruga27 | 0:7fb6877b5d7c | 321 | * that SDL loads a DLL providing the shader compiler. |
miruga27 | 0:7fb6877b5d7c | 322 | * |
miruga27 | 0:7fb6877b5d7c | 323 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 324 | * "d3dcompiler_46.dll" - default, best for Vista or later. |
miruga27 | 0:7fb6877b5d7c | 325 | * "d3dcompiler_43.dll" - for XP support. |
miruga27 | 0:7fb6877b5d7c | 326 | * "none" - do not load any library, useful if you compiled ANGLE from source and included the compiler in your binaries. |
miruga27 | 0:7fb6877b5d7c | 327 | * |
miruga27 | 0:7fb6877b5d7c | 328 | */ |
miruga27 | 0:7fb6877b5d7c | 329 | #define SDL_HINT_VIDEO_WIN_D3DCOMPILER "SDL_VIDEO_WIN_D3DCOMPILER" |
miruga27 | 0:7fb6877b5d7c | 330 | |
miruga27 | 0:7fb6877b5d7c | 331 | /** |
miruga27 | 0:7fb6877b5d7c | 332 | * \brief A variable that is the address of another SDL_Window* (as a hex string formatted with "%p"). |
miruga27 | 0:7fb6877b5d7c | 333 | * |
miruga27 | 0:7fb6877b5d7c | 334 | * If this hint is set before SDL_CreateWindowFrom() and the SDL_Window* it is set to has |
miruga27 | 0:7fb6877b5d7c | 335 | * SDL_WINDOW_OPENGL set (and running on WGL only, currently), then two things will occur on the newly |
miruga27 | 0:7fb6877b5d7c | 336 | * created SDL_Window: |
miruga27 | 0:7fb6877b5d7c | 337 | |
miruga27 | 0:7fb6877b5d7c | 338 | * 1. Its pixel format will be set to the same pixel format as this SDL_Window. This is |
miruga27 | 0:7fb6877b5d7c | 339 | * needed for example when sharing an OpenGL context across multiple windows. |
miruga27 | 0:7fb6877b5d7c | 340 | * |
miruga27 | 0:7fb6877b5d7c | 341 | * 2. The flag SDL_WINDOW_OPENGL will be set on the new window so it can be used for |
miruga27 | 0:7fb6877b5d7c | 342 | * OpenGL rendering. |
miruga27 | 0:7fb6877b5d7c | 343 | * |
miruga27 | 0:7fb6877b5d7c | 344 | * This variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 345 | * The address (as a string "%p") of the SDL_Window* that new windows created with SDL_CreateWindowFrom() should |
miruga27 | 0:7fb6877b5d7c | 346 | * share a pixel format with. |
miruga27 | 0:7fb6877b5d7c | 347 | */ |
miruga27 | 0:7fb6877b5d7c | 348 | #define SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT "SDL_VIDEO_WINDOW_SHARE_PIXEL_FORMAT" |
miruga27 | 0:7fb6877b5d7c | 349 | |
miruga27 | 0:7fb6877b5d7c | 350 | /** |
miruga27 | 0:7fb6877b5d7c | 351 | * \brief A variable that dictates policy for fullscreen Spaces on Mac OS X. |
miruga27 | 0:7fb6877b5d7c | 352 | * |
miruga27 | 0:7fb6877b5d7c | 353 | * This hint only applies to Mac OS X. |
miruga27 | 0:7fb6877b5d7c | 354 | * |
miruga27 | 0:7fb6877b5d7c | 355 | * The variable can be set to the following values: |
miruga27 | 0:7fb6877b5d7c | 356 | * "0" - Disable Spaces support (FULLSCREEN_DESKTOP won't use them and |
miruga27 | 0:7fb6877b5d7c | 357 | * SDL_WINDOW_RESIZABLE windows won't offer the "fullscreen" |
miruga27 | 0:7fb6877b5d7c | 358 | * button on their titlebars). |
miruga27 | 0:7fb6877b5d7c | 359 | * "1" - Enable Spaces support (FULLSCREEN_DESKTOP will use them and |
miruga27 | 0:7fb6877b5d7c | 360 | * SDL_WINDOW_RESIZABLE windows will offer the "fullscreen" |
miruga27 | 0:7fb6877b5d7c | 361 | * button on their titlebars. |
miruga27 | 0:7fb6877b5d7c | 362 | * |
miruga27 | 0:7fb6877b5d7c | 363 | * The default value is "1". Spaces are disabled regardless of this hint if |
miruga27 | 0:7fb6877b5d7c | 364 | * the OS isn't at least Mac OS X Lion (10.7). This hint must be set before |
miruga27 | 0:7fb6877b5d7c | 365 | * any windows are created. |
miruga27 | 0:7fb6877b5d7c | 366 | */ |
miruga27 | 0:7fb6877b5d7c | 367 | #define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES "SDL_VIDEO_MAC_FULLSCREEN_SPACES" |
miruga27 | 0:7fb6877b5d7c | 368 | |
miruga27 | 0:7fb6877b5d7c | 369 | |
miruga27 | 0:7fb6877b5d7c | 370 | /** |
miruga27 | 0:7fb6877b5d7c | 371 | * \brief An enumeration of hint priorities |
miruga27 | 0:7fb6877b5d7c | 372 | */ |
miruga27 | 0:7fb6877b5d7c | 373 | typedef enum |
miruga27 | 0:7fb6877b5d7c | 374 | { |
miruga27 | 0:7fb6877b5d7c | 375 | SDL_HINT_DEFAULT, |
miruga27 | 0:7fb6877b5d7c | 376 | SDL_HINT_NORMAL, |
miruga27 | 0:7fb6877b5d7c | 377 | SDL_HINT_OVERRIDE |
miruga27 | 0:7fb6877b5d7c | 378 | } SDL_HintPriority; |
miruga27 | 0:7fb6877b5d7c | 379 | |
miruga27 | 0:7fb6877b5d7c | 380 | |
miruga27 | 0:7fb6877b5d7c | 381 | /** |
miruga27 | 0:7fb6877b5d7c | 382 | * \brief Set a hint with a specific priority |
miruga27 | 0:7fb6877b5d7c | 383 | * |
miruga27 | 0:7fb6877b5d7c | 384 | * The priority controls the behavior when setting a hint that already |
miruga27 | 0:7fb6877b5d7c | 385 | * has a value. Hints will replace existing hints of their priority and |
miruga27 | 0:7fb6877b5d7c | 386 | * lower. Environment variables are considered to have override priority. |
miruga27 | 0:7fb6877b5d7c | 387 | * |
miruga27 | 0:7fb6877b5d7c | 388 | * \return SDL_TRUE if the hint was set, SDL_FALSE otherwise |
miruga27 | 0:7fb6877b5d7c | 389 | */ |
miruga27 | 0:7fb6877b5d7c | 390 | extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name, |
miruga27 | 0:7fb6877b5d7c | 391 | const char *value, |
miruga27 | 0:7fb6877b5d7c | 392 | SDL_HintPriority priority); |
miruga27 | 0:7fb6877b5d7c | 393 | |
miruga27 | 0:7fb6877b5d7c | 394 | /** |
miruga27 | 0:7fb6877b5d7c | 395 | * \brief Set a hint with normal priority |
miruga27 | 0:7fb6877b5d7c | 396 | * |
miruga27 | 0:7fb6877b5d7c | 397 | * \return SDL_TRUE if the hint was set, SDL_FALSE otherwise |
miruga27 | 0:7fb6877b5d7c | 398 | */ |
miruga27 | 0:7fb6877b5d7c | 399 | extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name, |
miruga27 | 0:7fb6877b5d7c | 400 | const char *value); |
miruga27 | 0:7fb6877b5d7c | 401 | |
miruga27 | 0:7fb6877b5d7c | 402 | /** |
miruga27 | 0:7fb6877b5d7c | 403 | * \brief Get a hint |
miruga27 | 0:7fb6877b5d7c | 404 | * |
miruga27 | 0:7fb6877b5d7c | 405 | * \return The string value of a hint variable. |
miruga27 | 0:7fb6877b5d7c | 406 | */ |
miruga27 | 0:7fb6877b5d7c | 407 | extern DECLSPEC const char * SDLCALL SDL_GetHint(const char *name); |
miruga27 | 0:7fb6877b5d7c | 408 | |
miruga27 | 0:7fb6877b5d7c | 409 | /** |
miruga27 | 0:7fb6877b5d7c | 410 | * \brief Add a function to watch a particular hint |
miruga27 | 0:7fb6877b5d7c | 411 | * |
miruga27 | 0:7fb6877b5d7c | 412 | * \param name The hint to watch |
miruga27 | 0:7fb6877b5d7c | 413 | * \param callback The function to call when the hint value changes |
miruga27 | 0:7fb6877b5d7c | 414 | * \param userdata A pointer to pass to the callback function |
miruga27 | 0:7fb6877b5d7c | 415 | */ |
miruga27 | 0:7fb6877b5d7c | 416 | typedef void (*SDL_HintCallback)(void *userdata, const char *name, const char *oldValue, const char *newValue); |
miruga27 | 0:7fb6877b5d7c | 417 | extern DECLSPEC void SDLCALL SDL_AddHintCallback(const char *name, |
miruga27 | 0:7fb6877b5d7c | 418 | SDL_HintCallback callback, |
miruga27 | 0:7fb6877b5d7c | 419 | void *userdata); |
miruga27 | 0:7fb6877b5d7c | 420 | |
miruga27 | 0:7fb6877b5d7c | 421 | /** |
miruga27 | 0:7fb6877b5d7c | 422 | * \brief Remove a function watching a particular hint |
miruga27 | 0:7fb6877b5d7c | 423 | * |
miruga27 | 0:7fb6877b5d7c | 424 | * \param name The hint being watched |
miruga27 | 0:7fb6877b5d7c | 425 | * \param callback The function being called when the hint value changes |
miruga27 | 0:7fb6877b5d7c | 426 | * \param userdata A pointer being passed to the callback function |
miruga27 | 0:7fb6877b5d7c | 427 | */ |
miruga27 | 0:7fb6877b5d7c | 428 | extern DECLSPEC void SDLCALL SDL_DelHintCallback(const char *name, |
miruga27 | 0:7fb6877b5d7c | 429 | SDL_HintCallback callback, |
miruga27 | 0:7fb6877b5d7c | 430 | void *userdata); |
miruga27 | 0:7fb6877b5d7c | 431 | |
miruga27 | 0:7fb6877b5d7c | 432 | /** |
miruga27 | 0:7fb6877b5d7c | 433 | * \brief Clear all hints |
miruga27 | 0:7fb6877b5d7c | 434 | * |
miruga27 | 0:7fb6877b5d7c | 435 | * This function is called during SDL_Quit() to free stored hints. |
miruga27 | 0:7fb6877b5d7c | 436 | */ |
miruga27 | 0:7fb6877b5d7c | 437 | extern DECLSPEC void SDLCALL SDL_ClearHints(void); |
miruga27 | 0:7fb6877b5d7c | 438 | |
miruga27 | 0:7fb6877b5d7c | 439 | |
miruga27 | 0:7fb6877b5d7c | 440 | /* Ends C function definitions when using C++ */ |
miruga27 | 0:7fb6877b5d7c | 441 | #ifdef __cplusplus |
miruga27 | 0:7fb6877b5d7c | 442 | } |
miruga27 | 0:7fb6877b5d7c | 443 | #endif |
miruga27 | 0:7fb6877b5d7c | 444 | #include "close_code.h" |
miruga27 | 0:7fb6877b5d7c | 445 | |
miruga27 | 0:7fb6877b5d7c | 446 | #endif /* _SDL_hints_h */ |
miruga27 | 0:7fb6877b5d7c | 447 | |
miruga27 | 0:7fb6877b5d7c | 448 | /* vi: set ts=4 sw=4 expandtab: */ |