cairo_mesh_pattern_get_control_point: cairo_mesh_pattern_get_control_point

In coolbutuseless/cairocore: Low-Level Cairo Bindings

Description

Gets the control point point_num of patch patch_num for a mesh pattern.

Usage

cairo_mesh_pattern_get_control_point(pattern, patch_num, point_num, x, y)

Arguments

pattern	[cairo_pattern_t *] a #cairo_pattern_t
patch_num	[unsigned int] the patch number to return data for
point_num	[unsigned int] the control point number to return data for
x	[double *] return value for the x coordinate of the control point, or %NULL
y	[double *] return value for the y coordinate of the control point, or %NULL

Details

patch_num can range from 0 to n-1 where n is the number returned by cairo_mesh_pattern_get_patch_count().

Valid values for point_num are from 0 to 3 and identify the control points as explained in cairo_pattern_create_mesh().

Return value: %CAIRO_STATUS_SUCCESS, or %CAIRO_STATUS_INVALID_INDEX if patch_num or point_num is not valid for pattern. If pattern is not a mesh pattern, %CAIRO_STATUS_PATTERN_TYPE_MISMATCH is returned.

Since: 1.12

C function prototype: cairo_status_t cairo_mesh_pattern_get_control_point (cairo_pattern_t *pattern, unsigned int patch_num, unsigned int point_num, double *x, double *y)

Value

[int]

See Also

Other cairo-pattern: cairo_mesh_pattern_begin_patch(), cairo_mesh_pattern_curve_to(), cairo_mesh_pattern_end_patch(), 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_linear(), 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.