Skip to content

Latest commit

 

History

History
95 lines (72 loc) · 3.73 KB

README.md

File metadata and controls

95 lines (72 loc) · 3.73 KB
Raw

CI Build

Auto-generated D bindings for the sokol headers.

Targets

  • Native
  • Wasm (-Dtarget=wasm32-emscripten-none)

By default, the backend 3D API will be selected based on the target platform:

  • macOS: Metal
  • Windows: D3D11
  • Linux: GL

BUILD

Required

  • zig v0.13.0 or master
  • ldc v1.39.0 or latest-CI (nightly)

Supported platforms are: Windows, macOS, Linux (with X11)

On Linux install the following packages: libglu1-mesa-dev, mesa-common-dev, xorg-dev, libasound-dev (or generally: the dev packages required for X11, GL and ALSA development)

# build sokol library + all examples [default: static library]
zig build -Doptimize=ReleaseSafe

# build sokol shared library + all examples
zig build -Doptimize=ReleaseSafe -Dshared

# Run Examples
zig build run-blend -Doptimize=ReleaseSafe
zig build run-clear -Doptimize=ReleaseSafe
zig build run-cube -Doptimize=ReleaseSafe
zig build run-debugtext -Doptimize=ReleaseSafe
zig build run-mrt -Doptimize=ReleaseSafe
zig build run-saudio -Doptimize=ReleaseSafe
zig build run-sgl_context -Doptimize=ReleaseSafe
zig build run-sgl_points -Doptimize=ReleaseSafe
zig build run-user_data -Doptimize=ReleaseSafe
zig build run-triangle -Doptimize=ReleaseSafe
zig build run-imgui -Doptimize=ReleaseSafe -Dimgui
zig build run-droptest -Doptimize=ReleaseSafe -Dimgui

zig build --help
# Project-Specific Options:
#  -Dgl=[bool]                  Force OpenGL (default: false)
#  -Dwgpu=[bool]                Force WebGPU (default: false, web only)
#  -Dx11=[bool]                 Force X11 (default: true, Linux only)
#  -Dwayland=[bool]             Force Wayland (default: false, Linux only, not supported in main-line headers)
#  -Degl=[bool]                 Force EGL (default: false, Linux only)
#  -Dimgui=[bool]               Add support for sokol_imgui.h bindings
#  -Dartifact=[bool]            Build artifacts (default: false)
#  -DbetterC=[bool]             Omit generating some runtime information and helper functions #(default: false)
#  -DzigCC=[bool]               Use zig cc as compiler and linker (default: false)
#  -Dtarget=[string]            The CPU architecture, OS, and ABI to build for
#  -Dcpu=[string]               Target CPU features to add or subtract
#  -Ddynamic-linker=[string]    Path to interpreter on the target system
#  -Doptimize=[enum]            Prioritize performance, safety, or binary size
#                                 Supported Values:
#                                   Debug
#                                   ReleaseSafe
#                                   ReleaseFast
#                                   ReleaseSmall
#  -Dshared=[bool]              Build sokol dynamic library (default: static)

(also run zig build -l to get a list of build targets)

Shaders

Checkout sokol-tools for a sokol shader pipeline! It supports these D bindings and all shaders in the examples folder here have been compiled using it with -f sokol_d!

zig build shaders # (re)generate D bindings from shaders.

License and attributions

This code is released under the zlib license (see `LICENSE` for info). Parts of `gen_d.py` have been copied and modified from the zig-bindings (https://github.com/floooh/sokol-zig/) and rust-bindings (https://github.com/floooh/sokol-rust/) for sokol. The sokol headers are created by Andre Weissflog (floooh) and sokol is released under its own license here: https://github.com/floooh/sokol/blob/master/LICENSE