author | Sam Lantinga <slouken@libsdl.org> |
Mon, 29 May 2006 04:04:35 +0000 | |
branch | SDL-1.3 |
changeset 1668 | 4da1ee79c9af |
parent 1662 | 782fd950bd46 |
permissions | -rw-r--r-- |
0 | 1 |
/* |
2 |
SDL - Simple DirectMedia Layer |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
3 |
Copyright (C) 1997-2006 Sam Lantinga |
0 | 4 |
|
5 |
This library is free software; you can redistribute it and/or |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
6 |
modify it under the terms of the GNU Lesser General Public |
0 | 7 |
License as published by the Free Software Foundation; either |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
8 |
version 2.1 of the License, or (at your option) any later version. |
0 | 9 |
|
10 |
This library is distributed in the hope that it will be useful, |
|
11 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
12 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
13 |
Lesser General Public License for more details. |
0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
15 |
You should have received a copy of the GNU Lesser General Public |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
16 |
License along with this library; if not, write to the Free Software |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1188
diff
changeset
|
17 |
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
0 | 18 |
|
19 |
Sam Lantinga |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 |
slouken@libsdl.org |
0 | 21 |
*/ |
22 |
||
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
23 |
/** |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
24 |
* \file SDL.h |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
25 |
* |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
26 |
* Main include header for the SDL library |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
27 |
*/ |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
28 |
/** |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
29 |
* \mainpage Simple DirectMedia Layer (SDL) |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
30 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
31 |
http://www.libsdl.org/ |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
32 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
33 |
* \section intro_sec Introduction |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
34 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
35 |
This is the Simple DirectMedia Layer, a general API that provides low |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
36 |
level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL, |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
37 |
and 2D framebuffer across multiple platforms. |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
38 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
39 |
The current version supports Linux, Windows, Windows CE, BeOS, MacOS, |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
40 |
Mac OS X, FreeBSD, NetBSD, OpenBSD, BSD/OS, Solaris, IRIX, and QNX. |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
41 |
The code contains support for AmigaOS, Dreamcast, Atari, AIX, OSF/Tru64, |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
42 |
RISC OS, SymbianOS, and OS/2, but these are not officially supported. |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
43 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
44 |
SDL is written in C, but works with C++ natively, and has bindings to |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
45 |
several other languages, including Ada, C#, Eiffel, Erlang, Euphoria, |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
46 |
Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP, |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
47 |
Pike, Pliant, Python, Ruby, and Smalltalk. |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
48 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
49 |
This library is distributed under GNU LGPL version 2, which can be |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
50 |
found in the file "COPYING". This license allows you to use SDL |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
51 |
freely in commercial programs as long as you link with the dynamic |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
52 |
library. |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
53 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
54 |
The best way to learn how to use SDL is to check out the header files in |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
55 |
the "include" subdirectory and the programs in the "test" subdirectory. |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
56 |
The header files and test programs are well commented and always up to date. |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
57 |
More documentation is available in HTML format in "docs/index.html", and |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
58 |
a documentation wiki is available online at: |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
59 |
http://www.libsdl.org/cgi/docwiki.cgi |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
60 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
61 |
The test programs in the "test" subdirectory are in the public domain. |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
62 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
63 |
Frequently asked questions are answered online: |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
64 |
http://www.libsdl.org/faq.php |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
65 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
66 |
If you need help with the library, or just want to discuss SDL related |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
67 |
issues, you can join the developers mailing list: |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
68 |
http://www.libsdl.org/mailing-list.php |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
69 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
70 |
Enjoy! |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
71 |
Sam Lantinga (slouken@libsdl.org) |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
72 |
*/ |
0 | 73 |
|
74 |
#ifndef _SDL_H |
|
75 |
#define _SDL_H |
|
76 |
||
1423
4ed717f9e509
Updated for Visual Studio Express 2005
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
77 |
#include "SDL_main.h" |
1353
7ba544e2888d
Started the process of improving configure support, and merging C types
Sam Lantinga <slouken@libsdl.org>
parents:
1335
diff
changeset
|
78 |
#include "SDL_stdinc.h" |
0 | 79 |
#include "SDL_audio.h" |
80 |
#include "SDL_cdrom.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
81 |
#include "SDL_cpuinfo.h" |
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
82 |
#include "SDL_endian.h" |
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
83 |
#include "SDL_error.h" |
0 | 84 |
#include "SDL_events.h" |
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
85 |
#include "SDL_loadso.h" |
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
86 |
#include "SDL_mutex.h" |
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
87 |
#include "SDL_rwops.h" |
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
88 |
#include "SDL_thread.h" |
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
89 |
#include "SDL_timer.h" |
0 | 90 |
#include "SDL_video.h" |
91 |
#include "SDL_version.h" |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
92 |
#include "SDL_compat.h" |
0 | 93 |
|
94 |
#include "begin_code.h" |
|
95 |
/* Set up for C function definitions, even when using C++ */ |
|
96 |
#ifdef __cplusplus |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
97 |
/* *INDENT-OFF* */ |
0 | 98 |
extern "C" { |
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
99 |
/* *INDENT-ON* */ |
0 | 100 |
#endif |
101 |
||
102 |
/* As of version 0.5, SDL is loaded dynamically into the application */ |
|
103 |
||
104 |
/* These are the flags which may be passed to SDL_Init() -- you should |
|
105 |
specify the subsystems which you will be using in your application. |
|
106 |
*/ |
|
107 |
#define SDL_INIT_TIMER 0x00000001 |
|
108 |
#define SDL_INIT_AUDIO 0x00000010 |
|
109 |
#define SDL_INIT_VIDEO 0x00000020 |
|
110 |
#define SDL_INIT_CDROM 0x00000100 |
|
111 |
#define SDL_INIT_JOYSTICK 0x00000200 |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
112 |
#define SDL_INIT_NOPARACHUTE 0x00100000 /* Don't catch fatal signals */ |
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
113 |
#define SDL_INIT_EVENTTHREAD 0x01000000 /* Not supported on all OS's */ |
0 | 114 |
#define SDL_INIT_EVERYTHING 0x0000FFFF |
115 |
||
116 |
/* This function loads the SDL dynamically linked library and initializes |
|
117 |
* the subsystems specified by 'flags' (and those satisfying dependencies) |
|
118 |
* Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup |
|
119 |
* signal handlers for some commonly ignored fatal signals (like SIGSEGV) |
|
120 |
*/ |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
121 |
extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags); |
0 | 122 |
|
123 |
/* This function initializes specific SDL subsystems */ |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
124 |
extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags); |
0 | 125 |
|
126 |
/* This function cleans up specific SDL subsystems */ |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
127 |
extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags); |
0 | 128 |
|
129 |
/* This function returns mask of the specified subsystems which have |
|
130 |
been initialized. |
|
131 |
If 'flags' is 0, it returns a mask of all initialized subsystems. |
|
132 |
*/ |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
133 |
extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags); |
0 | 134 |
|
135 |
/* This function cleans up all initialized subsystems and unloads the |
|
136 |
* dynamically linked library. You should call it upon all exit conditions. |
|
137 |
*/ |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
138 |
extern DECLSPEC void SDLCALL SDL_Quit(void); |
0 | 139 |
|
140 |
/* Ends C function definitions when using C++ */ |
|
141 |
#ifdef __cplusplus |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
142 |
/* *INDENT-OFF* */ |
0 | 143 |
} |
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
144 |
/* *INDENT-ON* */ |
0 | 145 |
#endif |
146 |
#include "close_code.h" |
|
147 |
||
148 |
#endif /* _SDL_H */ |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
149 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1423
diff
changeset
|
150 |
/* vi: set ts=4 sw=4 expandtab: */ |