From 19f6e5b734a7932ae36b6fcc8cbf4a0156535fde Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Tue, 22 Dec 2015 18:51:29 +0100
Subject: [PATCH] Document rectangular buffer <-> buffer transfers (Fix #104)
---
pyopencl/__init__.py | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/pyopencl/__init__.py b/pyopencl/__init__.py
index 1dca2f29..e23a365d 100644
--- a/pyopencl/__init__.py
+++ b/pyopencl/__init__.py
@@ -1445,6 +1445,22 @@ def enqueue_copy(queue, dest, src, **kwargs):
:arg host_pitches: :class:`tuple` of :class:`int` of length
two or shorter. (optional, "tightly-packed" if unspecified)
+ .. ------------------------------------------------------------------------
+ .. rubric :: Rectangular :class:`Buffer` ↔ :class:`Buffer`
+ transfers (CL 1.1 and newer)
+ .. ------------------------------------------------------------------------
+
+ :arg src_origin: :class:`tuple` of :class:`int` of length
+ three or shorter. (mandatory)
+ :arg dst_origin: :class:`tuple` of :class:`int` of length
+ three or shorter. (mandatory)
+ :arg region: :class:`tuple` of :class:`int` of length
+ three or shorter. (mandatory)
+ :arg src_pitches: :class:`tuple` of :class:`int` of length
+ two or shorter. (optional, "tightly-packed" if unspecified)
+ :arg dst_pitches: :class:`tuple` of :class:`int` of length
+ two or shorter. (optional, "tightly-packed" if unspecified)
+
.. ------------------------------------------------------------------------
.. rubric :: Transfer :class:`Image` ↔ host
.. ------------------------------------------------------------------------
--
GitLab