eden-emu/SDL
14
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-15 01:08:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
SDL/docs
History
nightmareci 718034f5fa Remove newlines from log messages
2025-01-22 20:25:04 -08: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
hello.c Remove newlines from log messages 2025-01-22 20:25:04 -08:00
INTRO-androidstudio.md Added https://github.com/Ravbug/sdl3-sample as a more complete Android example 2025-01-14 12:22:00 -08:00
INTRO-cmake.md Updated README-cmake.md with build instructions for several platforms 2025-01-14 11:15:34 -08:00
INTRO-emscripten.md Tweaked emscripten introduction 2025-01-22 13:05:44 -08:00
INTRO-visualstudio.md Removed redundant step in Visual Studio instructions 2025-01-22 13:26:11 -08:00
INTRO-xcode.md Added INTRO-xcode.md 2025-01-13 16:42:50 -08:00
README-android.md Revert "Separate android initialization from Activity (#11891)" 2025-01-10 15:27:08 -08:00
README-bsd.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-cmake.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-contributing.md Minor readability improvement for README-contributing.md 2025-01-13 16:42:50 -08:00
README-documentation-rules.md README-documentation-rules.md: Mention not listing types in param/returns docs. 2024-11-20 23:59:24 -05:00
README-dynapi.md Removed SDL_bool in favor of plain bool 2024-09-18 08:32:30 -07:00
README-emscripten.md Added INTRO-emscripten.md 2025-01-13 16:42:50 -08: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-haiku.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-highdpi.md Sync SDL3 wiki -> header 2024-10-11 20:51:42 +00:00
README-ios.md Bumped deployment requirements for Apple platforms 2025-01-14 12:03:07 -08:00
README-kmsbsd.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-linux.md asyncio: Added Linux io_uring support. 2024-12-03 17:32:20 -05:00
README-macos.md Bumped deployment requirements for Apple platforms 2025-01-14 12:03:07 -08:00
README-main-functions.md docs/README-main-functions.md: reformatted Best Practices section. 2024-11-28 00:19:55 -05:00
README-migration.md Remove newlines from log messages 2025-01-22 20:25:04 -08:00
README-n3ds.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-ngage.md ngage: Remove Nokia N-Gage support. 2024-12-11 13:29:43 -05:00
README-platforms.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-porting.md winrt: Removed WinRT/Windows Phone/UWP support. 2024-09-06 13:28:39 -04:00
README-ps2.md JANITORIAL: Fix typos in comments in various files (#10058) 2024-06-19 07:13:46 -07:00
README-ps4.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-ps5.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-psp.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-steamos.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-strings.md Removed temporary memory from the API 2024-07-26 20:59:14 -07:00
README-switch.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-touch.md Sync SDL3 wiki -> header 2024-12-17 07:29:13 +00:00
README-versions.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-vita.md Sync SDL3 wiki -> header 2025-01-09 20:15:17 +00:00
README-wayland.md examples now using SDL_ALPHA_OPAQUE(_FLOAT) for opaque alpha value 2024-10-23 07:28:33 -07:00
README-windows.md minor update to mingw-w64 build instructions. 2025-01-14 05:04:24 +03:00
README.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
release_checklist.md Added a reminder to sign the source archives when creating a release 2024-12-07 11:50:42 -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, Android, Xbox, PlayStation 4/5, Nintendo Switch, and many other platforms.

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 "examples" 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