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

This function allows you to set the current display option settings for either a specific HIGEAR image or to set the settings that will be inherited by each new HIGEAR image.


Copy Code
AT_ERRCOUNT ACCUAPI IG_display_option_set (
        HIGEAR  hIGear, 
        AT_MODE nOption, 
        const LPVOID lpOption, 
        LPVOID lpReserved


Name Type Description
hIGear HIGEAR HIGEAR handle of image or NULL.
nOption AT_MODE A integer of type AT_MODE that tells ImageGear which display option to set. The options are defined in accucnst.h and their names begin with IG_DISPLAY_OPTION_.
lpOption const LPVOID A long pointer to VOID display option data. See details below.
lpReserved LPVOID This argument is reserved for future use. Please set to NULL for now.

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.


Copy Code
HIGEAR            hIGear;                        /* HIGEAR handle of image */
IG_display_option_set( hIGear, IG_DISPLAY_OPTION_DOWNSHIFT, (LPVOID)0, NULL);


You may set these options for a specific HIGEAR or for all newly created HIGEAR images. To set the options for a particular HIGEAR image, set hIGear to the appropriate handle. To set the options for all newly created HIGEAR images, set hIGear to NULL.

nOption must be set to one of the IG_DISPLAY_OPTION_ constants defined in accucnst.h. lpOption should be set to the value of the option. This will vary depending on what option you are setting. See the list below.

Currently, this function is useful for 16-bit grayscale images only. However, constants will be added to support all bit depths. See accucnst.h for new constants beginning with IG_DISPLAY_OPTION_.

Currently available options include:

Additional options include:

Is this page helpful?
Yes No
Thanks for your feedback.