Package org.lwjgl.util.remotery

@NullMarked package org.lwjgl.util.remotery

Contains bindings to Remotery, a realtime CPU/GPU profiler hosted in a single C file with a viewer that runs in a web browser.

LWJGL: The current version of the Remotery bindings is compatible with commit c3e8a2f. Run the following commands to clone the Remotery repository at that commit:

 git clone --depth=1 https://github.com/Celtoys/Remotery.git
 cd Remotery
 git fetch --depth=1 origin c3e8a2f38603c054be479bcefeaa54ad455dd4b9
 git branch --no-track lwjgl c3e8a2f38603c054be479bcefeaa54ad455dd4b9
 git checkout lwjgl
 git branch -D @{-1}

Now open vis/index.html in your favorite browser to view the profiler.

Class	Description
Remotery
RemoteryGL
RemoteryMetal
RemoteryVulkan
RMTFree	Callback function: rmtFreePtr
RMTFreeI	Callback function: rmtFreePtr
RMTInputHandler	Callback function: rmtInputHandlerPtr
RMTInputHandlerI	Callback function: rmtInputHandlerPtr
RMTMalloc	Callback function: rmtMallocPtr
RMTMallocI	Callback function: rmtMallocPtr
RMTProperty	struct rmtProperty { rmtBool initialised; rmtPropertyType type; rmtPropertyFlags flags; rmtPropertyValue value; rmtPropertyValue lastFrameValue; rmtPropertyValue prevValue; rmtU32 prevValueFrame; char const * name; char const * description; rmtPropertyValue defaultValue; rmtProperty * parent; rmtProperty * firstChild; rmtProperty * lastChild; rmtProperty * nextSibling; rmtU32 nameHash; rmtU32 uniqueID; }
RMTProperty.Buffer	An array of RMTProperty structs.
RMTPropertyHandler	Callback function: rmtPropertyHandlerPtr
RMTPropertyHandlerI	Callback function: rmtPropertyHandlerPtr
RMTPropertyIterator	struct rmtPropertyIterator { rmtProperty * property; rmtProperty * initial; }
RMTPropertyValue	union rmtPropertyValue { rmtBool Bool; rmtS32 S32; rmtU32 U32; rmtF32 F32; rmtS64 S64; rmtU64 U64; rmtF64 F64; }
RMTPropertyValue.Buffer	An array of RMTPropertyValue structs.
RMTRealloc	Callback function: rmtReallocPtr
RMTReallocI	Callback function: rmtReallocPtr
RMTSampleIterator	struct rmtSampleIterator { rmtSample * sample; rmtSample * initial; }
RMTSampleTreeHandler	Callback function: rmtSampleTreeHandlerPtr
RMTSampleTreeHandlerI	Callback function: rmtSampleTreeHandlerPtr
RMTSettings	struct rmtSettings { rmtU16 port; rmtBool reuse_open_port; rmtBool limit_connections_to_localhost; rmtBool enableThreadSampler; rmtU32 msSleepBetweenServerUpdates; rmtU32 messageQueueSizeInBytes; rmtU32 maxNbMessagesPerUpdate; rmtMallocPtr _malloc; rmtReallocPtr realloc; rmtFreePtr _free; void * mm_context; rmtInputHandlerPtr input_handler; rmtSampleTreeHandlerPtr sampletree_handler; void * sampletree_context; rmtPropertyHandlerPtr snapshot_callback; void * snapshot_context; void * input_handler_context; rmtPStr logPath; }
RMTVulkanBind	struct rmtVulkanBind { VkInstance instance; VkPhysicalDevice physical_device; VkDevice device; VkQueue queue; }
RMTVulkanBind.Buffer	An array of RMTVulkanBind structs.
RMTVulkanFunctions	struct rmtVulkanFunctions { void * vkGetPhysicalDeviceProperties; void * vkQueueSubmit; void * vkQueueWaitIdle; void * vkCreateQueryPool; void * vkDestroyQueryPool; void * vkResetQueryPool; void * vkGetQueryPoolResults; void * vkCmdWriteTimestamp; void * vkCreateSemaphore; void * vkDestroySemaphore; void * vkSignalSemaphore; void * vkGetSemaphoreCounterValue; void * vkGetCalibratedTimestampsEXT; }
RMTVulkanFunctions.Buffer	An array of RMTVulkanFunctions structs.