From 998b647a71e0609ea783d373bfa05d7232bd1f9d Mon Sep 17 00:00:00 2001 From: Oscar Gustafsson Date: Mon, 10 Oct 2022 23:49:25 +0200 Subject: [PATCH 1/4] 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..26bb6ffa4d68 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:: + + Note that the zorder of artists is not taken into account when 'blitting' + as the artists are always 'blit' 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 From bf0919b4a94cacdecd36b8e2a681ecb14a02844d Mon Sep 17 00:00:00 2001 From: Oscar Gustafsson Date: Tue, 11 Oct 2022 08:25:27 +0200 Subject: [PATCH 2/4] Update doc/api/animation_api.rst Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> --- doc/api/animation_api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst index 26bb6ffa4d68..040b54dacc39 100644 --- a/doc/api/animation_api.rst +++ b/doc/api/animation_api.rst @@ -99,7 +99,7 @@ and ``func`` are used inside of `FuncAnimation` and the theory of how .. note:: - Note that the zorder of artists is not taken into account when 'blitting' + The zorder of artists is not taken into account when 'blitting' as the artists are always 'blit' on top. The expected signature on ``func`` and ``init_func`` is very simple to From e0c3f63d983af9eac79fd50bd8e95cdfed840864 Mon Sep 17 00:00:00 2001 From: Oscar Gustafsson Date: Wed, 12 Oct 2022 16:06:04 +0200 Subject: [PATCH 3/4] Update doc/api/animation_api.rst Co-authored-by: Elliott Sales de Andrade --- doc/api/animation_api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst index 040b54dacc39..5fe9275877b0 100644 --- a/doc/api/animation_api.rst +++ b/doc/api/animation_api.rst @@ -100,7 +100,7 @@ and ``func`` are used inside of `FuncAnimation` and the theory of how .. note:: The zorder of artists is not taken into account when 'blitting' - as the artists are always 'blit' on top. + as 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 From 0890cd98a2ff7a52a40b18d9dee211f6823ee90c Mon Sep 17 00:00:00 2001 From: Oscar Gustafsson Date: Wed, 12 Oct 2022 16:12:53 +0200 Subject: [PATCH 4/4] Update doc/api/animation_api.rst Co-authored-by: hannah --- doc/api/animation_api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst index 5fe9275877b0..132590456763 100644 --- a/doc/api/animation_api.rst +++ b/doc/api/animation_api.rst @@ -100,7 +100,7 @@ and ``func`` are used inside of `FuncAnimation` and the theory of how .. note:: The zorder of artists is not taken into account when 'blitting' - as the blitted artists are always drawn on top. + 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