sdl3-wiki

Files (200)

• API_INDEX.md
• PAGE_INDEX.md
• SKILL.md
• UPDATING.md
• APIByCategory.md · references/
• Android.md · references/
• AppFreezeDuringDrag.md · references/
• Articles.md · references/
• BestKeyboardPractices.md · references/
• Books.md · references/
• CategoryAPI.md · references/
• CategoryAPICategory.md · references/
• CategoryAPIDatatype.md · references/
• CategoryAPIEnum.md · references/
• CategoryAPIEnumerators.md · references/
• CategoryAPIFunction.md · references/
• CategoryAPIMacro.md · references/
• CategoryAPIStruct.md · references/
• CategoryAndroid.md · references/
• CategoryAssert.md · references/
• CategoryAsyncIO.md · references/
• CategoryAtomic.md · references/
• CategoryAudio.md · references/
• CategoryBeginCode.md · references/
• CategoryBits.md · references/
• CategoryBlendmode.md · references/
• CategoryCPUInfo.md · references/
• CategoryCamera.md · references/
• CategoryClipboard.md · references/
• CategoryDialog.md · references/
• CategoryDlopenNotes.md · references/
• CategoryEndian.md · references/
• CategoryError.md · references/
• CategoryEvents.md · references/
• CategoryFilesystem.md · references/
• CategoryGPU.md · references/
• CategoryGUID.md · references/
• CategoryGameController.md · references/
• CategoryGamepad.md · references/
• CategoryHIDAPI.md · references/
• CategoryHaptic.md · references/
• CategoryHints.md · references/
• CategoryIOStream.md · references/
• CategoryInit.md · references/
• CategoryIntrinsics.md · references/
• CategoryJoystick.md · references/
• CategoryKeyboard.md · references/
• CategoryKeycode.md · references/
• CategoryLocale.md · references/
• CategoryLog.md · references/
• CategoryMain.md · references/
• CategoryMessagebox.md · references/
• CategoryMetal.md · references/
• CategoryMisc.md · references/
• CategoryMouse.md · references/
• CategoryMutex.md · references/
• CategoryOpenXR.md · references/
• CategoryPen.md · references/
• CategoryPixels.md · references/
• CategoryPlatform.md · references/
• …and 140 more

SKILL.md (first lines)

# SDL3 Wiki — Offline Reference

This skill is an offline mirror of the official SDL3 wiki at
<https://wiki.libsdl.org/SDL3/>, sourced from the upstream
[`libsdl-org/sdlwiki`](https://github.com/libsdl-org/sdlwiki) repository
(`SDL3/` subtree). The original pages were already authored in CommonMark
Markdown, so no format conversion was required — every page in
[`references/`](references/) is the exact source published on the wiki,
except that pure redirect pages have been eliminated and references to them
rewritten to point at the destination page (see [UPDATING.md](UPDATING.md)).

- **License of the wiki content:** Creative Commons Attribution 4.0
  International ([CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)).
  Stated by the wiki itself in [references/FAQLicensing.md](references/FAQLicensing.md):
  *"The wiki content is under the Creative Commons Attribution 4.0
  International license."* This is **not** the same as SDL's library
  license (which is the [zlib license](https://www.libsdl.org/license.php));
  the wiki and the library are licensed separately.
- **Attribution:** "SDL3 Wiki" by the SDL community
  (<https://github.com/libsdl-org/sdlwiki> contributors), used under
  CC BY 4.0. Individual page contents are unmodified except that links
  pointing at upstream redirect pages have been retargeted at the redirect
  destination. The only additions in this skill are this `SKILL.md`,
  `PAGE_INDEX.md`, `API_INDEX.md`, and `UPDATING.md`, which are derivative
  organizational material released under the same CC BY 4.0 terms.
- **Pages mirrored:** 2,371
- **API symbols indexed:** 4,119 (functions, structs, enums, enumerator
  values, macros, datatypes)

## How to use this skill

1. **Don't guess.** SDL3 renamed and reshaped a lot of SDL2 surface area
   (e.g. `SDL_RWops` → `SDL_IOStream`, `SDL_GetWindowSize` semantics, the
   whole new `SDL_gpu.h` / `SDL_camera.h` / `SDL_storage.h` subsystems).
   When in doubt, look the symbol up here before writing code.
2. **Pick the right entry point** from the TOC below:
   - Need a specific function/struct/enum? → [API Symbol Index](API_INDEX.md)
   - Browsing by subsystem (audio, video, GPU, input…)? →
     [API by Category](references/APIByCategory.md) (the wiki's own grouped TOC)
   - Migrating from SDL2? → [README-migration](references/README-migration.md)
     and [SDL12MigrationGuide](references/SDL12MigrationGuide.md)
   - Looking for any page by name? → [Full Page Index](PAGE_INDEX.md)
3. **Cross-link convention.** Inside the wiki, links like `[SDL_Foo](SDL_Foo)`
   are bare page names; in this skill they resolve to
   `references/SDL_Foo.md`. When you follow a link from a wiki page, prepend
   `references/` and append `.md` if the link doesn't already include them.
   Six pages whose names collide only by letter case (so they cannot coexist
   on Windows/macOS filesystems) were renamed with a `__uppercase`/
   `__lowercase` suffix and their inbound links retargeted — e.g. the
   natural-log `SDL_log` lives at `references/SDL_log__lowercase.md` (so it no
   longer clashes with the logging `SDL_Log`). See [UPDATING.md](UPDATING.md)
   for the full list.
4. **Image links may be broken.** A few pages reference images that live on
   the rendered wiki only — focus on the text, which is complete.

## Top-Level Table of Contents

Each entry below points to a *sub-TOC* — typically one of the wiki's own
auto-generated `Category*` pages, which then links to every individual page
in that section. This mirrors the wiki's own navigation structure rather
than imposing a new one.

| Section | Sub-TOC | What's in it |
|---|---|---|
| **Front page** | [FrontPage](references/FrontPage.md) | Wiki landing page, top-level orientation. |
| **API by category** | [APIByCategory](references/APIByCategory.md) | Subsystem-grouped index of all SDL3 headers (Basics, Video, Input, Audio, GPU, Threads, Time, File I/O, Platform, etc.). The canonical browsing entry point. |
| **Full API listing** | [CategoryAPI](references/CategoryAPI.md) | Master index of every API symbol (alphabetic). |
| **API symbol indexes (by symbol kind)** | see [API_INDEX.md](API_INDEX.md) | Functions / Structs / Enums / Enumerator values / Macros / Datatypes — each listing every symbol of that kind, with links. |
| **Full page index** | [PAGE_INDEX.md](PAGE_INDEX.md) | Every actual wiki page (2,371 of them), grouped into Guide / Category / SDL\_\* / Integer types. |
| **Quick reference** | [QuickReference](references/QuickReference.md) | One-page cheat sheet of the entire SDL3 API. Also: [QuickReferenceNoUnicode](references/QuickReferenceNoUnicode.md). |
| **FAQs** | [FAQs](references/FAQs.md) | Hub for [FAQGeneral](references/FAQGeneral.md), [FAQDevelopment](references/FAQDevelopment.md), [FAQUsingSDL](references/FAQUsingSDL.md), [FAQLicensing](references/FAQLicensing.md), [FAQCommunities](references/FAQCommunities.md). |
| **Tutorials** | [Tutorials](references/Tutorials.md) | Curated tutorial list (most tutorials live off-wiki at examples.libsdl.org). |
| **Getting started** | [SourceCode](references/SourceCode.md) | Plus IDE/build introductions: [INTRO-cmake](references/INTRO-cmake.md), [INTRO-visualstudio](references/INTRO-visualstudio.md), [INTRO-xcode](references/INTRO-xcode.md), [INTRO-mingw](references/INTRO-mingw.md), [INTRO-androidstudio](references/INTRO-androidstudio.md), [INTRO-emscripten](references/INTRO-emscripten.md). |
| **What's new in SDL3** | [NewFeatures](references/NewFeatures.md) | High-level feature additions over SDL2. |
| **SDL2 → SDL3 migration** | [README-migration](references/README-migration.md) | Detailed migration guide. Also [SDL12MigrationGuide](references/SDL12MigrationGuide.md) for the older SDL1 → SDL2 transition (still useful context). |
| **Platform & topic READMEs** | [READMEs](references/READMEs.md) | Per-platform setup and notes (Windows, macOS, Linux, iOS, Android, Wayland, Haiku, BSD, KMS/BSD, Emscripten, GDK, RISC OS, SteamOS, PS2/PS4/PS5/PSP/Vita, N3DS, Switch, NGage, QNX, DOS, OpenXR) and topic READMEs: [main-functions](references/README-main-functions.md), [highdpi](references/README-highdpi.md), [touch](references/README-touch.md), [strings](references/README-strings.md), [versions](references/README-versions.md), [dynapi](references/README-dynapi.md), [porting](references/README-porting.md), [contributing](references/README-contributing.md), [documentation-rules](references/README-documentation-rules.md). |
| **Reference / further reading** | [Articles](references/Articles.md), [Books](references/Books.md), [LanguageBindings](references/LanguageBindings.md), [Libraries](references/Libraries.md), [SupportedPlatforms](references/README-platforms.md), [EnvironmentVariables](references/EnvironmentVariables.md), [HowToReportBugs](references/HowToReportBugs.md) | Misc reference material. |
| **Subsystem sub-TOCs** | see table below | Each SDL subsystem has its own `Category*` page that lists every function, struct, enum, and macro for that header. |

### Subsystem sub-TOCs

These are the wiki's own per-subsystem index pages. Each one is a
self-contained sub-TOC — open it to see every symbol in that subsystem
with links to the individual symbol pages.

#### Basics
- [CategoryMain](references/CategoryMain.md) — Application entry points (`SDL_main.h`)
- [CategoryInit](references/CategoryInit.md) — Initialization and shutdown (`SDL_init.h`)
- [CategoryHints](references/CategoryHints.md) — Configuration hints (`SDL_hints.h`)
- [CategoryProperties](references/CategoryProperties.md) — Object properties (`SDL_properties.h`)
- [CategoryError](references/CategoryError.md) — Error handling (`SDL_error.h`)
- [CategoryLog](references/CategoryLog.md) — Logging (`SDL_log.h`)
- [CategoryAssert](references/CategoryAssert.md) — Assertions (`SDL_assert.h`)
- [CategoryVersion](references/CategoryVersion.md) — Version querying (`SDL_version.h`)

#### Video
- [CategoryVideo](references/CategoryVideo.md) — Display and window management (`SDL_video.h`)
- [CategoryRender](references/CategoryRender.md) — 2D accelerated rendering (`SDL_render.h`)
- [CategoryPixels](references/CategoryPixels.md) — Pixel formats (`SDL_pixels.h`)
- [CategoryBlendmode](references/CategoryBlendmode.md) — Blend modes (`SDL_blendmode.h`)
- [CategoryRect](references/CategoryRect.md) — Rectangle math (`SDL_rect.h`)
- [CategorySurface](references/CategorySurface.md) — Software surfaces (`SDL_surface.h`)
- [CategoryClipboard](references/CategoryClipboard.md) — Clipboard (`SDL_clipboard.h`)
- [CategoryVulkan](references/CategoryVulkan.md) — Vulkan integration (`SDL_vulkan.h`)
- [CategoryMetal](references/CategoryMetal.md) — Metal integration (`SDL_metal.h`)
- [CategoryOpenXR](references/CategoryOpenXR.md) — OpenXR integration (`SDL_openxr.h`)
- [CategoryCamera](references/CategoryCamera.md) — Camera capture (`SDL_camera.h`)

#### Input
- [CategoryEvents](references/CategoryEvents.md) — Event handling (`SDL_events.h`)
- [CategoryKeyboard](references/CategoryKeyboard.md) — Keyboard (`SDL_keyboard.h`)
- [CategoryKeycode](references/CategoryKeycode.md) — Keycodes (`SDL_keycode.h`)
- [CategoryScancode](references/CategoryScancode.md) — Scancodes (`SDL_scancode.h`)
- [CategoryMouse](references/CategoryMouse.md) — Mouse (`SDL_mouse.h`)
- [CategoryJoystick](references/CategoryJoystick.md) — Joystick (`SDL_joystick.h`)
- [CategoryGamepad](references/CategoryGamepad.md) — Gamepad (`SDL_gamepad.h`)
- [CategoryTouch](references/CategoryTouch.md) — Touch (`SDL_touch.h`)
- [CategoryPen](references/CategoryPen.md) — Pen / stylus (`SDL_pen.h`)
- [CategorySensor](references/CategorySensor.md) — Sensors (`SDL_sensor.h`)

From viktor-ferenczi/skills, MIT.

More from viktor-ferenczi/skills