OverrunGL - Overrun Game Library

Introduction

Overrun Game Library is a high-performance library implemented with Java 23, which enables cross-platform access to a set of C/C++ library bindings, providing various useful utilities.

Comparing with LWJGL 3

LWJGL 3 is also a Java library that enables cross-platform access.

LWJGL 3 uses JNI to access native functions, in OverrunGL, however, the FFM API 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 or the samples.

Check 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. A documentation of the customizer is here.

• 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-<module-name>

Currently, OverrunGL uses preview features preventing users from using newer JDKs, so only -SNAPSHOT versions are provided at this time.

Using -SNAPSHOT Versions

We publish -SNAPSHOT versions frequently.

For -SNAPSHOT versions, you can check the list of available versions and include this maven repository:

repositories {
    maven("https://s01.oss.sonatype.org/content/repositories/snapshots")
}

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	The most widely adopted 2D and 3D graphics API in the industry, bringing thousands of applications to a wide variety of computer platforms.

Display and Input

Library	Description
GLFW	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.
Native File Dialog Extended	A small C library that portably invokes native file open, folder select and file save dialogs.

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_resize	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	A Java math library for OpenGL rendering calculations

Release Notes

See doc/notes.

Additional

The latest Javadoc can be found here.

The documentation of OpenGL can be found from Khronos' references and docs.gl.

OverrunGL uses Marshal.

JavaPoet is used to generate source files.

Credits