Skip to content
/ kgpu Public

A Cross Platform Graphics API For Kotlin JVM and Kotlin JS

License

Notifications You must be signed in to change notification settings

kgpu/kgpu

Repository files navigation

Kgpu

A Cross Platform Graphics API For Kotlin JVM/JS based on WebGPU and WebGPU Native

Warning: Because WebGPU is under active development, kgpu is very unstable! Once the specification is more finalized, this will not be an issue.

Rewrite: Currently the project's native backend is being rewritten to support the JVM's new FFI API (Project Panama). To access the old version, see the jnr branch

Requirements:

  • JDK 17+

Supported Platforms:

  • Windows 10
  • MacOS
  • Linux
  • Chrome Canary
  • Firefox Nightly

Links

Kgpu Book

Documentation

Live Example

Modules

kgpu is split into multiple modules:

  • kgpu: The core of this library (Kotlin bindings to WebGPU)
  • kcgmath: A cross platform graphics library for Kotlin based on the Rust crate cgmath
  • kshader: A library to help compile GLSL to SPIR-V

More Info

Images

Earth Example

Examples

To run the examples on Desktop:

gradlew runTriangleExample
gradlew runCubeExample
gradlew runTextureExample
gradlew runEarthExample

To run the examples on the Web:

gradlew buildWeb startWebServer

Then navigate to http://localhost:8080/index.html

Getting Started

To get started, see the Getting Started Page in the Kgpu book