README

A SDL FFI bindings for the PHP language.

• System Requirements
• Installation
• Extensions
• Documentation
• Initialization
• Example

Requirements

• PHP ^8.1
• ext-ffi
• Windows, Linux, BSD or MacOS
  • Android, iOS or something else are not supported yet
• SDL >= 2.0

Installation

Library is available as composer repository and can be installed using the following command in a root of your project.

$ composer require serafim/ffi-sdl

Additional dependencies:

• Debian-based Linux: sudo apt install libsdl2-2.0-0 -y
• MacOS: brew install sdl2
• Window: Can be downloaded from here

Extensions

• SDL Image
• SDL TTF
• SDL Mixer

Documentation

The library API completely supports and repeats the analogue in the C language.

• SDL2 official documentation

• API not yet fully documented and may not work in places.

• Low level and inline functions (such as SDL_malloc or SDL_memcpy) have been removed.

Initialization

To specify a library pathname explicitly, you can add the library argument to the Serafim\SDL\SDL constructor.

By default, the library will try to resolve the binary's pathname automatically.

// Load library from pathname (it may be relative or part of system-dependent path)
$sdl = new Serafim\SDL\SDL(library: __DIR__ . '/path/to/library.so');

// Try to automatically resolve library's pathname
$sdl = new Serafim\SDL\SDL(library: null);

You can explicitly specify the platform (OS) that will be used as the basis for compiling headers.

By default, the library will try to resolve the platform automatically.

// Use Linux as compile-aware platform
$sdl = new Serafim\SDL\SDL(platform: Serafim\SDL\Platform::LINUX);

// Detect platform automatically
$sdl = new Serafim\SDL\SDL(platform: null);

You can also specify the library version explicitly. Depending on this version, the corresponding functions of the SDL will be available.

By default, the library will try to resolve SDL version automatically.

// Use v2.28.2 from string
$sdl = new Serafim\SDL\SDL(version: '2.28.2');

// Use v2.24.1 from predefined versions constant
$sdl = new Serafim\SDL\SDL(version: \Serafim\SDL\Version::V2_24_1);

// Use latest supported version
$sdl = new Serafim\SDL\SDL(version: \Serafim\SDL\Version::LATEST);

To speed up the header compiler, you can use any PSR-16 compatible cache driver.

$sdl = new Serafim\SDL\SDL(cache: new Psr16Cache(...));

In addition, you can control other preprocessor directives explicitly:

$pre = new \FFI\Preprocessor\Preprocessor();
$pre->setLogger(new ExampleLogger());
$pre->define('__ANDROID__', '1');

$sdl = new Serafim\SDL\SDL(pre: $pre);
$jni = $sdl->SDL_AndroidGetJNIEnv();

Example

use Serafim\SDL\SDL;
use Serafim\SDL\Event\Type;

$sdl = new SDL();

$sdl->SDL_Init(SDL::SDL_INIT_VIDEO);

$window = $sdl->SDL_CreateWindow(
    'An SDL2 window',
    SDL::SDL_WINDOWPOS_UNDEFINED,
    SDL::SDL_WINDOWPOS_UNDEFINED,
    640,
    480,
    SDL::SDL_WINDOW_OPENGL
);

if ($window === null) {
    throw new \Exception(sprintf('Could not create window: %s', $sdl->SDL_GetError()));
}

$event = $sdl->new('SDL_Event');
$running = true;

while ($running) {
    $sdl->SDL_PollEvent(FFI::addr($event));
    if ($event->type === Type::SDL_QUIT) {
        $running = false;
    }
}

$sdl->SDL_DestroyWindow($window);
$sdl->SDL_Quit();