Module renderdoc::entry [] [src]

Entry point loading and API versioning.

Modules

version

API versioning.

Structs

EntryV100

Entry point for RenderDoc API version 1.0.

EntryV110

Entry point for RenderDoc API version 1.1.

Type Definitions

EndFrameCaptureFn

Ends the ongoing capture on the given device pointer and window handle.

GetApiVersionFn

Provides the major, minor, and patch version numbers of the RenderDoc API given to the application.

GetCaptureFn

Retrieves the details of a frame capture with the given index idx.

GetCaptureOptionF32Fn

Returns the current value of the given CaptureOption as a u32 value.

GetCaptureOptionU32Fn

Returns the current value of the given CaptureOption as a u32 value.

GetLogFilePathTemplateFn

Returns the current frame capture file template as a raw UTF-8 string.

GetNumCapturesFn

Returns the number of frame captures that have been made so far.

GetOverlayBitsFn

Returns the OverlayBits that have been set.

IsFrameCapturingFn

Returns whether or not a frame capture is currently ongoing anywhere.

IsTargetControlConnectedFn

Returns whether the external RenderDoc UI is connected to this application.

LaunchReplayUiFn

Launches the replay UI from within the injected application.

MaskOverlayBitsFn

Sets the given OverlayBits with an AND and OR mask.

SetActiveWindowFn

Activates the RenderDoc in-app overlay inside the given window handle wnd_handle and API device pointer device.

SetCaptureKeysFn

Sets which key(s) can be used to capture the next frame.

SetCaptureOptionF32Fn

Sets the specified CaptureOption to the given f32 value.

SetCaptureOptionU32Fn

Sets the specified CaptureOption to the given u32 value.

SetFocusToggleKeysFn

Sets which key(s) can be used to toggle focus between multiple windows.

SetLogFilePathTemplateFn

Sets the naming prefix to be used when saving frame capture files.

ShutdownFn

Attempts to shut down RenderDoc.

StartFrameCaptureFn

Immediately starts capturing API calls from the specified device pointer and window handle.

TriggerCaptureFn

Captures the next frame from the currently active window and API device.

TriggerMultiFrameCaptureFn

Captures the next n frames from the currently active window and API device.

UnloadCrashHandlerFn

Unloads the RenderDoc crash handler from your application.