include/SDL_hints.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 08 Apr 2011 13:03:26 -0700
changeset 5535 96594ac5fd1a
parent 5484 e20c93bc9122
child 5554 4b4258be8699
permissions -rw-r--r--
SDL 1.3 is now under the zlib license.
slouken@5189
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@5535
     3
  Copyright (C) 1997-2011 Sam Lantinga <slouken@libsdl.org>
slouken@5189
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@5189
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@5189
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@5189
    20
*/
slouken@5189
    21
slouken@5189
    22
/**
slouken@5189
    23
 *  \file SDL_hints.h
slouken@5189
    24
 *  
slouken@5189
    25
 *  Official documentation for SDL configuration variables
slouken@5189
    26
 *
slouken@5189
    27
 *  This file contains functions to set and get configuration hints,
slouken@5189
    28
 *  as well as listing each of them alphabetically.
slouken@5189
    29
 *
slouken@5189
    30
 *  The convention for naming hints is SDL_HINT_X, where "SDL_X" is
slouken@5189
    31
 *  the environment variable that can be used to override the default.
slouken@5189
    32
 *
slouken@5189
    33
 *  In general these hints are just that - they may or may not be
slouken@5189
    34
 *  supported or applicable on any given platform, but they provide
slouken@5189
    35
 *  a way for an application or user to give the library a hint as
slouken@5189
    36
 *  to how they would like the library to work.
slouken@5189
    37
 */
slouken@5189
    38
slouken@5189
    39
#ifndef _SDL_hints_h
slouken@5189
    40
#define _SDL_hints_h
slouken@5189
    41
slouken@5189
    42
#include "SDL_stdinc.h"
slouken@5189
    43
slouken@5189
    44
#include "begin_code.h"
slouken@5189
    45
/* Set up for C function definitions, even when using C++ */
slouken@5189
    46
#ifdef __cplusplus
slouken@5189
    47
/* *INDENT-OFF* */
slouken@5189
    48
extern "C" {
slouken@5189
    49
/* *INDENT-ON* */
slouken@5189
    50
#endif
slouken@5189
    51
slouken@5190
    52
/**
slouken@5190
    53
 *  \brief  A variable controlling how 3D acceleration is used to accelerate the SDL 1.2 screen surface. 
slouken@5190
    54
 *
slouken@5190
    55
 *  SDL can try to accelerate the SDL 1.2 screen surface by using streaming
slouken@5190
    56
 *  textures with a 3D rendering engine.  This variable controls whether and
slouken@5190
    57
 *  how this is done.
slouken@5190
    58
 *
slouken@5190
    59
 *  This variable can be set to the following values:
slouken@5190
    60
 *    "0"       - Disable 3D acceleration
slouken@5190
    61
 *    "1"       - Enable 3D acceleration, using the default renderer.
slouken@5190
    62
 *    "X"       - Enable 3D acceleration, using X where X is one of the valid rendering drivers.  (e.g. "direct3d", "opengl", etc.)
slouken@5190
    63
 *
slouken@5190
    64
 *  By default SDL tries to make a best guess for each platform whether
slouken@5190
    65
 *  to use acceleration or not.
slouken@5190
    66
 */
slouken@5190
    67
#define SDL_HINT_FRAMEBUFFER_ACCELERATION   "SDL_FRAMEBUFFER_ACCELERATION"
slouken@5189
    68
slouken@5192
    69
/**
slouken@5192
    70
 *  \brief  A variable specifying which render driver to use.
slouken@5192
    71
 *
slouken@5192
    72
 *  If the application doesn't pick a specific renderer to use, this variable
slouken@5192
    73
 *  specifies the name of the preferred renderer.  If the preferred renderer
slouken@5192
    74
 *  can't be initialized, the normal default renderer is used.
slouken@5192
    75
 *
slouken@5192
    76
 *  This variable is case insensitive and can be set to the following values:
slouken@5192
    77
 *    "direct3d"
slouken@5192
    78
 *    "opengl"
slouken@5233
    79
 *    "opengles2"
slouken@5192
    80
 *    "opengles"
slouken@5192
    81
 *    "software"
slouken@5233
    82
 *
slouken@5233
    83
 *  The default varies by platform, but it's the first one in the list that
slouken@5233
    84
 *  is available on the current platform.
slouken@5192
    85
 */
slouken@5192
    86
#define SDL_HINT_RENDER_DRIVER              "SDL_RENDER_DRIVER"
slouken@5192
    87
slouken@5192
    88
/**
slouken@5233
    89
 *  \brief  A variable controlling whether the OpenGL render driver uses shaders if they are available.
slouken@5233
    90
 *
slouken@5233
    91
 *  This variable can be set to the following values:
slouken@5233
    92
 *    "0"       - Disable shaders
slouken@5233
    93
 *    "1"       - Enable shaders
slouken@5233
    94
 *
slouken@5233
    95
 *  By default shaders are used if OpenGL supports them.
slouken@5233
    96
 */
slouken@5233
    97
#define SDL_HINT_RENDER_OPENGL_SHADERS      "SDL_RENDER_OPENGL_SHADERS"
slouken@5233
    98
slouken@5233
    99
/**
slouken@5484
   100
 *  \brief  A variable controlling the scaling quality
slouken@5484
   101
 *
slouken@5484
   102
 *  This variable can be set to the following values:
slouken@5484
   103
 *    "0" or "nearest" - Nearest pixel sampling
slouken@5484
   104
 *    "1" or "linear"  - Linear filtering (supported by OpenGL and Direct3D)
slouken@5484
   105
 *    "2" or "best"    - Anisotropic filtering (supported by Direct3D)
slouken@5484
   106
 *
slouken@5484
   107
 *  By default nearest pixel sampling is used
slouken@5484
   108
 */
slouken@5484
   109
#define SDL_HINT_RENDER_SCALE_QUALITY       "SDL_RENDER_SCALE_QUALITY"
slouken@5484
   110
slouken@5484
   111
/**
slouken@5192
   112
 *  \brief  A variable controlling whether updates to the SDL 1.2 screen surface should be synchronized with the vertical refresh, to avoid tearing.
slouken@5192
   113
 *
slouken@5192
   114
 *  This variable can be set to the following values:
slouken@5192
   115
 *    "0"       - Disable vsync
slouken@5192
   116
 *    "1"       - Enable vsync
slouken@5192
   117
 *
slouken@5192
   118
 *  By default SDL does not sync screen surface updates with vertical refresh.
slouken@5192
   119
 */
slouken@5192
   120
#define SDL_HINT_RENDER_VSYNC               "SDL_RENDER_VSYNC"
slouken@5192
   121
slouken@5189
   122
slouken@5189
   123
/**
slouken@5189
   124
 *  \brief  An enumeration of hint priorities
slouken@5189
   125
 */
slouken@5189
   126
typedef enum
slouken@5189
   127
{
slouken@5189
   128
    SDL_HINT_DEFAULT,
slouken@5189
   129
    SDL_HINT_NORMAL,
slouken@5189
   130
    SDL_HINT_OVERRIDE
slouken@5189
   131
} SDL_HintPriority;
slouken@5189
   132
slouken@5189
   133
slouken@5189
   134
/**
slouken@5200
   135
 *  \brief Set a hint with a specific priority
slouken@5189
   136
 *
slouken@5189
   137
 *  The priority controls the behavior when setting a hint that already
slouken@5189
   138
 *  has a value.  Hints will replace existing hints of their priority and
slouken@5189
   139
 *  lower.  Environment variables are considered to have override priority.
slouken@5189
   140
 * 
slouken@5189
   141
 *  \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
slouken@5189
   142
 */
slouken@5200
   143
extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name,
slouken@5200
   144
                                                         const char *value,
slouken@5200
   145
                                                         SDL_HintPriority priority);
slouken@5200
   146
slouken@5200
   147
/**
slouken@5200
   148
 *  \brief Set a hint with normal priority
slouken@5200
   149
 * 
slouken@5200
   150
 *  \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
slouken@5200
   151
 */
slouken@5189
   152
extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name,
slouken@5200
   153
                                             const char *value);
slouken@5200
   154
slouken@5189
   155
slouken@5189
   156
/**
slouken@5189
   157
 *  \brief Get a hint
slouken@5189
   158
 *  
slouken@5189
   159
 *  \return The string value of a hint variable.
slouken@5189
   160
 */
slouken@5189
   161
extern DECLSPEC const char * SDLCALL SDL_GetHint(const char *name);
slouken@5189
   162
slouken@5189
   163
/**
slouken@5189
   164
 *  \brief  Clear all hints
slouken@5189
   165
 *
slouken@5189
   166
 *  This function is called during SDL_Quit() to free stored hints.
slouken@5189
   167
 */
slouken@5272
   168
extern DECLSPEC void SDLCALL SDL_ClearHints(void);
slouken@5189
   169
slouken@5189
   170
slouken@5189
   171
/* Ends C function definitions when using C++ */
slouken@5189
   172
#ifdef __cplusplus
slouken@5189
   173
/* *INDENT-OFF* */
slouken@5189
   174
}
slouken@5189
   175
/* *INDENT-ON* */
slouken@5189
   176
#endif
slouken@5189
   177
#include "close_code.h"
slouken@5189
   178
slouken@5189
   179
#endif /* _SDL_hints_h */
slouken@5189
   180
slouken@5189
   181
/* vi: set ts=4 sw=4 expandtab: */