sokol-samples

The spine-c runtime is a non-rendering library. To use it with a graphics API (like Sokol, OpenGL, or SFML), you must implement three specific extension methods to bridge the runtime with your renderer:

1. _spAtlasPage_createTexture: Loads a texture and stores the texture handle and its dimensions (width, height) in the void* rendererObject, width, and height fields of an spAtlasPage struct.
2. _spAtlasPage_disposeTexture: Handles the disposal of textures previously loaded via _spAtlasPage_createTexture.
3. _spUtil_readFile: Handles file reading. If you do not need custom logic, you can use the provided _readFile which uses standard fopen.

Rendering Workflow: Once these are implemented, you can load Spine animation data. To render, you must:

1. Enumerate the slots for a skeleton.
2. Render the attachment for each slot.
3. Access the void* rendererObject field on the attachment (which is populated during loading) to retrieve your renderer-specific texture or data.

For example, when using an AtlasAttachmentLoader with a texture atlas, a RegionAttachment will have its void* rendererObject set to an AtlasRegion. You can then use that to find its AtlasPage and the corresponding texture handle stored in the page's void* rendererObject.

For manual integration into your own projects, you can build samples directly using your system compiler. The expected directory structure assumes sokol-samples, sokol, and sokol-tools-bin are cloned side-by-side.

macOS (Clang)

Metal Sample: cc cube-metal.c osxentry.m sokol_gfx.m -o cube-metal -fobjc-arc -I../../sokol -framework Metal -framework AppKit -framework QuartzCore

sokol-app (sapp) with Metal:

1. Compile shaders: ../../sokol-tools-bin/bin/osx/sokol-shdc -i cube-sapp.glsl -o cube-sapp.glsl.h -l metal_macos
2. Compile C code: cc cube-sapp.c ../libs/sokol/sokol.m -o cube-sapp -DSOKOL_METAL -fobjc-arc -I../../sokol -I ../libs -framework Metal -framework AppKit -framework QuartzCore -framework AudioToolbox

Windows (MSVC)

Run from a Developer Command Prompt.

D3D11 Sample: cl cube-d3d11.c d3d11entry.c /I..//..//sokol

sokol-app (sapp) with D3D11:

1. Compile shaders: ..\..\sokol-tools-bin\bin\win32\sokol-shdc -i cube-sapp.glsl -o cube-sapp.glsl.h -l hlsl5
2. Compile C code: cl cube-sapp.c ..\libs\sokol\sokol.c /DSOKOL_D3D11 /I..\..\sokol /I..\libs

Windows (MSYS2/MinGW GCC)

Use the -mwin32 flag for proper platform detection.

sokol-app (sapp) with D3D11:

1. Compile shaders: ../../sokol-tools-bin/bin/win32/sokol-shdc -i cube-sapp.glsl -o cube-sapp.glsl.h -l hlsl5:glsl430
2. Compile C code: gcc cube-sapp.c ../libs/sokol/sokol.c -o cube-sapp-d3d11 -mwin32 -O2 -DSOKOL_D3D11 -I../../sokol -I ../libs -lkernel32 -luser32 -lshell32 -ldxgi -ld3d11 -lole32 -lgdi32

Linux (GCC)

GLFW Sample: cc cube-glfw.c glfw_glue.c flextgl/flextGL.c -o cube-glfw -I../../sokol -lGL -ldl -lm -lglfw3

sokol-app (sapp) with GL:

1. Compile shaders: ../../sokol-tools-bin/bin/linux/sokol-shdc -i cube-sapp.glsl -o cube-sapp.glsl.h -l glsl430
2. Compile C code: cc cube-sapp.c ../libs/sokol/sokol.c -o cube-sapp -DSOKOL_GLCORE -pthread -I../../sokol -I../libs -lGL -ldl -lm -lX11 -lasound -lXi -lXcursor

# Example: Manual build of a Metal sample on macOS
cd sokol-samples/metal
cc cube-metal.c osxentry.m sokol_gfx.m -o cube-metal -fobjc-arc -I../../sokol -framework Metal -framework AppKit -framework QuartzCore

You can use fibs to target different platforms.

Emscripten (Web/WASM)

1. Install the Emscripten SDK: ./fibs emsdk install
2. Pick a config with -emsc- in the name, build, and run: ./fibs config sapp-gles-emsc-ninja-debug ./fibs build ./fibs run triangle-sapp (this opens your default browser).

iOS

1. Pick an iOS build config and open in Xcode: ./fibs config sapp-metal-ios-xcode-debug ./fibs open
2. To build for a real device, set your iOS Team Id: ./fibs set iosteamid [your-team-id] ./fibs config sapp-metal-ios-xcode-debug

Android

1. Ensure JDK 17 is installed. Verify tools via ./fibs diag tools (look for java, javac, and unzip).
2. Install the Android SDK/NDK: ./fibs android install
3. Pick an Android config and build: ./fibs config sapp-gles-android-ninja-debug ./fibs build
4. Run on an attached device: ./fibs run triangle-sapp

# Emscripten example
./fibs emsdk install
./fibs config sapp-gles-emsc-ninja-debug
./fibs build
./fibs run triangle-sapp

# iOS Team ID setup
./fibs set iosteamid [your-team-id]
./fibs config sapp-metal-ios-xcode-debug

# Android setup
./fibs diag tools
./fibs android install
./fibs config sapp-gles-android-ninja-debug
./fibs build
./fibs run triangle-sapp