From: Corbin Simpson <MostAwesomeDude@gmail.com>
Date: Thu, 28 Jan 2010 10:58:28 +0000 (-0800)
Subject: gallium-docs: Moar buffer info.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=f0a3f824acdce98b5ca1543ecb3d7a316cfdd108;p=mesa.git

gallium-docs: Moar buffer info.

Oh look, that one question about map_buffer_range is answered.
---

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.