[Bf-docboard-svn] bf-manual: [8016] trunk/blender_docs/manual: Document animation player "Frame Cache" behavior

[Campbell Barton]

Revision: 8016
          https://developer.blender.org/rBM8016
Author:   campbellbarton
Date:     2021-05-10 05:47:34 +0200 (Mon, 10 May 2021)
Log Message:
-----------
Document animation player "Frame Cache" behavior

Modified Paths:
--------------
    trunk/blender_docs/manual/editors/preferences/system.rst
    trunk/blender_docs/manual/render/output/animation_player.rst

Modified: trunk/blender_docs/manual/editors/preferences/system.rst
===================================================================
--- trunk/blender_docs/manual/editors/preferences/system.rst	2021-05-10 03:43:25 UTC (rev 8015)
+++ trunk/blender_docs/manual/editors/preferences/system.rst	2021-05-10 03:47:34 UTC (rev 8016)
@@ -91,6 +91,8 @@
 Video Sequencer
 ===============
 
+.. _prefs-system-memory-cache-limit:
+
 Memory Cache Limit
    Upper limit of the Video Sequencer and Movie Clip Editor memory cache (in megabytes).
    For an optimal Clip editor and Sequencer performance, high values are recommended.

Modified: trunk/blender_docs/manual/render/output/animation_player.rst
===================================================================
--- trunk/blender_docs/manual/render/output/animation_player.rst	2021-05-10 03:43:25 UTC (rev 8015)
+++ trunk/blender_docs/manual/render/output/animation_player.rst	2021-05-10 03:47:34 UTC (rev 8016)
@@ -7,9 +7,24 @@
 Animation Player
 ****************
 
-The :menuselection:`Topbar --> Render --> View Animation`
-menu will play back the rendered animation in a new window.
+The animation player is a utility typically used for previewing rendered animations,
+supporting all image and video formats supported by Blender.
 
+This is a convenient way to play back image sequences at the correct frame-rate.
+
+
+Usage
+=====
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Menu:    :menuselection:`Topbar --> Render --> View Animation`
+   :Shortcut:  :kbd:`Ctrl-F11`
+
+Launching the animation player opens a new window,
+playing back images or video located at the render output of the current scene.
+
 You can also drop images or movie files in a running animation player.
 It will then restart the player with the new data.
 
@@ -20,7 +35,7 @@
 
 
 Shortcuts
-=========
+---------
 
 The following table shows the available hotkeys for the animation player.
 
@@ -118,3 +133,19 @@
 - 10 fps :kbd:`Numpad8`
 - |numsp|\ 6 fps :kbd:`Numpad9`
 - |numsp|\ 5 fps :kbd:`NumpadSlash`
+
+
+Frame Cache
+-----------
+
+Image files are cached during playback for faster access.
+
+While loading images isn't always a bottleneck,
+there are situations where high resolution images may slow down playback causing frame skipping.
+
+.. seealso::
+
+   :ref:`Memory Cache Limit <prefs-system-memory-cache-limit>` preference to control this limit,
+   which may be increased to cache more images during playback.
+
+   :ref:`command-line-args-animation-playback-options` to specify this value when launching from the command line.