Mention that tobytes() with the raw encoder uses Pack.c

This commit is contained in:
Andrew Murray 2025-04-10 20:45:53 +10:00
parent c8d98d56a0
commit af52060e97

View File

@ -767,18 +767,20 @@ class Image:
.. warning::
This method returns the raw image data from the internal
storage. For compressed image data (e.g. PNG, JPEG) use
:meth:`~.save`, with a BytesIO parameter for in-memory
data.
This method returns raw image data derived from Pillow's internal
storage. For compressed image data (e.g. PNG, JPEG) use
:meth:`~.save`, with a BytesIO parameter for in-memory data.
:param encoder_name: What encoder to use. The default is to
use the standard "raw" encoder.
:param encoder_name: What encoder to use.
A list of C encoders can be seen under
codecs section of the function array in
:file:`_imaging.c`. Python encoders are
registered within the relevant plugins.
The default is to use the standard "raw" encoder.
To see how this packs pixel data into the returned
bytes, see :file:`libImaging/Pack.c`.
A list of C encoders can be seen under codecs
section of the function array in
:file:`_imaging.c`. Python encoders are registered
within the relevant plugins.
:param args: Extra arguments to the encoder.
:returns: A :py:class:`bytes` object.
"""