summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorHai Shi <shihai1992@gmail.com>2019-07-31 14:48:15 (GMT)
committerAntoine Pitrou <antoine@python.org>2019-07-31 14:48:15 (GMT)
commit1b29af83bc17e773b0c0d117f5fe1018fde46b0d (patch)
tree223cdf5413a705772e0c5a34b94abb6b296bfe19 /Doc
parentc9345e382c630ddcc2b148b30954640e0e435c8a (diff)
downloadcpython-1b29af83bc17e773b0c0d117f5fe1018fde46b0d.zip
cpython-1b29af83bc17e773b0c0d117f5fe1018fde46b0d.tar.gz
cpython-1b29af83bc17e773b0c0d117f5fe1018fde46b0d.tar.bz2
bpo-34101: Add doc of PyBuffer_GetPointer (GH-14994)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/buffer.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index 7553efc..fdb8bd1 100644
--- a/Doc/c-api/buffer.rst
+++ b/Doc/c-api/buffer.rst
@@ -475,6 +475,12 @@ Buffer-related functions
(*order* is ``'A'``). Return ``0`` otherwise. This function always succeeds.
+.. c:function:: void* PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
+
+ Get the memory area pointed to by the *indices* inside the given *view*.
+ *indices* must point to an array of ``view->ndim`` indices.
+
+
.. c:function:: int PyBuffer_ToContiguous(void *buf, Py_buffer *src, Py_ssize_t len, char order)
Copy *len* bytes from *src* to its contiguous representation in *buf*.