ImageGear for C and C++ on Windows v19.1 - Updated
IG_vect_geom_get_colors
API Reference Guide > Vector Component API Reference > Vector Component Functions Reference > Geometry Functions > IG_vect_geom_get_colors

This function returns the geometry colors in the range of nStart.. nEnd.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_vect_geom_get_colors(
        HIG_VECT_ENTITY hEntity, 
        unsigned char* lpColors,
        long nStart,
        long nEnd
);

Arguments:

Name Type Description
hEntity HIG_VECT_ENTITY Geometry entity handle.
lpColors unsigned char* Buffer for the local colors of the geometry.
nStart long Index of the start color.
nEnd long Index of the end color.

Return Value:

Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

This function does not process image pixels.

Sample:

None

Remarks:

Using this function makes sense only if the argument bUseColors of IG_vect_geom_init() is set to VECT_TRUE.

The number of the color components is defined by nColorAlign argument of IG_vect_geom_init(). The color buffer must be long enough to receive (nEnd - nStart + 1) * nColorAlign bytes.