This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL.h
160 lines (141 loc) · 4.86 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2010 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
14
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
22
*/
23
/**
24
25
26
* \file SDL.h
*
* Main include header for the SDL library
27
28
*/
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/**
* \mainpage Simple DirectMedia Layer (SDL)
*
* http://www.libsdl.org/
*
* \section intro_sec Introduction
*
* This is the Simple DirectMedia Layer, a general API that provides low
* level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL,
* and 2D framebuffer across multiple platforms.
*
* SDL is written in C, but works with C++ natively, and has bindings to
* several other languages, including Ada, C#, Eiffel, Erlang, Euphoria,
* Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP,
* Pike, Pliant, Python, Ruby, and Smalltalk.
*
* This library is distributed under GNU LGPL version 2, which can be
* found in the file "COPYING". This license allows you to use SDL
* freely in commercial programs as long as you link with the dynamic
* library.
*
* The best way to learn how to use SDL is to check out the header files in
* the "include" subdirectory and the programs in the "test" subdirectory.
* The header files and test programs are well commented and always up to date.
* More documentation is available in HTML format in "docs/index.html", and
* a documentation wiki is available online at:
* http://www.libsdl.org/cgi/docwiki.cgi
*
* The test programs in the "test" subdirectory are in the public domain.
*
* Frequently asked questions are answered online:
* http://www.libsdl.org/faq.php
*
* If you need help with the library, or just want to discuss SDL related
* issues, you can join the developers mailing list:
* http://www.libsdl.org/mailing-list.php
*
* Enjoy!
* Sam Lantinga (slouken@libsdl.org)
68
*/
69
70
71
72
#ifndef _SDL_H
#define _SDL_H
73
#include "SDL_main.h"
74
#include "SDL_stdinc.h"
75
#include "SDL_atomic.h"
76
#include "SDL_audio.h"
77
#include "SDL_clipboard.h"
78
79
80
#include "SDL_cpuinfo.h"
#include "SDL_endian.h"
#include "SDL_error.h"
81
#include "SDL_events.h"
82
#include "SDL_loadso.h"
83
#include "SDL_mutex.h"
84
#include "SDL_power.h"
85
#include "SDL_render.h"
86
87
88
#include "SDL_rwops.h"
#include "SDL_thread.h"
#include "SDL_timer.h"
89
#include "SDL_version.h"
90
#include "SDL_video.h"
91
#include "SDL_compat.h"
92
93
94
95
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
96
/* *INDENT-OFF* */
97
extern "C" {
98
/* *INDENT-ON* */
99
100
101
102
#endif
/* As of version 0.5, SDL is loaded dynamically into the application */
103
104
105
106
107
108
109
/**
* \name SDL_INIT_*
*
* These are the flags which may be passed to SDL_Init(). You should
* specify the subsystems which you will be using in your application.
*/
/*@{*/
110
111
112
113
114
#define SDL_INIT_TIMER 0x00000001
#define SDL_INIT_AUDIO 0x00000010
#define SDL_INIT_VIDEO 0x00000020
#define SDL_INIT_JOYSTICK 0x00000200
#define SDL_INIT_HAPTIC 0x00001000
115
#define SDL_INIT_NOPARACHUTE 0x00100000 /**< Don't catch fatal signals */
116
#define SDL_INIT_EVERYTHING 0x0000FFFF
117
/*@}*/
118
119
/**
120
* This function initializes the subsystems specified by \c flags
121
122
* Unless the ::SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
* signal handlers for some commonly ignored fatal signals (like SIGSEGV).
123
*/
124
extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
125
126
/**
127
* This function initializes specific SDL subsystems
128
*/
129
extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
130
131
132
133
/**
* This function cleans up specific SDL subsystems
*/
134
extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
135
136
/**
137
138
* This function returns a mask of the specified subsystems which have
* previously been initialized.
139
140
141
*
* If \c flags is 0, it returns a mask of all initialized subsystems.
*/
142
extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
143
144
/**
145
146
* This function cleans up all initialized subsystems. You should
* call it upon all exit conditions.
147
*/
148
extern DECLSPEC void SDLCALL SDL_Quit(void);
149
150
151
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
152
/* *INDENT-OFF* */
153
}
154
/* *INDENT-ON* */
155
156
157
158
#endif
#include "close_code.h"
#endif /* _SDL_H */
159
160
/* vi: set ts=4 sw=4 expandtab: */