Commit 1ff3984c authored by Roland Scheidegger's avatar Roland Scheidegger

docs: fix transfer_map description

parent 20bf14be
...@@ -275,12 +275,13 @@ These methods are used to get data to/from a resource. ...@@ -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. data to be written to the resource at this point.
``transfer_map`` creates a memory mapping for the transfer object. ``transfer_map`` creates a memory mapping for the transfer object.
The returned map is always relative to the beginning of the resource, not The returned map points to the start of the mapped range according to
taking the potential box region into account. the box region, not the beginning of the resource.
.. _transfer_flush_region: .. _transfer_flush_region:
``transfer_flush_region`` If a transfer was created with TRANFER_FLUSH_EXPLICIT, ``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. ``transfer_unmap`` remove the memory mapping for the transfer object.
Any pointers into the map should be considered invalid and discarded. Any pointers into the map should be considered invalid and discarded.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment