yuzu/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL synced 2024-11-20 16:06:10 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
SDL/docs
History
Ryan C. Gordon 279eb89ce5
Some checks failed
Build (Android) / ${{ matrix.platform.name }} (map[android_abi:arm64-v8a android_platform:23 arch:aarch64 cmake:1 name:CMake]) (push) Has been cancelled
Details
Build (Android) / ${{ matrix.platform.name }} (map[name:Android.mk]) (push) Has been cancelled
Details
Build (C/P Actions) / FreeBSD (push) Has been cancelled
Details
Build (Emscripten) / emscripten (push) Has been cancelled
Details
Build (iOS/tvOS) / ${{ matrix.platform.name }} (map[name:iOS sdk:iphoneos target:Static Library-iOS]) (push) Has been cancelled
Details
Build (iOS/tvOS) / ${{ matrix.platform.name }} (map[name:tvOS sdk:appletvos target:Static Library-tvOS]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[artifact:SDL-ubuntu20.04-icc cmake:-DSDL_CLANG_TIDY=OFF intel:true name:Intel Compiler (Ubuntu 20.04) os:ubuntu-20.04 shell:bash source_cmd:source /opt/intel/oneapi/setvars.sh; export CC=icc; export CXX=icpc; export CFL… (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[artifact:SDL-ubuntu20.04-oneapi intel:true name:Intel oneAPI (Ubuntu 20.04) os:ubuntu-20.04 shell:bash source_cmd:source /opt/intel/oneapi/setvars.sh; export CC=icx; export CXX=icx;]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[autotools:true name:MacOS (autotools) os:macos-latest shell:sh]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[autotools:true name:Ubuntu 20.04 (autotools) os:ubuntu-20.04 shell:sh]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[autotools:true name:Ubuntu 22.04 (autotools) os:ubuntu-22.04 shell:sh]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[cmake:-DCMAKE_OSX_ARCHITECTURES="x86_64;arm64" name:MacOS (CMake) os:macos-latest shell:sh]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[msys-env:mingw-w64-clang-i686 msystem:clang32 name:Windows (clang32) os:windows-latest shell:msys2 {0}]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[msys-env:mingw-w64-clang-x86_64 msystem:clang64 name:Windows (clang64) os:windows-latest shell:msys2 {0}]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[msys-env:mingw-w64-i686 msystem:mingw32 name:Windows (mingw32) os:windows-latest shell:msys2 {0}]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[msys-env:mingw-w64-ucrt-x86_64 msystem:ucrt64 name:Windows (ucrt64) os:windows-latest shell:msys2 {0}]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[msys-env:mingw-w64-x86_64 msystem:mingw64 name:Windows (mingw64) os:windows-latest shell:msys2 {0}]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[name:Ubuntu 20.04 (CMake) os:ubuntu-20.04 shell:sh]) (push) Has been cancelled
Details
Build / ${{ matrix.platform.name }} (map[name:Ubuntu 22.04 (CMake) os:ubuntu-22.04 shell:sh]) (push) Has been cancelled
Details
Build (MSVC) / ${{ matrix.platform.name }} (map[flags:-A ARM name:Windows (ARM)]) (push) Has been cancelled
Details
Build (MSVC) / ${{ matrix.platform.name }} (map[flags:-A ARM64 name:Windows (ARM64)]) (push) Has been cancelled
Details
Build (MSVC) / ${{ matrix.platform.name }} (map[flags:-A Win32 -DSDL_FORCE_STATIC_VCRT=ON name:Windows static VCRT (x86)]) (push) Has been cancelled
Details
Build (MSVC) / ${{ matrix.platform.name }} (map[flags:-A Win32 name:Windows (x86) project:VisualC/SDL.sln projectflags:/p:Platform=Win32]) (push) Has been cancelled
Details
Build (MSVC) / ${{ matrix.platform.name }} (map[flags:-A x64 -DCMAKE_SYSTEM_NAME=WindowsStore -DCMAKE_SYSTEM_VERSION="10.0" -DSDL_TESTS=OFF name:UWP (x64) nowerror:true project:VisualC-WinRT/SDL-UWP.sln projectflags:/p:Platform=x64 /p:WindowsTargetPlatformVersion=10.… (push) Has been cancelled
Details
Build (MSVC) / ${{ matrix.platform.name }} (map[flags:-A x64 -DSDL_FORCE_STATIC_VCRT=ON name:Windows static VCRT (x64)]) (push) Has been cancelled
Details
Build (MSVC) / ${{ matrix.platform.name }} (map[flags:-A x64 name:Windows (x64) project:VisualC/SDL.sln projectflags:/p:Platform=x64]) (push) Has been cancelled
Details
Build (MSVC) / ${{ matrix.platform.name }} (map[flags:-T ClangCL -A Win32 name:Windows (clang-cl x86)]) (push) Has been cancelled
Details
Build (MSVC) / ${{ matrix.platform.name }} (map[flags:-T ClangCL -A x64 name:Windows (clang-cl x64)]) (push) Has been cancelled
Details
Build (Nintendo 3DS) / n3ds (push) Has been cancelled
Details
Build (Sony Playstation 2) / ps2 (push) Has been cancelled
Details
Build (Sony Playstation Portable) / psp (push) Has been cancelled
Details
Build (RISC OS) / ${{ matrix.platform.name }} (map[name:CMake]) (push) Has been cancelled
Details
Build (RISC OS) / ${{ matrix.platform.name }} (map[name:autotools test_args:-DTEST_SHARED=FALSE]) (push) Has been cancelled
Details
Build (Sony Playstation Vita) / ${{ matrix.platform.name }} (map[name:GLES (PVR_PSP2 + gl4es4vita) os:windows-latest pvr:true]) (push) Has been cancelled
Details
Build (Sony Playstation Vita) / ${{ matrix.platform.name }} (map[name:GLES (pib) os:windows-latest pib:true]) (push) Has been cancelled
Details
Build (OpenWatcom) / ${{ matrix.platform.name }} (map[makefile:Makefile.os2 name:OS/2]) (push) Has been cancelled
Details
Build (OpenWatcom) / ${{ matrix.platform.name }} (map[makefile:Makefile.w32 name:Windows]) (push) Has been cancelled
Details
README-macos: Typo fixes. 
(Manually cherry-picked from 199e6929e5284b8573f02dcb655d3803ed436615.)
2024-07-16 08:32:29 -04:00
..
CONTRIBUTING.md Add contributing guidelines. 2022-08-07 16:34:52 -07:00
doxyfile docs/release_checklist.md: Document how/where to bump version numbers 2022-05-04 09:55:35 -07:00
README-android.md Sync wiki -> header 2023-10-10 10:19:51 -04:00
README-cmake.md cmake: update cmake_minimum_required to avoid deprecated warning 2023-08-09 02:53:48 +02:00
README-directfb.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-dynapi.md Fixed types used in documentation (thanks @Dragon-Baroque!) 2024-01-19 05:26:44 -08:00
README-emscripten.md docs: Added Emscripten filesystem notes. 2023-09-09 21:22:45 -04:00
README-gdk.md gdk: Backport SDL3 MR #8844 2024-01-21 13:55:17 -05:00
README-gesture.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-git.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-hg.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-ios.md cmake: fix uses of undefined macro identifiers (-Wundef) 2023-11-17 03:06:26 +00:00
README-kmsbsd.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-linux.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-macos.md README-macos: Typo fixes. 2024-07-16 08:32:29 -04:00
README-n3ds.md N3DS: Backport semaphore fixes from #6776. 2022-12-11 17:09:28 -08:00
README-nacl.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-ngage.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-os2.md update docs/README-os2 after the last os/2 audio patch. 2023-07-25 20:51:32 +03:00
README-pandora.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-platforms.md Revert "Update wiki.libsdl.org urls to libsdl-org/SDL/wiki (#4069)" 2021-04-01 12:15:28 -04:00
README-porting.md docs: Replace references to configure.in with configure.ac 2019-03-27 20:58:33 +11:00
README-ps2.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-psp.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-raspberrypi.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-riscos.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-touch.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-versions.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-visualc.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-vita.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-wince.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-windows.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README-winrt.md Sync wiki -> headers. 2023-02-28 12:56:01 -05:00
README.md Update README.md 2022-09-28 10:17:39 -04:00
release_checklist.md Added a note to update the website after a stable release 2022-10-08 09:41:10 -07: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