include/SDL_hints.h
author David Ludwig <dludwig@pobox.com>
Sun, 27 Oct 2013 23:19:35 -0400
changeset 8537 ea81cf5b6252
parent 8535 e8ee0708ef5c
child 8543 b9dd3cf38585
permissions -rw-r--r--
WinRT: spelling fix in SDL_hints.h
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
6885
700f1b25f77f Happy New Year!
Sam Lantinga <slouken@libsdl.org>
parents: 6782
diff changeset
     3
  Copyright (C) 1997-2013 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
/**
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
   109
 *  \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
   110
 *
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   111
 *  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
   112
 *    "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
   113
 *    "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
   114
 *    "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
   115
 *
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   116
 *  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
   117
 */
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   118
#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
   119
e20c93bc9122 Added the SDL_HINT_RENDER_SCALE_QUALITY hint, which defaults to nearest pixel sampling.
Sam Lantinga <slouken@libsdl.org>
parents: 5272
diff changeset
   120
/**
7328
bbfc72c803df Remove / update references to 1.2.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7279
diff changeset
   121
 *  \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
   122
 *
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   123
 *  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
   124
 *    "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
   125
 *    "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
   126
 *
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   127
 *  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
   128
 */
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   129
#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
   130
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
   131
/**
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
   132
 *  \brief  A variable controlling whether to enable Direct3D 11+'s Debug Layer.
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
   133
 *
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
   134
 *  This variable does not have any effect on the Direct3D 9 based renderer,
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
   135
 *  which is used in Win32-based (aka Windows Desktop) apps.
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
   136
 *
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
   137
 *  This variable can be set to the following values:
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
   138
 *    "0"       - Disable Debug Layer use
8537
ea81cf5b6252 WinRT: spelling fix in SDL_hints.h
David Ludwig <dludwig@pobox.com>
parents: 8535
diff changeset
   139
 *    "1"       - Enable Debug Layer use
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
   140
 *
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
   141
 *  By default, SDL does not use Direct3D Debug Layer.
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
   142
 */
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
   143
#define SDL_HINT_RENDER_DIRECT3D11_DEBUG    "SDL_HINT_RENDER_DIRECT3D11_DEBUG"
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
   144
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
   145
/**
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
   146
 *  \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
   147
 *
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
   148
 *  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
   149
 *    "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
   150
 *    "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
   151
 *
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
   152
 *  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
   153
 */
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
   154
#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
   155
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
/**
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
 *  \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
   158
 *
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
 *  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
   160
 *    "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
   161
 *    "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
   162
 *
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
 *  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
   164
 */
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
#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
   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
/**
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
 *  \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
   169
 *
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
 *  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
   171
 *    "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
   172
 *    "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
   173
 *
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
   174
 *  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
   175
 */
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
#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
   177
5554
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   178
/**
6662
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   179
 *  \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
   180
 *
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   181
 *  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
   182
 *    "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
   183
 *    "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
   184
 *
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   185
 *  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
   186
 */
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   187
#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
   188
698c2e533a7e SDL no longer grabs the keyboard by default on X11.
Sam Lantinga <slouken@libsdl.org>
parents: 6558
diff changeset
   189
/**
6755
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   190
 *  \brief Minimize your SDL_Window if it loses key focus when in Fullscreen mode. Defaults to true.
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   191
 *
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   192
 */
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   193
#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
   194
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 6990
diff changeset
   195
6755
af77e1a6faf0 Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6690
diff changeset
   196
/**
5555
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   197
 *  \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
   198
 *
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   199
 *  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
   200
 *  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
   201
 *  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
   202
 *  hint.
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   203
 *
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   204
 *  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
   205
 *    "0"       - Enable idle timer
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   206
 *    "1"       - Disable idle timer
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   207
 */
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   208
#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
   209
5555
3ecad5e5dbe4 * SDL_IOS_IDLE_TIMER_DISABLED hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5554
diff changeset
   210
/**
5554
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   211
 *  \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
   212
 *
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   213
 *  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
   214
 *  which UI orientations are allowed.
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   215
 *
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   216
 *  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
   217
 *    "LandscapeLeft", "LandscapeRight", "Portrait" "PortraitUpsideDown"
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   218
 */
4b4258be8699 * SDL_IOS_ORIENTATIONS hint
Tim Angus <tim@blackcompanystudios.co.uk>
parents: 5535
diff changeset
   219
#define SDL_HINT_ORIENTATIONS "SDL_IOS_ORIENTATIONS"
5192
ef5a61ea3202 Added the SDL_HINT_RENDER_DRIVER and SDL_HINT_RENDER_VSYNC hints.
Sam Lantinga <slouken@libsdl.org>
parents: 5190
diff changeset
   220
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   221
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   222
/**
6965
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   223
 *  \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
   224
 *
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   225
 *  The variable can be set to the following values:
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   226
 *    "0"       - Disable XInput timer (only uses direct input)
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   227
 *    "1"       - Enable XInput timer (the default)
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   228
 */
6990
2514368c2aaf First shot at Windows XInput haptics.
Ryan C. Gordon <icculus@icculus.org>
parents: 6982
diff changeset
   229
#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
   230
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
   231
6965
ab4bb4e99961 add hint to allow disabling the use of Xinput.
Edward Rudd <urkle@outoforder.cc>
parents: 6885
diff changeset
   232
/**
6690
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   233
 *  \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
   234
 *
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
   235
 *  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
   236
 *
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
   237
 *  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
   238
 *  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
   239
 */
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   240
#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
   241
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   242
9548c8a58103 Added hotplug joystick support and simplified game controller API, courtesy of Alfred Reynolds
Sam Lantinga <slouken@libsdl.org>
parents: 6662
diff changeset
   243
/**
7279
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   244
 *  \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
   245
 *
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   246
 *  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
   247
 *    "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
   248
 *                application is in the background.
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   249
 *    "1"       - Enable 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
   250
 *                application is in the backgroumd.
7432
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   251
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   252
 *  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
   253
 */
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   254
#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
   255
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   256
f7805b13b485 Joystick: Only send joy events when focused.
Jørgen P. Tjernø <jorgen@valvesoftware.com>
parents: 7191
diff changeset
   257
/**
6782
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   258
 *  \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
   259
 *      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
   260
 *
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   261
 *  This variable can be set to the following values:
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   262
 *    "0"       - don't allow topmost
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   263
 *    "1"       - allow topmost
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   264
 */
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   265
#define SDL_HINT_ALLOW_TOPMOST "SDL_ALLOW_TOPMOST"
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   266
582d35419e8a Improvements from Alfred:
Sam Lantinga <slouken@libsdl.org>
parents: 6755
diff changeset
   267
7432
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   268
/**
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   269
 *  \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
   270
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   271
 *  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
   272
 *  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
   273
 *  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
   274
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   275
 *  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
   276
 *  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
   277
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   278
 *  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
   279
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   280
 *  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
   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
#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
   283
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   284
7746
6a05d7352575 add in High DPI support (aka Retina)
Edward Rudd <urkle@outoforder.cc>
parents: 7577
diff changeset
   285
/**
6a05d7352575 add in High DPI support (aka Retina)
Edward Rudd <urkle@outoforder.cc>
parents: 7577
diff changeset
   286
 *  \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
   287
 */
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
   288
#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
   289
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
/**
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   292
 *  \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
   293
 */
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   294
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
   295
{
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   296
    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
   297
    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
   298
    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
   299
} 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
   300
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   301
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   302
/**
5200
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   303
 *  \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
   304
 *
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   305
 *  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
   306
 *  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
   307
 *  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
   308
 *
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   309
 *  \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
   310
 */
5200
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   311
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
   312
                                                         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
   313
                                                         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
   314
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   315
/**
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   316
 *  \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
   317
 *
5200
01bced9a4cc1 Created a simpler version of SDL_SetHint() that doesn't need a priority.
Sam Lantinga <slouken@libsdl.org>
parents: 5192
diff changeset
   318
 *  \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
   319
 */
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   320
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
   321
                                             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
   322
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   323
/**
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   324
 *  \brief Get a hint
7191
75360622e65f File style cleanup for the SDL 2.0 release
Sam Lantinga <slouken@libsdl.org>
parents: 6990
diff changeset
   325
 *
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   326
 *  \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
   327
 */
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   328
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
   329
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   330
/**
7432
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   331
 *  \brief 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
   332
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   333
 *  \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
   334
 *  \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
   335
 *  \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
   336
 */
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   337
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
   338
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
   339
                                                 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
   340
                                                 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
   341
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   342
/**
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   343
 *  \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
   344
 *
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   345
 *  \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
   346
 *  \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
   347
 *  \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
   348
 */
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   349
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
   350
                                                 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
   351
                                                 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
   352
58908b180ebd Added a hint to control the Windows timer resolution: SDL_HINT_TIMER_RESOLUTION
Sam Lantinga <slouken@libsdl.org>
parents: 7328
diff changeset
   353
/**
5189
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   354
 *  \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
   355
 *
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   356
 *  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
   357
 */
5272
3c94c559f5c2 changeset: 5272:cb08ef104ac4
Sam Lantinga <slouken@libsdl.org>
parents: 5262
diff changeset
   358
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
   359
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   360
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   361
/* 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
   362
#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
   363
}
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   364
#endif
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   365
#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
   366
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   367
#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
   368
6f6a9340fb93 Added a hint system to allow configuration hints to be specified by the application.
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
   369
/* vi: set ts=4 sw=4 expandtab: */