mirror
/
SDL
mirror of https://github.com/libsdl-org/SDL.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
SDL/docs
History
Ryan C. Gordon 525919b315
rwops: Reworked RWops for SDL3. 
- SDL_RWops is now an opaque struct.
- SDL_AllocRW is gone. If an app is creating a custom RWops, they pass the
  function pointers to SDL_CreateRW(), which are stored internally.
- SDL_RWclose is gone, there is only SDL_DestroyRW(), which calls the
  implementation's `->close` method before freeing other things.
- There is only one path to create and use RWops now, so we don't have to
  worry about whether `->close` will call SDL_DestroyRW, or if this will
  risk any Properties not being released, etc.
- SDL_RWFrom* still works as expected, for getting a RWops without having
  to supply your own implementation. Objects from these functions are also
  destroyed with SDL_DestroyRW.
- Lots of other cleanup and SDL3ization of the library code.
 		2024-03-14 19:36:08 -04:00
..
README-android.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-cmake.md Sync SDL3 wiki -> header 2024-02-25 22:26:23 +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 docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-gdk.md Define SDL_PLATFORM_* macros instead of underscored ones (#8875) 2024-01-24 01:40:51 +00:00
README-git.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-hg.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-highdpi.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-ios.md Define SDL_PLATFORM_* macros instead of underscored ones (#8875) 2024-01-24 01:40:51 +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 Sync SDL3 wiki -> header 2023-12-01 06:39:09 +00:00
README-migration.md rwops: Reworked RWops for SDL3. 2024-03-14 19:36:08 -04: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 docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-vita.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-wayland.md docs: Hint envvars needs to use the hint string, not the macro name 2024-01-28 15:12:03 -05:00
README-windows.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-winrt.md Define SDL_PLATFORM_* macros instead of underscored ones (#8875) 2024-01-24 01:40:51 +00:00
README.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05: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 via OpenGL and Direct3D. 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".

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.

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