/renderdoc_jffm

RenderDoc FFM API

Primary LanguageJava

renderdoc_jffm

Maven Central Maven Central (snapshot) Codecov Java Version

com.io7m.renderdoc_jffm

JVM Platform Status
OpenJDK (Temurin) Current Linux Build (OpenJDK (Temurin) Current, Linux)
OpenJDK (Temurin) LTS Linux Build (OpenJDK (Temurin) LTS, Linux)
OpenJDK (Temurin) Current Windows Build (OpenJDK (Temurin) Current, Windows)
OpenJDK (Temurin) LTS Windows Build (OpenJDK (Temurin) LTS, Windows)

renderdoc_jffm

A Java interface to the RenderDoc API.

Features

  • A friendly Java interface to the RenderDoc API.
  • JPMS-ready.
  • ISC license.

Usage

When running your application, you must allow access to the FFM API for the module com.io7m.renderdoc_jffm.core:

$ java --enable-native-access=com.io7m.renderdoc_jffm.core ...

Run your application from RenderDoc. RenderDoc works by injecting a native library into your application. Then, inside your application, call RenderDoc.open():

try (final var doc = RenderDoc.open()) {
  ...
}

The obtained RenderDocType interface is a type-safe, memory-safe interface to the API exposed by the RenderDoc native library. The interface allows for setting options and triggering captures.

The open() method will raise an IOException with a useful error message if the renderdoc native library is not present in the current application process.