{"id":19333556,"url":"https://github.com/ebkalderon/renderdoc-rs","last_synced_at":"2025-04-07T06:11:38.920Z","repository":{"id":37952709,"uuid":"105664260","full_name":"ebkalderon/renderdoc-rs","owner":"ebkalderon","description":"RenderDoc application bindings for Rust","archived":false,"fork":false,"pushed_at":"2024-04-29T21:31:38.000Z","size":414,"stargazers_count":42,"open_issues_count":8,"forks_count":6,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-29T23:10:19.250Z","etag":null,"topics":["bindings","directx","ffi","opengl","renderdoc","rust","vulkan"],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ebkalderon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-03T14:51:19.000Z","updated_at":"2024-06-20T23:28:49.033Z","dependencies_parsed_at":"2024-04-29T22:46:13.346Z","dependency_job_id":"99682867-5ba6-49e0-84de-f94d7e5af5ae","html_url":"https://github.com/ebkalderon/renderdoc-rs","commit_stats":{"total_commits":158,"total_committers":8,"mean_commits":19.75,"dds":"0.36708860759493667","last_synced_commit":"7a67fee9327545ae7425efb20b79511429a2163b"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebkalderon%2Frenderdoc-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebkalderon%2Frenderdoc-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebkalderon%2Frenderdoc-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebkalderon%2Frenderdoc-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ebkalderon","download_url":"https://codeload.github.com/ebkalderon/renderdoc-rs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247601448,"owners_count":20964864,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bindings","directx","ffi","opengl","renderdoc","rust","vulkan"],"created_at":"2024-11-10T02:53:29.756Z","updated_at":"2025-04-07T06:11:38.902Z","avatar_url":"https://github.com/ebkalderon.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# renderdoc-rs\n\n[![Build Status][build-badge]][build-url]\n[![Crates.io][crate-badge]][crate-url]\n[![Documentation][docs-badge]][docs-url]\n\n[build-badge]: https://github.com/ebkalderon/renderdoc-rs/actions/workflows/ci.yml/badge.svg\n[build-url]: https://github.com/ebkalderon/renderdoc-rs/actions\n[crate-badge]: https://img.shields.io/crates/v/renderdoc.svg\n[crate-url]: https://crates.io/crates/renderdoc\n[docs-badge]: https://docs.rs/renderdoc/badge.svg\n[docs-url]: https://docs.rs/renderdoc\n\nRust bindings to [RenderDoc], a popular graphics debugger.\n\n[RenderDoc]: https://renderdoc.org/\n\nRenderDoc is a free and open source debugger for real-time graphics providing\nquick and easy frame captures and detailed introspection of any application\nusing [Vulkan], [Direct3D 11], [Direct3D 12], [OpenGL], and [OpenGL ES].\n\n[Vulkan]: https://www.vulkan.org/\n[Direct3D 11]: https://learn.microsoft.com/en-us/windows/win32/direct3d11/atoc-dx-graphics-direct3d-11\n[Direct3D 12]: https://learn.microsoft.com/en-us/windows/win32/direct3d12/direct3d-12-graphics\n[OpenGL]: https://www.khronos.org/opengl/\n[OpenGL ES]: https://www.khronos.org/opengles/\n\nThese bindings require that RenderDoc be installed on the target machine, with\neither `renderdoc.dll` or `librenderdoc.so` visible from your `$PATH`.\n\nFor more details on how to use this API to integrate your game or renderer with\nthe RenderDoc profiler, consult the [in-application API][in-app] documentation.\n\n[in-app]: https://renderdoc.org/docs/in_application_api.html\n\n## Example\n\n```rust\nuse renderdoc::{RenderDoc, V100, V110};\n\nfn main() {\n    let mut rd: RenderDoc\u003cV110\u003e = RenderDoc::new().expect(\"Unable to connect\");\n\n    let (major, minor, patch) = rd.get_api_version();\n    assert_eq!(major, 1u32);\n    assert!(minor \u003e= 1u32);\n\n    // When a certain key is pressed, trigger a single-frame capture like this.\n    rd.trigger_capture();\n\n    // If you specify version `V110` or newer, you can trigger a multi-frame\n    // capture like this.\n    rd.trigger_multi_frame_capture(3);\n\n    // Query the details of an existing capture like this.\n    match rd.get_capture(0) {\n        Some((path, capture_time)) =\u003e println!(\"ID: 0, Path: {}, Captured: {:?}\", path, capture_time),\n        None =\u003e println!(\"No capture found with ID of 0!\"),\n    }\n\n    // Downgrade your effective API version at run-time like this.\n    let mut rd: RenderDoc\u003cV100\u003e = rd.into();\n\n    // Now this line will no longer compile!\n    // rd.trigger_multi_frame_capture(3);\n}\n```\n\nWorking examples are available in the `examples` directory.\n\n## License\n\n`renderdoc-rs` is free and open source software distributed under the terms of\neither the [MIT](LICENSE-MIT) or the [Apache 2.0](LICENSE-APACHE) license, at\nyour option.\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be\ndual licensed as above, without any additional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febkalderon%2Frenderdoc-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Febkalderon%2Frenderdoc-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febkalderon%2Frenderdoc-rs/lists"}