patternCreateLinear

fncairo.pattern.Pattern patternCreateLinear(double x0, double y0, double x1, double y1)

Create a new linear gradient #cairo_pattern_t along the line defined by (x0, y0) and (x1, y1). Before using the gradient pattern, a number of color stops should be defined using [cairo.pattern.Pattern.addColorStopRgb] or [cairo.pattern.Pattern.addColorStopRgba].

Note

The coordinates here are in pattern space. For a new pattern,

pattern space is identical to user space, but the relationship between the spaces can be changed with [cairo.pattern.Pattern.setMatrix].

Parameters

x0x coordinate of the start point
y0y coordinate of the start point
x1x coordinate of the end point
y1y coordinate of the end point

Returns

the newly created #cairo_pattern_t if successful, or

an error pattern in case of no memory. The caller owns the returned object and should call [cairo.pattern.Pattern.destroy] when finished with it.

This function will always return a valid pointer, but if an error occurred the pattern status will be set to an error. To inspect the status of a pattern use [cairo.pattern.Pattern.status].