diff options
| author | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
| commit | 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch) | |
| tree | f1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/elisp/multi_002dframe-images.html | |
new repository
Diffstat (limited to 'devdocs/elisp/multi_002dframe-images.html')
| -rw-r--r-- | devdocs/elisp/multi_002dframe-images.html | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/devdocs/elisp/multi_002dframe-images.html b/devdocs/elisp/multi_002dframe-images.html new file mode 100644 index 00000000..44962306 --- /dev/null +++ b/devdocs/elisp/multi_002dframe-images.html @@ -0,0 +1,17 @@ + <h4 class="subsection">Multi-Frame Images</h4> <p>Some image files can contain more than one image. We say that there are multiple “frames” in the image. At present, Emacs supports multiple frames for GIF, TIFF, and certain ImageMagick formats such as DJVM. </p> <p>The frames can be used either to represent multiple pages (this is usually the case with multi-frame TIFF files, for example), or to create animation (usually the case with multi-frame GIF files). </p> <p>A multi-frame image has a property <code>:index</code>, whose value is an integer (counting from 0) that specifies which frame is being displayed. </p> <dl> <dt id="image-multi-frame-p">Function: <strong>image-multi-frame-p</strong> <em>image</em> +</dt> <dd><p>This function returns non-<code>nil</code> if <var>image</var> contains more than one frame. The actual return value is a cons <code>(<var>nimages</var> +. <var>delay</var>)</code>, where <var>nimages</var> is the number of frames and <var>delay</var> is the delay in seconds between them, or <code>nil</code> if the image does not specify a delay. Images that are intended to be animated usually specify a frame delay, whereas ones that are intended to be treated as multiple pages do not. </p></dd> +</dl> <dl> <dt id="image-current-frame">Function: <strong>image-current-frame</strong> <em>image</em> +</dt> <dd><p>This function returns the index of the current frame number for <var>image</var>, counting from 0. </p></dd> +</dl> <dl> <dt id="image-show-frame">Function: <strong>image-show-frame</strong> <em>image n &optional nocheck</em> +</dt> <dd><p>This function switches <var>image</var> to frame number <var>n</var>. It replaces a frame number outside the valid range with that of the end of the range, unless <var>nocheck</var> is non-<code>nil</code>. If <var>image</var> does not contain a frame with the specified number, the image displays as a hollow box. </p></dd> +</dl> <dl> <dt id="image-animate">Function: <strong>image-animate</strong> <em>image &optional index limit</em> +</dt> <dd><p>This function animates <var>image</var>. The optional integer <var>index</var> specifies the frame from which to start (default 0). The optional argument <var>limit</var> controls the length of the animation. If omitted or <code>nil</code>, the image animates once only; if <code>t</code> it loops forever; if a number animation stops after that many seconds. </p></dd> +</dl> <p>Animation operates by means of a timer. Note that Emacs imposes a minimum frame delay of 0.01 (<code>image-minimum-frame-delay</code>) seconds. If the image itself does not specify a delay, Emacs uses <code>image-default-frame-delay</code>. </p> <dl> <dt id="image-animate-timer">Function: <strong>image-animate-timer</strong> <em>image</em> +</dt> <dd><p>This function returns the timer responsible for animating <var>image</var>, if there is one. </p></dd> +</dl><div class="_attribution"> + <p class="_attribution-p"> + Copyright © 1990-1996, 1998-2022 Free Software Foundation, Inc. <br>Licensed under the GNU GPL license.<br> + <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Multi_002dFrame-Images.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Multi_002dFrame-Images.html</a> + </p> +</div> |