fgi_avipal() (Fastgraph/Image)

Win32 DirectX Fastgraph/Light

Prototype

int fgi_avipal (char *filename, void *palette, int handle);

Function fgi_avipal (ByVal filename As String, palette() As Any, handle As Long) As Long

function fgi_avipal (filename : string; var palette; handle : integer) : integer;

Description

The fgi_avipal() function retrieves the palette of an image stored in an AVI file. The palette values are returned as RGB color components, each between 0 and 255.

Parameters

filename is the name of the AVI file. It may only include a file name and extension (such as CLOCK.AVI) and must be terminated by a null character (that is, a zero byte).

palette is the name of the array that will receive the AVI palette values. The palette values are returned as RGB color components, each between 0 and 255. The first three bytes of palette will contain the RGB values for color 0, the next three for color 1, and so forth. The size of the palette array must be at least three times the number of colors in the AVI image. You can also specify NULL for the palette parameter (nil^ for Delphi, ByVal 0 for Visual Basic, or BYVAL %NULL for PowerBASIC). In this case fgi_avipal() will return the AVI color depth but no palette values.

handle is the file handle for the FGI library containing filename.

Return value

>0 = The number of colors in the AVI palette

0 = The AVI file does not have a palette (probably a high color or true color AVI file)

-1 = Error reading the FGI library

-2 = The requested file is not in the FGI library

-3 = The requested file is not an AVI file

Restrictions

none

See also

fgi_avihead(), fg_setdacs(), fgi_showavi()