fgi_showbmp() (Fastgraph/Image)

Win32 DirectX Fastgraph/Light

Prototype

int fgi_showbmp (char *filename, int flags, int handle);

Function fgi_showbmp (ByVal filename As String, ByVal flags As Long, ByVal handle As Long) As Long

function fgi_showbmp (filename : string; flags, handle : integer) : integer;

Description

The fgi_showbmp() function displays a BMP file stored in an FGI library.

For 256-color virtual buffers, 256-color BMP files are reduced to the 236 non-system colors if color reduction is enabled. 16-color and monochrome BMP files are always remapped to colors 10 to 25 to avoid conflicts with the system colors.

Parameters

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

flags is a series of flags that controls how the image is displayed:

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

Return value

0 = Success

-1 = Error reading the FGI library

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

-3 = The requested file is not a BMP file

-4 = The BMP file cannot be loaded into the active virtual buffer

-5 = The BMP file is an unsupported RLE BMP file

-6 = Error allocating memory

Restrictions

A logical palette must be defined and realized in order to use the palette values stored in the BMP file.

24-bit BMP files can only be loaded into direct color virtual buffers.

See also

fgi_bmphead(), fgi_bmppal(), fg_bmpsize(), fgi_display(), fg_makebmp(), fg_realize()

Examples

FGIW5