sk_app

A small cross-platform library for windows / vulkan surfaces / input / OS functionality. Targets Win32, Linux, Android, and MacOS.

Building

From the project root:

Linux

Linux has both a Wayland and an X11 backend, picked at runtime. Wayland is preferred when a compositor is present, and X11 is used otherwise. Neither library is linked: both are loaded with dlopen, so one binary runs on a Wayland-only system, an X11-only system, or headless. Override the choice with SKA_VIDEODRIVER=wayland|x11, or the linux_backend field in ska_settings_t.

Only headers are needed to build. The Wayland protocol sources are generated ahead of time and committed under src/wayland, so neither wayland-scanner nor wayland-protocols is a build dependency; refresh them with tools/gen_wayland_protocols.sh when adding a protocol.

Windows always render at the display's native resolution: sizes are screen coordinates, ska_window_get_drawable_size is the pixel framebuffer, and ska_window_get_dpi_scale is the factor to raster UI by. For an application icon, install a .desktop file and set ska_settings_t.app_id to match its StartupWMClass; this is the only way a Wayland window gets one.

# Dependencies
sudo apt-get install cmake libx11-dev libxrandr-dev libxcursor-dev libxi-dev \
                     libxext-dev libwayland-dev libxkbcommon-dev libdecor-0-dev

# To configure
cmake -B build

# To build
cmake --build build -j8

# To run
./build/examples/test_window/test_window

Windows (Cross-compile with MinGW)

# To configure
cmake -B build-mingw -DCMAKE_TOOLCHAIN_FILE=cmake/mingw-toolchain.cmake -DCMAKE_BUILD_TYPE=Release

# To build
cmake --build build-mingw -j8

# To run with Wine
wine ./build-mingw/examples/test_window/test_window.exe

Android

Prerequisites:

• ANDROID_HOME or ANDROID_SDK_ROOT environment variable set
• ANDROID_NDK environment variable (optional - auto-detected from SDK)
• Java JDK installed for signing APKs

# Quick build for arm64 (default)
./build_android.sh
# Install and run on connected device or simulator
cmake --build build-android --target test_window-run

# OR x86_64
./build_android.sh x86
# Install and run on connected device or simulator
cmake --build build-androidx86 --target test_window-run

Android manual build

# arm64 (default)
cmake -B build-android \
    -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake \
    -DANDROID_ABI=arm64-v8a \
    -DANDROID_PLATFORM=android-32 \
    -DCMAKE_BUILD_TYPE=Release
cmake --build build-android -j8
# Build the APK
cmake --build build-android --target test_window-apk
# Install and run on connected device or simulator
adb install -r build-android/examples/test_window/test_window.apk
adb shell am start -n net.stereokit.test_window/net.stereokit.sk_app.SkAppActivity

# OR x86_64
cmake -B build-androidx86 \
    -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake \
    -DANDROID_ABI=x86_64 \
    -DANDROID_PLATFORM=android-32 \
    -DCMAKE_BUILD_TYPE=Release
cmake --build build-androidx86 -j8
# Build the APK
cmake --build build-androidx86 --target test_window-apk
# Install and run on connected device or simulator
adb install -r build-androidx86/examples/test_window/test_window.apk
adb shell am start -n net.stereokit.test_window/net.stereokit.sk_app.SkAppActivity

# Install and run on connected device or simulator
adb install -r build-android/examples/test_window/test_window.apk
adb shell am start -n net.stereokit.test_window/net.stereokit.sk_app.SkAppActivity

Filtering Android logcat

# Filtered logcat of the app
adb logcat -v color --uid `adb shell pm list package -U net.stereokit.test_window | cut -d ":" -f3`

Available commands

ESC - Exit application T - Show virtual keyboard M - Maximize window N - Minimize window R - Restore window H - Hide window (2 seconds) P - Set window position S - Set window size SPACE - Rename window title C - Toggle cursor visibility V - Toggle relative mouse mode Mouse - Move and click Wheel - Scroll