Add documentation for using testing using the command buffer
authorbsalomon <bsalomon@google.com>
Fri, 4 Nov 2016 15:36:00 +0000 (08:36 -0700)
committerCommit bot <commit-bot@chromium.org>
Fri, 4 Nov 2016 15:36:00 +0000 (08:36 -0700)
GOLD_TRYBOT_URL= https://gold.skia.org/search?issue=2479833003
NOTRY=true
DOCS_PREVIEW= https://skia.org/?cl=2479833003

Review-Url: https://codereview.chromium.org/2479833003

site/dev/chrome/commandbuffer.md [new file with mode: 0644]

diff --git a/site/dev/chrome/commandbuffer.md b/site/dev/chrome/commandbuffer.md
new file mode 100644 (file)
index 0000000..2afa5c9
--- /dev/null
@@ -0,0 +1,22 @@
+Chromium Command Buffer
+==========================
+
+It is possible to run Skia's correctness tool, dm, and benchmarking tool,
+nanobench, on top of the GL ES interface provided by Chromium's command
+buffer.
+
+The Skia tools are always built with this support. They dynamically load
+the command buffer as a shared library and thus no GYP/GN flags are
+required.
+
+The command buffer standalone shared library is built in a Chromium checkout
+by building the 'command_buffer_gles2' target. The command buffer should be
+built with the is_component_build in GN set to false. This will produce a .so,
+.dylib, or .dll depending on the target OS. This should be copied alongside
+the dm or nanobench executable built from a Skia repository.
+
+Both tools have a 'commandbuffer' config which can be used with the --config
+option to the tool and will run the tests or benchmarks using the command buffer
+library. Unit tests in dm always run on all appropriate and available backends
+regardless of the --config flag.
+