Mesa (gallium-resources): docs: fix transfer_map description

Roland Scheidegger sroland at kemper.freedesktop.org
Thu Apr 8 15:45:20 UTC 2010


Module: Mesa
Branch: gallium-resources
Commit: 1ff3984c2edce9927744f3cce3e7b07778990170
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=1ff3984c2edce9927744f3cce3e7b07778990170

Author: Roland Scheidegger <sroland at vmware.com>
Date:   Thu Apr  8 17:44:54 2010 +0200

docs: fix transfer_map description

---

 src/gallium/docs/source/context.rst |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/gallium/docs/source/context.rst b/src/gallium/docs/source/context.rst
index 26b003a..7439d10 100644
--- a/src/gallium/docs/source/context.rst
+++ b/src/gallium/docs/source/context.rst
@@ -275,12 +275,13 @@ These methods are used to get data to/from a resource.
 data to be written to the resource at this point.
 
 ``transfer_map`` creates a memory mapping for the transfer object.
-The returned map is always relative to the beginning of the resource, not
-taking the potential box region into account.
+The returned map points to the start of the mapped range according to
+the box region, not the beginning of the resource.
 
 .. _transfer_flush_region:
 ``transfer_flush_region`` If a transfer was created with TRANFER_FLUSH_EXPLICIT,
-only the region specified is guaranteed to be written to.
+only the region specified is guaranteed to be written to. This is relative to
+the mapped range, not the beginning of the resource.
 
 ``transfer_unmap`` remove the memory mapping for the transfer object.
 Any pointers into the map should be considered invalid and discarded.




More information about the mesa-commit mailing list