ImageGear for C and C++ on Linux v20.0 - Updated
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Display Functions > IG_dspl_background_set

This function sets the background settings.


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


Name Type Description
hIGear HIGEAR ImageGear handle of image.
dwGrpID DWORD Identifier of the group in which to set options.

IG_DSPL_BACKGROUND_NONE or a combination of the following flags:

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++.


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 );
Is this page helpful?
Yes No
Thanks for your feedback.