bpo-34101: Add doc of PyBuffer_GetPointer (GH-14994)
authorHai Shi <shihai1992@gmail.com>
Wed, 31 Jul 2019 14:48:15 +0000 (09:48 -0500)
committerAntoine Pitrou <antoine@python.org>
Wed, 31 Jul 2019 14:48:15 +0000 (16:48 +0200)
Doc/c-api/buffer.rst

index 7553efc2cfbc1e0d19c458acd312eb321f1d9e7b..fdb8bd19d218d22d9e2a1fc5bb6a42ab91a13fa0 100644 (file)
@@ -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*.