zinface
/
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 bcbf09acde Renamed SDL_AttachVirtualJoystickEx() to SDL_AttachVirtualJoystick() 
The shorthand version of this function didn't allow specifying a controller name, which seems pretty important. It seems like anyone actually implementing a virtual joystick is going to want to use some of the extended functionality.
 		2024-05-09 14:05:58 -07:00
..
README-android.md rwops: Changed filenames that reference "rwops" to "iostream". 2024-03-14 23:30:59 -04:00
README-cmake.md Sync SDL3 wiki -> header 2024-04-26 18:04:12 +00:00
README-contributing.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-dynapi.md Fixed types used in documentation (thanks @Dragon-Baroque!) 2024-01-19 05:23:38 -08:00
README-emscripten.md rwops: Renamed SDL_RWops to SDL_IOStream, and other related symbols. 2024-03-14 19:38:12 -04:00
README-gdk.md Define SDL_PLATFORM_* macros instead of underscored ones (#8875) 2024-01-24 01:40:51 +00: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 Sync SDL3 wiki -> header 2024-04-18 17:41:14 +00: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 docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-main-functions.md Removed misleading documentation for SDL_AppEvent() 2024-05-09 09:01:27 -07:00
README-migration.md Renamed SDL_AttachVirtualJoystickEx() to SDL_AttachVirtualJoystick() 2024-05-09 14:05:58 -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 Renamed SDL_HINT_PS2_DYNAMIC_VSYNC SDL_HINT_RENDER_PS2_DYNAMIC_VSYNC 2024-02-12 09:54:33 -08: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-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_RENDERER_ACCELERATED and SDL_RENDERER_SOFTWARE 2024-04-04 13:30:49 -07:00
README-vita.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-wayland.md wayland: Add mouse pointer warp support 2024-05-03 12:33:19 -04:00
README-windows.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-winrt.md Sync SDL3 wiki -> header 2024-04-26 18:04:12 +00:00
README.md Tweaking documentation for the SDL 3.0 preview release 2024-03-24 06:16:02 -07:00
doxyfile docs: Fix doxyfile 2023-02-19 10:01:33 -08: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