Simple DirectMedia Layer

Last updated

Simple DirectMedia Layer
Original author(s) Sam Lantinga
Developer(s) SDL Community
Initial release1998;26 years ago (1998)
Stable release
2.30.0 [1]   OOjs UI icon edit-ltr-progressive.svg / 2 February 2024
Repository
Written in C
Operating system Linux (e.g. SteamOS), Windows, macOS 10.4+, iOS 3.1.3+, tvOS, [2] Android 2.3.3+, FreeBSD 8.4+, Nintendo Switch, PlayStation 2, Haiku, RISC OS 3.5+ [3]
Additionally before v2.0.0: e.g. AmigaOS and MorphOS, and consoles (PlayStation, XBox, Wii, etc), Nintendo DS
Type API
License zlib License
Before 2.0.0:
GNU LGPL [4]
Website www.libsdl.org

Simple DirectMedia Layer (SDL) is a cross-platform software development library designed to provide a hardware abstraction layer for computer multimedia hardware components. Software developers can use it to write high-performance computer games and other multimedia applications that can run on many operating systems such as Android, iOS, Linux, macOS, and Windows. [5]

Contents

SDL manages video, audio, input devices, CD-ROM, threads, shared object loading, networking and timers. [6] For 3D graphics, it can handle an OpenGL, Vulkan, [7] Metal, or Direct3D11 (older Direct3D version 9 is also supported) context. A common misconception is that SDL is a game engine. However, the library is suited to building games directly, or is usable indirectly by engines built on top of it.

The library is internally written in C and possibly, depending on the target platform, C++ or Objective-C, and provides the application programming interface in C, with bindings to other languages available. [8] It is free and open-source software subject to the requirements of the zlib License since version 2.0, and with prior versions subject to the GNU Lesser General Public License. [4] Under the zlib License, SDL 2.0 is freely available for static linking in closed-source projects, unlike SDL 1.2. [9] SDL 2.0, released in 2013, was a major departure from previous versions, offering more opportunity for 3D hardware acceleration, but breaking backwards-compatibility.

SDL is extensively used in the industry in both large and small projects. Over 700 games, 180 applications, and 120 demos have been posted on the library website. [10]

History

Sam Lantinga created the library, first releasing it in early 1998, while working for Loki Software. He got the idea while porting a Windows application to Macintosh. He then used SDL to port Doom to BeOS (see Doom source ports). [11] Several other free libraries were developed to work alongside SDL, such as SMPEG and OpenAL. He also founded Galaxy Gameworks in 2008 to help commercially support SDL, although the company plans are currently on hold due to time constraints. [12]

Soon after putting Galaxy Gameworks on hold, Lantinga announced that SDL 1.3 (which would then later become SDL 2.0) would be licensed under the zlib License. [13] Lantinga announced SDL 2.0 on 14 July 2012, at the same time announcing that he was joining Valve, the first version of which was announced the same day he joined the company. [14] Lantinga announced the stable release of SDL 2.0.0 on 13 August 2013. [15]

SDL 2.0 is a major update to the SDL 1.2 codebase with a different, not backwards-compatible [16] API. It replaces several parts of the 1.2 API with more general support for multiple input and output options. Some feature additions include multiple window support, hardware-accelerated 2D graphics, and better Unicode support. [17]

Support for Mir and Wayland was added in SDL 2.0.2 [18] and enabled by default in SDL 2.0.4. [19] Version 2.0.4 also provided better support for Android. [20]

Software architecture

SDL is a wrapper around the operating-system-specific functions that the game needs to access. The only purpose of SDL is to provide a common framework for accessing these functions for multiple operating systems (cross-platform). [21] SDL provides support for 2D pixel operations, sound, file access, event handling, timing and threading. It is often used to complement OpenGL by setting up the graphical output and providing mouse and keyboard input, since OpenGL comprises only rendering.

A game using the Simple DirectMedia Layer will not automatically run on every operating system; further adaptations must be applied. These are reduced to the minimum, since SDL also contains a few abstraction APIs for frequent functions offered by an operating system.

The syntax of SDL is function-based: all operations done in SDL are done by passing parameters to subroutines (functions). Special structures are also used to store the specific information SDL needs to handle. SDL functions are categorized under several different subsystems.

Subsystems

SDL is divided into several subsystems: [22]

Basics
Initialization and Shutdown, Configuration Variables, Error Handling, Log Handling
Video
Display and Window Management, surface functions, rendering acceleration, etc.
Input Events
Event handling, Support for Keyboard, Mouse, Joystick and Game controller
Force Feedback
SDL_haptic.h implements support for "Force Feedback"
Audio
SDL_audio.h implements Audio Device Management, Playing and Recording
Threads
multi-threading: Thread Management, Thread Synchronization Primitives, Atomic Operations
Timers
Timer Support
File Abstraction
Filesystem Paths, File I/O Abstraction
Shared Object Support
Shared Object Loading and Function Lookup
Platform and CPU Information
Platform Detection, CPU Feature Detection, Byte Order and Byte Swapping, Bit Manipulation
Power Management
Power Management Status
Additional
Platform-specific functionality

Besides this basic, low-level support, there also are a few separate official libraries that provide some more functions. These comprise the "standard library", and are provided on the official website and included in the official documentation:

Other, non-standard libraries also exist. For example: SDL_Collide on SourceForge created by Amir Taaki.

Language bindings

The SDL 2.0 library has language bindings for:

Supported back-ends

Abstraction layers of several SDL platforms SDL Layers.svg
Abstraction layers of several SDL platforms

Because of the way SDL is designed, much of its source code is split into separate modules for each operating system, to make calls to the underlying system. When SDL is compiled, the appropriate modules are selected for the target system. The following back-ends are available: [5]

An unofficial Sixel back-end is available for SDL 1.2. [49]

The Rockbox MP3 player firmware also distributes a version of SDL 1.2, which is used to run games such as Quake. [50]

Reception and adoption

Workshop on SDL, University of Cadiz SDL-Workshop-IMG 2612.jpg
Workshop on SDL, University of Cádiz

Over the years SDL was used for many commercial and non-commercial video game projects. For instance, MobyGames listed 120 games using SDL in 2013, [51] and the SDL website itself listed around 700 games in 2012. [52] Important commercial examples are Angry Birds , [53] Unreal Tournament , and games developed using Valve's Source Engine, which uses SDL extensively for cross-platform compatibility; ones from the open-source domain are OpenTTD , [54] The Battle for Wesnoth [55] or Freeciv . [56]

The cross-platform game releases of the popular Humble Indie Bundles for Linux, Mac and Android are often SDL-based.

SDL is also often used for later ports on new platforms with legacy code. For instance, the PC game Homeworld was ported to the Pandora handheld [57] and Jagged Alliance 2 for Android [58] via SDL.

Also, several non video game programs use SDL; examples are the emulators, such as DOSBox, FUSE ZX Spectrum emulator and VisualBoyAdvance.

There were several books written for development with SDL (see further readings).

SDL is used in university courses teaching multimedia and computer science, for instance, in a workshop about game programming using libSDL at the University of Cadiz in 2010, or a Game Design discipline at UTFPR (Ponta Grossa campus) in 2015.

Video game examples using SDL

See also

Related Research Articles

<span class="mw-page-title-main">OpenGL Utility Toolkit</span>

The OpenGL Utility Toolkit (GLUT) is a library of utilities for OpenGL programs, which primarily perform system-level I/O with the host operating system. Functions performed include window definition, window control, and monitoring of keyboard and mouse input. Routines for drawing a number of geometric primitives are also provided, including cubes, spheres and the Utah teapot. GLUT also has some limited support for creating pop-up menus.

<span class="mw-page-title-main">OpenGL</span> Cross-platform graphics API

OpenGL is a cross-language, cross-platform application programming interface (API) for rendering 2D and 3D vector graphics. The API is typically used to interact with a graphics processing unit (GPU), to achieve hardware-accelerated rendering.

Irrlicht is an open-source game engine written in C++. It is cross-platform, officially running on Windows, macOS, Linux and Windows CE and due to its open nature ports to other systems are available, including FreeBSD, Xbox, PlayStation Portable, Symbian, iPhone, AmigaOS 4, Sailfish OS via a QT/Qml wrapper, and Google Native Client.

<span class="mw-page-title-main">OpenAL</span> API for rendering audio

OpenAL is a cross-platform audio application programming interface (API). It is designed for efficient rendering of multichannel three-dimensional positional audio. Its API style and conventions deliberately resemble those of OpenGL. OpenAL is an environmental 3D audio library, which can add realism to a game by simulating attenuation, the Doppler effect, and material densities.

<i>SuperTux</i> Free and open-source 2D platform game

SuperTux is a free and open-source two-dimensional platform video game inspired by Nintendo's Super Mario Bros. series. The player character is Tux, the official mascot of the Linux kernel.

<i>Abuse</i> (video game) 1996 video game

Abuse is a run and gun video game developed by Crack dot Com and published by Electronic Arts in North America and Origin Systems in Europe. It was released on February 29, 1996 for MS-DOS. A Mac OS port of the game was published by Bungie and released on March 5, 1997. The game's source code, along with some of the shareware content, has been in the public domain since the late 1990s and has been ported to Linux and many other platforms.

Pygame is a cross-platform set of Python modules designed for writing video games. It includes computer graphics and sound libraries designed to be used with the Python programming language.

<span class="mw-page-title-main">OpenGL ES</span> Subset of the OpenGL API for embedded systems

OpenGL for Embedded Systems is a subset of the OpenGL computer graphics rendering application programming interface (API) for rendering 2D and 3D computer graphics such as those used by video games, typically hardware-accelerated using a graphics processing unit (GPU). It is designed for embedded systems like smartphones, tablet computers, video game consoles and PDAs. OpenGL ES is the "most widely deployed 3D graphics API in history".

Sam Oscar Lantinga is a computer programmer. He used to be the lead software engineer at Blizzard Entertainment, where he was known to the community as Slouken. He is best known as the creator of the Simple DirectMedia Layer, a very popular open source multimedia programming library, and also developed the compatibility database for Executor, a proprietary Mac OS emulator.

<span class="mw-page-title-main">Open-source video game</span> Video game whose source code is open-source software

An open-source video game, or simply an open-source game, is a video game whose source code is open-source. They are often freely distributable and sometimes cross-platform compatible.

<i>C-Dogs</i> 2023 video game

C-Dogs, the sequel to Cyberdogs, is a shoot 'em up video game where players work cooperatively during missions, and against each other in "dogfight" deathmatch mode.

<span class="mw-page-title-main">Simple and Fast Multimedia Library</span> Graphics and Multimedia Library written in C++

Simple and Fast Multimedia Library (SFML) is a cross-platform software development library designed to provide a simple application programming interface (API) to various multimedia components in computers. It is written in C++ with bindings available for Ada, C, Crystal, D, Euphoria, Go, Java, Julia, .NET, Nim, OCaml, Python, Ruby, and Rust. Experimental mobile ports were made available for Android and iOS with the release of SFML 2.2.

<span class="mw-page-title-main">Kivy (framework)</span> Free and multi-platform graphical library for Python

Kivy is a free and open source Python framework for developing mobile apps and other multitouch application software with a natural user interface (NUI). It is distributed under the terms of the MIT License, and can run on Android, iOS, Linux, macOS, and Windows.

GLFW is a lightweight utility library for use with OpenGL. It provides programmers with the ability to create and manage windows and OpenGL contexts, as well as handle joystick, keyboard and mouse input.

mpv (media player) Free and open-source media player software

mpv is free and open-source media player software based on MPlayer, mplayer2 and FFmpeg. It runs on several operating systems, including Unix-like operating systems and Microsoft Windows, along with having an Android port called mpv-android. It is cross-platform, running on ARM, PowerPC, x86/IA-32, x86-64, and MIPS architecture.

MonoGame is a free and open source C# framework used by game developers to make games for multiple platforms and other systems. It is also used to make Windows and Windows Phone games run on other systems. It supports iOS, Android, macOS, tvOS, Linux, PlayStation 4, PlayStation 5, PlayStation Vita, Xbox One and Nintendo Switch. It implements the Microsoft XNA 4 application programming interface (API). It has been used for several games, including Bastion, Celeste,Fez and Stardew Valley.

<span class="mw-page-title-main">ORX</span> Game Engine

Orx is an open-source, portable, lightweight, plug-in-based, data-driven and easy to use 2D-oriented game engine written in C.

<span class="mw-page-title-main">Immediate mode GUI</span> Type of graphical user interface

An immediate mode graphic user interface (GUI), also known as IMGUI, is a graphical user interface design pattern which uses an immediate mode API to render controls, as opposed to a retained mode one.

LÖVE is a free, open-source, cross-platform framework released under the zlib license for developing video games. The framework is written in C++ and uses Lua as its scripting language and is still maintained by its original developers. The framework is cross-platform supporting the platforms Microsoft Windows, macOS, Linux, Android, and iOS.

raylib Game programming library

Raylib is a cross-platform open-source software development library. The library was made to create graphical applications and games.

References

  1. "2.30.0". 2 February 2024. Retrieved 3 February 2024.
  2. "Oh look, we'll have official tvOS support in SDL 2.0.5, for people that want their SDL-based games on Apple TV!". 15 September 2016.
  3. "SDL/docs/README-riscos.md at 9d83c0a65d969a902c91f4f94fd5a904c0828a33 · libsdl-org/SDL". GitHub. Retrieved 17 March 2024.
  4. 1 2 "SDL license" . Retrieved 3 March 2014.
  5. 1 2 "a list of the platforms SDL supports". Libsdl.org. Archived from the original on 1 April 2016. Retrieved 9 April 2016.
  6. "SDL official website". Libsdl.org. Retrieved 19 March 2010.
  7. 1 2 "CategoryVulkan - SDL Wiki'". wiki.libsdl.org. Retrieved 5 May 2019.
  8. 1 2 3 4 5 6 7 8 9 10 "SDL Language Bindings". libsdl.org. Simple DirectMedia Layer. Retrieved 13 August 2014.
  9. "Licensing the Simple DirectMedia Layer library" . Retrieved 30 January 2012.
  10. "Simple DirectMedia Layer". 29 June 2010. Archived from the original on 29 June 2010. Retrieved 7 August 2021.
  11. Lantinga, Sam (1 September 1999). "SDL: Making Linux fun". IBM . Archived from the original on 11 May 2003. Retrieved 15 December 2023.
  12. "Exploring the Galaxy". 6 April 2011. Retrieved 30 January 2012.
  13. SDL 1.3 to be zLib Licensed, SDL Mailing List, 7 April 2011
  14. "SDL 2.0 Is Coming Very Soon With New Features" . Retrieved 17 August 2012.
  15. Announcing SDL 2.0.0, SDL Mailing List, 13 August 2013
  16. MigrationGuide - SDL Wiki'. Wiki.libsdl.org (21 November 2013). Retrieved on 2013-12-08.
  17. "SDL 1.3 Roadmap". 14 June 2011. Retrieved 25 July 2011.
  18. Sneddon, Joey-Elijah (5 February 2014). "Some of Linux's Most Popular Games Will Run Natively On Mir" . Retrieved 19 March 2014.
  19. Lantinga, Sam (2 January 2016). "SDL 2.0.4 Changelog" . Retrieved 6 January 2016.
  20. "SDL_SysWMinfo".
  21. "Introduction to SDL" . Retrieved 3 March 2014.
  22. "APIByCategory".
  23. "SDL_image 2.0". libsdl.org. Retrieved 19 July 2014.
  24. "SDL_mixer 2.0". libsdl.org. Retrieved 19 July 2014.
  25. "SDL_net 2.0". libsdl.org. Retrieved 19 July 2014.
  26. "SDL_ttf 2.0". libsdl.org. Retrieved 19 July 2014.
  27. "SDL_rtf 0.1". libsdl.org. Retrieved 19 July 2014.
  28. "cl-sdl2". GitHub. Retrieved 23 November 2017.
  29. "f03sdl2". GitHub. Retrieved 28 October 2019.
  30. "gb.sdl2". Gambas Wiki. Retrieved 2 February 2023.
  31. 1 2 Robison, Arch D. (9 November 2015). "Go + Julia + Fourier = Open Source Frequon Invaders". software.intel.com. Retrieved 2 August 2019.
  32. "SDL on Hackage".
  33. "SDL2 on Hackage".
  34. Bieler, Jonathan (30 July 2020). "jonathanBieler/SimpleDirectMediaLayer.jl". GitHub . Retrieved 8 August 2020.
  35. SquidSinker (2 August 2020). "Example games for GameZero.jl". GitHub . Retrieved 8 August 2020.
  36. Daly, Nathan (31 July 2019). "Example game written in julia using SDL2". GitHub . Retrieved 2 August 2019.
  37. "SDL2 for Nim". GitHub. Retrieved 31 May 2022.
  38. "PerlGameDev/SDL". GitHub. Retrieved 20 February 2019.
  39. "PHP-SDL". GitHub. Retrieved 28 October 2019.
  40. "SDL2::Raw". modules.raku.org. Retrieved 15 May 2020.
  41. Beginning Ring Programming - From Novice to Professional | Mansour Ayouni | Apress.
  42. "Using RingLibSDL — Ring 1.16 documentation".
  43. "WhatsNew.txt" . Retrieved 28 September 2020.
  44. "[Commits] SDL: Enable building the Metal renderer by default, and weak lin..." 7 December 2017.
  45. "SDL: README-platforms.txt@3e2f230a6d62". Hg.libsdl.org. libsdl.org. Archived from the original on 15 December 2013. Retrieved 8 December 2013.
  46. "Using OpenGL With SDL" . Retrieved 9 July 2015.
  47. "SDL and Wayland".
  48. Larabel, Michael (30 September 2013). "Raspberry Pi Support Added To SDL2 Library".
  49. "SDL 1.2 Sixel". GitHub . Retrieved 9 April 2016.
  50. "SDLPluginPort" . Retrieved 11 August 2019.
  51. "Middleware: SDL Group Description". MobyGames. 27 September 2013. Retrieved 18 May 2012. Games that use the very portable Simple DirectMedia Layer.
  52. "Games". libsdl.org. 18 May 2012. Archived from the original on 29 June 2010. Retrieved 18 May 2012.
  53. "SDL Testimonials". Galaxygameworks.com. Archived from the original on 16 July 2011. Retrieved 1 February 2012.
  54. "Development". OpenTTD. Retrieved 19 March 2010.
  55. "CompilingWesnoth". Wesnoth. 27 February 2010. Retrieved 19 March 2010.
  56. "SDLClient - Freeciv.org". Freeciv.wikia.com. Retrieved 19 March 2010.
  57. may88 (23 June 2011). "Game of the Week #3 – Homeworld SDL". pandorapress.net. Retrieved 8 May 2012. [...] released port of HomeworldSDL. Forum member Edglex enables your Pandora to experience the excellent work done by the guys at HomeworldSDL.{{cite web}}: CS1 maint: numeric names: authors list (link)
  58. JA2 Stracciatella Feedback » Jagged Alliance 2 Android Stracciatella Port RC2 Release - please test Archived 23 October 2012 at the Wayback Machine on the Bear's Pit Forum, 3 October 2011
  59. "Features · fifengine/fifengine Wiki · GitHub". GitHub . Retrieved 9 March 2015.
  60. "FAQ Hedgewars". hedgewars.org. Retrieved 3 October 2014. ...SDL >= 1.2.5...
  61. "Development Details". scorched3d.co.uk. Archived from the original on 6 October 2014. Retrieved 3 October 2014. ...Simple DirectMedia Layer - SDL for cross platform game windowing...
  62. "About the game" . Retrieved 20 September 2021.
  63. "OOlite SDL Dependencies". GitHub . 29 May 2016. Retrieved 21 September 2021.
  64. "Roadmap - Wesnoth". www.wesnoth.org. Retrieved 9 March 2015.
  65. "New Release: 0 A.D. Alpha 19 Syllepsis". 26 November 2015. Retrieved 20 September 2021. Linux users, please be advised that SDL2 is now enabled by default on Linux.
  66. "Secret Maryo Chronicles". sourceforge.net. 28 August 2014. Retrieved 3 October 2014. ... based on SDL ...
  67. "Frozenbyte Support". trine2.com. Retrieved 1 September 2020.
  68. "[HowTo] Compile 0.7 on windows (Page 1) — Development — Teeworlds Forum".

Further reading