OpenDlssNrSupport.kt

src/jvmMain/kotlin/afield/graphics/render/neural/OpenDlssNrSupport.kt · 48 lines

Whether the native neural-rendering (NR) pass can run on this renderer.

OpenDlssNrSupport.availability returns an OpenDlssNrSupport.Availability that is ready only when the device enabled the required Vulkan features and the pinned weights and kernels are on disk; its reason names the Gradle task to run when they are missing (fetchOpenDlssNrWeights, buildOpenDlssNrNative). The paths can be overridden with FIELD_OPEN_DLSS_NR_MODEL and FIELD_OPEN_DLSS_NR_SHADERS.

package afield.graphics.render.neural

import afield.graphics.vulkan.Renderer
import java.lang.foreign.*
import java.lang.foreign.ValueLayout.ADDRESS
import java.nio.file.Path
import kotlin.io.path.*

`object OpenDlssNrSupport`

Advertised features are checked before device creation; readiness also requires the pinned assets.

`internal class DevicePlan(val native: OpenDlssNrNative,val handle: MemorySegment) : AutoCloseable`

`fun apply(features: Long) = native.check(native.apply.invokeWithArguments(handle,features))`

`override fun close() {native.planClose.invokeWithArguments(handle)}`

`internal fun prepare(instance: Long,physical: Long): Result<DevicePlan>`

    internal fun prepare(instance: Long,physical: Long): Result<DevicePlan> = OpenDlssNrNative.loaded.mapCatching { native ->
        Arena.ofConfined().use { arena ->
            val result=arena.allocate(ADDRESS)
            native.check(native.probe.invokeWithArguments(instance,physical,result))
            DevicePlan(native,result.get(ADDRESS,0))
        }
    }

`internal fun model(): Path`

    internal fun model(): Path=Path.of(System.getenv("FIELD_OPEN_DLSS_NR_MODEL") ?: OpenDlssNrNative.root().resolve("model").toString()).toAbsolutePath()

`internal fun shaders(): Path`

    internal fun shaders(): Path=Path.of(System.getenv("FIELD_OPEN_DLSS_NR_SHADERS") ?: OpenDlssNrNative.root().resolve("shaders").toString()).toAbsolutePath()

`data class Availability(val ready: Boolean,val reason: String)`

`internal const val BUILT_AFTER_DEVICE`

The adapter was absent when this renderer created its Vulkan device but is present now: the device lacks the NR features and only a new device can gain them.

    internal const val BUILT_AFTER_DEVICE="NR adapter was built after this renderer's Vulkan device was created, so the device lacks the NR features; restart the renderer to enable NR"

`internal fun deviceFailureReason(failure: String,libraryPresentNow: Boolean): String`

    internal fun deviceFailureReason(failure: String,libraryPresentNow: Boolean): String =
        if(failure==OpenDlssNrNative.ABSENT && libraryPresentNow)BUILT_AFTER_DEVICE else failure

`fun availability(renderer: Renderer): Availability`

    fun availability(renderer: Renderer): Availability {
        val failure=renderer.device.openDlssNrFeatureFailure
        if(failure!=null)return Availability(false,deviceFailureReason(failure,OpenDlssNrNative.libraryPath().isRegularFile()))
        if(!model().resolve("manifest.json").isRegularFile() || !model().resolve("model/stages/nr.bin").isRegularFile())return Availability(false,"NR weights absent; run fetchOpenDlssNrWeights")
        if(!shaders().resolve("field_nr_composite.spv").isRegularFile())return Availability(false,"NR kernels absent; run buildOpenDlssNrNative")
        return Availability(true,"NR Vulkan features enabled and pinned assets present")
    }
}