From 24ceb47cbc809f22059a4ef14af5aceff533c377 Mon Sep 17 00:00:00 2001 From: Benjamin Otte Date: Sat, 13 Jan 2024 17:21:44 +0100 Subject: [PATCH] tools: Add the new benchmark command to the docs --- docs/reference/gtk/gtk4-rendernode-tool.rst | 31 ++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/docs/reference/gtk/gtk4-rendernode-tool.rst b/docs/reference/gtk/gtk4-rendernode-tool.rst index a01b6b58e4..879112cde5 100644 --- a/docs/reference/gtk/gtk4-rendernode-tool.rst +++ b/docs/reference/gtk/gtk4-rendernode-tool.rst @@ -12,9 +12,10 @@ SYNOPSIS -------- | **gtk4-rendernode-tool** [OPTIONS...] | +| **gtk4-rendernode-tool** benchmark [OPTIONS...] | **gtk4-rendernode-tool** info [OPTIONS...] -| **gtk4-rendernode-tool** show [OPTIONS...] | **gtk4-rendernode-tool** render [OPTIONS...] [] +| **gtk4-rendernode-tool** show [OPTIONS...] DESCRIPTION ----------- @@ -50,3 +51,31 @@ The name of the file to write can be specified as a second FILE argument. Use the given renderer. Use ``--renderer=help`` to get a information about poassible values for the ``RENDERER``. + +Benchmark +^^^^^^^^^ + +The ``benchmark`` command benchmarks rendering of a node with the existing renderers +and prints the runtimes. + +``--renderer=RENDERER`` + + Add the given renderer. This argument can be passed multiple times to test multiple + renderers. By default, all major GTK renderers are run. + +``--runs=RUNS`` + + Number of times to render the node on each renderer. By default, this is 3 times. + Keep in mind that the first run is often used to populate caches and might be + significantly slower. + +``--no-download`` + + Do not attempt to download the result. This may cause the measurement to not include + the execution of the commands on the GPU. It can be useful to use this flag to test + command submission performance. + + + + +