ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / Core Component API Reference / Core Component Functions Reference / Display Functions / IG_dspl_orientation_set
In This Topic
    IG_dspl_orientation_set
    In This Topic

    This function sets the new orientation mode.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT  ACCUAPI IG_dspl_orientation_set( 
            [IN] HIGEAR hIGear, 
            [IN] DWORD dwGrpID,
            [IN] AT_MODE nOrientMode
    );
    

    Arguments:

    Name Type Description
    hIGear HIGEAR Image handle where to set orientation mode.
    dwGrpID DWORD Identifier of the group in which to set the orientation.
    nOrientMode AT_MODE

    New OrientMode value to set. Possible values are:

    • IG_DSPL_ORIENT_TOP_LEFT
    • IG_DSPL_ORIENT_LEFT_TOP
    • IG_DSPL_ORIENT_RIGHT_TOP
    • IG_DSPL_ORIENT_TOP_RIGHT
    • IG_DSPL_ORIENT_BOTTOM_RIGHT
    • IG_DSPL_ORIENT_RIGHT_BOTTOM
    • IG_DSPL_ORIENT_LEFT_BOTTOM
    • IG_DSPL_ORIENT_BOTTOM_LEFT

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

    Sample:

    ASCII, Display, MFC, ArtX, Vector

    Example:

     
    Copy Code
    HIGEAR       hIGear;      /* HIGEAR handle of image  */ 
    DWORD        nGrpID;      /* display group identifier  */
     ...
    /* rotate image orientation by 90 degree   */
    IG_dspl_orientation_set( hIGear, nGrpID, IG_DSPL_ORIENT_TOP_RIGHT );
     ...