Pic.FileNewFramesPart of Pic module

Syntax   Pic.FileNewFrames (pathName : string, var picIDs : array 1 .. * of int, var delayTime : int)

Description   Pic.FileNewFrames loads multiple pictures stored in a single multiframe GIF image file into an array of integers.
Details   GIF files can contain multiple frames (pictures). Animated GIFs function by displaying each frame in the GIF one after another with a delay between them. This delay can also be specified in the GIF file.

Pic.FileNewFrames reads the series of frames from the multiframe GIF file, and turns each frame into a picture. The picture is then assigned to an element in the picIDs array. If the array is not large enough, then an error occurs and no pictures are loaded.

Pic.FileNewFrames also reads the delay specified in the GIF file and sets delayTime to the delay in milliseconds. Note that many multiple frame GIF files do not specify a delay, in which case delayTime will be set to 0.

In order to determine the number of frames in multiple frame GIF file, you must use the Pic.Frames function. This returns a number that can be used to declare the array that will be passed to Pic.FileNewFrames.

var numFrames = Pic.Frames ("mypic.gif")
var pics : array 1 .. numFrames of int
var delayTime : int
Pic.FileNewFrames ("mypic.gif", pics, delayTime)

The frames can be sequentially displayed using either Pic.DrawFrames or Pic.DrawFramesBack which display the images one at a time. (Pic.DrawFrames returns once all the images have been displayed, Pic.DrawFramesBack returns immediately allowing the program to continue execution while the frames are being displayed.

Details   GIF files can have a transparent color. This color will be added to the color palette, if not already present. Thus you may notice that maxcolor changes after calling Pic.FileNew or Pic.FileNewFrames. The GIF image will be be displayed without the transparent color if mode parameter in any of the Pic.Draw... procedures is set to picMerge.

Details   Each picture is in the array has been allocated by the system and should be freed separately once the program is finished with the pictures. Failing to do so can use up the system's memory.

Example   The program loads a multiple frame GIF called "globe.gif" and displays it. 
        % Determine the number of frames in "globe.gif"
        % Create the original picture
        var numFrames := Pic.Frames ("globe.gif")
        % Load the picture
        var delayTime : int
        var pics : array 1 .. numFrames of int

	Pic.FileNewFrames ("globe.gif", pics, delayTime)
	Pic.DrawFrames (pics, 10, 10, picCopy, numFrames, 50, false)

Execute  

Status   Exported qualified.

This means that you can only call the function by calling Pic.FileNewFrames, not by calling FileNewFrames.

See also   Pic.Frames for information on how to determine the number of frames in a GIF image.

Pic.DrawFrames for information on how to sequentially display the images stored in array of pictures.

Pic.DrawFramesBack for information on how to sequentially display the images stored in array of pictures while continuing to execute the program.