gallium/docs: clarify that samplers are not used with PIPE_BUFFER resources
authorBrian Paul <brianp@vmware.com>
Fri, 30 Jun 2017 15:23:17 +0000 (09:23 -0600)
committerBrian Paul <brianp@vmware.com>
Fri, 30 Jun 2017 19:37:10 +0000 (13:37 -0600)
Commit 8aba778fa2cd98a0b5a7429d3c5057778a0c808c "st/mesa: don't set
sampler states for TBOs" changed how texture buffer objects are handled.
Document the new convention.

Reviewed-by: Roland Scheidegger <sroland@vmware.com>
src/gallium/docs/source/context.rst

index 6563a7e..a46131c 100644 (file)
@@ -99,6 +99,14 @@ objects. They all follow simple, one-method binding calls, e.g.
   various debug messages, eventually reported via KHR_debug and
   similar mechanisms.
 
+Samplers
+^^^^^^^^
+
+pipe_sampler_state objects control how textures are sampled (coordinate
+wrap modes, interpolation modes, etc).  Note that samplers are not used
+for texture buffer objects.  That is, pipe_context::bind_sampler_views()
+will not bind a sampler if the corresponding sampler view refers to a
+PIPE_BUFFER resource.
 
 Sampler Views
 ^^^^^^^^^^^^^