README

PHP extension providing Vulkan API bindings for use with PHPolygon — a 2D/3D engine written in PHP.

Requirements

• PHP >= 8.1
• Vulkan SDK (LunarG / MoltenVK on macOS)
• C compiler (gcc/clang)

Installation

macOS / Linux (From Source)

# Install Vulkan SDK (macOS)
brew install vulkan-sdk

# Build the extension
phpize
./configure --with-vulkan
make
make install

Add to your php.ini:

extension=vulkan

Windows

On Windows, no build toolchain is needed — PHP extensions are distributed as pre-compiled DLLs. Download the matching DLL from the Releases page (match your PHP version and thread-safety mode), then:

1. Copy php_vulkan.dll into your PHP ext\ directory
2. Add extension=vulkan to your php.ini
3. Restart PHP / your web server

Quick Start

<?php
// Create Vulkan instance
$instance = new Vk\Instance(appName: 'MyApp');

// List GPUs
foreach ($instance->getPhysicalDevices() as $device) {
    echo $device->getName() . " (" . $device->getTypeName() . ")\n";
}

API Overview

All classes live in the Vk namespace:

Constants are available via Vk\Vk::CONSTANT_NAME.

Examples

See the examples/ directory:

• 01_enumerate_devices.php — List all GPUs and their properties
• 02_compute_shader.php — Run a compute shader (multiply by 2)
• 03_memory_info.php — Buffer creation and memory operations

License

MIT