gallium/docs: clean up texture usage text, added texture geom info
authorBrian Paul <brianp@vmware.com>
Wed, 24 Feb 2010 15:52:03 +0000 (08:52 -0700)
committerBrian Paul <brianp@vmware.com>
Wed, 24 Feb 2010 15:52:33 +0000 (08:52 -0700)
src/gallium/docs/source/screen.rst

index 27f65522b6991c0f2bdd1e676ab9b73a09dd0f0a..e78634e59e9077a558f7e54ecc6d7b645474d9db 100644 (file)
@@ -147,16 +147,30 @@ These flags determine the possible roles a texture may be used for during its
 lifetime. Texture usage flags are cumulative and may be combined to create a
 texture that can be used as multiple things.
 
-* ``RENDER_TARGET``: A colorbuffer or pixelbuffer.
+* ``RENDER_TARGET``: A color buffer or pixel buffer which will be rendered to.
 * ``DISPLAY_TARGET``: A sharable buffer that can be given to another process.
-* ``PRIMARY``: A frontbuffer or scanout buffer.
-* ``DEPTH_STENCIL``: A depthbuffer, stencilbuffer, or Z buffer. Gallium does
-  not explicitly provide for stencil-only buffers, so any stencilbuffer
-  validated here is implicitly also a depthbuffer.
+* ``PRIMARY``: A front color buffer or scanout buffer.
+* ``DEPTH_STENCIL``: A depth (Z) buffer or stencil buffer.  Gallium does
+  not explicitly provide for stencil-only buffers, so any stencil buffer
+  validated here is implicitly also a depth buffer.
 * ``SAMPLER``: A texture that may be sampled from in a fragment or vertex
   shader.
 * ``DYNAMIC``: A texture that will be mapped frequently.
 
+
+PIPE_TEXTURE_GEOM
+^^^^^^^^^^^^^^^^^
+
+These flags are used when querying whether a particular pipe_format is
+supported by the driver (with the `is_format_supported` function).
+Some formats may only be supported for certain kinds of textures.
+For example, a compressed format might only be used for POT textures.
+
+* ``PIPE_TEXTURE_GEOM_NON_SQUARE``: The texture may not be square
+* ``PIPE_TEXTURE_GEOM_NON_POWER_OF_TWO``: The texture dimensions may not be
+  powers of two.
+
+
 Methods
 -------