README.md

renderdoc-rs

Rust bindings to RenderDoc, a popular graphics debugger.

RenderDoc is a free and open source graphics debugging tool. RenderDoc allows game developers to take frame captures of their applications, replay them, examine the graphics pipeline state, and potentially identify nasty graphics bugs.

These bindings require that RenderDoc be installed on the target machine, with either renderdoc.dll or librenderdoc.so visible from yourPATH.

Example

extern crate renderdoc;

use renderdoc::{RenderDoc, V100, V110};
use renderdoc::prelude::*;

fn main() {
    let mut rd: RenderDoc<V110> = RenderDoc::new().expect("Failed to init");

    let (major, minor, patch) = rd.get_api_version();
    assert_eq!(major, 1u32);
    assert_eq!(minor, 1u32);

    // When a certain key is pressed, trigger a single-frame capture like this.
    rd.trigger_capture();

    // If you specify version `V110` or newer, you can trigger a multi-frame
    // capture like this.
    rd.trigger_multi_frame_capture(3);

    // Query the details of an existing capture like this.
    match rd.get_capture(0) {
        Some(cap) => println!("ID: 0, Path: {}, Timestamp: {}", cap.0, cap.1),
        None => println!("No capture found with ID of 0!"),
    }

    // Downgrade your effective API version at run-time like this.
    let mut rd: RenderDoc<V100> = rd.into();

    // Now this line will no longer compile!
    // rd.trigger_multi_frame_capture(3);
}

Working examples are available in the examples directory.

License

renderdoc-rs is free and open source software distributed under the terms of both the MIT and the Apache 2.0 licenses.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.