SDL/docs
Daniel Gibson 28b93451dc Make WinRT's SDL_main header-only
As the implementation requires C++, the user will have to include
SDL_main.h in a C++ source file (that needs to be compiled with /ZW).
It's ok to keep the standard main() implementation in plain C and use
an otherwise empty C++ source file for the SDL_main implementation part,
if both source files #include <SDL3/SDL_main.h>

Including SDL_main.h in a C source file will print a message at
compilation (when building for WinRT or possibly other not yet implemented
platforms that require C++ for main), to remind the user of also
including it in a .cpp source file. This message/warning can be disabled
with #define SDL_MAIN_NOIMPL before including SDL_main.h in the C file.
When including it in a .cpp file, there will be a compiler error with
helpful message if it's not compiled with /ZW

For this I renamend _SDL_MAIN_NOIMPL to SDL_MAIN_NOIMPL, because now it's
not for internal use only anymore, but also useful for users (that want
their main() function in a different file than the SDL_main implementation)

Add a project for the testdraw2.c test to the WinRT solution to at least
get some minimal testing on WinRT.
I won't add all tests because it's a lot of manual clicking per test,
but this should be better than nothing :)
2022-12-15 08:01:01 -08:00
..
CONTRIBUTING.md Add contributing guidelines. 2022-08-07 16:34:52 -07:00
README-android.md Rename SDLmain to SDL_main and SDLtest to SDL_test for consistency with other SDL libraries 2022-11-28 10:57:59 -08:00
README-cmake.md Rename SDLmain to SDL_main and SDLtest to SDL_test for consistency with other SDL libraries 2022-11-28 10:57:59 -08:00
README-dynapi.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-emscripten.md docs: remove references to configure build systems from documentation 2022-11-25 15:37:30 -08:00
README-gdk.md Make GDK's SDL_main header-only 2022-12-15 08:01:01 -08:00
README-git.md Revert "Update wiki.libsdl.org urls to libsdl-org/SDL/wiki (#4069)" 2021-04-01 12:15:28 -04:00
README-hg.md Deprecate SDL_GetRevisionNumber and update things for git instead of hg. 2021-02-12 14:31:38 -05:00
README-ios.md Make iOS/tvOS (uikit) SDL_main header-only 2022-12-15 08:01:01 -08:00
README-kmsbsd.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-linux.md docs: remove references to configure build systems from documentation 2022-11-25 15:37:30 -08:00
README-macos.md Remove sdl3.m4 and sdl3-config, and document pkg-config as the recommended replacement 2022-11-27 14:11:06 -08:00
README-migration.md render: Remove SDL_GetRenderDriverInfo and change SDL_CreateRenderer. 2022-12-13 23:27:35 -05:00
README-n3ds.md N3DS: Semaphore fixes. (#6776) 2022-12-11 11:27:16 -08:00
README-ngage.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08: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 Remove SDL_config.h from the public headers 2022-11-26 04:48:36 -08:00
README-ps2.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-psp.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-raspberrypi.md Remove sdl3.m4 and sdl3-config, and document pkg-config as the recommended replacement 2022-11-27 14:11:06 -08:00
README-riscos.md Update docs/README-riscos.md 2022-11-25 15:37:30 -08:00
README-touch.md gesture: Removed the gesture API from SDL3. 2022-12-13 14:54:37 -05:00
README-versions.md docs: Document new versioning scheme 2022-05-04 09:55:35 -07:00
README-visualc.md render: Remove SDL_GetRenderDriverInfo and change SDL_CreateRenderer. 2022-12-13 23:27:35 -05:00
README-vita.md Vita: fix readme 2022-03-31 06:02:50 -07:00
README-windows.md README-windows: Notes on building with Visual Studio/LLVM. 2022-03-26 08:55:26 -04:00
README-winrt.md Make WinRT's SDL_main header-only 2022-12-15 08:01:01 -08:00
README.md gesture: Removed the gesture API from SDL3. 2022-12-13 14:54:37 -05:00
doxyfile reverted opengles removal. 2022-11-23 18:50:02 +03: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