Skip to content

Add note about blitting and zorder in animations #24137

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

Merged
story645 merged 4 commits into from
Oct 12, 2022
Merged

Add note about blitting and zorder in animations #24137

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
998b647
Add note about blitting and zorder in animations
oscargus Oct 10, 2022
bf0919b
Update doc/api/animation_api.rst
oscargus Oct 11, 2022
e0c3f63
Update doc/api/animation_api.rst
oscargus Oct 12, 2022
0890cd9
Update doc/api/animation_api.rst
oscargus Oct 12, 2022
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
5 changes: 5 additions & 0 deletions doc/api/animation_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,11 @@ this hopefully minimalist example gives a sense of how ``init_func``
and ``func`` are used inside of `FuncAnimation` and the theory of how
'blitting' works.

.. note::

Note that the zorder of artists is not taken into account when 'blitting'
Comment thread
oscargus marked this conversation as resolved.
Outdated
as the artists are always 'blit' on top.
Copy link
Copy Markdown
Member

@story645 story645 Oct 12, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Um I'm not sure what blit on top means with respect to zorder so I'm not sure this clarifies things.

Comment thread
oscargus marked this conversation as resolved.
Outdated

The expected signature on ``func`` and ``init_func`` is very simple to
keep `FuncAnimation` out of your book keeping and plotting logic, but
this means that the callable objects you pass in must know what
Expand Down