History

Ryan C. Gordon f4c2c09f78 examples: Link to SDL integer types in code examples, too.		2024-09-09 15:41:28 -04:00
..
audio	The parameter to SDL_AppEvent() should be non-const	2024-09-03 08:18:36 -07:00
camera/01-read-and-draw	The parameter to SDL_AppEvent() should be non-const	2024-09-03 08:18:36 -07:00
game/01-snake	The parameter to SDL_AppEvent() should be non-const	2024-09-03 08:18:36 -07:00
pen/01-drawing-lines	The parameter to SDL_AppEvent() should be non-const	2024-09-03 08:18:36 -07:00
renderer	The parameter to SDL_AppEvent() should be non-const	2024-09-03 08:18:36 -07:00
CMakeLists.txt	winrt: Removed WinRT/Windows Phone/UWP support.	2024-09-06 13:28:39 -04:00
README.md	examples: Add CMake glue to optionally build examples, as we do for the tests.	2024-07-23 00:58:57 -04:00
highlight-plugin.lua	examples: Link to SDL integer types in code examples, too.	2024-09-09 15:41:28 -04:00
template.c	The parameter to SDL_AppEvent() should be non-const	2024-09-03 08:18:36 -07:00
template.html	Fix examples description CSS	2024-07-30 13:46:34 -04:00

README.md

Examples

What is this?

In here are a collection of standalone SDL application examples. Unless otherwise stated, they should work on all supported platforms out of the box. If they don't please file a bug to let us know.

What is this SDL_AppIterate thing?

SDL can optionally build apps as a collection of callbacks instead of the usual program structure that starts and ends in a function called main. The examples use this format for two reasons.

First, it allows the examples to work when built as web applications without a pile of ugly #ifdefs, and all of these examples are published on the web at examples.libsdl.org, so you can easily see them in action.

Second, it's example code! The callbacks let us cleanly break the program up into the four logical pieces most apps care about:

Program startup
Event handling
What the program actually does in a single frame
Program shutdown

A detailed technical explanation of these callbacks is in docs/README-main-functions.md (or view that page on the web on the wiki).

I would like to build and run these examples myself.

When you build SDL with CMake, you can add -DSDL_EXAMPLES=On to the CMake command line. When you build SDL, these examples will be built with it.

But most of these can just be built as a single .c file, as long as you point your compiler at SDL3's headers and link against SDL.

What is the license on the example code? Can I paste this into my project?

All code in the examples directory is considered public domain! You can do anything you like with it, including copy/paste it into your closed-source project, sell it, and pretend you wrote it yourself. We do not require you to give us credit for this code (but we always appreciate if you do!).

This is only true for the examples directory. The rest of SDL falls under the zlib license.

What is template.html and highlight-plugin.lua in this directory?

This is what examples.libsdl.org uses when generating the web versions of these example programs. You can ignore this, unless you are improving it, in which case we definitely would love to hear from you!

What is template.c in this directory?

If writing new examples, this is the skeleton code we start from, to keep everything consistent. You can ignore it.