Merge branch 'main' into fix/missing-xlib-struct-and-querypool-stride

build.gradle.kts

@@ -95,11 +95,11 @@ dependencies {
         }
     }
     implementation("org.xerial.snappy:snappy-java:1.1.10.5")
-    implementation("com.fasterxml.jackson.core:jackson-databind:2.16.1")
+    implementation("com.fasterxml.jackson.core:jackson-databind:2.17.0")
     implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.16.1")
-    implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.16.1")
-    implementation("org.zeromq:jeromq:0.5.4")
-    implementation("com.esotericsoftware:kryo:5.5.0")
+    implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.17.0")
+    implementation("org.zeromq:jeromq:0.6.0")
+    implementation("com.esotericsoftware:kryo:5.6.0")
     implementation("de.javakaffee:kryo-serializers:0.45")
     implementation("org.msgpack:msgpack-core:0.9.8")
     implementation("org.msgpack:jackson-dataformat-msgpack:0.9.8")

src/main/kotlin/graphics/scenery/backends/RenderConfigReader.kt

@@ -183,11 +183,11 @@ class RenderConfigReader {
         mapper.registerModule(
             KotlinModule.Builder()
                 .withReflectionCacheSize(512)
-                .configure(KotlinFeature.NullToEmptyCollection, false)
-                .configure(KotlinFeature.NullToEmptyMap, false)
+                .configure(KotlinFeature.NullToEmptyCollection, true)
+                .configure(KotlinFeature.NullToEmptyMap, true)
                 .configure(KotlinFeature.NullIsSameAsDefault, false)
-                .configure(KotlinFeature.SingletonSupport, false)
-                .configure(KotlinFeature.StrictNullChecks, false)
+                .configure(KotlinFeature.SingletonSupport, true)
+                .configure(KotlinFeature.StrictNullChecks, true)
                 .build()
         )
 

src/main/kotlin/graphics/scenery/controls/OpenVRHMD.kt

@@ -5,6 +5,7 @@ import com.fasterxml.jackson.databind.DeserializationFeature
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
+import com.fasterxml.jackson.module.kotlin.KotlinFeature
 import com.fasterxml.jackson.module.kotlin.KotlinModule
 import graphics.scenery.*
 import graphics.scenery.backends.Display
@@ -1271,7 +1272,15 @@ open class OpenVRHMD(val seated: Boolean = false, val useCompositor: Boolean = t
                 compositeFile.exists() && compositeFile.length() > 1024 -> {
                     logger.info("Loading model from composite JSON, ${compositeFile.absolutePath}")
                     val mapper = ObjectMapper(YAMLFactory())
-                    mapper.registerModule(KotlinModule())
+                    mapper.registerModule(
+                        KotlinModule.Builder()
+                            .configure(KotlinFeature.NullToEmptyCollection, true)
+                            .configure(KotlinFeature.NullToEmptyMap, true)
+                            .configure(KotlinFeature.NullIsSameAsDefault, false)
+                            .configure(KotlinFeature.SingletonSupport, true)
+                            .configure(KotlinFeature.StrictNullChecks, true)
+                            .build()
+                    )
                     mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
                     mapper.configure(DeserializationFeature.FAIL_ON_IGNORED_PROPERTIES, false)
 

src/main/kotlin/graphics/scenery/controls/ScreenConfig.kt

@@ -5,6 +5,7 @@ import org.joml.Vector3f
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
+import com.fasterxml.jackson.module.kotlin.KotlinFeature
 import com.fasterxml.jackson.module.kotlin.KotlinModule
 import graphics.scenery.utils.JsonDeserialisers
 import graphics.scenery.utils.lazyLogger
@@ -142,7 +143,15 @@ class ScreenConfig {
          */
         @JvmStatic fun loadFromFile(path: String): ScreenConfig.Config {
             val mapper = ObjectMapper(YAMLFactory())
-            mapper.registerModule(KotlinModule())
+            mapper.registerModule(
+                KotlinModule.Builder()
+                    .configure(KotlinFeature.NullToEmptyCollection, true)
+                    .configure(KotlinFeature.NullToEmptyMap, true)
+                    .configure(KotlinFeature.NullIsSameAsDefault, false)
+                    .configure(KotlinFeature.SingletonSupport, true)
+                    .configure(KotlinFeature.StrictNullChecks, true)
+                    .build()
+            )
 
             var stream = ScreenConfig::class.java.getResourceAsStream(path)
 

src/main/kotlin/graphics/scenery/utils/extensions/TextureUtils.kt

@@ -3,21 +3,36 @@ package graphics.scenery.utils.extensions
 import graphics.scenery.backends.vulkan.VulkanTexture
 import graphics.scenery.textures.Texture
 import graphics.scenery.utils.lazyLogger
+import org.jetbrains.annotations.ApiStatus.Experimental
 
-fun Texture.fetchTexture(texture: Texture): Int {
+
+/**
+ * Fetches this [Texture] from the GPU. This replaced the texture's
+ * contents with whatever is fetched from the GPU and returns true.
+ * If the texture is not known to the renderer, or no storage buffer
+ * is available, it'll return false.
+ */
+@Experimental
+fun Texture.fetchFromGPU(): Boolean {
     val logger by lazyLogger()
 
-    val ref = VulkanTexture.getReference(texture)
-    val buffer = texture.contents ?: return -1
+    val buffer = this.contents
+    if(buffer == null) {
+        logger.error("Texture copy from GPU requested, but no storage available.")
+        return false
+    }
+
+    val ref = VulkanTexture.getReference(this)
 
     if(ref != null) {
         val start = System.nanoTime()
-        texture.contents = ref.copyTo(buffer, true)
+        this.contents = ref.copyTo(buffer, true)
         val end = System.nanoTime()
-        logger.info("The request textures of size ${texture.contents?.remaining()?.toFloat()?.div((1024f*1024f))} took: ${(end.toDouble()-start.toDouble())/1000000.0}")
+        logger.info("The request textures of size ${this.contents?.remaining()?.toFloat()?.div((1024f*1024f))} took: ${(end.toDouble()-start.toDouble())/1000000.0}")
     } else {
-        logger.error("In fetchTexture: Texture not accessible")
+        logger.error("In fetchFromGPU: Texture not accessible")
+        return false
     }
 
-    return 0
+    return true
 }

src/main/kotlin/graphics/scenery/volumes/vdi/VDIData.kt

@@ -1,5 +1,6 @@
 package graphics.scenery.volumes.vdi
 
+import org.jetbrains.annotations.ApiStatus.Experimental
 import org.joml.Matrix4f
 import org.joml.Vector2i
 import org.joml.Vector3f
@@ -18,6 +19,7 @@ import org.joml.Vector3f
  *
  * @author Aryaman Gupta <[email protected]> and Ulrik Günther <[email protected]>
  */
+@Experimental
 data class VDIMetadata(
     val version: Int = 1,
     var index: Int = 0,

src/main/kotlin/graphics/scenery/volumes/vdi/VDIDataIO.kt

@@ -3,6 +3,7 @@ package graphics.scenery.volumes.vdi
 import com.esotericsoftware.kryo.Kryo
 import com.esotericsoftware.kryo.io.Input
 import com.esotericsoftware.kryo.io.Output
+import org.jetbrains.annotations.ApiStatus.Experimental
 import org.joml.Matrix4f
 import org.joml.Vector2i
 import org.joml.Vector3f
@@ -15,6 +16,7 @@ import java.io.OutputStream
  *
  * @author Aryaman Gupta <[email protected]> and Ulrik Günther <[email protected]>
  */
+@Experimental
 class VDIDataIO {
     companion object {
 

src/main/kotlin/graphics/scenery/volumes/vdi/VDINode.kt

@@ -12,6 +12,7 @@ import graphics.scenery.utils.Image
 import graphics.scenery.utils.extensions.applyVulkanCoordinateSystem
 import net.imglib2.type.numeric.integer.UnsignedIntType
 import net.imglib2.type.numeric.real.FloatType
+import org.jetbrains.annotations.ApiStatus.Experimental
 import org.joml.Matrix4f
 import org.joml.Vector3f
 import org.joml.Vector3i
@@ -29,6 +30,7 @@ import java.nio.ByteBuffer
  * @param[vdiData] The metadata ([VDIData]) associated with the VDI.
  */
 
+@Experimental
 class VDINode(windowWidth: Int, windowHeight: Int, val numSupersegments: Int, vdiData: VDIData) : RichNode() {
 
     /** The projection matrix of the camera viewport that was used to generate the VDI in the first (default) buffer */

src/main/kotlin/graphics/scenery/volumes/vdi/VDIStreamer.kt

@@ -3,13 +3,12 @@ package graphics.scenery.volumes.vdi
 import graphics.scenery.Camera
 import graphics.scenery.Settings
 import graphics.scenery.backends.Renderer
-import graphics.scenery.textures.Texture
 import graphics.scenery.utils.DataCompressor
-import graphics.scenery.utils.extensions.fetchTexture
+import graphics.scenery.utils.extensions.fetchFromGPU
 import graphics.scenery.utils.lazyLogger
-import graphics.scenery.volumes.VDIVolumeManager
 import graphics.scenery.volumes.Volume
 import graphics.scenery.volumes.VolumeManager
+import org.jetbrains.annotations.ApiStatus.Experimental
 import org.joml.Vector2i
 import org.joml.Vector3f
 import org.lwjgl.system.MemoryUtil
@@ -29,6 +28,7 @@ import kotlin.system.measureNanoTime
  * Class to support streaming of Volumetric Depth Images (VDIs). Provides public functions to stream generated VDIs on the
  * server side and to receive and update them on the client side.
  */
+@Experimental
 class VDIStreamer {
 
     private val logger by lazyLogger()
@@ -112,9 +112,9 @@ class VDIStreamer {
 
             if (!firstFrame && vdiStreaming.get()) {
 
-                Texture().fetchTexture(vdiColor)
-                Texture().fetchTexture(vdiDepth)
-                Texture().fetchTexture(gridCells)
+                vdiColor.fetchFromGPU()
+                vdiDepth.fetchFromGPU()
+                gridCells.fetchFromGPU()
 
                 val model = volume.spatial().world
 

src/main/kotlin/graphics/scenery/volumes/VDIVolumeManager.kt → src/main/kotlin/graphics/scenery/volumes/vdi/VDIVolumeManager.kt

@@ -1,4 +1,4 @@
-package graphics.scenery.volumes
+package graphics.scenery.volumes.vdi
 
 import bvv.core.shadergen.generate.SegmentTemplate
 import bvv.core.shadergen.generate.SegmentType
@@ -12,9 +12,11 @@ import graphics.scenery.compute.InvocationType
 import graphics.scenery.textures.Texture
 import graphics.scenery.utils.Image
 import graphics.scenery.utils.lazyLogger
+import graphics.scenery.volumes.VolumeManager
 import net.imglib2.type.numeric.integer.IntType
 import net.imglib2.type.numeric.integer.UnsignedIntType
 import net.imglib2.type.numeric.real.FloatType
+import org.jetbrains.annotations.ApiStatus.Experimental
 import org.joml.Vector3f
 import org.joml.Vector3i
 import org.lwjgl.system.MemoryUtil
@@ -32,6 +34,8 @@ import kotlin.math.ceil
  *
  * @author Aryaman Gupta <[email protected]> and Wissal Salhi
  */
+
+@Experimental
 class VDIVolumeManager (var hub: Hub, val windowWidth: Int, val windowHeight: Int, val maxSupersegments: Int, val scene: Scene)
 {
     private val logger by lazyLogger()