Skip to content
Snippets Groups Projects
Commit ba40af36 authored by Andreas Klöckner's avatar Andreas Klöckner
Browse files

Improve docs of image constructor.

parent 72fd36d4
No related branches found
No related tags found
No related merge requests found
...@@ -394,7 +394,11 @@ Images ...@@ -394,7 +394,11 @@ Images
^^^^^^ ^^^^^^
.. class:: Image(context, flags, format, shape=None, pitches=None, hostbuf=None) .. class:: Image(context, flags, format, shape=None, pitches=None, hostbuf=None)
*shape* is a 2- or 3-tuple. See :class:`mem_flags` for values of *flags*.
*shape* is a 2- or 3-tuple. *format* is an instance of :class:`ImageFormat`.
*pitches* is a 1-tuple for 2D images and a 2-tuple for 3D images, indicating
the distance in bytes from one scan line to the next, and from one 2D image
slice to the next.
If *hostbuf* is given and *shape* is `None`, then *hostbuf.shape* is If *hostbuf* is given and *shape* is `None`, then *hostbuf.shape* is
used as the *shape* parameter. used as the *shape* parameter.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment