SDL_ts

SDL bindings for TypeScript.

Currently working via deno on Windows, Linux, and mac OS using FFI (Foreign Function Interface).

Primary Goals

Resembling the C API as much as possible. If someone reads a SDL tutorial (for example
LazyFoo) then they should be able to easily translate the tutorial to the
equivalent in this library.

Secondary Goals

Provide utiltiy functions which wrap SDL features into idomatic JavaScript (i.e. Events.asyncIterator).

Non Goals

Creating a higher level API or Game Framework. This library's only purpose is to expose the SDL API to TypeScript.

Versioning

This library's version number will match the SDL major and minor version against which it is currently tested. The patch number will be specifici to this library. I.E.

Getting Started

SDL2 Installation

Linux

Debain

sudo apt install libsdl2-2.0-0 libsdl2-image-2.0-0 libsdl2-ttf-2.0-0

Fedora

sudo dnf install SDL2 SDL2_image SDL2_ttf

Windows

MSYS2

pacman -S mingw-w64-ucrt-x86_64-SDL2 mingw-w64-ucrt-x86_64-SDL2_image mingw-w64-ucrt-x86_64-SDL2_ttf

You'll need to ensure then that the sysroot (in this case ucrt) is in your path. Assuming the default install location for msys2 then C:\msys64\ucrt64\bin.

MacOS

Homebrew

brew install sdl2 sdl2_image sdl2_ttf

Creating a Project

Located in the directory examples/getting-started are a minimal set of files needed to get a project up and running. Copy these files onto your computer and start the project with deno task start. You should see a window with SDL_ts as the title.

Loading shared libraries

Unless libraryPath is specified in the Init functions, SDL_ts will attempt to "find" the SDL shared libraries by determining the prefix and file extension appropriate for the operating system and looking in a set of different places also based on the operating system. The places where the shared libraries are searched for can be influenced by the environment variable SDL_TS_LIBRARY_PATH.

libraryPath

The Init functions (i.e. SDL_Init) have in their options object a libraryPath property. This property should be a path to the shared library and SDL_ts will make no attempt to guess where the library should be loaded from. This means it's up to the caller of the Init function to account for changes in the name of the library between the different platforms. For example the shared library on Linux is called libSDL2.so and Windows it is called SDL2.dll. There is a lib prefix on Linux and on Windows the file extension is .dll instead of .so.

SDL_TS_LIBRARY_PATH

The environmnet variable SDL_TS_LIBRARY_PATH can be used to instruct SDL_ts where the SDL shared libraries should be loaded from. See deno.json. All example projects will load the SDL shared libraries from the .lib directory if it exists.

Loading only required functions

Per default SDL.Init (or IMG.Init or TTF.Init) will load all known functions from the SDL assemblies. This can be problematic when attempting to run your script on an older version of the SDL assemblies than the version against which this library is developed. The Init functions accept an options parameter in which the functions to load can be specified:

SDL.Init(SDL.InitFlags.VIDEO, {
  functions: [
    SDL.Init,
    SDL.PollEvent,
    SDL.Quit,
    // And so on
  ],
});

Concepts

AllocatableStruct: is a Struct that can be allocated from JavaScript and will be backed by a Uint8Array. The constructor allows all properties to be set in a few ways.
OpaqueStruct: is a Struct where no properties are known to JavaScript (C code would also know about the fields) and can only be created by the native side. The Struct can only be passed back to the native side and usally to a function that will return information related to the Struct. The best example of this concept is SDL.Window.
Pointer<T>: represents a pointer to something and is explicitly typed as unknown by SDL_ts. Pointer<T> can only be returned from functions and will never be created by the JavaScript side. The concept of pointers can't completely be hidden when interfacing with SDL but SDL_ts attempts to constrain pointers to a type level concept. SDL_ts will take care of passing pointers to the native side as part of the marshalling process. See PointerLike<T>.
PointerLike<T>: is used only as an input to functions and is used to represent anything to which a pointer can be created for. This includes Pointer<T>, TypedArray(s), Struct(s) and StructArray(s).
Struct: the JavaScript representation of structs from the native side. Struct(s) are special classes because their data is either a Pointer<T> or a Uint8Array. If the Struct data is a Pointer<T> the Struct it was allocated on the native side and is read only (see OpaqueStruct). If the Struct data is an instance of Uint8Array it was allocated on the JavaScript side and can be written to as well as read from (see AllocatableStruct).
StructArray: Use the StructArray class to allocate an array on Struct(s). All Struct(s) in the the array will be backed by a shared Uint8Array allowing the entire array to be passed to the native side. Normal JavaScript arrays are not guarenteed to be laid out contiguously in memory. The Struct type passed to the constructor of the array must be an AllocatableStruct. All Struct(s) passed into the the constructor will have their data copied into the shared Uint8Array.