SDL/docs
Frank Praznik f7dd0f9491 wayland: Allow the creation of roleless window surfaces for custom application use
Allow for the creation of SDL windows with a roleless surface that applications can use for their own purposes, such as with a windowing protocol other than XDG toplevel.

The property `wayland.surface_role_custom` will create a window with a surface that SDL can render to and handles input for, but is not associated with a toplevel window, so applications can use it for their own, custom purposes (e.g. wlr_layer_shell).

A test/minimal example is included in tests/testwaylandcustom.c
2024-01-08 14:54:47 -05:00
..
README-android.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-cmake.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-contributing.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-dynapi.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-emscripten.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-gdk.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05: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 docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05: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 Removed SDL_GL_BindTexture() and SDL_GL_UnbindTexture() 2024-01-07 20:19:19 -08: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 docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05: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 wayland: Allow the creation of roleless window surfaces for custom application use 2024-01-08 14:54:47 -05:00
README-windows.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-winrt.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05: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