2 Simple DirectMedia Layer
3 Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
25 * Official documentation for SDL configuration variables
27 * This file contains functions to set and get configuration hints,
28 * as well as listing each of them alphabetically.
30 * The convention for naming hints is SDL_HINT_X, where "SDL_X" is
31 * the environment variable that can be used to override the default.
33 * In general these hints are just that - they may or may not be
34 * supported or applicable on any given platform, but they provide
35 * a way for an application or user to give the library a hint as
36 * to how they would like the library to work.
42 #include "SDL_stdinc.h"
44 #include "begin_code.h"
45 /* Set up for C function definitions, even when using C++ */
53 * \brief A variable controlling how 3D acceleration is used to accelerate the SDL 1.2 screen surface.
55 * SDL can try to accelerate the SDL 1.2 screen surface by using streaming
56 * textures with a 3D rendering engine. This variable controls whether and
59 * This variable can be set to the following values:
60 * "0" - Disable 3D acceleration
61 * "1" - Enable 3D acceleration, using the default renderer.
62 * "X" - Enable 3D acceleration, using X where X is one of the valid rendering drivers. (e.g. "direct3d", "opengl", etc.)
64 * By default SDL tries to make a best guess for each platform whether
65 * to use acceleration or not.
67 #define SDL_HINT_FRAMEBUFFER_ACCELERATION "SDL_FRAMEBUFFER_ACCELERATION"
70 * \brief A variable specifying which render driver to use.
72 * If the application doesn't pick a specific renderer to use, this variable
73 * specifies the name of the preferred renderer. If the preferred renderer
74 * can't be initialized, the normal default renderer is used.
76 * This variable is case insensitive and can be set to the following values:
83 * The default varies by platform, but it's the first one in the list that
84 * is available on the current platform.
86 #define SDL_HINT_RENDER_DRIVER "SDL_RENDER_DRIVER"
89 * \brief A variable controlling whether the OpenGL render driver uses shaders if they are available.
91 * This variable can be set to the following values:
92 * "0" - Disable shaders
93 * "1" - Enable shaders
95 * By default shaders are used if OpenGL supports them.
97 #define SDL_HINT_RENDER_OPENGL_SHADERS "SDL_RENDER_OPENGL_SHADERS"
100 * \brief A variable controlling the scaling quality
102 * This variable can be set to the following values:
103 * "0" or "nearest" - Nearest pixel sampling
104 * "1" or "linear" - Linear filtering (supported by OpenGL and Direct3D)
105 * "2" or "best" - Anisotropic filtering (supported by Direct3D)
107 * By default nearest pixel sampling is used
109 #define SDL_HINT_RENDER_SCALE_QUALITY "SDL_RENDER_SCALE_QUALITY"
112 * \brief A variable controlling whether updates to the SDL 1.2 screen surface should be synchronized with the vertical refresh, to avoid tearing.
114 * This variable can be set to the following values:
115 * "0" - Disable vsync
118 * By default SDL does not sync screen surface updates with vertical refresh.
120 #define SDL_HINT_RENDER_VSYNC "SDL_RENDER_VSYNC"
123 * \brief A variable controlling whether the idle timer is disabled on iOS.
125 * When an iOS app does not receive touches for some time, the screen is
126 * dimmed automatically. For games where the accelerometer is the only input
127 * this is problematic. This functionality can be disabled by setting this
130 * This variable can be set to the following values:
131 * "0" - Enable idle timer
132 * "1" - Disable idle timer
134 #define SDL_HINT_IDLE_TIMER_DISABLED "SDL_IOS_IDLE_TIMER_DISABLED"
137 * \brief A variable controlling which orientations are allowed on iOS.
139 * In some circumstances it is necessary to be able to explicitly control
140 * which UI orientations are allowed.
142 * This variable is a space delimited list of the following values:
143 * "LandscapeLeft", "LandscapeRight", "Portrait" "PortraitUpsideDown"
145 #define SDL_HINT_ORIENTATIONS "SDL_IOS_ORIENTATIONS"
149 * \brief An enumeration of hint priorities
160 * \brief Set a hint with a specific priority
162 * The priority controls the behavior when setting a hint that already
163 * has a value. Hints will replace existing hints of their priority and
164 * lower. Environment variables are considered to have override priority.
166 * \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
168 extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name,
170 SDL_HintPriority priority);
173 * \brief Set a hint with normal priority
175 * \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
177 extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name,
184 * \return The string value of a hint variable.
186 extern DECLSPEC const char * SDLCALL SDL_GetHint(const char *name);
189 * \brief Clear all hints
191 * This function is called during SDL_Quit() to free stored hints.
193 extern DECLSPEC void SDLCALL SDL_ClearHints(void);
196 /* Ends C function definitions when using C++ */
202 #include "close_code.h"
204 #endif /* _SDL_hints_h */
206 /* vi: set ts=4 sw=4 expandtab: */