Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/BindBC/bindbc-sdl

Static & dynamic D bindings to SDL and the SDL_* libraries, compatible with BetterC, @nogc, and nothrow.
https://github.com/BindBC/bindbc-sdl
bindbc dlang sdl-image sdl-mixer sdl-net sdl-ttf sdl2 sdl2-bindings
Last synced: 2 months ago
JSON representation
Static & dynamic D bindings to SDL and the SDL_* libraries, compatible with BetterC, @nogc, and nothrow.
Host: GitHub
URL: https://github.com/BindBC/bindbc-sdl
Owner: BindBC
License: bsl-1.0
Created: 2018-03-07T12:26:50.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-07-27T03:24:51.000Z (2 months ago)
Last Synced: 2024-07-28T03:34:08.473Z (2 months ago)
Topics: bindbc, dlang, sdl-image, sdl-mixer, sdl-net, sdl-ttf, sdl2, sdl2-bindings
Language: D
Homepage:
Size: 763 KB
Stars: 85
Watchers: 6
Forks: 25
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE_1_0.txt
Awesome Lists containing this project

awesome-d - bindbc-sdl
README

        ## NOTICE: All future pull requests for SDL2 support should be in the [SDL2](https://github.com/BindBC/bindbc-sdl/tree/SDL2) branch, as `~master` is now moving towards supporting SDL3 exclusively.

## NOTICE: SDL 3.0 has not been officially released yet. This documentation is being written as if it is.



	



# BindBC-SDL

This project provides a set of both static and dynamic bindings to

[SDL (Simple DirectMedia Layer)](https://libsdl.org/) and its official extension libraries. They are compatible with `@nogc` and `nothrow`, and can be compiled with BetterC compatibility.

| Table of Contents |

|-------------------|

|[License](#license)|

|[SDL documentation](#sdl-documentation)|

|[Quickstart guide](#quickstart-guide)|

|[Configurations](#configurations)|

|[Library versions](#library-versions)|

|[Special platforms](#special-platforms)|

|[Windows: Loading from outside the DLL search path](#windows-loading-from-outside-the-dll-search-path)|

## License

BindBC-SDL—as well as every other binding in the [BindBC project](https://github.com/BindBC)—is licensed under the [Boost Software License](https://www.boost.org/LICENSE_1_0.txt).

Bear in mind that you still need to abide by [SDL's license](https://github.com/libsdl-org/SDL/blob/main/LICENSE.txt), and the licenses of any SDL_* libraries that you use through these bindings.

## SDL documentation

This readme describes how to use BindBC-SDL, *not* SDL itself. BindBC-SDL is a direct D binding to the SDL3 API, so any existing SDL documentation and tutorials can be adapted with only minor modifications.

* [The SDL Wiki](https://wiki.libsdl.org/FrontPage) has official documentation of the SDL API. It also has [a list of tutorials](https://wiki.libsdl.org/SDL3/Tutorials), although most still deal with SDL2 at present.

* [How to migrate from SDL 2.0](https://github.com/libsdl-org/SDL/blob/main/docs/README-migration.md).

> [!NOTE]\

> The bindings for `SDL_atomics.h` have not been thoroughly tested. If the `SDL_atomics` binding causes trouble and you don't need to use it, you can supply the version identifier `SDL_No_Atomics` and the module's contents will not be compiled. If it's causing trouble and you need it, please report an issue.

## Quickstart guide

To use BindBC-SDL in your dub project, add it to the list of `dependencies` in your dub configuration file. The easiest way is by running `dub add bindbc-sdl` in your project folder. The result should look like this:

Example __dub.json__

```json

"dependencies": {

	"bindbc-sdl": "~>2.0.0",

},

```

Example __dub.sdl__

```sdl

dependency "bindbc-sdl" version="~>2.0.0"

```

By default, BindBC-SDL is configured to compile as a dynamic binding that is not BetterC-compatible. If you prefer static bindings or need BetterC compatibility, they can be enabled via `subConfigurations` in your dub configuration file. For configuration naming & more details, see [Configurations](#configurations).

Example __dub.json__

```json

"subConfigurations": {

	"bindbc-sdl": "staticBC",

},

```

Example __dub.sdl__

```sdl

subConfiguration "bindbc-sdl" "staticBC"

```

If you need to use the SDL_* libraries, or versions of SDL newer than 3.0.0, then you will have to add the appropriate version identifiers to `versions` in your dub configuration. For a list of library version identifiers, see [Library versions](#library-versions).

If you're using static bindings, then you will also need to add the name of each library you're using to `libs`.

Example __dub.json__

```json

"versions": [

	"SDL_3_2", "SDL_Net_3_0",

],

"libs": [

	"SDL3", "SDL3_net",

],

```

Example __dub.sdl__

```sdl

versions "SDL_3_2" "SDL_Net_3_2"

libs "SDL3" "SDL3_net"

```

**If you're using static bindings**: `import bindbc.sdl` in your code, and then you can use all of SDL just like you would in C. That's it!

```d

import bindbc.sdl;

void main(){

	SDL_Init(SDL_INIT_VIDEO);

	

	//etc.

	

	SDL_Quit();

}

```

**If you're using dynamic bindings**: you need to load each library you need with the appropriate load function. 

For most use cases, it's best to use BindBC-Loader's [error handling API](https://github.com/BindBC/bindbc-loader#error-handling) to see if there were any errors while loading the libraries. This information can be written to a log file before aborting the program.

The load function will also return a member of the `LoadMsg` enum, which can be used for debugging:

* `noLibrary` means the library couldn't be found.

* `badLibrary` means there was an error while loading the library.

* `success` means that the library was loaded without any errors.

You should also check that the desired minimum version of the library was loaded. You can do this using:

* `SDL_GetVersion()` for SDL.

* `IMG_Linked_Version()` for SDL_image.

* `Mix_Linked_Version()` for SDL_mixer.

* `SDLNet_Linked_Version()` for SDL_net.

* `TTF_Linked_Version()` for SDL_ttf.

Here's a simple example using only the load function's return value:

```d

import bindbc.sdl;

import bindbc.loader;

/*

This code attempts to load the SDL shared library using

well-known variations of the library name for the host system.

*/

LoadMsg ret = loadSDL();

if(ret != LoadMsg.success){

	/*

	Error handling. For most use cases, it's best to use the error handling API in

	BindBC-Loader to retrieve error messages for logging and then abort.

	If necessary, it's possible to determine the root cause via the return value:

	*/

	if(ret == LoadMsg.noLibrary){

		//The SDL shared library failed to load

	}else if(ret == LoadMsg.badLibrary){

		/*

		One or more symbols failed to load. The likely cause is that

		the shared library is for a lower version than BindBC-SDL was

		configured to load.

		*/

	}

}

/*

This code attempts to load the SDL library using a user-supplied file name.

Usually, the name and/or path used will be platform specific, as in this

example which attempts to load `sdl3.dll` from the `libs` subdirectory,

relative to the executable, only on Windows.

*/

version(Windows) loadSDL("libs/sdl3.dll");

```

[The error handling API](https://github.com/BindBC/bindbc-loader#error-handling) in BindBC-Loader can be used to log error messages:

```d

import bindbc.sdl;

/*

Import the sharedlib module for error handling. Assigning an alias ensures that the

function names do not conflict with other public APIs. This isn't strictly necessary,

but the API names are common enough that they could appear in other packages.

*/

import loader = bindbc.loader.sharedlib;

bool loadLib(){

	LoadMsg ret = loadSDL();

	if(ret != LoadMsg.success){

		//Log the error info

		foreach(info; loader.errors){

			/*

			A hypothetical logging function. Note that `info.error` and

			`info.message` are null-terminated `const(char)*`, not `string`.

			*/

			logError(info.error, info.message);

		}

		

		//Optionally construct a user-friendly error message for the user

		string msg;

		if(ret == LoadMsg.noLibrary){

			msg = "This application requires the SDL library.";

		}else{

			SDL_version version_;

			SDL_GetVersion(&version_);

			msg = "Your SDL version is too low: "~

				itoa(version_.major)~"."~

				itoa(version_.minor)~"."~

				itoa(version_.patch)~

				". Please upgrade to 3.2.0+.";

		}

		//A hypothetical message box function

		showMessageBox(msg);

		return false;

	}

	return true;

}

```

## Configurations

BindBC-SDL has the following configurations:

|      ┌      |  DRuntime  |   BetterC   |

|-------------|------------|-------------|

| **Dynamic** | `dynamic`  | `dynamicBC` |

| **Static**  | `static`   | `staticBC`  |

For projects that don't use dub, if BindBC-SDL is compiled for static bindings then the version identifier `BindSDL_Static` must be passed to your compiler when building your project.

> [!NOTE]\

> The version identifier `BindBC_Static` can be used to configure all of the _official_ BindBC packages used in your program. (i.e. those maintained in [the BindBC GitHub organisation](https://github.com/BindBC)) Some third-party BindBC packages may support it as well.

### Dynamic bindings

The dynamic bindings have no link-time dependency on the SDL libraries, so the SDL shared libraries must be manually loaded at runtime from the shared library search path of the user's system.

On Windows, this is typically handled by distributing the SDL DLLs with your program.

On other systems, it usually means installing the SDL shared libraries through a package manager.

It is recommended that you always select the minimum version you require _and no higher_.

If a lower version is loaded then it's still possible to call functions available in that lower version, but any calls to functions from versions between that version and the one you configured will result in a null pointer access.

For example, if you configured SDL to 3.4.0 (`SDL_3_4`) but loaded SDL 3.0.0 at runtime, then any function pointers from 3.4.0 and 3.2.0 will be `null`. For this reason, it's recommended to always specify your required version of the SDL library at compile time and unconditionally abort when you receive an `LoadMsg.badLibrary` return value from `loadSDL` (or equivalent).

The function `isSDLLoaded` returns `true` if any version of the shared library has been loaded and `false` if not. `unloadSDL` can be used to unload a successfully loaded shared library. The SDL_* libraries provide similar functions: `isSDLImageLoaded`, `unloadSDLImage`, etc.

### Static bindings

Static _bindings_ do not require static _linking_. The static bindings have a link-time dependency on either the shared _or_ static SDL libraries and any satellite SDL libraries the program uses. On Windows, you can link with the static libraries or, to use the DLLs, the import libraries. On other systems, you can link with either the static libraries or directly with the shared libraries.

When linking with the shared (or import) libraries, there is a runtime dependency on the shared library just as there is when using the dynamic bindings. The difference is that the shared libraries are no longer loaded manually—loading is handled automatically by the system when the program is launched. Attempting to call `loadSDL` with the static bindings enabled will result in a compilation error.

Static linking requires the SDL development packages be installed on your system. The [SDL releases page](https://github.com/libsdl-org/SDL/releases) provides development packages for Windows and macOS. You can also install them via your system's package manager. For example, on Debian-based Linux distributions `sudo apt install libsdl3-dev` will install both the development and runtime packages.

When linking with the static libraries, there is no runtime dependency on SDL. The SDL homepage does not distribute pre-compiled static libraries. If you decide to obtain static libraries from another source (usually by compiling them yourself) you will also need to ensure that you link with all of SDL's link-time dependencies (such as the OpenGL library and system API libraries).

## Library Versions

These are the supported versions of each SDL_* library, along with the corresponding version identifiers to add to your dub configuration or pass to the compiler.

> [!NOTE]\

> If you have `SDL_THREAD_SAFETY_ANALYSIS` support enabled in SDL, you may use version identifier `SDL_ThreadSafetyAnalysis`.

> [!NOTE]\

> It is necessary to specify only a single version identifier per library. For example, `SDL_Image_3_0` by itself will activate the SDL_image binding.

> [!NOTE]\

> All even-numbered SDL/SDL_* versions are releases, while all odd-numbered versions are pre-releases—which are not for general use and are therefore not supported by BindBC-SDL.

	
SDL versions


| Version     |Version identifier|

|-------------|------------------|

| 3.0.0       | (none; default)  |

SDL_image versions


| Version |Version identifier| Public API changed |

|---------|------------------|--------------------|

| 3.0.0   | `SDL_Image_3_0`  |                    |

SDL_mixer versions


| Version |Version identifier| Public API changed |

|---------|------------------|--------------------|

| 3.0.0   | `SDL_Mixer_3_0`  |                    |

SDL_net versions


| Version |Version identifier| Public API changed |

|---------|------------------|--------------------|

| 3.0.0   | `SDL_Net_3_0`    |                    |

SDL_ttf versions


| Version |Version identifier| Public API changed |

|---------|------------------|--------------------|

| 3.0.0   | `SDL_TTF_3_0`    |                    |

## Special platforms

Some platforms do not have [pre-defined versions in D](https://dlang.org/spec/version.html#predefined-versions), meaning that BindBC-SDL has to use custom version identifiers for them.

If you intend to compile for any of these platforms, please add the corresponding version identifier(s) in your dub recipe's `versions` list, or supply them directly to the compiler.

> [!NOTE]\

> If you're building on Wayland and you have X11 support disabled in SDL, please add version identifier `SDL_NoX11`.

| Platform                       | Version identifier |

|--------------------------------|--------------------|

| DirectFB                       | `DirectFB`         |

| KMS/DRM                        | `KMSDRM`           |

| Mir-server                     | `Mir`              |

| Operating System/2             | `OS2`              |

| Vivante                        | `Vivante`          |

| Microsoft Game Development Kit | `WinGDK`           |

| Windows Runtime                | `WinRT`            |

## Windows: Loading from outside the DLL search path

The SDL libraries load some dependency DLLs dynamically in the same way that BindBC can load libraries dynamically. There is an issue that can arise on Windows when putting some of the SDL DLLs in a subdirectory of your executable directory. That is, if your executable is (for example) in the directory `myapp`, and the SDL DLLs are in the directory `myapp\libs`, you may find that one or more of the SDL libraries fails to load. To solve or prevent this problem, take the following steps:

First, make sure the non-system libraries on which the SDL libraries depend (such as `zlib.dll`) are in the same directory as the SDL libraries.

Second, you'll want to add your subdirectory path to the Windows DLL search path. This can be accomplished via the function `setCustomLoaderSearchPath` in `BindBC-Loader`. For more details, see ["Default Windows search path"](https://github.com/BindBC/bindbc-loader#default-windows-search-path) from the BindBC-Loader readme.

The idea is that you call the function with the path to all of the DLLs before calling any of the load functions, then call it again with a `null` argument to reset to the default search path. Bear in mind that some of the SDL_* libraries load their dependencies lazily. For example, SDL_image will only load `libpng` when `IMG_Init` is called with the `IMG_INIT_PNG` flag, so the second call should not occur until after the libraries have been initialised.

```d

import bindbc.loader,

	bindbc.sdl;

// Assume the DLLs are stored in the "dlls" subdirectory

version(Windows) setCustomLoaderSearchPath("dlls");

if(loadSDL() < sdlSupport) { /* handle error */ }

if(loadSDLImage() < sdlImageSupport) { /* handle error */ }

// Give SDL_image a chance to load libpng and libjpeg

auto flags = IMG_INIT_PNG | IMG_INIT_JPEG;

if(IMG_Init(flags) != flags) { /* handle error */ }

// Now reset the default loader search path

version(Windows) setCustomLoaderSearchPath(null);

```

It is not strictly necessary to reset the default search path, but doing so can avoid unexpected issues for any other dependencies that may be loaded dynamically by an application's process.

`setCustomLoaderSearchPath` is only implemented on Windows. I know of no way to programmatically manipulate the default search path on Linux or other platforms (please correct me if I'm wrong). Then again, this issue doesn't generally arise on those platforms.