ImageGear Professional DLL v17.2 for Windows
IG_dspl_background_get
Send Feedback
ImageGear Professional DLL v17.2 for Windows > API Reference Guide > Core Component API Reference > Core Component Functions Reference > Display Functions > IG_dspl_background_get

Glossary Item Box

This function returns the background settings' current values.

Declaration:

  Copy Code
AT_ERRCOUNT  ACCUAPI  IG_dspl_background_get(
        [IN] HIGEAR hIGear,
        [IN] DWORD dwGrpID,
        [OUT] LPAT_MODE lpnBkMode,
        [OUT] LPAT_RGB lpBkColor,
        [OUT] HBITMAP FAR* lphBrush
);

Arguments:

Name Type Description
hIGear HIGEAR ImageGear handle of image.
dwGrpID DWORD Identifier of the group to use.
lpnBkMode LPAT_MODE Pointer to where BkMode options are returned. If NULL, then this parameter is ignored.
lpBkColor LPAT_RGB Pointer to where BkColor option is returned. If NULL, then this parameter is ignored.
lphBrush HBITMAP FAR Pointer to where BkBrush option is returned. If NULL, then this parameter is ignored.

Return Value:

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

Supported Raster Image Formats:

All pixel formats supported by ImageGear Professional.

Sample:

Display

Example:

  Copy Code
HIGEAR           hIGear;      /* HIGEAR handle of image  */
DWORD           nGrpID;      /* display group identifier */
AT_MODE nBkMode;    /* backgound mode  */
AT_RGB BkColor;    /* background color  */
HBITMAP hBrush;     /* background mask  */
 ...
IG_dspl_background_get( hIGear, nGrpID, &nBkMode, &BkColor, &hBrush );
 ...

Remarks:

Possible values are listed in the description of function IG_dspl_background_set().

©2012. Accusoft Corporation. All Rights Reserved.