cairo_pattern_create_linear: cairo_pattern_create_linear

In coolbutuseless/cairocore: Low-Level Cairo Bindings

Description

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_add_color_stop_rgb() or cairo_pattern_add_color_stop_rgba().

Usage

cairo_pattern_create_linear(x0, y0, x1, y1)

Arguments

x0	[double] x coordinate of the start point
y0	[double] y coordinate of the start point
x1	[double] x coordinate of the end point
y1	[double] y coordinate of the end point

Details

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_set_matrix().

Return value: 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_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_status().

Since: 1.0

C function prototype: cairo_pattern_t * cairo_pattern_create_linear (double x0, double y0, double x1, double y1)

Value

[cairo_pattern_t *]

See Also

Other cairo-pattern: cairo_mesh_pattern_begin_patch(), cairo_mesh_pattern_curve_to(), cairo_mesh_pattern_end_patch(), cairo_mesh_pattern_get_control_point(), cairo_mesh_pattern_get_corner_color_rgba(), cairo_mesh_pattern_get_patch_count(), cairo_mesh_pattern_get_path(), cairo_mesh_pattern_line_to(), cairo_mesh_pattern_move_to(), cairo_mesh_pattern_set_control_point(), cairo_mesh_pattern_set_corner_color_rgba(), cairo_mesh_pattern_set_corner_color_rgb(), cairo_pattern_add_color_stop_rgba(), cairo_pattern_add_color_stop_rgb(), cairo_pattern_create_for_surface(), cairo_pattern_create_mesh(), cairo_pattern_create_radial(), cairo_pattern_create_rgba(), cairo_pattern_create_rgb(), cairo_pattern_get_color_stop_count(), cairo_pattern_get_color_stop_rgba(), cairo_pattern_get_extend(), cairo_pattern_get_filter(), cairo_pattern_get_linear_points(), cairo_pattern_get_matrix(), cairo_pattern_get_radial_circles(), cairo_pattern_get_rgba(), cairo_pattern_get_type(), cairo_pattern_set_extend(), cairo_pattern_set_filter(), cairo_pattern_set_matrix(), cairo_pattern_status()

coolbutuseless/cairocore documentation built on Aug. 31, 2020, 12:43 a.m.