annotate README @ 5145:c8e049de174c

Making the API simpler, the renderer present semantics are always having a backbuffer and then discarding it. This is best for hardware accelerated rendering.
author Sam Lantinga <slouken@libsdl.org>
date Tue, 01 Feb 2011 12:19:46 -0800
parents 797b37c0c046
children 1435f8a6425c
rev   line source
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
1
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
2 Simple DirectMedia Layer
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
3
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
4 (SDL)
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
5
5105
797b37c0c046 Nobody is maintaining RISC OS code, so I'm removing it for now.
Sam Lantinga <slouken@libsdl.org>
parents: 3283
diff changeset
6 Version 1.3
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
7
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
8 ---
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
9 http://www.libsdl.org/
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
10
602
a24bd700f92e *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 579
diff changeset
11 This is the Simple DirectMedia Layer, a general API that provides low
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
12 level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL,
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
13 and 2D framebuffer across multiple platforms.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
14
5105
797b37c0c046 Nobody is maintaining RISC OS code, so I'm removing it for now.
Sam Lantinga <slouken@libsdl.org>
parents: 3283
diff changeset
15 The current version supports Windows, Windows CE, Mac OS X, Linux, FreeBSD,
797b37c0c046 Nobody is maintaining RISC OS code, so I'm removing it for now.
Sam Lantinga <slouken@libsdl.org>
parents: 3283
diff changeset
16 NetBSD, OpenBSD, BSD/OS, Solaris, QNX, iOS, and Android. The code contains
797b37c0c046 Nobody is maintaining RISC OS code, so I'm removing it for now.
Sam Lantinga <slouken@libsdl.org>
parents: 3283
diff changeset
17 support for other operating systems but those are not officially supported.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
18
1763
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
19 SDL is written in C, but works with C++ natively, and has bindings to
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
20 several other languages, including Ada, C#, Eiffel, Erlang, Euphoria,
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
21 Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP,
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
22 Pike, Pliant, Python, Ruby, and Smalltalk.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
23
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
24 This library is distributed under GNU LGPL version 2, which can be
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
25 found in the file "COPYING". This license allows you to use SDL
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
26 freely in commercial programs as long as you link with the dynamic
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
27 library.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
28
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
29 The best way to learn how to use SDL is to check out the header files in
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
30 the "include" subdirectory and the programs in the "test" subdirectory.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
31 The header files and test programs are well commented and always up to date.
1763
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
32 More documentation is available in HTML format in "docs/index.html", and
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
33 a documentation wiki is available online at:
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
34 http://www.libsdl.org/cgi/docwiki.cgi
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
35
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
36 The test programs in the "test" subdirectory are in the public domain.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
37
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
38 Frequently asked questions are answered online:
369
e405cf8bf580 *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 362
diff changeset
39 http://www.libsdl.org/faq.php
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
40
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
41 If you need help with the library, or just want to discuss SDL related
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
42 issues, you can join the developers mailing list:
369
e405cf8bf580 *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 362
diff changeset
43 http://www.libsdl.org/mailing-list.php
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
44
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
45 Enjoy!
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
46 Sam Lantinga (slouken@libsdl.org)
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
47