graphics.scenery.utils.RemoteryProfiler.kt Maven / Gradle / Ivy

Go to download
package graphics.scenery.utils

import graphics.scenery.Hub
import graphics.scenery.Hubable
import org.lwjgl.PointerBuffer
import org.lwjgl.util.remotery.Remotery.rmt_BeginCPUSample
import org.lwjgl.util.remotery.Remotery.rmt_CreateGlobalInstance
import org.lwjgl.util.remotery.Remotery.rmt_DestroyGlobalInstance
import org.lwjgl.util.remotery.Remotery.rmt_EndCPUSample
import org.lwjgl.util.remotery.Remotery.rmt_SetCurrentThreadName

/**
 * Class for using the Remotery profiler.
 * To use, set `scenery.Profiler` to true, and connect to the profiler
 * by using opening `vis/index.html` from the [Remotery Github repository](https://github.com/Celtoys/Remotery).
 *
 * As parameter, the class requires a [hub] to attach to.
 *
 * @author Ulrik Guenther 
 */
class RemoteryProfiler(override var hub : Hub?) : Hubable, Profiler, AutoCloseable {
    private var instance = PointerBuffer.allocateDirect(1)
    private val logger by lazyLogger()

    init {
        val error = rmt_CreateGlobalInstance(instance)
        if(error == 0) {
            logger.info("Created Remotery profiler instance")
        } else {
            throw IllegalStateException("Could not create Remotery profiler ($error)")
        }
    }

    /**
     * Sets the current thread name to [name].
     */
    override fun setThreadName(name: String) {
        rmt_SetCurrentThreadName(name)
    }

    /**
     * Begins a new sample with [name]. Default type is [SampleType.Default].
     *  Calls to [begin] and [end] behave like brackets an can be nested.
     */
    override fun begin(name: String, type: Profiler.SampleType) {
        rmt_BeginCPUSample(name, type.ordinal, null)
    }

    /**
     * Ends the current sample. Must have a corresponding [begin].
     */
    override fun end() {
        rmt_EndCPUSample()
    }

    /**
     * Closes the Remotery instance.
     */
    override fun close() {
        rmt_DestroyGlobalInstance(instance.get(0))
        logger.info("Closing Remotery...")
    }
}