https://github.com/over-run/overrungl
Overrun Game Library is a high-performance library implemented with Java 24, enables cross-platform access to a set of C library bindings, and provides some useful utilities.
https://github.com/over-run/overrungl
bindings glfw java java-24 java24 openal opengl overrungl project-panama stb vulkan
Last synced: 7 months ago
JSON representation
Overrun Game Library is a high-performance library implemented with Java 24, enables cross-platform access to a set of C library bindings, and provides some useful utilities.
- Host: GitHub
- URL: https://github.com/over-run/overrungl
- Owner: Over-Run
- License: mit
- Created: 2022-08-13T10:20:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-15T07:38:47.000Z (7 months ago)
- Last Synced: 2025-08-15T09:22:47.039Z (7 months ago)
- Topics: bindings, glfw, java, java-24, java24, openal, opengl, overrungl, project-panama, stb, vulkan
- Language: Java
- Homepage: https://over-run.github.io/overrungl/
- Size: 18.4 MB
- Stars: 16
- Watchers: 1
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# OverrunGL - Overrun Game Library
[](https://github.com/Over-Run/overrungl/actions/workflows/gradle.yml)
[](https://www.bestpractices.dev/projects/8279)
## Overview
```java
void main() {
// invoke native functions via static methods
glfwInit();
// use MemorySegment to represent memory addresses
MemorySegment window = glfwCreateWindow(
800, 600,
// use MemoryUtil::allocString to allocate string and manage by GC
MemoryUtil.allocString("Title"),
MemorySegment.NULL,
MemorySegment.NULL
);
int width, height;
// use MemoryStack for one-time and quick allocation
try (var stack = MemoryStack.pushLocal()) {
// use MemoryStack::alloc*Ptr to allocate memory
var pWidth = stack.allocIntPtr();
var pHeight = stack.allocIntPtr();
glfwGetFramebufferSize(window, pWidth.segment(), pHeight.segment());
// use accessors in *Ptr to read and write memory
width = pWidth.value();
height = pHeight.value();
}
// for OpenGL, create instance of wrappers
var gl = new GL(GLFW::glfwGetProcAddress);
// invoke OpenGL functions via instance methods
gl.ClearColor(0.0f, 0.0f, 0.0f, 1.0f);
// for Vulkan, load functions with GLFW
VK.create(GLFW::glfwGetInstanceProcAddress);
}
```
## Introduction
Overrun Game Library is a high-performance library implemented with Java 24,
which enables cross-platform access to a set of C library bindings, providing various useful utilities.
### Comparing with LWJGL 3
[LWJGL 3](https://github.com/LWJGL/lwjgl3) is also a Java library that enables cross-platform access.
LWJGL 3 uses JNI to access native functions, in OverrunGL, however,
the [FFM API](https://openjdk.org/jeps/454) is used, which makes the linking to native functions more convenient
as well as providing better memory management.
## Getting Started
You can check our [wiki](https://github.com/Over-Run/overrungl/wiki) or
the [samples](modules/samples/src/test/java/overrungl/demo).
Check [discussions](https://github.com/Over-Run/overrungl/discussions) in case you have trouble in setup works, such as environment configuring.
Feel free to ask questions as long as you have searched in discussions and found no one had the same question.
## Import as a Dependency
We provided a modules customizer [here](https://over-run.github.io/overrungl-gen/). The customizer is the recommended way to generate dependency declarations.
- Platform Maven coordinate: `io.github.over-run:overrungl-bom`
- Core module Maven coordinate: `io.github.over-run:overrungl`
- For others: `io.github.over-run:overrungl-`
For example:
```kotlin
dependencies {
implementation(platform("io.github.over-run:overrungl-bom:"))
implementation("io.github.over-run:overrungl")
implementation("io.github.over-run:overrungl-glfw")
runtimeOnly("io.github.over-run:overrungl-glfw::natives--")
}
```
### Enable native access
You must enable the access to restricted methods by adding a VM argument or a manifest attribute.
The customizer has already included this.
```
--enable-native-access=overrungl.core,...
```
## List of Supported Bindings
### Khronos APIs
| Library | Description |
|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [OpenGL](https://www.khronos.org/opengl/) | The most widely adopted 2D and 3D graphics API in the industry, bringing thousands of applications to a wide variety of computer platforms. |
| [Vulkan](https://www.khronos.org/vulkan/) | A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms. |
### Display and Input
| Library | Description |
|----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [GLFW](http://www.glfw.org/) | Create multiple windows, handle user input (keyboard, mouse, gaming peripherals) and manage contexts. Also features multi-monitor support, clipboard access, file drag-n-drop, and [much more](http://www.glfw.org/docs/latest/news.html). |
| [Native File Dialog Extended](https://github.com/btzy/nativefiledialog-extended) | A small C library that portably invokes native file open, folder select and file save dialogs. |
### Audio
| Library | Description |
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| [OpenAL](https://www.openal.org/) | A cross-platform 3D audio API appropriate for use with gaming applications and many other types of audio applications. |
| [OpenAL Soft](https://openal-soft.org/) | An LGPL-licensed, cross-platform, software implementation of the OpenAL 3D audio API. |
### Graphics
| Library | Description |
|----------------------------------------------------------------------------------------------|----------------------------------------------------|
| [Vulkan Memory Allocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator) | Easy to integrate Vulkan memory allocation library |
### [stb](https://github.com/nothings/stb) - single-file public domain libraries for C/C++
| Library | Description |
|-------------------|---------------------------------------------------------------------------------|
| stb_easy_font | Quick-and-dirty easy-to-deploy bitmap font for printing frame rate, etc. |
| stb_image | Image loading/decoding from file/memory: JPG, PNG, TGA, BMP, PSD, GIF, HDR, PIC |
| stb_image_resize2 | Resize images larger/smaller with good quality. |
| stb_image_write | Image writing to disk: PNG, TGA, BMP |
| stb_perlin | Revised Perlin noise (3D input, 1D output). |
| stb_rect_pack | Simple 2D rectangle packer with decent quality. |
| stb_truetype | Parse, decode, and rasterize characters from truetype fonts. |
| stb_vorbis | Decode ogg vorbis files from file/memory to float/16-bit signed output. |
### Other
| Library | Description |
|-----------------------------------------|-------------------------------------------------------|
| [JOML](https://github.com/JOML-CI/JOML) | A Java math library for OpenGL rendering calculations |
## Release Notes
See [doc/notes](doc/notes/README.md).
## Additions
The latest Javadoc can be found [here](https://over-run.github.io/overrungl/).
[//]: # (### Credits)
[//]: # ([
](https://jb.gg/OpenSourceSupport))