From 4cc1aaa2f5d8bbd790639d5324c7b95d6eb1e731 Mon Sep 17 00:00:00 2001 From: Oscar Gustafsson Date: Wed, 12 Oct 2022 18:33:20 +0200 Subject: [PATCH] Backport PR #24137: Add note about blitting and zorder in animations --- doc/api/animation_api.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst index 5a3d53442fde..132590456763 100644 --- a/doc/api/animation_api.rst +++ b/doc/api/animation_api.rst @@ -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:: + + The zorder of artists is not taken into account when 'blitting' + because the 'blitted' artists are always drawn on top. + 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