gallium/docs: document interface changes for timestamp query
authorMarek Olšák <maraeo@gmail.com>
Tue, 10 Jul 2012 16:55:46 +0000 (18:55 +0200)
committerMarek Olšák <maraeo@gmail.com>
Tue, 10 Jul 2012 17:04:13 +0000 (19:04 +0200)
the query type is already documented

src/gallium/docs/source/screen.rst

index 2c683efa9a76fa464f581e2e49edae346907f3ee..4eb5b32edcfee97f34e52a9bc7c5eebb32e60e16 100644 (file)
@@ -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).