gallium/docs: clarify when query results are reset
authorRob Clark <robclark@freedesktop.org>
Tue, 13 May 2014 02:19:03 +0000 (22:19 -0400)
committerRob Clark <robclark@freedesktop.org>
Wed, 14 May 2014 11:54:02 +0000 (07:54 -0400)
It wasn't completely clear from the docs, so I had to figure out by
looking at piglit results.  Hopefully this saves the next driver writer
implementing queries some time.

Signed-off-by: Rob Clark <robclark@freedesktop.org>
src/gallium/docs/source/context.rst

index fc8dd16f8949f2dbcb33aa14a7977aa6d99d4c32..571ee87c2dc1f4047f6ac080030961c5ca1b87d5 100644 (file)
@@ -300,6 +300,8 @@ Queries can be created with ``create_query`` and deleted with
 ``destroy_query``. To start a query, use ``begin_query``, and when finished,
 use ``end_query`` to end the query.
 
+``begin_query`` will clear/reset previous query results.
+
 ``get_query_result`` is used to retrieve the results of a query.  If
 the ``wait`` parameter is TRUE, then the ``get_query_result`` call
 will block until the results of the query are ready (and TRUE will be