gallium/docs: Update for timer queries.
authorCorbin Simpson <MostAwesomeDude@gmail.com>
Mon, 17 May 2010 19:00:59 +0000 (12:00 -0700)
committerCorbin Simpson <MostAwesomeDude@gmail.com>
Mon, 17 May 2010 19:05:18 +0000 (12:05 -0700)
src/gallium/docs/source/context.rst
src/gallium/docs/source/screen.rst

index c82e681a254db3b40077f3ed59a810aa52553faf..66028a63b599ab8344b137b57a2ce2bd6bc3868b 100644 (file)
@@ -200,9 +200,16 @@ returned).  Otherwise, if the ``wait`` parameter is FALSE, the call
 will not block and the return value will be TRUE if the query has
 completed or FALSE otherwise.
 
-A common type of query is the occlusion query which counts the number of
-fragments/pixels which are written to the framebuffer (and not culled by
-Z/stencil/alpha testing or shader KILL instructions).
+The most common type of query is the occlusion query,
+``PIPE_QUERY_OCCLUSION_COUNTER``, which counts the number of fragments which
+are written to the framebuffer without being culled by
+:ref:`Depth, Stencil, & Alpha` testing or shader KILL instructions.
+
+Another type of query, ``PIPE_QUERY_TIME_ELAPSED``, returns the amount of
+time, in milliseconds, the context takes to perform operations.
+
+Gallium does not guarantee the availability of any query types; one must
+always check the capabilities of the :ref:`Screen` first.
 
 
 Conditional Rendering
index 71b7aec35a5cc85755c8767b305d7bd682015d30..96257f93df9161b953fcb975964249ea03498876 100644 (file)
@@ -1,3 +1,5 @@
+.. _screen:
+
 Screen
 ======
 
@@ -33,6 +35,7 @@ The integer capabilities:
 * ``MAX_RENDER_TARGETS``: The maximum number of render targets that may be
   bound.
 * ``OCCLUSION_QUERY``: Whether occlusion queries are available.
+* ``TIMER_QUERY``: Whether timer queries are available.
 * ``TEXTURE_SHADOW_MAP``: XXX
 * ``MAX_TEXTURE_2D_LEVELS``: The maximum number of mipmap levels available
   for a 2D texture.