IG_dspl_background

IG_dspl_background_set

In This Topic

This function sets the background settings.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_dspl_background_set( [IN] HIGEAR hIGear, [IN] DWORD dwGrpID, [IN] AT_MODE nBkMode, [IN] const LPAT_RGB lpBkColor, [IN] HBITMAP hBrush );

Arguments:

Name	Type	Description
hIGear	HIGEAR	ImageGear handle of image.
dwGrpID	DWORD	Identifier of the group in which to set options.
nBkMode	AT_MODE	IG_DSPL_BACKGROUND_NONE or a combination of the following flags: IG_DSPL_BACKGROUND_UNDER_IMAGE IG_DSPL_BACKGROUND_BEYOND_IMAGE
lpBkColor	const LPAT_RGB	New value of BkColor to set. If NULL, then this parameter is ignored.
hBrush	HBITMAP	New value of BkBrush option to set. Please note that the old bitmap is not deleted, and the application code is responsible for removing the old value of this option.

Return Value:

Returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++.

Sample:

None

Example:

	Copy Code
HIGEAR hIGear; /* HIGEAR handle of image / DWORD nGrpID; / display group identifier / ... / disable background under image and beyond image */ IG_dspl_background_set( hIGear, nGrpID, IG_DSPL_BACKGROUND_NONE, NULL, NULL ); ...

Copy Code

HIGEAR           hIGear;    /* HIGEAR handle of image  */ 
DWORD           nGrpID;  /* display group identifier  */
 ...
/* disable background under image and beyond image  */
IG_dspl_background_set( hIGear, nGrpID, IG_DSPL_BACKGROUND_NONE, NULL, NULL );
 ...

Get Product Support