summaryrefslogtreecommitdiffstats
path: root/src/gallium/docs/source/screen.rst
diff options
context:
space:
mode:
authorCorbin Simpson <[email protected]>2010-01-28 02:58:28 -0800
committerCorbin Simpson <[email protected]>2010-01-28 03:05:46 -0800
commitf0a3f824acdce98b5ca1543ecb3d7a316cfdd108 (patch)
tree3487e7e46f0a7fd897a1ea3800cc3391001cda15 /src/gallium/docs/source/screen.rst
parent2102ee204c4dc39f11f07c4c32080c8d69c0e7e7 (diff)
gallium-docs: Moar buffer info.
Oh look, that one question about map_buffer_range is answered.
Diffstat (limited to 'src/gallium/docs/source/screen.rst')
-rw-r--r--src/gallium/docs/source/screen.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/src/gallium/docs/source/screen.rst b/src/gallium/docs/source/screen.rst
index 7830a9ee078..1fff20f5398 100644
--- a/src/gallium/docs/source/screen.rst
+++ b/src/gallium/docs/source/screen.rst
@@ -116,3 +116,38 @@ texture_destroy
Destroy a texture. The buffer backing the texture is destroyed if it has no
more references.
+
+buffer_map
+^^^^^^^^^^
+
+Map a buffer into memory.
+
+**usage** is a bitmask of :ref:`PIPE_TEXTURE_USAGE` flags.
+
+Returns a pointer to the map, or NULL if the mapping failed.
+
+buffer_map_range
+^^^^^^^^^^^^^^^^
+
+Map a range of a buffer into memory.
+
+The returned map is always relative to the beginning of the buffer, not the
+beginning of the mapped range.
+
+.. _buffer_flush_mapped_range:
+
+buffer_flush_mapped_range
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Flush a range of mapped memory into a buffer.
+
+The buffer must have been mapped with ``PIPE_BUFFER_USAGE_FLUSH_EXPLICIT``.
+
+**usage** is a bitmask of :ref:`PIPE_TEXTURE_USAGE` flags.
+
+buffer_unmap
+^^^^^^^^^^^^
+
+Unmap a buffer from memory.
+
+Any pointers into the map should be considered invalid and discarded.