com.io7m.jcoronado

The jcoronado package attempts to provide a type-safe, mildly object-oriented frontend to the Vulkan API. Currently, it uses the high-quality LWJGL bindings internally, and wraps them with a thin layer of short-lived immutable types for safety and efficiency. It strongly separates the API and implementation to allow for easy unit testing and mocking of code that calls Vulkan.

Features
Releases
Documentation
Maven
Changes
Sources
License
Bug Tracker

Features

Type-safe Vulkan frontend.
Strong separation of API and implementation to allow for switching to different bindings at compile-time
Strongly-typed interfaces with a heavy emphasis on immutable value types
Fully documented (JavaDoc)
Example code included
OSGi-ready
JPMS-ready
ISC license

Releases

The current release is 0.0.1-SNAPSHOT.

Source code and binaries are available from the repository.

Documentation

Documentation for the 0.0.1-SNAPSHOT release is available for reading online.

Documentation for current and older releases is archived in the repository.

User documentation

JavaDoc

API documentation

Maven

The following is a complete list of the project's modules expressed as Maven dependencies:

<dependency>
  <groupId>com.io7m.jcoronado</groupId>
  <artifactId>com.io7m.jcoronado</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jcoronado</groupId>
  <artifactId>com.io7m.jcoronado.allocation_tracker</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jcoronado</groupId>
  <artifactId>com.io7m.jcoronado.api</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jcoronado</groupId>
  <artifactId>com.io7m.jcoronado.documentation</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jcoronado</groupId>
  <artifactId>com.io7m.jcoronado.examples</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jcoronado</groupId>
  <artifactId>com.io7m.jcoronado.extensions.khr_surface.api</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jcoronado</groupId>
  <artifactId>com.io7m.jcoronado.lwjgl</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jcoronado</groupId>
  <artifactId>com.io7m.jcoronado.tests.device</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jcoronado</groupId>
  <artifactId>com.io7m.jcoronado.tests</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>

<dependency>
  <groupId>com.io7m.jcoronado</groupId>
  <artifactId>com.io7m.jcoronado.vma</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

No formal releases have been made.

Sources

This project uses Git to manage source code.

Repository: https://github.com/io7m/jcoronado

$ git clone https://github.com/io7m/jcoronado

License

Copyright ⓒ 2018 Mark Raynsford <code@io7m.com> http://io7m.com

Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted, provided that the
above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

Bug Tracker

The project uses GitHub Issues to track issues.