fg_pcxpal()

Win32 DirectX Fastgraph/Light

Prototype

int fg_pcxpal (char *filename, void *palette);

Function fg_pcxpal (ByVal filename As String, palette() As Any) As Long

function fg_pcxpal (filename : string; var palette) : integer;

Description

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

If the PCX file includes an extended (256-color) palette, fg_pcxpal() will return the values in the extended palette. Otherwise, fg_pcxpal() will return the values from the 16-color palette in the PCX header.

Parameters

filename is name of the PCX file. The file name must be terminated by a zero byte.

palette is the name of the array that will receive the PCX 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 PCX palette. 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 fg_pcxpal() will return the image's color depth but no palette values.

Return value

>0 = The number of colors in the PCX palette (16 or 256)

0 = The PCX file does not have a palette (24-bit PCX file)

-1 = The specified file does not exist

-2 = The specified file is not a PCX file

Restrictions

none

See also

fg_pcxhead(), fg_setdacs(), fg_showpcx()

Examples

Image, ImgProc