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

    Provides the effect of warping around a cylinder on the hIGear image.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_FX_cylinder(
            HIGEAR hIGear, 
            AT_INT nDistance,
            AT_INT nRadius, 
            AT_INT nHeight, 
            AT_BOOL bHorizontal, 
            AT_BOOL bInterpolate, 
            HIGPIXEL hbkColor, 
            LPAT_RECT lpRect 
    );
    

    Arguments:

    Name Type Description
    hIGear HIGEAR Image to which to apply the effect.
    nDistance AT_INT Distance to the cylinder axes, in pixels.
    nRadius AT_INT Cylinder radius, in pixels.
    nHeight AT_INT Height of the cylinder segment, in pixels. Height can be changed from (-radius) to (radius).
    bHorizontal AT_BOOL If TRUE, cylinder is horizontal.
    bInterpolate AT_BOOL If TRUE, interpolation is used during processing.
    hbkColor HIGPIXEL Background color. It should have the same color space and channel depths as the image to which the effect is applied.
    lpRect LPAT_RECT Rectangle area to which to apply the effect, or NULL for whole image.

    Return Value:

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

    Supported Raster Image Formats:

    When bInterpolate is FALSE, all pixel formats supported by ImageGear for C and C++, except:

    When bInterpolate is TRUE, all pixel formats supported by ImageGear for C and C++, except: