https://github.com/serafimarts/ffi-sdl

SDL2 FFI bindings for the PHP language
https://github.com/serafimarts/ffi-sdl

ffi opengl php sdl sdl2 sdl2-bindings

Last synced: 3 months ago
JSON representation

SDL2 FFI bindings for the PHP language

• Host: GitHub
• URL: https://github.com/serafimarts/ffi-sdl
• Owner: SerafimArts
• License: mit
• Created: 2020-02-23T03:46:55.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-08-12T20:25:09.000Z (over 1 year ago)
• Last Synced: 2024-03-15T15:10:08.069Z (11 months ago)
• Topics: ffi, opengl, php, sdl, sdl2, sdl2-bindings
• Language: C
• Homepage:
• Size: 4.9 MB
• Stars: 27
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# FFI SDL Bindings



    

    

    

    

    

    





    



A SDL FFI bindings for the PHP language.

- [System Requirements](#requirements)

- [Installation](#installation)

- [Extensions](#extensions)

- [Documentation](#documentation)

- [Initialization](#initialization)

- [Example](#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.

```bash

$ 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](https://github.com/libsdl-org/SDL/releases)

## Extensions

- [SDL Image](https://github.com/SerafimArts/ffi-sdl-image)

- [SDL TTF](https://github.com/SerafimArts/ffi-sdl-ttf)

- [SDL Mixer](https://github.com/SerafimArts/ffi-sdl-mixer)

## Documentation

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

- [SDL2 official documentation](https://wiki.libsdl.org/FrontPage)

- 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.

```php

// 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.

```php

// 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.

```php

// 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.

```php

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

```

In addition, you can control other preprocessor directives explicitly:

```php

$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

```php

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();

```