Skip to content

Commit 81a3bf5

Browse files
authored
Merge pull request #8504 from radarhere/mpo
Move MPO into "Fully supported formats"
2 parents 35ddbb4 + e1f4b5a commit 81a3bf5

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

docs/handbook/image-file-formats.rst

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -692,6 +692,30 @@ The :py:meth:`~PIL.Image.Image.save` method supports the following options:
692692
you fail to do this, you will get errors about not being able to load the
693693
``_imaging`` DLL).
694694

695+
MPO
696+
^^^
697+
698+
Pillow reads and writes Multi Picture Object (MPO) files. When first opened, it loads
699+
the primary image. The :py:meth:`~PIL.Image.Image.seek` and
700+
:py:meth:`~PIL.Image.Image.tell` methods may be used to read other pictures from the
701+
file. The pictures are zero-indexed and random access is supported.
702+
703+
.. _mpo-saving:
704+
705+
Saving
706+
~~~~~~
707+
708+
When calling :py:meth:`~PIL.Image.Image.save` to write an MPO file, by default
709+
only the first frame of a multiframe image will be saved. If the ``save_all``
710+
argument is present and true, then all frames will be saved, and the following
711+
option will also be available.
712+
713+
**append_images**
714+
A list of images to append as additional pictures. Each of the
715+
images in the list can be single or multiframe images.
716+
717+
.. versionadded:: 9.3.0
718+
695719
MSP
696720
^^^
697721

@@ -1435,30 +1459,6 @@ Note that there may be an embedded gamma of 2.2 in MIC files.
14351459

14361460
To enable MIC support, you must install :pypi:`olefile`.
14371461

1438-
MPO
1439-
^^^
1440-
1441-
Pillow identifies and reads Multi Picture Object (MPO) files, loading the primary
1442-
image when first opened. The :py:meth:`~PIL.Image.Image.seek` and :py:meth:`~PIL.Image.Image.tell`
1443-
methods may be used to read other pictures from the file. The pictures are
1444-
zero-indexed and random access is supported.
1445-
1446-
.. _mpo-saving:
1447-
1448-
Saving
1449-
~~~~~~
1450-
1451-
When calling :py:meth:`~PIL.Image.Image.save` to write an MPO file, by default
1452-
only the first frame of a multiframe image will be saved. If the ``save_all``
1453-
argument is present and true, then all frames will be saved, and the following
1454-
option will also be available.
1455-
1456-
**append_images**
1457-
A list of images to append as additional pictures. Each of the
1458-
images in the list can be single or multiframe images.
1459-
1460-
.. versionadded:: 9.3.0
1461-
14621462
PCD
14631463
^^^
14641464

0 commit comments

Comments
 (0)