sdl3

Scala Native bindings for SDL3 and its satellite libraries, as a monorepo of one-library-per-module bindings. Each module is a thin two-layer binding: a raw @extern FFI layer (the only place Scala Native types appear) and a pure-Scala wrapper that speaks in Int, Double, Boolean, String, Color, and zero-cost AnyVal-wrapped handles.

These are Native-only artifacts — there is no JVM or JS build.

Documentation

Full documentation — installation, a quick start, the binding's design, and a page per module with examples — is at sdl3.edadma.dev (source in docs/). This README is a quick taste; the site is the reference.

Modules

Module	Artifact	System library	Description
`core`	`io.github.edadma::sdl3`	`SDL3`	Window (incl. resize events and display usable bounds), float render API (incl. `RenderGeometry` fills), textures, surfaces, events, keyboard/mouse, clipboard, hints, render targets, PCM audio playback
`ttf`	`io.github.edadma::sdl3_ttf`	`SDL3_ttf`	Font loading and text rendering (built on `core`)
`image`	`io.github.edadma::sdl3_image`	`SDL3_image`	Image decoding to surfaces/textures (built on `core`)
`mixer`	`io.github.edadma::sdl3_mixer`	`SDL3_mixer`	Audio file loading and mixing — music and decoded effects (built on `core`). For raw/synthesised PCM, `core`'s audio streams need no extra system library.

The satellite modules depend on core directly within the build, so the suite can be developed and tested without publishing intermediate versions.

Why SDL3

Versus SDL2, the SDL3 render API takes floating-point coordinates (no more 16-bit clamping), most calls return Boolean success, and SDL_ttf 3 brings a HarfBuzz text-shaping engine. Antialiased/filled primitives that used to need SDL2_gfx are covered by the float SDL_RenderLine/SDL_RenderGeometry calls plus supersampled render targets, so there is no gfx module.

Prerequisites

Install the native libraries (macOS / Homebrew):

brew install sdl3 sdl3_ttf sdl3_image sdl3_mixer

Usage

Add the module(s) you need (Scala Native):

libraryDependencies += "io.github.edadma" %%% "sdl3"       % "0.2.7"
libraryDependencies += "io.github.edadma" %%% "sdl3_ttf"   % "0.2.7"
libraryDependencies += "io.github.edadma" %%% "sdl3_image" % "0.2.7"
libraryDependencies += "io.github.edadma" %%% "sdl3_mixer" % "0.2.7"

import io.github.edadma.sdl3.*

setMainReady()
init(INIT_VIDEO)

val window   = createWindow("Hello SDL3", 800, 600)
val renderer = window.createRenderer()

renderer.clear(Color.Black)
renderer.setDrawColor(Color.fromRGB(0x4dabf7))
renderer.fillRect(100, 100, 200, 150)
renderer.fillCircle(400, 300, 60, Color.fromRGB(0xff6b6b))   // triangulated fill
renderer.thickLine(0, 0, 800, 600, 3, Color.White)
renderer.present()

delay(2000)

renderer.destroy()
window.destroy()
quit()

Building

sbt core/test    # build, link against libSDL3, run tests
sbt ttf/test
sbt image/test

License

ISC — see LICENSE.

edadma / sdl3 0.2.7