Expand description
Rust bindings to RenderDoc, a popular graphics debugger.
RenderDoc is a free and open source debugger for real-time graphics providing quick and easy frame captures and detailed introspection of any application using Vulkan, Direct3D 11, Direct3D 12, OpenGL, and OpenGL ES.
These bindings require that RenderDoc be installed on the target machine, with either
renderdoc.dll or librenderdoc.so visible from your $PATH.
For more details on how to use this API to integrate your game or renderer with the RenderDoc profiler, consult the upstream in-application API documentation.
Structs§
- Device
Pointer - Raw mutable pointer to the API’s root handle.
- Error
- Errors that can occur with the RenderDoc in-application API.
- Overlay
Bits - Bit flags for customizing the RenderDoc overlay.
- Render
Doc - An instance of the RenderDoc API with baseline version
V.
Enums§
- Capture
Option - RenderDoc capture options.
- Input
Button - User input key codes.
- V100
- Requests a minimum version number of 1.0.0.
- V110
- Requests a minimum version number of 1.1.0.
- V111
- Requests a minimum version number of 1.1.1.
- V112
- Requests a minimum version number of 1.1.2.
- V120
- Requests a minimum version number of 1.2.0.
- V130
- Requests a minimum version number of 1.3.0.
- V140
- Requests a minimum version number of 1.4.0.
- V141
- Requests a minimum version number of 1.4.1.
Constants§
- SHADER_
MAGIC_ DEBUG_ VALUE_ BYTE_ ARRAY - Magic value used for when applications pass a path where shader debug information can be found to match up with a stripped shader.
- SHADER_
MAGIC_ DEBUG_ VALUE_ TRUNCATED - Magic value used for when applications pass a path where shader debug information can be found to match up with a stripped shader.
Traits§
- HasPrevious
- Trait for statically enforcing backwards compatibility.
- Version
- Entry point into the RenderDoc API.
Type Aliases§
- Entry
- Entry point for the RenderDoc API.
- Window
Handle - Raw mutable pointer to the OS-provided window handle.