diff scripts/image/imwrite.m @ 17854:adb0ba0d0c13

imwrite: implement DelayTime option. * __magick_read__.cc (F__magick_write__): set animationDelay() when writing an image to implement the DelayTime option. * private/__imwrite__.m: input check for the new option DelayTime and set its default. Organize options in alphabetic order. * imwrite.m: document new option.
author Carnë Draug <carandraug@octave.org>
date Tue, 05 Nov 2013 05:48:56 +0000
parents aacb9da13df6
children bfbe5dcc9943
line wrap: on
line diff
--- a/scripts/image/imwrite.m	Tue Nov 05 05:05:11 2013 +0000
+++ b/scripts/image/imwrite.m	Tue Nov 05 05:48:56 2013 +0000
@@ -47,6 +47,13 @@
 ## dimension must be a singleton.  By default, image will be completely
 ## opaque.
 ##
+## @item DelayTime
+## For formats that accept animations (such as GIF), controls for how long a
+## frame is displayed until it moves to the next one. The value must be scalar
+## (which will applied to all frames in @var{img}), or a vector of length
+## equal to the number of frames in @var{im}.  The value is in seconds, must
+## be between 0 and 655.35, and defaults to 0.5.
+##
 ## @item LoopCount
 ## For formats that accept animations (such as GIF), controls how many times
 ## the sequence is repeated.  A value of Inf means an infinite loop (default),