include/SDL.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 21 Sep 2009 09:38:10 +0000
branchSDL-1.2
changeset 4217 4c4113c2162c
parent 4159 a1b03ba2fcd0
child 6137 4720145f848b
permissions -rw-r--r--
Fixed bug #706

Ken Bull 2009-02-25 13:22:02 PST

Adds Doxygen support for all headers (except config and boilerplate headers) in
the include folder for SDL-1.2 revision 4446.

While in general SDL is quite thoroughly commented, none of these comments are
correctly formatted for Doxygen and are generally inconsistent in their
formatting.
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@4159
     3
    Copyright (C) 1997-2009 Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@251
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@4217
    23
/** @file SDL.h
slouken@4217
    24
 *  Main include header for the SDL library
slouken@4217
    25
 */
slouken@0
    26
slouken@0
    27
#ifndef _SDL_H
slouken@0
    28
#define _SDL_H
slouken@0
    29
slouken@1423
    30
#include "SDL_main.h"
slouken@1353
    31
#include "SDL_stdinc.h"
slouken@0
    32
#include "SDL_audio.h"
slouken@0
    33
#include "SDL_cdrom.h"
slouken@1358
    34
#include "SDL_cpuinfo.h"
slouken@1358
    35
#include "SDL_endian.h"
slouken@1358
    36
#include "SDL_error.h"
slouken@0
    37
#include "SDL_events.h"
slouken@1358
    38
#include "SDL_loadso.h"
slouken@1358
    39
#include "SDL_mutex.h"
slouken@1358
    40
#include "SDL_rwops.h"
slouken@1358
    41
#include "SDL_thread.h"
slouken@1358
    42
#include "SDL_timer.h"
slouken@0
    43
#include "SDL_video.h"
slouken@0
    44
#include "SDL_version.h"
slouken@0
    45
slouken@0
    46
#include "begin_code.h"
slouken@0
    47
/* Set up for C function definitions, even when using C++ */
slouken@0
    48
#ifdef __cplusplus
slouken@0
    49
extern "C" {
slouken@0
    50
#endif
slouken@0
    51
slouken@4217
    52
/** @file SDL.h
slouken@4217
    53
 *  @note As of version 0.5, SDL is loaded dynamically into the application
slouken@4217
    54
 */
slouken@0
    55
slouken@4217
    56
/** @name SDL_INIT Flags
slouken@4217
    57
 *  These are the flags which may be passed to SDL_Init() -- you should
slouken@4217
    58
 *  specify the subsystems which you will be using in your application.
slouken@4217
    59
 */
slouken@4217
    60
/*@{*/
slouken@0
    61
#define	SDL_INIT_TIMER		0x00000001
slouken@0
    62
#define SDL_INIT_AUDIO		0x00000010
slouken@0
    63
#define SDL_INIT_VIDEO		0x00000020
slouken@0
    64
#define SDL_INIT_CDROM		0x00000100
slouken@0
    65
#define SDL_INIT_JOYSTICK	0x00000200
slouken@4217
    66
#define SDL_INIT_NOPARACHUTE	0x00100000	/**< Don't catch fatal signals */
slouken@4217
    67
#define SDL_INIT_EVENTTHREAD	0x01000000	/**< Not supported on all OS's */
slouken@0
    68
#define SDL_INIT_EVERYTHING	0x0000FFFF
slouken@4217
    69
/*@}*/
slouken@0
    70
slouken@4217
    71
/** This function loads the SDL dynamically linked library and initializes 
slouken@4217
    72
 *  the subsystems specified by 'flags' (and those satisfying dependencies)
slouken@4217
    73
 *  Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
slouken@4217
    74
 *  signal handlers for some commonly ignored fatal signals (like SIGSEGV)
slouken@0
    75
 */
slouken@337
    76
extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
slouken@0
    77
slouken@4217
    78
/** This function initializes specific SDL subsystems */
slouken@337
    79
extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
slouken@0
    80
slouken@4217
    81
/** This function cleans up specific SDL subsystems */
slouken@337
    82
extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
slouken@0
    83
slouken@4217
    84
/** This function returns mask of the specified subsystems which have
slouken@4217
    85
 *  been initialized.
slouken@4217
    86
 *  If 'flags' is 0, it returns a mask of all initialized subsystems.
slouken@4217
    87
 */
slouken@337
    88
extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
slouken@0
    89
slouken@4217
    90
/** This function cleans up all initialized subsystems and unloads the
slouken@4217
    91
 *  dynamically linked library.  You should call it upon all exit conditions.
slouken@0
    92
 */
slouken@337
    93
extern DECLSPEC void SDLCALL SDL_Quit(void);
slouken@0
    94
slouken@0
    95
/* Ends C function definitions when using C++ */
slouken@0
    96
#ifdef __cplusplus
slouken@0
    97
}
slouken@0
    98
#endif
slouken@0
    99
#include "close_code.h"
slouken@0
   100
slouken@0
   101
#endif /* _SDL_H */