diff options
| author | Ben Clayton <bclayton@google.com> | 2021-09-10 14:45:35 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-10 09:45:35 -0400 |
| commit | 540f09fb4a83f234692e311d77afacd6c6003b6f (patch) | |
| tree | 3232dfcb9ec6286f09dfd9d3b6612b336791399f | |
| parent | 3e22a7d6694983df7bf575b0c0ae829b8333a5bf (diff) | |
| download | amber-540f09fb4a83f234692e311d77afacd6c6003b6f.tar.gz | |
debugger.md: Replace WIP with Caveats (#961)
No one is actively working on this at the moment.
| -rw-r--r-- | docs/debugger.md | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/docs/debugger.md b/docs/debugger.md index 6c3208b..dc887d0 100644 --- a/docs/debugger.md +++ b/docs/debugger.md @@ -3,9 +3,7 @@ This document describes Amber's shader debugger testing framework, which allows developers to write tests for Vulkan drivers that expose shader debugging functionality via the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/). --- -**Work In Progress** - -Note that shader debugging is very much work-in-progress: +**Caveats** * Vulkan shader debugging currently does not have a formalized specification. A shader debugger implementation is being developed in [SwiftShader](https://swiftshader.googlesource.com/SwiftShader/), which one day may become a reference implementation for a formal specifiction. * Currently SwiftShader is the only Vulkan driver to implement a [DAP based shader debugger](https://swiftshader.googlesource.com/SwiftShader/+/refs/heads/master/docs/VulkanShaderDebugging.md). This implementation is also work-in-progress, and may significantly change. @@ -189,4 +187,4 @@ The `amber::Engine::Debugger` interface can be obtained from the `amber::Engine` * If the `amber::Command` holds a `amber::debug::Script`, then this script is executed on the `amber::Engine::Debugger` using the `amber::debug::Script::Run(amber::debug::Events *)` method, before the Vulkan command is executed. * The command is then executed with `amber::Executor::ExecuteCommand()` * Once the command has completed, all debugger threads are synchronized and debugger test results are collected with a call to `amber::Engine::Debugger::Flush()`. -* This process is repeated for all commands in the script.
\ No newline at end of file +* This process is repeated for all commands in the script. |