From: Marek Olšák <maraeo@gmail.com>
Date: Tue, 10 Jul 2012 16:55:46 +0000 (+0200)
Subject: gallium/docs: document interface changes for timestamp query
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=67a8ee891b2e119d826d8f830c1cbbe64ecb4f82;p=mesa.git

gallium/docs: document interface changes for timestamp query

the query type is already documented
---

diff --git a/src/gallium/docs/source/screen.rst b/src/gallium/docs/source/screen.rst
index 2c683efa9a7..4eb5b32edcf 100644
--- a/src/gallium/docs/source/screen.rst
+++ b/src/gallium/docs/source/screen.rst
@@ -128,6 +128,8 @@ The integer capabilities:
   alignment of pipe_constant_buffer::buffer_offset.
 * ``PIPE_CAP_START_INSTANCE``: Whether the driver supports
   pipe_draw_info::start_instance.
+* ``PIPE_CAP_QUERY_TIMESTAMP``: Whether PIPE_QUERY_TIMESTAMP and
+  the pipe_screen::get_timestamp hook are implemented.
 
 
 .. _pipe_capf:
@@ -399,3 +401,11 @@ resource_destroy
 
 Destroy a resource. A resource is destroyed if it has no more references.
 
+
+
+get_timestamp
+^^^^^^^^^^^^^
+
+Query a timestamp in nanoseconds. The returned value should match
+PIPE_QUERY_TIMESTAMP. This function returns immediately and doesn't
+wait for rendering to complete (which cannot be achieved with queries).