renderdoc.h

#include <modkit/renderdoc.h>10 functions

RenderDoc integration for frame capture.

Provides integration with RenderDoc for capturing frames and debugging GPU rendering. When RenderDoc is attached, you can trigger captures via:F11 key (when MK_DEBUG_RENDERDOC is enabled)mk_renderdoc_capture_frame() API Usage:Launch your app from RenderDoc, orInject RenderDoc into running appPress F11 or call mk_renderdoc_capture_frame()View capture in RenderDoc UI

Functions

mk_renderdoc_availablefunction

bool mk_renderdoc_available(void)

Check if RenderDoc is available (attached to process).

Returns true if RenderDoc is attached

mk_renderdoc_capture_framefunction

void mk_renderdoc_capture_frame(void)

Capture the next frame.

Call this before mk_frame_end() to capture that frame. Does nothing if RenderDoc is not attached.

mk_renderdoc_get_capture_countfunction

uint32_t mk_renderdoc_get_capture_count(void)

Get the number of captures made this session.

Returns Capture count

mk_renderdoc_initfunction

mk_result mk_renderdoc_init(void)

Initialize the renderdoc.

Returns MK_SUCCESS or an error result.

mk_renderdoc_is_capturingfunction

bool mk_renderdoc_is_capturing(void)

Check if a capture is currently in progress.

Returns true if capturing

mk_renderdoc_launch_uifunction

bool mk_renderdoc_launch_ui(void)

Launch the RenderDoc UI (if available).

Opens RenderDoc with the most recent capture.

Returns true if UI was launched successfully

mk_renderdoc_set_optionsfunction

void mk_renderdoc_set_options(bool capture_callstacks, bool ref_all_resources)

Set capture options.

Parameter	Type	Description
capture_callstacks	bool	Capture CPU callstacks (slower)
ref_all_resources	bool	Reference all resources, not just used ones

mk_renderdoc_shutdownfunction

void mk_renderdoc_shutdown(void)

Perform the renderdoc shutdown operation.

mk_renderdoc_start_capturefunction

void mk_renderdoc_start_capture(uint32_t num_frames)

Start a multi-frame capture.

Parameter	Type	Description
num_frames	uint32_t	Number of frames to capture (0 = until stop)

mk_renderdoc_stop_capturefunction

void mk_renderdoc_stop_capture(void)

Stop an ongoing multi-frame capture.