ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / Vector Component API Reference / Vector Component Functions Reference / Entity Functions / IG_vect_ent_set_cliprgn
In This Topic
    IG_vect_ent_set_cliprgn
    In This Topic

    This function creates clipping region for the entity and copies specified region data there.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_vect_ent_set_cliprgn(
       HIG_VECT_ENTITY hEntity,
       IGVectPoint3D* lpRgnData,
       long nPointCount
    );
    

    Arguments:

    Name Type Description
    hEntity HIG_VECT_ENTITY Handle of the entity to set the clipping region.
    lpRgnData IGVectPoint3D* Array of IGVectPoint3D structures containing the new clipping region data.
    nPointCount long Count of points in IGVectPoint3D array.

    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:

    If clipping region already exists, it will be replaced with the new one.