summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorRoland Scheidegger <sroland@vmware.com>2010-04-08 17:44:54 +0200
committerRoland Scheidegger <sroland@vmware.com>2010-04-08 17:44:54 +0200
commit1ff3984c2edce9927744f3cce3e7b07778990170 (patch)
treeefd57dc0d2b82d3a40932bc6f69d9e036f3b7400 /src
parent20bf14be8ac6438cb1afa38212e306fc06a5ed40 (diff)
docs: fix transfer_map description
Diffstat (limited to 'src')
-rw-r--r--src/gallium/docs/source/context.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/gallium/docs/source/context.rst b/src/gallium/docs/source/context.rst
index 26b003a7b7..7439d10097 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.