fg_showbmp()

Win32 DirectX Fastgraph/Light

Prototype

int fg_showbmp (char *filename, int flags);

Function fg_showbmp (ByVal filename As String, ByVal flags As Long) As Long

function fg_showbmp (filename : string; flags : integer) : integer;

Description

The fg_showbmp() function displays a BMP file.

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. A device and path name may be included as part of the file name. The file name 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:

Flag	Meaning
FG_AT_XY	If specified, display the image relative to the current graphics position. If not, display the image relative to (0,0).
FG_IGNOREPALETTE	If specified, display the image using the current palette. If not, use the palette values stored in the BMP file. Not meaningful for 24-bit BMP files.
FG_FROMBUFFER	If specified, get the image data from the fg_imagebuf() buffer. If not, get the image data from the BMP file.
FG_KEEPCOLORS	If specified, disable color reduction and remapping. If not, enable color reduction and remapping to avoid using the Windows system colors. Not meaningful for 24-bit BMP files.

Return value

0 = Success

1 = The specified file does not exist

2 = The specified file is not a BMP file

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

4 = The BMP file is an unsupported RLE BMP file

5 = 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.

Examples

Blend, Image, ImgProc, KBdemo, Panner, Prdemo

Contents
Fastgraph Home Page