pandory500/SDL-mirror
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

File style cleanup for the SDL 2.0 release

Browse source
This commit is contained in:
Sam Lantinga 2013-05-18 14:17:52 -07:00
parent 2ac8624930
commit 0cb6385637
376 changed files with 17562 additions and 17773 deletions
Download patch file Download diff file Expand all files Collapse all files

22
include/SDL_hints.h
View file

@ -21,7 +21,7 @@
/**
* \file SDL_hints.h
*
*
* Official documentation for SDL configuration variables
*
* This file contains functions to set and get configuration hints,
@ -44,13 +44,11 @@
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
/* *INDENT-ON* */
#endif
/**
* \brief A variable controlling how 3D acceleration is used to accelerate the SDL 1.2 screen surface.
* \brief A variable controlling how 3D acceleration is used to accelerate the SDL 1.2 screen surface.
*
* SDL can try to accelerate the SDL 1.2 screen surface by using streaming
* textures with a 3D rendering engine. This variable controls whether and
@ -169,7 +167,7 @@ extern "C" {
*/
#define SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS "SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS"
/**
* \brief A variable controlling whether the idle timer is disabled on iOS.
*
@ -183,7 +181,7 @@ extern "C" {
* "1" - Disable idle timer
*/
#define SDL_HINT_IDLE_TIMER_DISABLED "SDL_IOS_IDLE_TIMER_DISABLED"
/**
* \brief A variable controlling which orientations are allowed on iOS.
*
@ -208,7 +206,7 @@ extern "C" {
/**
* \brief A variable that lets you manually hint extra gamecontroller db entries
*
*
* The variable should be newline delimited rows of gamecontroller config data, see SDL_gamecontroller.h
*
* This hint must be set before calling SDL_Init(SDL_INIT_GAMECONTROLLER)
@ -219,7 +217,7 @@ extern "C" {
/**
* \brief If set to 0 then never set the top most bit on a SDL Window, even if the video mode expects it.
* This is a debugging aid for developers and not expected to be used by end users. The default is "1"
* This is a debugging aid for developers and not expected to be used by end users. The default is "1"
*
* This variable can be set to the following values:
* "0" - don't allow topmost
@ -246,7 +244,7 @@ typedef enum
* The priority controls the behavior when setting a hint that already
* has a value. Hints will replace existing hints of their priority and
* lower. Environment variables are considered to have override priority.
*
*
* \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
*/
extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name,
@ -255,7 +253,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name,
/**
* \brief Set a hint with normal priority
*
*
* \return SDL_TRUE if the hint was set, SDL_FALSE otherwise
*/
extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name,
@ -264,7 +262,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name,
/**
* \brief Get a hint
*
*
* \return The string value of a hint variable.
*/
extern DECLSPEC const char * SDLCALL SDL_GetHint(const char *name);
@ -279,9 +277,7 @@ extern DECLSPEC void SDLCALL SDL_ClearHints(void);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
/* *INDENT-OFF* */
}
/* *INDENT-ON* */
#endif
#include "close_code.h"