Reorganize modules and README.

io7m-com · Dec 12, 2024 · 9280bea · 9280bea
1 parent 73ac382
commit 9280bea
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 2 deletions.
diff --git a/README.in b/README.in
@@ -163,3 +163,6 @@ By avoiding rendering during window resizes, we effectively avoid creating
 and destroying swapchains for the intermediate window sizes. When the window
 eventually stops resizing, we'll automatically create a suitable swapchain
 for the final size.
+
+See the [HelloSwapChain](com.io7m.jcoronado.examples/src/main/java/com/io7m/jcoronado/examples/HelloSwapChain.java)
+example.
diff --git a/README.md b/README.md
@@ -81,6 +81,16 @@ If this step fails, it's a bug. Please report it!
 
 ## Utilities
 
+### com.io7m.jcoronado.utility.allocation_tracker
+
+The `com.io7m.jcoronado.utility.allocation_tracker` module provides a simple
+implementation of the `VulkanHostAllocatorType` interface that simply delegates
+an existing allocator (such as `jemalloc`) but also tracks the current amount
+of memory allocated for every allocation type.
+
+Simply instantiate a `VulkanHostAllocatorTracker` instance and use it anywhere
+the API accepts a `VulkanHostAllocatorType`.
+
 ### com.io7m.jcoronado.utility.swapchain
 
 The `com.io7m.jcoronado.utility.swapchain` module provides a utility for
@@ -170,3 +180,6 @@ and destroying swapchains for the intermediate window sizes. When the window
 eventually stops resizing, we'll automatically create a suitable swapchain
 for the final size.
 
+See the [HelloSwapChain](com.io7m.jcoronado.examples/src/main/java/com/io7m/jcoronado/examples/HelloSwapChain.java)
+example.
+
diff --git a/com.io7m.jcoronado.documentation/pom.xml b/com.io7m.jcoronado.documentation/pom.xml
@@ -54,6 +54,26 @@
       <artifactId>com.io7m.jcoronado.vma</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>com.io7m.jcoronado.extensions.ext_debug_utils.api</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>com.io7m.jcoronado.extensions.ext_layer_settings.api</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>com.io7m.jcoronado.layers.khronos_validation.api</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>com.io7m.jcoronado.layers.lunarg_api_dump.api</artifactId>
+      <version>${project.version}</version>
+    </dependency>
 
     <dependency>
       <groupId>com.io7m.primogenitor</groupId>

diff --git a/com.io7m.jcoronado.documentation/src/main/java/module-info.java b/com.io7m.jcoronado.documentation/src/main/java/module-info.java
@@ -25,10 +25,14 @@
   requires static com.io7m.immutables.style;
   requires static org.immutables.value;
 
-  requires com.io7m.jcoronado.vma;
   requires com.io7m.jcoronado.api;
+  requires com.io7m.jcoronado.extensions.ext_debug_utils.api;
+  requires com.io7m.jcoronado.extensions.ext_layer_settings.api;
   requires com.io7m.jcoronado.extensions.khr.surface.api;
+  requires com.io7m.jcoronado.layers.khronos_validation.api;
+  requires com.io7m.jcoronado.layers.lunarg_api_dump.api;
+  requires com.io7m.jcoronado.lwjgl;
   requires com.io7m.jcoronado.utility.allocation_tracker;
   requires com.io7m.jcoronado.utility.swapchain;
-  requires com.io7m.jcoronado.lwjgl;
+  requires com.io7m.jcoronado.vma;
 }