mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
SDL/docs
History
Sam Lantinga 627cb8acd0 SDL_EventFilter functions now return SDL_bool 2024-08-06 07:59:45 -07:00
..
README-android.md Document the new SDL3 Android archive artifact 2024-08-01 17:48:49 +00:00
README-cmake.md examples: Add CMake glue to optionally build examples, as we do for the tests. 2024-07-23 00:58:57 -04:00
README-contributing.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-documentation-rules.md JANITORIAL: Fix judgement typos (#10059) 2024-06-19 07:14:58 -07:00
README-dynapi.md Fixed types used in documentation (thanks @Dragon-Baroque!) 2024-01-19 05:23:38 -08:00
README-emscripten.md JANITORIAL: Fix typos in comments in various files (#10058) 2024-06-19 07:13:46 -07:00
README-gdk.md Rename functions in SDL_system.h to match SDL 3.0 naming convention 2024-07-15 16:27:48 -07:00
README-git.md Sync SDL3 wiki -> header 2024-03-24 18:34:24 +00:00
README-highdpi.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-ios.md Rename functions in SDL_system.h to match SDL 3.0 naming convention 2024-07-15 16:27:48 -07:00
README-kmsbsd.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-linux.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-macos.md Updated macOS build requirements 2024-08-04 20:24:19 -07:00
README-main-functions.md Sync SDL3 wiki -> header 2024-06-03 18:41:23 +00:00
README-migration.md SDL_EventFilter functions now return SDL_bool 2024-08-06 07:59:45 -07:00
README-n3ds.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-ngage.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-platforms.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-porting.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-ps2.md JANITORIAL: Fix typos in comments in various files (#10058) 2024-06-19 07:13:46 -07:00
README-psp.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-raspberrypi.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-riscos.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-strings.md Removed temporary memory from the API 2024-07-26 20:59:14 -07:00
README-touch.md touch: Replace GetNumTouchDevices/GetTouchDevice with a single function. 2023-11-29 20:50:44 -05:00
README-versions.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-visualc.md Removed SDL_RendererFlags 2024-05-13 15:06:11 -07:00
README-vita.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-wayland.md Renamed SDL_Get/SetProperty() to SDL_Get/SetPointerProperty() 2024-07-12 10:41:02 -07:00
README-windows.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-winrt.md Removed temporary memory from the API 2024-07-26 20:59:14 -07:00
README.md Tweaking documentation for the SDL 3.0 preview release 2024-03-24 06:16:02 -07:00
doxyfile Don't automatically free temporary memory, let the application call SDL_FreeTemporaryMemory() when it's ready. 2024-07-26 10:05:03 -07:00
release_checklist.md Updated release_checklist.md for SDL 3.0 2023-01-04 23:47:01 -08:00

README.md

Simple DirectMedia Layer

https://www.libsdl.org/

Simple DirectMedia Layer is a cross-platform development library designed to provide low level access to audio, keyboard, mouse, joystick, and graphics hardware. It is used by video playback software, emulators, and popular games including Valve's award winning catalog and many Humble Bundle games.

SDL officially supports Windows, macOS, Linux, iOS, and Android. Support for other platforms may be found in the source code.

SDL is written in C, works natively with C++, and there are bindings available for several other languages, including C# and Python.

This library is distributed under the zlib license, which can be found in the file "LICENSE.txt".

Information on building SDL with CMake is available in README-cmake.md

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.

Information on reporting bugs and contributing is available in README-contributing.md

More documentation and FAQs are available online at the wiki

If you need help with the library, or just want to discuss SDL related issues, you can join the SDL Discourse, which can be used as a web forum or a mailing list, at your preference.

If you want to report bugs or contribute patches, please submit them to our bug tracker

Enjoy!

Sam Lantinga mailto:slouken@libsdl.org