Skip to main content

renderdog/
lib.rs

1//! RenderDoc in-application API wrapper.
2//!
3//! This crate provides a Rust wrapper around RenderDoc's *in-app capture API* (`renderdoc_app.h`).
4//! It supports:
5//! - connecting to an injected RenderDoc (Windows),
6//! - dynamically loading the RenderDoc library (Windows/Linux),
7//! - runtime API version negotiation (tries 1.7.0 down to 1.0.0),
8//! - RenderDoc 1.7 object/command annotations when the runtime supports them.
9//!
10//! For automation workflows (renderdoccmd/qrenderdoc), see the `renderdog-automation` crate.
11
12mod annotations;
13mod in_app;
14mod settings;
15
16pub use annotations::*;
17pub use in_app::*;
18pub use settings::*;
19
20pub type SysCaptureOption = RENDERDOC_CaptureOption;
21pub type SysInputButton = RENDERDOC_InputButton;
22pub type SysDevicePointer = RENDERDOC_DevicePointer;
23pub type SysWindowHandle = RENDERDOC_WindowHandle;