edit_gradient_fill


Description:

[ Version ( since = "2.10" ) ]
public bool edit_gradient_fill (GradientType gradient_type, double offset, bool supersample, int supersample_max_depth, double supersample_threshold, bool dither, double x1, double y1, double x2, double y2)

Draw a gradient between the starting and ending coordinates with the specified gradient type.

This tool requires information on the gradient type. It creates the specified variety of gradient using the starting and ending coordinates as defined for each gradient type. For shapeburst gradient types, the context's distance metric is also relevant and can be updated with context_set_distance_metric.

This procedure is affected by the following context setters: context_set_opacity , context_set_paint_mode, context_set_foreground, context_set_background, context_set_gradient and all gradient property settings, context_set_distance_metric.

Parameters:

this

The affected drawable.

gradient_type

The type of gradient.

offset

Offset relates to the starting and ending coordinates specified for the blend. This parameter is mode dependent.

supersample

Do adaptive supersampling.

supersample_max_depth

Maximum recursion levels for supersampling.

supersample_threshold

Supersampling threshold.

dither

Use dithering to reduce banding.

x1

The x coordinate of this gradient's starting point.

y1

The y coordinate of this gradient's starting point.

x2

The x coordinate of this gradient's ending point.

y2

The y coordinate of this gradient's ending point.

Returns:

TRUE on success.