Method: Magick::Image#vignette

Defined in:

ext/RMagick/rmimage.cpp

#vignette(horz_radius = self.columns*0.1+0.5, vert_radius = self.rows*0.1+0.5, radius = 0.0, sigma = 1.0) ⇒ Magick::Image

Soften the edges of an image.

Returns a new image.

Parameters:

• horz_radius (Numeric) (defaults to: self.columns*0.1+0.5) —

  Influences the amount of background color in the horizontal dimension.

• vert_radius (Numeric) (defaults to: self.rows*0.1+0.5) —

  Influences the amount of background color in the vertical dimension.

• radius (Numeric) (defaults to: 0.0) —

  Controls the amount of blurring.

• sigma (Numeric) (defaults to: 1.0) —

  Controls the amount of blurring.

Returns:

• (Magick::Image) —

  a new image

# File 'ext/RMagick/rmimage.cpp', line 15378

VALUE
Image_vignette(int argc, VALUE *argv, VALUE self)
{
    Image *image, *new_image;
    long horz_radius, vert_radius;
    double radius = 0.0, sigma = 10.0;
    ExceptionInfo *exception;

    image = rm_check_destroyed(self);

    horz_radius = (long)(image->columns * 0.10 + 0.5);
    vert_radius = (long)(image->rows * 0.10 + 0.5);

    switch (argc)
    {
        case 4:
            sigma = NUM2DBL(argv[3]);
        case 3:
            radius = NUM2DBL(argv[2]);
        case 2:
            vert_radius = NUM2INT(argv[1]);
        case 1:
            horz_radius = NUM2INT(argv[0]);
        case 0:
            break;
        default:
            rb_raise(rb_eArgError, "wrong number of arguments (%d for 0 to 4)", argc);
            break;
    }

    exception = AcquireExceptionInfo();

    GVL_STRUCT_TYPE(VignetteImage) args = { image, radius, sigma, horz_radius, vert_radius, exception };
    new_image = (Image *)CALL_FUNC_WITHOUT_GVL(GVL_FUNC(VignetteImage), &args);
    rm_check_exception(exception, new_image, DestroyOnError);
    DestroyExceptionInfo(exception);

    return rm_image_new(new_image);
}