renderdoc_sys/lib.rs
1//! Low-level bindings to the [RenderDoc](https://renderdoc.org/) in-application API.
2//!
3//! RenderDoc is a free and open source debugger for real-time graphics providing quick and easy
4//! frame captures and detailed introspection of any application using [Vulkan], [Direct3D 11],
5//! [Direct3D 12], [OpenGL], and [OpenGL ES].
6//!
7//! [Vulkan]: https://www.vulkan.org/
8//! [Direct3D 11]: https://learn.microsoft.com/en-us/windows/win32/direct3d11/atoc-dx-graphics-direct3d-11
9//! [Direct3D 12]: https://learn.microsoft.com/en-us/windows/win32/direct3d12/direct3d-12-graphics
10//! [OpenGL]: https://www.khronos.org/opengl/
11//! [OpenGL ES]: https://www.khronos.org/opengles/
12//!
13//! These bindings are automatically generated from [`renderdoc_app.h`] with [`bindgen`]. This
14//! crate does not provide nor link to the `renderdoc.dll` or `librenderdoc.so` libraries on its
15//! own; it only contains FFI symbols. Refer to the official [In-Application API][api]
16//! documentation for correct usage.
17//!
18//! [`renderdoc_app.h`]: https://github.com/baldurk/renderdoc/blob/v1.x/renderdoc/api/app/renderdoc_app.h
19//! [`bindgen`]: https://github.com/rust-lang/rust-bindgen
20//! [api]: https://renderdoc.org/docs/in_application_api.html
21//!
22//! For a safe wrapper, see the [`renderdoc`](https://docs.rs/renderdoc) crate.
23
24#![allow(non_camel_case_types)]
25#![allow(non_snake_case)]
26#![allow(non_upper_case_globals)]
27
28include!("./bindings.rs");