Skip to content

Minor documentation update regarding images #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Lucas-C wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Minor documentation update regarding images #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,14 @@ To render a :class:`.Page`, you first need to create a :class:`.PageRenderer` ob
Then you give the :class:`.Page` to the :meth:`.PageRenderer.render_page`
method to obtain an :class:`.Image` object.

You can control the resulting resolution of the image,
by specifying the ``xres`` and ``yres`` parameters:

.. code-block:: python

if not PageRenderer().render_page(page, xres=dpi, yres=dpi).save(img_filepath, "JPEG"):
raise RuntimeError(f"Failed to save page as image: {img_filepath}")


Working with images
-------------------
Expand Down Expand Up @@ -189,7 +197,7 @@ compatible with the PIL raw importer:
tk_image = ImageTk.PhotoImage(pil_image)

Unfortunately, it is not possible to build a PIL image using the
buffer interface. A copy of the image data in unavoidable.
buffer interface. A copy of the image data is unavoidable.

If you need to use the image with Tk, you create if from a PIL image.

Expand Down