Mesa (master): gallium/docs: Update for timer queries.
Corbin Simpson
csimpson at kemper.freedesktop.org
Mon May 17 19:05:47 UTC 2010
Module: Mesa
Branch: master
Commit: f1cf6b0d371c907938fd3780ef7a53f294ec1064
URL: http://cgit.freedesktop.org/mesa/mesa/commit/?id=f1cf6b0d371c907938fd3780ef7a53f294ec1064
Author: Corbin Simpson <MostAwesomeDude at gmail.com>
Date: Mon May 17 12:00:59 2010 -0700
gallium/docs: Update for timer queries.
---
src/gallium/docs/source/context.rst | 13 ++++++++++---
src/gallium/docs/source/screen.rst | 3 +++
2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/src/gallium/docs/source/context.rst b/src/gallium/docs/source/context.rst
index c82e681..66028a6 100644
--- a/src/gallium/docs/source/context.rst
+++ b/src/gallium/docs/source/context.rst
@@ -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
diff --git a/src/gallium/docs/source/screen.rst b/src/gallium/docs/source/screen.rst
index 71b7aec..96257f9 100644
--- a/src/gallium/docs/source/screen.rst
+++ b/src/gallium/docs/source/screen.rst
@@ -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.
More information about the mesa-commit
mailing list