w32tex
About: TeX Live provides a comprehensive TeX system including all the major TeX-related programs, macro packages, and fonts that are free software. Windows sources.
  Fossies Dox: w32tex-src.tar.xz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

cairo.h File Reference
#include "cairo-version.h"
#include "cairo-features.h"
#include "cairo-deprecated.h"
Include dependency graph for cairo.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  _cairo_matrix
 
struct  _cairo_user_data_key
 
struct  _cairo_rectangle_int
 
struct  _cairo_rectangle
 
struct  _cairo_rectangle_list
 
struct  cairo_glyph_t
 
struct  cairo_text_cluster_t
 
struct  cairo_text_extents_t
 
struct  cairo_font_extents_t
 
union  _cairo_path_data_t
 
struct  cairo_path
 

Macros

#define CAIRO_BEGIN_DECLS
 
#define CAIRO_END_DECLS
 
#define cairo_public
 
#define CAIRO_VERSION_ENCODE(major, minor, micro)
 
#define CAIRO_VERSION
 
#define CAIRO_VERSION_STRINGIZE_(major, minor, micro)    #major"."#minor"."#micro
 
#define CAIRO_VERSION_STRINGIZE(major, minor, micro)    CAIRO_VERSION_STRINGIZE_(major, minor, micro)
 
#define CAIRO_VERSION_STRING
 
#define CAIRO_TAG_DEST   "cairo.dest"
 
#define CAIRO_TAG_LINK   "Link"
 
#define CAIRO_MIME_TYPE_JPEG   "image/jpeg"
 
#define CAIRO_MIME_TYPE_PNG   "image/png"
 
#define CAIRO_MIME_TYPE_JP2   "image/jp2"
 
#define CAIRO_MIME_TYPE_URI   "text/x-uri"
 
#define CAIRO_MIME_TYPE_UNIQUE_ID   "application/x-cairo.uuid"
 
#define CAIRO_MIME_TYPE_JBIG2   "application/x-cairo.jbig2"
 
#define CAIRO_MIME_TYPE_JBIG2_GLOBAL   "application/x-cairo.jbig2-global"
 
#define CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID   "application/x-cairo.jbig2-global-id"
 
#define CAIRO_MIME_TYPE_CCITT_FAX   "image/g3fax"
 
#define CAIRO_MIME_TYPE_CCITT_FAX_PARAMS   "application/x-cairo.ccitt.params"
 
#define CAIRO_MIME_TYPE_EPS   "application/postscript"
 
#define CAIRO_MIME_TYPE_EPS_PARAMS   "application/x-cairo.eps.params"
 

Typedefs

typedef int cairo_bool_t
 
typedef struct _cairo cairo_t
 
typedef struct _cairo_surface cairo_surface_t
 
typedef struct _cairo_device cairo_device_t
 
typedef struct _cairo_matrix cairo_matrix_t
 
typedef struct _cairo_pattern cairo_pattern_t
 
typedef void(* cairo_destroy_func_t) (void *data)
 
typedef struct _cairo_user_data_key cairo_user_data_key_t
 
typedef enum _cairo_status cairo_status_t
 
typedef enum _cairo_content cairo_content_t
 
typedef enum _cairo_format cairo_format_t
 
typedef cairo_status_t(* cairo_write_func_t) (void *closure, const unsigned char *data, unsigned int length)
 
typedef cairo_status_t(* cairo_read_func_t) (void *closure, unsigned char *data, unsigned int length)
 
typedef struct _cairo_rectangle_int cairo_rectangle_int_t
 
typedef enum _cairo_operator cairo_operator_t
 
typedef enum _cairo_antialias cairo_antialias_t
 
typedef enum _cairo_fill_rule cairo_fill_rule_t
 
typedef enum _cairo_line_cap cairo_line_cap_t
 
typedef enum _cairo_line_join cairo_line_join_t
 
typedef struct _cairo_rectangle cairo_rectangle_t
 
typedef struct _cairo_rectangle_list cairo_rectangle_list_t
 
typedef struct _cairo_scaled_font cairo_scaled_font_t
 
typedef struct _cairo_font_face cairo_font_face_t
 
typedef enum _cairo_text_cluster_flags cairo_text_cluster_flags_t
 
typedef enum _cairo_font_slant cairo_font_slant_t
 
typedef enum _cairo_font_weight cairo_font_weight_t
 
typedef enum _cairo_subpixel_order cairo_subpixel_order_t
 
typedef enum _cairo_hint_style cairo_hint_style_t
 
typedef enum _cairo_hint_metrics cairo_hint_metrics_t
 
typedef struct _cairo_font_options cairo_font_options_t
 
typedef enum _cairo_font_type cairo_font_type_t
 
typedef cairo_status_t(* cairo_user_scaled_font_init_func_t) (cairo_scaled_font_t *scaled_font, cairo_t *cr, cairo_font_extents_t *extents)
 
typedef cairo_status_t(* cairo_user_scaled_font_render_glyph_func_t) (cairo_scaled_font_t *scaled_font, unsigned long glyph, cairo_t *cr, cairo_text_extents_t *extents)
 
typedef cairo_status_t(* cairo_user_scaled_font_text_to_glyphs_func_t) (cairo_scaled_font_t *scaled_font, const char *utf8, int utf8_len, cairo_glyph_t **glyphs, int *num_glyphs, cairo_text_cluster_t **clusters, int *num_clusters, cairo_text_cluster_flags_t *cluster_flags)
 
typedef cairo_status_t(* cairo_user_scaled_font_unicode_to_glyph_func_t) (cairo_scaled_font_t *scaled_font, unsigned long unicode, unsigned long *glyph_index)
 
typedef enum _cairo_path_data_type cairo_path_data_type_t
 
typedef union _cairo_path_data_t cairo_path_data_t
 
typedef struct cairo_path cairo_path_t
 
typedef enum _cairo_device_type cairo_device_type_t
 
typedef void(* cairo_surface_observer_callback_t) (cairo_surface_t *observer, cairo_surface_t *target, void *data)
 
typedef enum _cairo_surface_type cairo_surface_type_t
 
typedef cairo_surface_t *(* cairo_raster_source_acquire_func_t) (cairo_pattern_t *pattern, void *callback_data, cairo_surface_t *target, const cairo_rectangle_int_t *extents)
 
typedef void(* cairo_raster_source_release_func_t) (cairo_pattern_t *pattern, void *callback_data, cairo_surface_t *surface)
 
typedef cairo_status_t(* cairo_raster_source_snapshot_func_t) (cairo_pattern_t *pattern, void *callback_data)
 
typedef cairo_status_t(* cairo_raster_source_copy_func_t) (cairo_pattern_t *pattern, void *callback_data, const cairo_pattern_t *other)
 
typedef void(* cairo_raster_source_finish_func_t) (cairo_pattern_t *pattern, void *callback_data)
 
typedef enum _cairo_pattern_type cairo_pattern_type_t
 
typedef enum _cairo_extend cairo_extend_t
 
typedef enum _cairo_filter cairo_filter_t
 
typedef struct _cairo_region cairo_region_t
 
typedef enum _cairo_region_overlap cairo_region_overlap_t
 

Enumerations

enum  _cairo_status {
  CAIRO_STATUS_SUCCESS = 0 , CAIRO_STATUS_NO_MEMORY , CAIRO_STATUS_INVALID_RESTORE , CAIRO_STATUS_INVALID_POP_GROUP ,
  CAIRO_STATUS_NO_CURRENT_POINT , CAIRO_STATUS_INVALID_MATRIX , CAIRO_STATUS_INVALID_STATUS , CAIRO_STATUS_NULL_POINTER ,
  CAIRO_STATUS_INVALID_STRING , CAIRO_STATUS_INVALID_PATH_DATA , CAIRO_STATUS_READ_ERROR , CAIRO_STATUS_WRITE_ERROR ,
  CAIRO_STATUS_SURFACE_FINISHED , CAIRO_STATUS_SURFACE_TYPE_MISMATCH , CAIRO_STATUS_PATTERN_TYPE_MISMATCH , CAIRO_STATUS_INVALID_CONTENT ,
  CAIRO_STATUS_INVALID_FORMAT , CAIRO_STATUS_INVALID_VISUAL , CAIRO_STATUS_FILE_NOT_FOUND , CAIRO_STATUS_INVALID_DASH ,
  CAIRO_STATUS_INVALID_DSC_COMMENT , CAIRO_STATUS_INVALID_INDEX , CAIRO_STATUS_CLIP_NOT_REPRESENTABLE , CAIRO_STATUS_TEMP_FILE_ERROR ,
  CAIRO_STATUS_INVALID_STRIDE , CAIRO_STATUS_FONT_TYPE_MISMATCH , CAIRO_STATUS_USER_FONT_IMMUTABLE , CAIRO_STATUS_USER_FONT_ERROR ,
  CAIRO_STATUS_NEGATIVE_COUNT , CAIRO_STATUS_INVALID_CLUSTERS , CAIRO_STATUS_INVALID_SLANT , CAIRO_STATUS_INVALID_WEIGHT ,
  CAIRO_STATUS_INVALID_SIZE , CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED , CAIRO_STATUS_DEVICE_TYPE_MISMATCH , CAIRO_STATUS_DEVICE_ERROR ,
  CAIRO_STATUS_INVALID_MESH_CONSTRUCTION , CAIRO_STATUS_DEVICE_FINISHED , CAIRO_STATUS_JBIG2_GLOBAL_MISSING , CAIRO_STATUS_PNG_ERROR ,
  CAIRO_STATUS_FREETYPE_ERROR , CAIRO_STATUS_WIN32_GDI_ERROR , CAIRO_STATUS_TAG_ERROR , CAIRO_STATUS_LAST_STATUS ,
  CAIRO_STATUS_SUCCESS = 0 , CAIRO_STATUS_NO_MEMORY , CAIRO_STATUS_INVALID_RESTORE , CAIRO_STATUS_INVALID_POP_GROUP ,
  CAIRO_STATUS_NO_CURRENT_POINT , CAIRO_STATUS_INVALID_MATRIX , CAIRO_STATUS_INVALID_STATUS , CAIRO_STATUS_NULL_POINTER ,
  CAIRO_STATUS_INVALID_STRING , CAIRO_STATUS_INVALID_PATH_DATA , CAIRO_STATUS_READ_ERROR , CAIRO_STATUS_WRITE_ERROR ,
  CAIRO_STATUS_SURFACE_FINISHED , CAIRO_STATUS_SURFACE_TYPE_MISMATCH , CAIRO_STATUS_PATTERN_TYPE_MISMATCH , CAIRO_STATUS_INVALID_CONTENT ,
  CAIRO_STATUS_INVALID_FORMAT , CAIRO_STATUS_INVALID_VISUAL , CAIRO_STATUS_FILE_NOT_FOUND , CAIRO_STATUS_INVALID_DASH ,
  CAIRO_STATUS_INVALID_DSC_COMMENT , CAIRO_STATUS_INVALID_INDEX , CAIRO_STATUS_CLIP_NOT_REPRESENTABLE , CAIRO_STATUS_TEMP_FILE_ERROR ,
  CAIRO_STATUS_INVALID_STRIDE , CAIRO_STATUS_FONT_TYPE_MISMATCH , CAIRO_STATUS_USER_FONT_IMMUTABLE , CAIRO_STATUS_USER_FONT_ERROR ,
  CAIRO_STATUS_NEGATIVE_COUNT , CAIRO_STATUS_INVALID_CLUSTERS , CAIRO_STATUS_INVALID_SLANT , CAIRO_STATUS_INVALID_WEIGHT ,
  CAIRO_STATUS_INVALID_SIZE , CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED , CAIRO_STATUS_DEVICE_TYPE_MISMATCH , CAIRO_STATUS_DEVICE_ERROR ,
  CAIRO_STATUS_INVALID_MESH_CONSTRUCTION , CAIRO_STATUS_DEVICE_FINISHED , CAIRO_STATUS_JBIG2_GLOBAL_MISSING , CAIRO_STATUS_PNG_ERROR ,
  CAIRO_STATUS_FREETYPE_ERROR , CAIRO_STATUS_WIN32_GDI_ERROR , CAIRO_STATUS_TAG_ERROR , CAIRO_STATUS_LAST_STATUS ,
  CAIRO_STATUS_SUCCESS = 0 , CAIRO_STATUS_NO_MEMORY , CAIRO_STATUS_INVALID_RESTORE , CAIRO_STATUS_INVALID_POP_GROUP ,
  CAIRO_STATUS_NO_CURRENT_POINT , CAIRO_STATUS_INVALID_MATRIX , CAIRO_STATUS_INVALID_STATUS , CAIRO_STATUS_NULL_POINTER ,
  CAIRO_STATUS_INVALID_STRING , CAIRO_STATUS_INVALID_PATH_DATA , CAIRO_STATUS_READ_ERROR , CAIRO_STATUS_WRITE_ERROR ,
  CAIRO_STATUS_SURFACE_FINISHED , CAIRO_STATUS_SURFACE_TYPE_MISMATCH , CAIRO_STATUS_PATTERN_TYPE_MISMATCH , CAIRO_STATUS_INVALID_CONTENT ,
  CAIRO_STATUS_INVALID_FORMAT , CAIRO_STATUS_INVALID_VISUAL , CAIRO_STATUS_FILE_NOT_FOUND , CAIRO_STATUS_INVALID_DASH ,
  CAIRO_STATUS_INVALID_DSC_COMMENT , CAIRO_STATUS_INVALID_INDEX , CAIRO_STATUS_CLIP_NOT_REPRESENTABLE , CAIRO_STATUS_TEMP_FILE_ERROR ,
  CAIRO_STATUS_INVALID_STRIDE , CAIRO_STATUS_FONT_TYPE_MISMATCH , CAIRO_STATUS_USER_FONT_IMMUTABLE , CAIRO_STATUS_USER_FONT_ERROR ,
  CAIRO_STATUS_NEGATIVE_COUNT , CAIRO_STATUS_INVALID_CLUSTERS , CAIRO_STATUS_INVALID_SLANT , CAIRO_STATUS_INVALID_WEIGHT ,
  CAIRO_STATUS_INVALID_SIZE , CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED , CAIRO_STATUS_DEVICE_TYPE_MISMATCH , CAIRO_STATUS_DEVICE_ERROR ,
  CAIRO_STATUS_INVALID_MESH_CONSTRUCTION , CAIRO_STATUS_DEVICE_FINISHED , CAIRO_STATUS_JBIG2_GLOBAL_MISSING , CAIRO_STATUS_PNG_ERROR ,
  CAIRO_STATUS_FREETYPE_ERROR , CAIRO_STATUS_WIN32_GDI_ERROR , CAIRO_STATUS_TAG_ERROR , CAIRO_STATUS_LAST_STATUS
}
 
enum  _cairo_content {
  CAIRO_CONTENT_COLOR = 0x1000 , CAIRO_CONTENT_ALPHA = 0x2000 , CAIRO_CONTENT_COLOR_ALPHA = 0x3000 , CAIRO_CONTENT_COLOR = 0x1000 ,
  CAIRO_CONTENT_ALPHA = 0x2000 , CAIRO_CONTENT_COLOR_ALPHA = 0x3000 , CAIRO_CONTENT_COLOR = 0x1000 , CAIRO_CONTENT_ALPHA = 0x2000 ,
  CAIRO_CONTENT_COLOR_ALPHA = 0x3000
}
 
enum  _cairo_format {
  CAIRO_FORMAT_INVALID = -1 , CAIRO_FORMAT_ARGB32 = 0 , CAIRO_FORMAT_RGB24 = 1 , CAIRO_FORMAT_A8 = 2 ,
  CAIRO_FORMAT_A1 = 3 , CAIRO_FORMAT_RGB16_565 = 4 , CAIRO_FORMAT_RGB30 = 5 , CAIRO_FORMAT_INVALID = -1 ,
  CAIRO_FORMAT_ARGB32 = 0 , CAIRO_FORMAT_RGB24 = 1 , CAIRO_FORMAT_A8 = 2 , CAIRO_FORMAT_A1 = 3 ,
  CAIRO_FORMAT_RGB16_565 = 4 , CAIRO_FORMAT_RGB30 = 5 , CAIRO_FORMAT_INVALID = -1 , CAIRO_FORMAT_ARGB32 = 0 ,
  CAIRO_FORMAT_RGB24 = 1 , CAIRO_FORMAT_A8 = 2 , CAIRO_FORMAT_A1 = 3 , CAIRO_FORMAT_RGB16_565 = 4 ,
  CAIRO_FORMAT_RGB30 = 5
}
 
enum  _cairo_operator {
  CAIRO_OPERATOR_CLEAR , CAIRO_OPERATOR_SOURCE , CAIRO_OPERATOR_OVER , CAIRO_OPERATOR_IN ,
  CAIRO_OPERATOR_OUT , CAIRO_OPERATOR_ATOP , CAIRO_OPERATOR_DEST , CAIRO_OPERATOR_DEST_OVER ,
  CAIRO_OPERATOR_DEST_IN , CAIRO_OPERATOR_DEST_OUT , CAIRO_OPERATOR_DEST_ATOP , CAIRO_OPERATOR_XOR ,
  CAIRO_OPERATOR_ADD , CAIRO_OPERATOR_SATURATE , CAIRO_OPERATOR_MULTIPLY , CAIRO_OPERATOR_SCREEN ,
  CAIRO_OPERATOR_OVERLAY , CAIRO_OPERATOR_DARKEN , CAIRO_OPERATOR_LIGHTEN , CAIRO_OPERATOR_COLOR_DODGE ,
  CAIRO_OPERATOR_COLOR_BURN , CAIRO_OPERATOR_HARD_LIGHT , CAIRO_OPERATOR_SOFT_LIGHT , CAIRO_OPERATOR_DIFFERENCE ,
  CAIRO_OPERATOR_EXCLUSION , CAIRO_OPERATOR_HSL_HUE , CAIRO_OPERATOR_HSL_SATURATION , CAIRO_OPERATOR_HSL_COLOR ,
  CAIRO_OPERATOR_HSL_LUMINOSITY , CAIRO_OPERATOR_CLEAR , CAIRO_OPERATOR_SOURCE , CAIRO_OPERATOR_OVER ,
  CAIRO_OPERATOR_IN , CAIRO_OPERATOR_OUT , CAIRO_OPERATOR_ATOP , CAIRO_OPERATOR_DEST ,
  CAIRO_OPERATOR_DEST_OVER , CAIRO_OPERATOR_DEST_IN , CAIRO_OPERATOR_DEST_OUT , CAIRO_OPERATOR_DEST_ATOP ,
  CAIRO_OPERATOR_XOR , CAIRO_OPERATOR_ADD , CAIRO_OPERATOR_SATURATE , CAIRO_OPERATOR_MULTIPLY ,
  CAIRO_OPERATOR_SCREEN , CAIRO_OPERATOR_OVERLAY , CAIRO_OPERATOR_DARKEN , CAIRO_OPERATOR_LIGHTEN ,
  CAIRO_OPERATOR_COLOR_DODGE , CAIRO_OPERATOR_COLOR_BURN , CAIRO_OPERATOR_HARD_LIGHT , CAIRO_OPERATOR_SOFT_LIGHT ,
  CAIRO_OPERATOR_DIFFERENCE , CAIRO_OPERATOR_EXCLUSION , CAIRO_OPERATOR_HSL_HUE , CAIRO_OPERATOR_HSL_SATURATION ,
  CAIRO_OPERATOR_HSL_COLOR , CAIRO_OPERATOR_HSL_LUMINOSITY , CAIRO_OPERATOR_CLEAR , CAIRO_OPERATOR_SOURCE ,
  CAIRO_OPERATOR_OVER , CAIRO_OPERATOR_IN , CAIRO_OPERATOR_OUT , CAIRO_OPERATOR_ATOP ,
  CAIRO_OPERATOR_DEST , CAIRO_OPERATOR_DEST_OVER , CAIRO_OPERATOR_DEST_IN , CAIRO_OPERATOR_DEST_OUT ,
  CAIRO_OPERATOR_DEST_ATOP , CAIRO_OPERATOR_XOR , CAIRO_OPERATOR_ADD , CAIRO_OPERATOR_SATURATE ,
  CAIRO_OPERATOR_MULTIPLY , CAIRO_OPERATOR_SCREEN , CAIRO_OPERATOR_OVERLAY , CAIRO_OPERATOR_DARKEN ,
  CAIRO_OPERATOR_LIGHTEN , CAIRO_OPERATOR_COLOR_DODGE , CAIRO_OPERATOR_COLOR_BURN , CAIRO_OPERATOR_HARD_LIGHT ,
  CAIRO_OPERATOR_SOFT_LIGHT , CAIRO_OPERATOR_DIFFERENCE , CAIRO_OPERATOR_EXCLUSION , CAIRO_OPERATOR_HSL_HUE ,
  CAIRO_OPERATOR_HSL_SATURATION , CAIRO_OPERATOR_HSL_COLOR , CAIRO_OPERATOR_HSL_LUMINOSITY
}
 
enum  _cairo_antialias {
  CAIRO_ANTIALIAS_DEFAULT , CAIRO_ANTIALIAS_NONE , CAIRO_ANTIALIAS_GRAY , CAIRO_ANTIALIAS_SUBPIXEL ,
  CAIRO_ANTIALIAS_FAST , CAIRO_ANTIALIAS_GOOD , CAIRO_ANTIALIAS_BEST , CAIRO_ANTIALIAS_DEFAULT ,
  CAIRO_ANTIALIAS_NONE , CAIRO_ANTIALIAS_GRAY , CAIRO_ANTIALIAS_SUBPIXEL , CAIRO_ANTIALIAS_FAST ,
  CAIRO_ANTIALIAS_GOOD , CAIRO_ANTIALIAS_BEST , CAIRO_ANTIALIAS_DEFAULT , CAIRO_ANTIALIAS_NONE ,
  CAIRO_ANTIALIAS_GRAY , CAIRO_ANTIALIAS_SUBPIXEL , CAIRO_ANTIALIAS_FAST , CAIRO_ANTIALIAS_GOOD ,
  CAIRO_ANTIALIAS_BEST
}
 
enum  _cairo_fill_rule {
  CAIRO_FILL_RULE_WINDING , CAIRO_FILL_RULE_EVEN_ODD , CAIRO_FILL_RULE_WINDING , CAIRO_FILL_RULE_EVEN_ODD ,
  CAIRO_FILL_RULE_WINDING , CAIRO_FILL_RULE_EVEN_ODD
}
 
enum  _cairo_line_cap {
  CAIRO_LINE_CAP_BUTT , CAIRO_LINE_CAP_ROUND , CAIRO_LINE_CAP_SQUARE , CAIRO_LINE_CAP_BUTT ,
  CAIRO_LINE_CAP_ROUND , CAIRO_LINE_CAP_SQUARE , CAIRO_LINE_CAP_BUTT , CAIRO_LINE_CAP_ROUND ,
  CAIRO_LINE_CAP_SQUARE
}
 
enum  _cairo_line_join {
  CAIRO_LINE_JOIN_MITER , CAIRO_LINE_JOIN_ROUND , CAIRO_LINE_JOIN_BEVEL , CAIRO_LINE_JOIN_MITER ,
  CAIRO_LINE_JOIN_ROUND , CAIRO_LINE_JOIN_BEVEL , CAIRO_LINE_JOIN_MITER , CAIRO_LINE_JOIN_ROUND ,
  CAIRO_LINE_JOIN_BEVEL
}
 
enum  _cairo_text_cluster_flags { CAIRO_TEXT_CLUSTER_FLAG_BACKWARD = 0x00000001 , CAIRO_TEXT_CLUSTER_FLAG_BACKWARD = 0x00000001 , CAIRO_TEXT_CLUSTER_FLAG_BACKWARD = 0x00000001 }
 
enum  _cairo_font_slant {
  CAIRO_FONT_SLANT_NORMAL , CAIRO_FONT_SLANT_ITALIC , CAIRO_FONT_SLANT_OBLIQUE , CAIRO_FONT_SLANT_NORMAL ,
  CAIRO_FONT_SLANT_ITALIC , CAIRO_FONT_SLANT_OBLIQUE , CAIRO_FONT_SLANT_NORMAL , CAIRO_FONT_SLANT_ITALIC ,
  CAIRO_FONT_SLANT_OBLIQUE
}
 
enum  _cairo_font_weight {
  CAIRO_FONT_WEIGHT_NORMAL , CAIRO_FONT_WEIGHT_BOLD , CAIRO_FONT_WEIGHT_NORMAL , CAIRO_FONT_WEIGHT_BOLD ,
  CAIRO_FONT_WEIGHT_NORMAL , CAIRO_FONT_WEIGHT_BOLD
}
 
enum  _cairo_subpixel_order {
  CAIRO_SUBPIXEL_ORDER_DEFAULT , CAIRO_SUBPIXEL_ORDER_RGB , CAIRO_SUBPIXEL_ORDER_BGR , CAIRO_SUBPIXEL_ORDER_VRGB ,
  CAIRO_SUBPIXEL_ORDER_VBGR , CAIRO_SUBPIXEL_ORDER_DEFAULT , CAIRO_SUBPIXEL_ORDER_RGB , CAIRO_SUBPIXEL_ORDER_BGR ,
  CAIRO_SUBPIXEL_ORDER_VRGB , CAIRO_SUBPIXEL_ORDER_VBGR , CAIRO_SUBPIXEL_ORDER_DEFAULT , CAIRO_SUBPIXEL_ORDER_RGB ,
  CAIRO_SUBPIXEL_ORDER_BGR , CAIRO_SUBPIXEL_ORDER_VRGB , CAIRO_SUBPIXEL_ORDER_VBGR
}
 
enum  _cairo_hint_style {
  CAIRO_HINT_STYLE_DEFAULT , CAIRO_HINT_STYLE_NONE , CAIRO_HINT_STYLE_SLIGHT , CAIRO_HINT_STYLE_MEDIUM ,
  CAIRO_HINT_STYLE_FULL , CAIRO_HINT_STYLE_DEFAULT , CAIRO_HINT_STYLE_NONE , CAIRO_HINT_STYLE_SLIGHT ,
  CAIRO_HINT_STYLE_MEDIUM , CAIRO_HINT_STYLE_FULL , CAIRO_HINT_STYLE_DEFAULT , CAIRO_HINT_STYLE_NONE ,
  CAIRO_HINT_STYLE_SLIGHT , CAIRO_HINT_STYLE_MEDIUM , CAIRO_HINT_STYLE_FULL
}
 
enum  _cairo_hint_metrics {
  CAIRO_HINT_METRICS_DEFAULT , CAIRO_HINT_METRICS_OFF , CAIRO_HINT_METRICS_ON , CAIRO_HINT_METRICS_DEFAULT ,
  CAIRO_HINT_METRICS_OFF , CAIRO_HINT_METRICS_ON , CAIRO_HINT_METRICS_DEFAULT , CAIRO_HINT_METRICS_OFF ,
  CAIRO_HINT_METRICS_ON
}
 
enum  _cairo_font_type {
  CAIRO_FONT_TYPE_TOY , CAIRO_FONT_TYPE_FT , CAIRO_FONT_TYPE_WIN32 , CAIRO_FONT_TYPE_QUARTZ ,
  CAIRO_FONT_TYPE_USER , CAIRO_FONT_TYPE_TOY , CAIRO_FONT_TYPE_FT , CAIRO_FONT_TYPE_WIN32 ,
  CAIRO_FONT_TYPE_QUARTZ , CAIRO_FONT_TYPE_USER , CAIRO_FONT_TYPE_TOY , CAIRO_FONT_TYPE_FT ,
  CAIRO_FONT_TYPE_WIN32 , CAIRO_FONT_TYPE_QUARTZ , CAIRO_FONT_TYPE_USER
}
 
enum  _cairo_path_data_type {
  CAIRO_PATH_MOVE_TO , CAIRO_PATH_LINE_TO , CAIRO_PATH_CURVE_TO , CAIRO_PATH_CLOSE_PATH ,
  CAIRO_PATH_MOVE_TO , CAIRO_PATH_LINE_TO , CAIRO_PATH_CURVE_TO , CAIRO_PATH_CLOSE_PATH ,
  CAIRO_PATH_MOVE_TO , CAIRO_PATH_LINE_TO , CAIRO_PATH_CURVE_TO , CAIRO_PATH_CLOSE_PATH
}
 
enum  _cairo_device_type {
  CAIRO_DEVICE_TYPE_DRM , CAIRO_DEVICE_TYPE_GL , CAIRO_DEVICE_TYPE_SCRIPT , CAIRO_DEVICE_TYPE_XCB ,
  CAIRO_DEVICE_TYPE_XLIB , CAIRO_DEVICE_TYPE_XML , CAIRO_DEVICE_TYPE_COGL , CAIRO_DEVICE_TYPE_WIN32 ,
  CAIRO_DEVICE_TYPE_INVALID = -1 , CAIRO_DEVICE_TYPE_DRM , CAIRO_DEVICE_TYPE_GL , CAIRO_DEVICE_TYPE_SCRIPT ,
  CAIRO_DEVICE_TYPE_XCB , CAIRO_DEVICE_TYPE_XLIB , CAIRO_DEVICE_TYPE_XML , CAIRO_DEVICE_TYPE_COGL ,
  CAIRO_DEVICE_TYPE_WIN32 , CAIRO_DEVICE_TYPE_INVALID = -1 , CAIRO_DEVICE_TYPE_DRM , CAIRO_DEVICE_TYPE_GL ,
  CAIRO_DEVICE_TYPE_SCRIPT , CAIRO_DEVICE_TYPE_XCB , CAIRO_DEVICE_TYPE_XLIB , CAIRO_DEVICE_TYPE_XML ,
  CAIRO_DEVICE_TYPE_COGL , CAIRO_DEVICE_TYPE_WIN32 , CAIRO_DEVICE_TYPE_INVALID = -1
}
 
enum  cairo_surface_observer_mode_t {
  CAIRO_SURFACE_OBSERVER_NORMAL = 0 , CAIRO_SURFACE_OBSERVER_RECORD_OPERATIONS = 0x1 , CAIRO_SURFACE_OBSERVER_NORMAL = 0 , CAIRO_SURFACE_OBSERVER_RECORD_OPERATIONS = 0x1 ,
  CAIRO_SURFACE_OBSERVER_NORMAL = 0 , CAIRO_SURFACE_OBSERVER_RECORD_OPERATIONS = 0x1
}
 
enum  _cairo_surface_type {
  CAIRO_SURFACE_TYPE_IMAGE , CAIRO_SURFACE_TYPE_PDF , CAIRO_SURFACE_TYPE_PS , CAIRO_SURFACE_TYPE_XLIB ,
  CAIRO_SURFACE_TYPE_XCB , CAIRO_SURFACE_TYPE_GLITZ , CAIRO_SURFACE_TYPE_QUARTZ , CAIRO_SURFACE_TYPE_WIN32 ,
  CAIRO_SURFACE_TYPE_BEOS , CAIRO_SURFACE_TYPE_DIRECTFB , CAIRO_SURFACE_TYPE_SVG , CAIRO_SURFACE_TYPE_OS2 ,
  CAIRO_SURFACE_TYPE_WIN32_PRINTING , CAIRO_SURFACE_TYPE_QUARTZ_IMAGE , CAIRO_SURFACE_TYPE_SCRIPT , CAIRO_SURFACE_TYPE_QT ,
  CAIRO_SURFACE_TYPE_RECORDING , CAIRO_SURFACE_TYPE_VG , CAIRO_SURFACE_TYPE_GL , CAIRO_SURFACE_TYPE_DRM ,
  CAIRO_SURFACE_TYPE_TEE , CAIRO_SURFACE_TYPE_XML , CAIRO_SURFACE_TYPE_SKIA , CAIRO_SURFACE_TYPE_SUBSURFACE ,
  CAIRO_SURFACE_TYPE_COGL , CAIRO_SURFACE_TYPE_IMAGE , CAIRO_SURFACE_TYPE_PDF , CAIRO_SURFACE_TYPE_PS ,
  CAIRO_SURFACE_TYPE_XLIB , CAIRO_SURFACE_TYPE_XCB , CAIRO_SURFACE_TYPE_GLITZ , CAIRO_SURFACE_TYPE_QUARTZ ,
  CAIRO_SURFACE_TYPE_WIN32 , CAIRO_SURFACE_TYPE_BEOS , CAIRO_SURFACE_TYPE_DIRECTFB , CAIRO_SURFACE_TYPE_SVG ,
  CAIRO_SURFACE_TYPE_OS2 , CAIRO_SURFACE_TYPE_WIN32_PRINTING , CAIRO_SURFACE_TYPE_QUARTZ_IMAGE , CAIRO_SURFACE_TYPE_SCRIPT ,
  CAIRO_SURFACE_TYPE_QT , CAIRO_SURFACE_TYPE_RECORDING , CAIRO_SURFACE_TYPE_VG , CAIRO_SURFACE_TYPE_GL ,
  CAIRO_SURFACE_TYPE_DRM , CAIRO_SURFACE_TYPE_TEE , CAIRO_SURFACE_TYPE_XML , CAIRO_SURFACE_TYPE_SKIA ,
  CAIRO_SURFACE_TYPE_SUBSURFACE , CAIRO_SURFACE_TYPE_COGL , CAIRO_SURFACE_TYPE_IMAGE , CAIRO_SURFACE_TYPE_PDF ,
  CAIRO_SURFACE_TYPE_PS , CAIRO_SURFACE_TYPE_XLIB , CAIRO_SURFACE_TYPE_XCB , CAIRO_SURFACE_TYPE_GLITZ ,
  CAIRO_SURFACE_TYPE_QUARTZ , CAIRO_SURFACE_TYPE_WIN32 , CAIRO_SURFACE_TYPE_BEOS , CAIRO_SURFACE_TYPE_DIRECTFB ,
  CAIRO_SURFACE_TYPE_SVG , CAIRO_SURFACE_TYPE_OS2 , CAIRO_SURFACE_TYPE_WIN32_PRINTING , CAIRO_SURFACE_TYPE_QUARTZ_IMAGE ,
  CAIRO_SURFACE_TYPE_SCRIPT , CAIRO_SURFACE_TYPE_QT , CAIRO_SURFACE_TYPE_RECORDING , CAIRO_SURFACE_TYPE_VG ,
  CAIRO_SURFACE_TYPE_GL , CAIRO_SURFACE_TYPE_DRM , CAIRO_SURFACE_TYPE_TEE , CAIRO_SURFACE_TYPE_XML ,
  CAIRO_SURFACE_TYPE_SKIA , CAIRO_SURFACE_TYPE_SUBSURFACE , CAIRO_SURFACE_TYPE_COGL
}
 
enum  _cairo_pattern_type {
  CAIRO_PATTERN_TYPE_SOLID , CAIRO_PATTERN_TYPE_SURFACE , CAIRO_PATTERN_TYPE_LINEAR , CAIRO_PATTERN_TYPE_RADIAL ,
  CAIRO_PATTERN_TYPE_MESH , CAIRO_PATTERN_TYPE_RASTER_SOURCE , CAIRO_PATTERN_TYPE_SOLID , CAIRO_PATTERN_TYPE_SURFACE ,
  CAIRO_PATTERN_TYPE_LINEAR , CAIRO_PATTERN_TYPE_RADIAL , CAIRO_PATTERN_TYPE_MESH , CAIRO_PATTERN_TYPE_RASTER_SOURCE ,
  CAIRO_PATTERN_TYPE_SOLID , CAIRO_PATTERN_TYPE_SURFACE , CAIRO_PATTERN_TYPE_LINEAR , CAIRO_PATTERN_TYPE_RADIAL ,
  CAIRO_PATTERN_TYPE_MESH , CAIRO_PATTERN_TYPE_RASTER_SOURCE
}
 
enum  _cairo_extend {
  CAIRO_EXTEND_NONE , CAIRO_EXTEND_REPEAT , CAIRO_EXTEND_REFLECT , CAIRO_EXTEND_PAD ,
  CAIRO_EXTEND_NONE , CAIRO_EXTEND_REPEAT , CAIRO_EXTEND_REFLECT , CAIRO_EXTEND_PAD ,
  CAIRO_EXTEND_NONE , CAIRO_EXTEND_REPEAT , CAIRO_EXTEND_REFLECT , CAIRO_EXTEND_PAD
}
 
enum  _cairo_filter {
  CAIRO_FILTER_FAST , CAIRO_FILTER_GOOD , CAIRO_FILTER_BEST , CAIRO_FILTER_NEAREST ,
  CAIRO_FILTER_BILINEAR , CAIRO_FILTER_GAUSSIAN , CAIRO_FILTER_FAST , CAIRO_FILTER_GOOD ,
  CAIRO_FILTER_BEST , CAIRO_FILTER_NEAREST , CAIRO_FILTER_BILINEAR , CAIRO_FILTER_GAUSSIAN ,
  CAIRO_FILTER_FAST , CAIRO_FILTER_GOOD , CAIRO_FILTER_BEST , CAIRO_FILTER_NEAREST ,
  CAIRO_FILTER_BILINEAR , CAIRO_FILTER_GAUSSIAN
}
 
enum  _cairo_region_overlap {
  CAIRO_REGION_OVERLAP_IN , CAIRO_REGION_OVERLAP_OUT , CAIRO_REGION_OVERLAP_PART , CAIRO_REGION_OVERLAP_IN ,
  CAIRO_REGION_OVERLAP_OUT , CAIRO_REGION_OVERLAP_PART , CAIRO_REGION_OVERLAP_IN , CAIRO_REGION_OVERLAP_OUT ,
  CAIRO_REGION_OVERLAP_PART
}
 

Functions

int cairo_version (void)
 
const char * cairo_version_string (void)
 
cairo_tcairo_create (cairo_surface_t *target)
 
cairo_tcairo_reference (cairo_t *cr)
 
void cairo_destroy (cairo_t *cr)
 
unsigned int cairo_get_reference_count (cairo_t *cr)
 
voidcairo_get_user_data (cairo_t *cr, const cairo_user_data_key_t *key)
 
cairo_status_t cairo_set_user_data (cairo_t *cr, const cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy)
 
void cairo_save (cairo_t *cr)
 
void cairo_restore (cairo_t *cr)
 
void cairo_push_group (cairo_t *cr)
 
void cairo_push_group_with_content (cairo_t *cr, cairo_content_t content)
 
cairo_pattern_tcairo_pop_group (cairo_t *cr)
 
void cairo_pop_group_to_source (cairo_t *cr)
 
void cairo_set_operator (cairo_t *cr, cairo_operator_t op)
 
void cairo_set_source (cairo_t *cr, cairo_pattern_t *source)
 
void cairo_set_source_rgb (cairo_t *cr, double red, double green, double blue)
 
void cairo_set_source_rgba (cairo_t *cr, double red, double green, double blue, double alpha)
 
void cairo_set_source_surface (cairo_t *cr, cairo_surface_t *surface, double x, double y)
 
void cairo_set_tolerance (cairo_t *cr, double tolerance)
 
void cairo_set_antialias (cairo_t *cr, cairo_antialias_t antialias)
 
void cairo_set_fill_rule (cairo_t *cr, cairo_fill_rule_t fill_rule)
 
void cairo_set_line_width (cairo_t *cr, double width)
 
void cairo_set_line_cap (cairo_t *cr, cairo_line_cap_t line_cap)
 
void cairo_set_line_join (cairo_t *cr, cairo_line_join_t line_join)
 
void cairo_set_dash (cairo_t *cr, const double *dashes, int num_dashes, double offset)
 
void cairo_set_miter_limit (cairo_t *cr, double limit)
 
void cairo_translate (cairo_t *cr, double tx, double ty)
 
void cairo_scale (cairo_t *cr, double sx, double sy)
 
void cairo_rotate (cairo_t *cr, double angle)
 
void cairo_transform (cairo_t *cr, const cairo_matrix_t *matrix)
 
void cairo_set_matrix (cairo_t *cr, const cairo_matrix_t *matrix)
 
void cairo_identity_matrix (cairo_t *cr)
 
void cairo_user_to_device (cairo_t *cr, double *x, double *y)
 
void cairo_user_to_device_distance (cairo_t *cr, double *dx, double *dy)
 
void cairo_device_to_user (cairo_t *cr, double *x, double *y)
 
void cairo_device_to_user_distance (cairo_t *cr, double *dx, double *dy)
 
void cairo_new_path (cairo_t *cr)
 
void cairo_move_to (cairo_t *cr, double x, double y)
 
void cairo_new_sub_path (cairo_t *cr)
 
void cairo_line_to (cairo_t *cr, double x, double y)
 
void cairo_curve_to (cairo_t *cr, double x1, double y1, double x2, double y2, double x3, double y3)
 
void cairo_arc (cairo_t *cr, double xc, double yc, double radius, double angle1, double angle2)
 
void cairo_arc_negative (cairo_t *cr, double xc, double yc, double radius, double angle1, double angle2)
 
void cairo_rel_move_to (cairo_t *cr, double dx, double dy)
 
void cairo_rel_line_to (cairo_t *cr, double dx, double dy)
 
void cairo_rel_curve_to (cairo_t *cr, double dx1, double dy1, double dx2, double dy2, double dx3, double dy3)
 
void cairo_rectangle (cairo_t *cr, double x, double y, double width, double height)
 
void cairo_close_path (cairo_t *cr)
 
void cairo_path_extents (cairo_t *cr, double *x1, double *y1, double *x2, double *y2)
 
void cairo_paint (cairo_t *cr)
 
void cairo_paint_with_alpha (cairo_t *cr, double alpha)
 
void cairo_mask (cairo_t *cr, cairo_pattern_t *pattern)
 
void cairo_mask_surface (cairo_t *cr, cairo_surface_t *surface, double surface_x, double surface_y)
 
void cairo_stroke (cairo_t *cr)
 
void cairo_stroke_preserve (cairo_t *cr)
 
void cairo_fill (cairo_t *cr)
 
void cairo_fill_preserve (cairo_t *cr)
 
void cairo_copy_page (cairo_t *cr)
 
void cairo_show_page (cairo_t *cr)
 
cairo_bool_t cairo_in_stroke (cairo_t *cr, double x, double y)
 
cairo_bool_t cairo_in_fill (cairo_t *cr, double x, double y)
 
cairo_bool_t cairo_in_clip (cairo_t *cr, double x, double y)
 
void cairo_stroke_extents (cairo_t *cr, double *x1, double *y1, double *x2, double *y2)
 
void cairo_fill_extents (cairo_t *cr, double *x1, double *y1, double *x2, double *y2)
 
void cairo_reset_clip (cairo_t *cr)
 
void cairo_clip (cairo_t *cr)
 
void cairo_clip_preserve (cairo_t *cr)
 
void cairo_clip_extents (cairo_t *cr, double *x1, double *y1, double *x2, double *y2)
 
cairo_rectangle_list_tcairo_copy_clip_rectangle_list (cairo_t *cr)
 
void cairo_rectangle_list_destroy (cairo_rectangle_list_t *rectangle_list)
 
void cairo_tag_begin (cairo_t *cr, const char *tag_name, const char *attributes)
 
void cairo_tag_end (cairo_t *cr, const char *tag_name)
 
cairo_glyph_tcairo_glyph_allocate (int num_glyphs)
 
void cairo_glyph_free (cairo_glyph_t *glyphs)
 
cairo_text_cluster_tcairo_text_cluster_allocate (int num_clusters)
 
void cairo_text_cluster_free (cairo_text_cluster_t *clusters)
 
cairo_font_options_tcairo_font_options_create (void)
 
cairo_font_options_tcairo_font_options_copy (const cairo_font_options_t *original)
 
void cairo_font_options_destroy (cairo_font_options_t *options)
 
cairo_status_t cairo_font_options_status (cairo_font_options_t *options)
 
void cairo_font_options_merge (cairo_font_options_t *options, const cairo_font_options_t *other)
 
cairo_bool_t cairo_font_options_equal (const cairo_font_options_t *options, const cairo_font_options_t *other)
 
unsigned long cairo_font_options_hash (const cairo_font_options_t *options)
 
void cairo_font_options_set_antialias (cairo_font_options_t *options, cairo_antialias_t antialias)
 
cairo_antialias_t cairo_font_options_get_antialias (const cairo_font_options_t *options)
 
void cairo_font_options_set_subpixel_order (cairo_font_options_t *options, cairo_subpixel_order_t subpixel_order)
 
cairo_subpixel_order_t cairo_font_options_get_subpixel_order (const cairo_font_options_t *options)
 
void cairo_font_options_set_hint_style (cairo_font_options_t *options, cairo_hint_style_t hint_style)
 
cairo_hint_style_t cairo_font_options_get_hint_style (const cairo_font_options_t *options)
 
void cairo_font_options_set_hint_metrics (cairo_font_options_t *options, cairo_hint_metrics_t hint_metrics)
 
cairo_hint_metrics_t cairo_font_options_get_hint_metrics (const cairo_font_options_t *options)
 
const char * cairo_font_options_get_variations (cairo_font_options_t *options)
 
void cairo_font_options_set_variations (cairo_font_options_t *options, const char *variations)
 
void cairo_select_font_face (cairo_t *cr, const char *family, cairo_font_slant_t slant, cairo_font_weight_t weight)
 
void cairo_set_font_size (cairo_t *cr, double size)
 
void cairo_set_font_matrix (cairo_t *cr, const cairo_matrix_t *matrix)
 
void cairo_get_font_matrix (cairo_t *cr, cairo_matrix_t *matrix)
 
void cairo_set_font_options (cairo_t *cr, const cairo_font_options_t *options)
 
void cairo_get_font_options (cairo_t *cr, cairo_font_options_t *options)
 
void cairo_set_font_face (cairo_t *cr, cairo_font_face_t *font_face)
 
cairo_font_face_tcairo_get_font_face (cairo_t *cr)
 
void cairo_set_scaled_font (cairo_t *cr, const cairo_scaled_font_t *scaled_font)
 
cairo_scaled_font_tcairo_get_scaled_font (cairo_t *cr)
 
void cairo_show_text (cairo_t *cr, const char *utf8)
 
void cairo_show_glyphs (cairo_t *cr, const cairo_glyph_t *glyphs, int num_glyphs)
 
void cairo_show_text_glyphs (cairo_t *cr, const char *utf8, int utf8_len, const cairo_glyph_t *glyphs, int num_glyphs, const cairo_text_cluster_t *clusters, int num_clusters, cairo_text_cluster_flags_t cluster_flags)
 
void cairo_text_path (cairo_t *cr, const char *utf8)
 
void cairo_glyph_path (cairo_t *cr, const cairo_glyph_t *glyphs, int num_glyphs)
 
void cairo_text_extents (cairo_t *cr, const char *utf8, cairo_text_extents_t *extents)
 
void cairo_glyph_extents (cairo_t *cr, const cairo_glyph_t *glyphs, int num_glyphs, cairo_text_extents_t *extents)
 
void cairo_font_extents (cairo_t *cr, cairo_font_extents_t *extents)
 
cairo_font_face_tcairo_font_face_reference (cairo_font_face_t *font_face)
 
void cairo_font_face_destroy (cairo_font_face_t *font_face)
 
unsigned int cairo_font_face_get_reference_count (cairo_font_face_t *font_face)
 
cairo_status_t cairo_font_face_status (cairo_font_face_t *font_face)
 
cairo_font_type_t cairo_font_face_get_type (cairo_font_face_t *font_face)
 
voidcairo_font_face_get_user_data (cairo_font_face_t *font_face, const cairo_user_data_key_t *key)
 
cairo_status_t cairo_font_face_set_user_data (cairo_font_face_t *font_face, const cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy)
 
cairo_scaled_font_tcairo_scaled_font_create (cairo_font_face_t *font_face, const cairo_matrix_t *font_matrix, const cairo_matrix_t *ctm, const cairo_font_options_t *options)
 
cairo_scaled_font_tcairo_scaled_font_reference (cairo_scaled_font_t *scaled_font)
 
void cairo_scaled_font_destroy (cairo_scaled_font_t *scaled_font)
 
unsigned int cairo_scaled_font_get_reference_count (cairo_scaled_font_t *scaled_font)
 
cairo_status_t cairo_scaled_font_status (cairo_scaled_font_t *scaled_font)
 
cairo_font_type_t cairo_scaled_font_get_type (cairo_scaled_font_t *scaled_font)
 
voidcairo_scaled_font_get_user_data (cairo_scaled_font_t *scaled_font, const cairo_user_data_key_t *key)
 
cairo_status_t cairo_scaled_font_set_user_data (cairo_scaled_font_t *scaled_font, const cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy)
 
void cairo_scaled_font_extents (cairo_scaled_font_t *scaled_font, cairo_font_extents_t *extents)
 
void cairo_scaled_font_text_extents (cairo_scaled_font_t *scaled_font, const char *utf8, cairo_text_extents_t *extents)
 
void cairo_scaled_font_glyph_extents (cairo_scaled_font_t *scaled_font, const cairo_glyph_t *glyphs, int num_glyphs, cairo_text_extents_t *extents)
 
cairo_status_t cairo_scaled_font_text_to_glyphs (cairo_scaled_font_t *scaled_font, double x, double y, const char *utf8, int utf8_len, cairo_glyph_t **glyphs, int *num_glyphs, cairo_text_cluster_t **clusters, int *num_clusters, cairo_text_cluster_flags_t *cluster_flags)
 
cairo_font_face_tcairo_scaled_font_get_font_face (cairo_scaled_font_t *scaled_font)
 
void cairo_scaled_font_get_font_matrix (cairo_scaled_font_t *scaled_font, cairo_matrix_t *font_matrix)
 
void cairo_scaled_font_get_ctm (cairo_scaled_font_t *scaled_font, cairo_matrix_t *ctm)
 
void cairo_scaled_font_get_scale_matrix (cairo_scaled_font_t *scaled_font, cairo_matrix_t *scale_matrix)
 
void cairo_scaled_font_get_font_options (cairo_scaled_font_t *scaled_font, cairo_font_options_t *options)
 
cairo_font_face_tcairo_toy_font_face_create (const char *family, cairo_font_slant_t slant, cairo_font_weight_t weight)
 
const char * cairo_toy_font_face_get_family (cairo_font_face_t *font_face)
 
cairo_font_slant_t cairo_toy_font_face_get_slant (cairo_font_face_t *font_face)
 
cairo_font_weight_t cairo_toy_font_face_get_weight (cairo_font_face_t *font_face)
 
cairo_font_face_tcairo_user_font_face_create (void)
 
void cairo_user_font_face_set_init_func (cairo_font_face_t *font_face, cairo_user_scaled_font_init_func_t init_func)
 
void cairo_user_font_face_set_render_glyph_func (cairo_font_face_t *font_face, cairo_user_scaled_font_render_glyph_func_t render_glyph_func)
 
void cairo_user_font_face_set_text_to_glyphs_func (cairo_font_face_t *font_face, cairo_user_scaled_font_text_to_glyphs_func_t text_to_glyphs_func)
 
void cairo_user_font_face_set_unicode_to_glyph_func (cairo_font_face_t *font_face, cairo_user_scaled_font_unicode_to_glyph_func_t unicode_to_glyph_func)
 
cairo_user_scaled_font_init_func_t cairo_user_font_face_get_init_func (cairo_font_face_t *font_face)
 
cairo_user_scaled_font_render_glyph_func_t cairo_user_font_face_get_render_glyph_func (cairo_font_face_t *font_face)
 
cairo_user_scaled_font_text_to_glyphs_func_t cairo_user_font_face_get_text_to_glyphs_func (cairo_font_face_t *font_face)
 
cairo_user_scaled_font_unicode_to_glyph_func_t cairo_user_font_face_get_unicode_to_glyph_func (cairo_font_face_t *font_face)
 
cairo_operator_t cairo_get_operator (cairo_t *cr)
 
cairo_pattern_tcairo_get_source (cairo_t *cr)
 
double cairo_get_tolerance (cairo_t *cr)
 
cairo_antialias_t cairo_get_antialias (cairo_t *cr)
 
cairo_bool_t cairo_has_current_point (cairo_t *cr)
 
void cairo_get_current_point (cairo_t *cr, double *x, double *y)
 
cairo_fill_rule_t cairo_get_fill_rule (cairo_t *cr)
 
double cairo_get_line_width (cairo_t *cr)
 
cairo_line_cap_t cairo_get_line_cap (cairo_t *cr)
 
cairo_line_join_t cairo_get_line_join (cairo_t *cr)
 
double cairo_get_miter_limit (cairo_t *cr)
 
int cairo_get_dash_count (cairo_t *cr)
 
void cairo_get_dash (cairo_t *cr, double *dashes, double *offset)
 
void cairo_get_matrix (cairo_t *cr, cairo_matrix_t *matrix)
 
cairo_surface_tcairo_get_target (cairo_t *cr)
 
cairo_surface_tcairo_get_group_target (cairo_t *cr)
 
cairo_path_tcairo_copy_path (cairo_t *cr)
 
cairo_path_tcairo_copy_path_flat (cairo_t *cr)
 
void cairo_append_path (cairo_t *cr, const cairo_path_t *path)
 
void cairo_path_destroy (cairo_path_t *path)
 
cairo_status_t cairo_status (cairo_t *cr)
 
const char * cairo_status_to_string (cairo_status_t status)
 
cairo_device_tcairo_device_reference (cairo_device_t *device)
 
cairo_device_type_t cairo_device_get_type (cairo_device_t *device)
 
cairo_status_t cairo_device_status (cairo_device_t *device)
 
cairo_status_t cairo_device_acquire (cairo_device_t *device)
 
void cairo_device_release (cairo_device_t *device)
 
void cairo_device_flush (cairo_device_t *device)
 
void cairo_device_finish (cairo_device_t *device)
 
void cairo_device_destroy (cairo_device_t *device)
 
unsigned int cairo_device_get_reference_count (cairo_device_t *device)
 
voidcairo_device_get_user_data (cairo_device_t *device, const cairo_user_data_key_t *key)
 
cairo_status_t cairo_device_set_user_data (cairo_device_t *device, const cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy)
 
cairo_surface_tcairo_surface_create_similar (cairo_surface_t *other, cairo_content_t content, int width, int height)
 
cairo_surface_tcairo_surface_create_similar_image (cairo_surface_t *other, cairo_format_t format, int width, int height)
 
cairo_surface_tcairo_surface_map_to_image (cairo_surface_t *surface, const cairo_rectangle_int_t *extents)
 
void cairo_surface_unmap_image (cairo_surface_t *surface, cairo_surface_t *image)
 
cairo_surface_tcairo_surface_create_for_rectangle (cairo_surface_t *target, double x, double y, double width, double height)
 
cairo_surface_tcairo_surface_create_observer (cairo_surface_t *target, cairo_surface_observer_mode_t mode)
 
cairo_status_t cairo_surface_observer_add_paint_callback (cairo_surface_t *abstract_surface, cairo_surface_observer_callback_t func, void *data)
 
cairo_status_t cairo_surface_observer_add_mask_callback (cairo_surface_t *abstract_surface, cairo_surface_observer_callback_t func, void *data)
 
cairo_status_t cairo_surface_observer_add_fill_callback (cairo_surface_t *abstract_surface, cairo_surface_observer_callback_t func, void *data)
 
cairo_status_t cairo_surface_observer_add_stroke_callback (cairo_surface_t *abstract_surface, cairo_surface_observer_callback_t func, void *data)
 
cairo_status_t cairo_surface_observer_add_glyphs_callback (cairo_surface_t *abstract_surface, cairo_surface_observer_callback_t func, void *data)
 
cairo_status_t cairo_surface_observer_add_flush_callback (cairo_surface_t *abstract_surface, cairo_surface_observer_callback_t func, void *data)
 
cairo_status_t cairo_surface_observer_add_finish_callback (cairo_surface_t *abstract_surface, cairo_surface_observer_callback_t func, void *data)
 
cairo_status_t cairo_surface_observer_print (cairo_surface_t *surface, cairo_write_func_t write_func, void *closure)
 
double cairo_surface_observer_elapsed (cairo_surface_t *surface)
 
cairo_status_t cairo_device_observer_print (cairo_device_t *device, cairo_write_func_t write_func, void *closure)
 
double cairo_device_observer_elapsed (cairo_device_t *device)
 
double cairo_device_observer_paint_elapsed (cairo_device_t *device)
 
double cairo_device_observer_mask_elapsed (cairo_device_t *device)
 
double cairo_device_observer_fill_elapsed (cairo_device_t *device)
 
double cairo_device_observer_stroke_elapsed (cairo_device_t *device)
 
double cairo_device_observer_glyphs_elapsed (cairo_device_t *device)
 
cairo_surface_tcairo_surface_reference (cairo_surface_t *surface)
 
void cairo_surface_finish (cairo_surface_t *surface)
 
void cairo_surface_destroy (cairo_surface_t *surface)
 
cairo_device_tcairo_surface_get_device (cairo_surface_t *surface)
 
unsigned int cairo_surface_get_reference_count (cairo_surface_t *surface)
 
cairo_status_t cairo_surface_status (cairo_surface_t *surface)
 
cairo_surface_type_t cairo_surface_get_type (cairo_surface_t *surface)
 
cairo_content_t cairo_surface_get_content (cairo_surface_t *surface)
 
cairo_status_t cairo_surface_write_to_png (cairo_surface_t *surface, const char *filename)
 
cairo_status_t cairo_surface_write_to_png_stream (cairo_surface_t *surface, cairo_write_func_t write_func, void *closure)
 
voidcairo_surface_get_user_data (cairo_surface_t *surface, const cairo_user_data_key_t *key)
 
cairo_status_t cairo_surface_set_user_data (cairo_surface_t *surface, const cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy)
 
void cairo_surface_get_mime_data (cairo_surface_t *surface, const char *mime_type, const unsigned char **data, unsigned long *length)
 
cairo_status_t cairo_surface_set_mime_data (cairo_surface_t *surface, const char *mime_type, const unsigned char *data, unsigned long length, cairo_destroy_func_t destroy, void *closure)
 
cairo_bool_t cairo_surface_supports_mime_type (cairo_surface_t *surface, const char *mime_type)
 
void cairo_surface_get_font_options (cairo_surface_t *surface, cairo_font_options_t *options)
 
void cairo_surface_flush (cairo_surface_t *surface)
 
void cairo_surface_mark_dirty (cairo_surface_t *surface)
 
void cairo_surface_mark_dirty_rectangle (cairo_surface_t *surface, int x, int y, int width, int height)
 
void cairo_surface_set_device_scale (cairo_surface_t *surface, double x_scale, double y_scale)
 
void cairo_surface_get_device_scale (cairo_surface_t *surface, double *x_scale, double *y_scale)
 
void cairo_surface_set_device_offset (cairo_surface_t *surface, double x_offset, double y_offset)
 
void cairo_surface_get_device_offset (cairo_surface_t *surface, double *x_offset, double *y_offset)
 
void cairo_surface_set_fallback_resolution (cairo_surface_t *surface, double x_pixels_per_inch, double y_pixels_per_inch)
 
void cairo_surface_get_fallback_resolution (cairo_surface_t *surface, double *x_pixels_per_inch, double *y_pixels_per_inch)
 
void cairo_surface_copy_page (cairo_surface_t *surface)
 
void cairo_surface_show_page (cairo_surface_t *surface)
 
cairo_bool_t cairo_surface_has_show_text_glyphs (cairo_surface_t *surface)
 
cairo_surface_tcairo_image_surface_create (cairo_format_t format, int width, int height)
 
int cairo_format_stride_for_width (cairo_format_t format, int width)
 
cairo_surface_tcairo_image_surface_create_for_data (unsigned char *data, cairo_format_t format, int width, int height, int stride)
 
unsigned char * cairo_image_surface_get_data (cairo_surface_t *surface)
 
cairo_format_t cairo_image_surface_get_format (cairo_surface_t *surface)
 
int cairo_image_surface_get_width (cairo_surface_t *surface)
 
int cairo_image_surface_get_height (cairo_surface_t *surface)
 
int cairo_image_surface_get_stride (cairo_surface_t *surface)
 
cairo_surface_tcairo_image_surface_create_from_png (const char *filename)
 
cairo_surface_tcairo_image_surface_create_from_png_stream (cairo_read_func_t read_func, void *closure)
 
cairo_surface_tcairo_recording_surface_create (cairo_content_t content, const cairo_rectangle_t *extents)
 
void cairo_recording_surface_ink_extents (cairo_surface_t *surface, double *x0, double *y0, double *width, double *height)
 
cairo_bool_t cairo_recording_surface_get_extents (cairo_surface_t *surface, cairo_rectangle_t *extents)
 
cairo_pattern_tcairo_pattern_create_raster_source (void *user_data, cairo_content_t content, int width, int height)
 
void cairo_raster_source_pattern_set_callback_data (cairo_pattern_t *pattern, void *data)
 
voidcairo_raster_source_pattern_get_callback_data (cairo_pattern_t *pattern)
 
void cairo_raster_source_pattern_set_acquire (cairo_pattern_t *pattern, cairo_raster_source_acquire_func_t acquire, cairo_raster_source_release_func_t release)
 
void cairo_raster_source_pattern_get_acquire (cairo_pattern_t *pattern, cairo_raster_source_acquire_func_t *acquire, cairo_raster_source_release_func_t *release)
 
void cairo_raster_source_pattern_set_snapshot (cairo_pattern_t *pattern, cairo_raster_source_snapshot_func_t snapshot)
 
cairo_raster_source_snapshot_func_t cairo_raster_source_pattern_get_snapshot (cairo_pattern_t *pattern)
 
void cairo_raster_source_pattern_set_copy (cairo_pattern_t *pattern, cairo_raster_source_copy_func_t copy)
 
cairo_raster_source_copy_func_t cairo_raster_source_pattern_get_copy (cairo_pattern_t *pattern)
 
void cairo_raster_source_pattern_set_finish (cairo_pattern_t *pattern, cairo_raster_source_finish_func_t finish)
 
cairo_raster_source_finish_func_t cairo_raster_source_pattern_get_finish (cairo_pattern_t *pattern)
 
cairo_pattern_tcairo_pattern_create_rgb (double red, double green, double blue)
 
cairo_pattern_tcairo_pattern_create_rgba (double red, double green, double blue, double alpha)
 
cairo_pattern_tcairo_pattern_create_for_surface (cairo_surface_t *surface)
 
cairo_pattern_tcairo_pattern_create_linear (double x0, double y0, double x1, double y1)
 
cairo_pattern_tcairo_pattern_create_radial (double cx0, double cy0, double radius0, double cx1, double cy1, double radius1)
 
cairo_pattern_tcairo_pattern_create_mesh (void)
 
cairo_pattern_tcairo_pattern_reference (cairo_pattern_t *pattern)
 
void cairo_pattern_destroy (cairo_pattern_t *pattern)
 
unsigned int cairo_pattern_get_reference_count (cairo_pattern_t *pattern)
 
cairo_status_t cairo_pattern_status (cairo_pattern_t *pattern)
 
voidcairo_pattern_get_user_data (cairo_pattern_t *pattern, const cairo_user_data_key_t *key)
 
cairo_status_t cairo_pattern_set_user_data (cairo_pattern_t *pattern, const cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy)
 
cairo_pattern_type_t cairo_pattern_get_type (cairo_pattern_t *pattern)
 
void cairo_pattern_add_color_stop_rgb (cairo_pattern_t *pattern, double offset, double red, double green, double blue)
 
void cairo_pattern_add_color_stop_rgba (cairo_pattern_t *pattern, double offset, double red, double green, double blue, double alpha)
 
void cairo_mesh_pattern_begin_patch (cairo_pattern_t *pattern)
 
void cairo_mesh_pattern_end_patch (cairo_pattern_t *pattern)
 
void cairo_mesh_pattern_curve_to (cairo_pattern_t *pattern, double x1, double y1, double x2, double y2, double x3, double y3)
 
void cairo_mesh_pattern_line_to (cairo_pattern_t *pattern, double x, double y)
 
void cairo_mesh_pattern_move_to (cairo_pattern_t *pattern, double x, double y)
 
void cairo_mesh_pattern_set_control_point (cairo_pattern_t *pattern, unsigned int point_num, double x, double y)
 
void cairo_mesh_pattern_set_corner_color_rgb (cairo_pattern_t *pattern, unsigned int corner_num, double red, double green, double blue)
 
void cairo_mesh_pattern_set_corner_color_rgba (cairo_pattern_t *pattern, unsigned int corner_num, double red, double green, double blue, double alpha)
 
void cairo_pattern_set_matrix (cairo_pattern_t *pattern, const cairo_matrix_t *matrix)
 
void cairo_pattern_get_matrix (cairo_pattern_t *pattern, cairo_matrix_t *matrix)
 
void cairo_pattern_set_extend (cairo_pattern_t *pattern, cairo_extend_t extend)
 
cairo_extend_t cairo_pattern_get_extend (cairo_pattern_t *pattern)
 
void cairo_pattern_set_filter (cairo_pattern_t *pattern, cairo_filter_t filter)
 
cairo_filter_t cairo_pattern_get_filter (cairo_pattern_t *pattern)
 
cairo_status_t cairo_pattern_get_rgba (cairo_pattern_t *pattern, double *red, double *green, double *blue, double *alpha)
 
cairo_status_t cairo_pattern_get_surface (cairo_pattern_t *pattern, cairo_surface_t **surface)
 
cairo_status_t cairo_pattern_get_color_stop_rgba (cairo_pattern_t *pattern, int index, double *offset, double *red, double *green, double *blue, double *alpha)
 
cairo_status_t cairo_pattern_get_color_stop_count (cairo_pattern_t *pattern, int *count)
 
cairo_status_t cairo_pattern_get_linear_points (cairo_pattern_t *pattern, double *x0, double *y0, double *x1, double *y1)
 
cairo_status_t cairo_pattern_get_radial_circles (cairo_pattern_t *pattern, double *x0, double *y0, double *r0, double *x1, double *y1, double *r1)
 
cairo_status_t cairo_mesh_pattern_get_patch_count (cairo_pattern_t *pattern, unsigned int *count)
 
cairo_path_tcairo_mesh_pattern_get_path (cairo_pattern_t *pattern, unsigned int patch_num)
 
cairo_status_t cairo_mesh_pattern_get_corner_color_rgba (cairo_pattern_t *pattern, unsigned int patch_num, unsigned int corner_num, double *red, double *green, double *blue, double *alpha)
 
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)
 
void cairo_matrix_init (cairo_matrix_t *matrix, double xx, double yx, double xy, double yy, double x0, double y0)
 
void cairo_matrix_init_identity (cairo_matrix_t *matrix)
 
void cairo_matrix_init_translate (cairo_matrix_t *matrix, double tx, double ty)
 
void cairo_matrix_init_scale (cairo_matrix_t *matrix, double sx, double sy)
 
void cairo_matrix_init_rotate (cairo_matrix_t *matrix, double radians)
 
void cairo_matrix_translate (cairo_matrix_t *matrix, double tx, double ty)
 
void cairo_matrix_scale (cairo_matrix_t *matrix, double sx, double sy)
 
void cairo_matrix_rotate (cairo_matrix_t *matrix, double radians)
 
cairo_status_t cairo_matrix_invert (cairo_matrix_t *matrix)
 
void cairo_matrix_multiply (cairo_matrix_t *result, const cairo_matrix_t *a, const cairo_matrix_t *b)
 
void cairo_matrix_transform_distance (const cairo_matrix_t *matrix, double *dx, double *dy)
 
void cairo_matrix_transform_point (const cairo_matrix_t *matrix, double *x, double *y)
 
cairo_region_tcairo_region_create (void)
 
cairo_region_tcairo_region_create_rectangle (const cairo_rectangle_int_t *rectangle)
 
cairo_region_tcairo_region_create_rectangles (const cairo_rectangle_int_t *rects, int count)
 
cairo_region_tcairo_region_copy (const cairo_region_t *original)
 
cairo_region_tcairo_region_reference (cairo_region_t *region)
 
void cairo_region_destroy (cairo_region_t *region)
 
cairo_bool_t cairo_region_equal (const cairo_region_t *a, const cairo_region_t *b)
 
cairo_status_t cairo_region_status (const cairo_region_t *region)
 
void cairo_region_get_extents (const cairo_region_t *region, cairo_rectangle_int_t *extents)
 
int cairo_region_num_rectangles (const cairo_region_t *region)
 
void cairo_region_get_rectangle (const cairo_region_t *region, int nth, cairo_rectangle_int_t *rectangle)
 
cairo_bool_t cairo_region_is_empty (const cairo_region_t *region)
 
cairo_region_overlap_t cairo_region_contains_rectangle (const cairo_region_t *region, const cairo_rectangle_int_t *rectangle)
 
cairo_bool_t cairo_region_contains_point (const cairo_region_t *region, int x, int y)
 
void cairo_region_translate (cairo_region_t *region, int dx, int dy)
 
cairo_status_t cairo_region_subtract (cairo_region_t *dst, const cairo_region_t *other)
 
cairo_status_t cairo_region_subtract_rectangle (cairo_region_t *dst, const cairo_rectangle_int_t *rectangle)
 
cairo_status_t cairo_region_intersect (cairo_region_t *dst, const cairo_region_t *other)
 
cairo_status_t cairo_region_intersect_rectangle (cairo_region_t *dst, const cairo_rectangle_int_t *rectangle)
 
cairo_status_t cairo_region_union (cairo_region_t *dst, const cairo_region_t *other)
 
cairo_status_t cairo_region_union_rectangle (cairo_region_t *dst, const cairo_rectangle_int_t *rectangle)
 
cairo_status_t cairo_region_xor (cairo_region_t *dst, const cairo_region_t *other)
 
cairo_status_t cairo_region_xor_rectangle (cairo_region_t *dst, const cairo_rectangle_int_t *rectangle)
 
void cairo_debug_reset_static_data (void)
 

Macro Definition Documentation

◆ CAIRO_BEGIN_DECLS

#define CAIRO_BEGIN_DECLS

Definition at line 49 of file cairo.h.

◆ CAIRO_END_DECLS

#define CAIRO_END_DECLS

Definition at line 50 of file cairo.h.

◆ CAIRO_MIME_TYPE_CCITT_FAX

#define CAIRO_MIME_TYPE_CCITT_FAX   "image/g3fax"

Definition at line 2462 of file cairo.h.

◆ CAIRO_MIME_TYPE_CCITT_FAX_PARAMS

#define CAIRO_MIME_TYPE_CCITT_FAX_PARAMS   "application/x-cairo.ccitt.params"

Definition at line 2463 of file cairo.h.

◆ CAIRO_MIME_TYPE_EPS

#define CAIRO_MIME_TYPE_EPS   "application/postscript"

Definition at line 2464 of file cairo.h.

◆ CAIRO_MIME_TYPE_EPS_PARAMS

#define CAIRO_MIME_TYPE_EPS_PARAMS   "application/x-cairo.eps.params"

Definition at line 2465 of file cairo.h.

◆ CAIRO_MIME_TYPE_JBIG2

#define CAIRO_MIME_TYPE_JBIG2   "application/x-cairo.jbig2"

Definition at line 2459 of file cairo.h.

◆ CAIRO_MIME_TYPE_JBIG2_GLOBAL

#define CAIRO_MIME_TYPE_JBIG2_GLOBAL   "application/x-cairo.jbig2-global"

Definition at line 2460 of file cairo.h.

◆ CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID

#define CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID   "application/x-cairo.jbig2-global-id"

Definition at line 2461 of file cairo.h.

◆ CAIRO_MIME_TYPE_JP2

#define CAIRO_MIME_TYPE_JP2   "image/jp2"

Definition at line 2456 of file cairo.h.

◆ CAIRO_MIME_TYPE_JPEG

#define CAIRO_MIME_TYPE_JPEG   "image/jpeg"

Definition at line 2454 of file cairo.h.

◆ CAIRO_MIME_TYPE_PNG

#define CAIRO_MIME_TYPE_PNG   "image/png"

Definition at line 2455 of file cairo.h.

◆ CAIRO_MIME_TYPE_UNIQUE_ID

#define CAIRO_MIME_TYPE_UNIQUE_ID   "application/x-cairo.uuid"

Definition at line 2458 of file cairo.h.

◆ CAIRO_MIME_TYPE_URI

#define CAIRO_MIME_TYPE_URI   "text/x-uri"

Definition at line 2457 of file cairo.h.

◆ cairo_public

#define cairo_public

Definition at line 57 of file cairo.h.

◆ CAIRO_TAG_DEST

#define CAIRO_TAG_DEST   "cairo.dest"

Definition at line 1031 of file cairo.h.

◆ CAIRO_TAG_LINK

#define CAIRO_TAG_LINK   "Link"

Definition at line 1032 of file cairo.h.

◆ CAIRO_VERSION

#define CAIRO_VERSION
Value:
#define CAIRO_VERSION_MINOR
Definition: cairo-version.h:5
#define CAIRO_VERSION_MICRO
Definition: cairo-version.h:6
#define CAIRO_VERSION_MAJOR
Definition: cairo-version.h:4
#define CAIRO_VERSION_ENCODE(major, minor, micro)
Definition: cairo.h:63

Definition at line 68 of file cairo.h.

◆ CAIRO_VERSION_ENCODE

#define CAIRO_VERSION_ENCODE (   major,
  minor,
  micro 
)
Value:
( \
((major) * 10000) \
+ ((minor) * 100) \
+ ((micro) * 1))
int major
Definition: pdfcolor.c:526
int minor
Definition: pdfcolor.c:527

Definition at line 63 of file cairo.h.

◆ CAIRO_VERSION_STRING

#define CAIRO_VERSION_STRING
Value:
#define CAIRO_VERSION_STRINGIZE(major, minor, micro)
Definition: cairo.h:76

Definition at line 79 of file cairo.h.

◆ CAIRO_VERSION_STRINGIZE

#define CAIRO_VERSION_STRINGIZE (   major,
  minor,
  micro 
)     CAIRO_VERSION_STRINGIZE_(major, minor, micro)

Definition at line 76 of file cairo.h.

◆ CAIRO_VERSION_STRINGIZE_

#define CAIRO_VERSION_STRINGIZE_ (   major,
  minor,
  micro 
)     #major"."#minor"."#micro

Definition at line 74 of file cairo.h.

Typedef Documentation

◆ cairo_antialias_t

cairo_antialias_t: @CAIRO_ANTIALIAS_DEFAULT: Use the default antialiasing for the subsystem and target device, since 1.0 @CAIRO_ANTIALIAS_NONE: Use a bilevel alpha mask, since 1.0 @CAIRO_ANTIALIAS_GRAY: Perform single-color antialiasing (using shades of gray for black text on a white background, for example), since 1.0 @CAIRO_ANTIALIAS_SUBPIXEL: Perform antialiasing by taking advantage of the order of subpixel elements on devices such as LCD panels, since 1.0 @CAIRO_ANTIALIAS_FAST: Hint that the backend should perform some antialiasing but prefer speed over quality, since 1.12 @CAIRO_ANTIALIAS_GOOD: The backend should balance quality against performance, since 1.12 @CAIRO_ANTIALIAS_BEST: Hint that the backend should render at the highest quality, sacrificing speed if necessary, since 1.12

Specifies the type of antialiasing to do when rendering text or shapes.

As it is not necessarily clear from the above what advantages a particular antialias method provides, since 1.12, there is also a set of hints: @CAIRO_ANTIALIAS_FAST: Allow the backend to degrade raster quality for speed @CAIRO_ANTIALIAS_GOOD: A balance between speed and quality @CAIRO_ANTIALIAS_BEST: A high-fidelity, but potentially slow, raster mode

These make no guarantee on how the backend will perform its rasterisation (if it even rasterises!), nor that they have any differing effect other than to enable some form of antialiasing. In the case of glyph rendering, @CAIRO_ANTIALIAS_FAST and @CAIRO_ANTIALIAS_GOOD will be mapped to @CAIRO_ANTIALIAS_GRAY, with @CAIRO_ANTALIAS_BEST being equivalent to @CAIRO_ANTIALIAS_SUBPIXEL.

The interpretation of @CAIRO_ANTIALIAS_DEFAULT is left entirely up to the backend, typically this will be similar to @CAIRO_ANTIALIAS_GOOD.

Since: 1.0

◆ cairo_bool_t

typedef int cairo_bool_t

cairo_bool_t:

cairo_bool_t is used for boolean values. Returns of type cairo_bool_t will always be either 0 or 1, but testing against these values explicitly is not encouraged; just use the value as a boolean condition.

<informalexample><programlisting> if (cairo_in_stroke (cr, x, y)) { /* do something */ } </programlisting></informalexample>

Since: 1.0

Definition at line 107 of file cairo.h.

◆ cairo_content_t

cairo_content_t: @CAIRO_CONTENT_COLOR: The surface will hold color content only. (Since 1.0) @CAIRO_CONTENT_ALPHA: The surface will hold alpha content only. (Since 1.0) @CAIRO_CONTENT_COLOR_ALPHA: The surface will hold color and alpha content. (Since 1.0)

cairo_content_t is used to describe the content that a surface will contain, whether color information, alpha information (translucence vs. opacity), or both.

Note: The large values here are designed to keep cairo_content_t values distinct from cairo_format_t values so that the implementation can detect the error if users confuse the two types.

Since: 1.0

◆ cairo_destroy_func_t

typedef void(* cairo_destroy_func_t) (void *data)

cairo_destroy_func_t: @data: The data element being destroyed.

cairo_destroy_func_t the type of function which is called when a data element is destroyed. It is passed the pointer to the data element and should free any memory and resources allocated for it.

Since: 1.0

Definition at line 232 of file cairo.h.

◆ cairo_device_t

typedef struct _cairo_device cairo_device_t

cairo_device_t:

A cairo_device_t represents the driver interface for drawing operations to a cairo_surface_t. There are different subtypes of cairo_device_t for different drawing backends; for example, cairo_egl_device_create() creates a device that wraps an EGL display and context.

The type of a device can be queried with cairo_device_get_type().

Memory management of cairo_device_t is done with cairo_device_reference() and cairo_device_destroy().

Since: 1.10

Definition at line 107 of file cairo.h.

◆ cairo_device_type_t

cairo_device_type_t: @CAIRO_DEVICE_TYPE_DRM: The device is of type Direct Render Manager, since 1.10 @CAIRO_DEVICE_TYPE_GL: The device is of type OpenGL, since 1.10 @CAIRO_DEVICE_TYPE_SCRIPT: The device is of type script, since 1.10 @CAIRO_DEVICE_TYPE_XCB: The device is of type xcb, since 1.10 @CAIRO_DEVICE_TYPE_XLIB: The device is of type xlib, since 1.10 @CAIRO_DEVICE_TYPE_XML: The device is of type XML, since 1.10 @CAIRO_DEVICE_TYPE_COGL: The device is of type cogl, since 1.12 @CAIRO_DEVICE_TYPE_WIN32: The device is of type win32, since 1.12 @CAIRO_DEVICE_TYPE_INVALID: The device is invalid, since 1.10

cairo_device_type_t is used to describe the type of a given device. The devices types are also known as "backends" within cairo.

The device type can be queried with cairo_device_get_type()

The various cairo_device_t functions can be used with devices of any type, but some backends also provide type-specific functions that must only be called with a device of the appropriate type. These functions have names that begin with <literal>cairo_<emphasis>type</emphasis>_device</literal> such as cairo_xcb_device_debug_cap_xrender_version().

The behavior of calling a type-specific function with a device of the wrong type is undefined.

New entries may be added in future versions.

Since: 1.10

◆ cairo_extend_t

cairo_extend_t: @CAIRO_EXTEND_NONE: pixels outside of the source pattern are fully transparent (Since 1.0) @CAIRO_EXTEND_REPEAT: the pattern is tiled by repeating (Since 1.0) @CAIRO_EXTEND_REFLECT: the pattern is tiled by reflecting at the edges (Since 1.0; but only implemented for surface patterns since 1.6) @CAIRO_EXTEND_PAD: pixels outside of the pattern copy the closest pixel from the source (Since 1.2; but only implemented for surface patterns since 1.6)

cairo_extend_t is used to describe how pattern color/alpha will be determined for areas "outside" the pattern's natural area, (for example, outside the surface bounds or outside the gradient geometry).

Mesh patterns are not affected by the extend mode.

The default extend mode is CAIRO_EXTEND_NONE for surface patterns and CAIRO_EXTEND_PAD for gradient patterns.

New entries may be added in future versions.

Since: 1.0

◆ cairo_fill_rule_t

cairo_fill_rule_t: @CAIRO_FILL_RULE_WINDING: If the path crosses the ray from left-to-right, counts +1. If the path crosses the ray from right to left, counts -1. (Left and right are determined from the perspective of looking along the ray from the starting point.) If the total count is non-zero, the point will be filled. (Since 1.0) @CAIRO_FILL_RULE_EVEN_ODD: Counts the total number of intersections, without regard to the orientation of the contour. If the total number of intersections is odd, the point will be filled. (Since 1.0)

cairo_fill_rule_t is used to select how paths are filled. For both fill rules, whether or not a point is included in the fill is determined by taking a ray from that point to infinity and looking at intersections with the path. The ray can be in any direction, as long as it doesn't pass through the end point of a segment or have a tricky intersection such as intersecting tangent to the path. (Note that filling is not actually implemented in this way. This is just a description of the rule that is applied.)

The default fill rule is CAIRO_FILL_RULE_WINDING.

New entries may be added in future versions.

Since: 1.0

◆ cairo_filter_t

cairo_filter_t: @CAIRO_FILTER_FAST: A high-performance filter, with quality similar to CAIRO_FILTER_NEAREST (Since 1.0) @CAIRO_FILTER_GOOD: A reasonable-performance filter, with quality similar to CAIRO_FILTER_BILINEAR (Since 1.0) @CAIRO_FILTER_BEST: The highest-quality available, performance may not be suitable for interactive use. (Since 1.0) @CAIRO_FILTER_NEAREST: Nearest-neighbor filtering (Since 1.0) @CAIRO_FILTER_BILINEAR: Linear interpolation in two dimensions (Since 1.0) @CAIRO_FILTER_GAUSSIAN: This filter value is currently unimplemented, and should not be used in current code. (Since 1.0)

cairo_filter_t is used to indicate what filtering should be applied when reading pixel values from patterns. See cairo_pattern_set_filter() for indicating the desired filter to be used with a particular pattern.

Since: 1.0

◆ cairo_font_face_t

cairo_font_face_t:

A cairo_font_face_t specifies all aspects of a font other than the size or font matrix (a font matrix is used to distort a font by shearing it or scaling it unequally in the two directions) . A font face can be set on a cairo_t by using cairo_set_font_face(); the size and font matrix are set with cairo_set_font_size() and cairo_set_font_matrix().

There are various types of font faces, depending on the <firstterm>font backend</firstterm> they use. The type of a font face can be queried using cairo_font_face_get_type().

Memory management of cairo_font_face_t is done with cairo_font_face_reference() and cairo_font_face_destroy().

Since: 1.0

Definition at line 1038 of file cairo.h.

◆ cairo_font_options_t

cairo_font_options_t:

An opaque structure holding all options that are used when rendering fonts.

Individual features of a cairo_font_options_t can be set or accessed using functions named <function>cairo_font_options_set_<emphasis>feature_name</emphasis>()</function> and <function>cairo_font_options_get_<emphasis>feature_name</emphasis>()</function>, like cairo_font_options_set_antialias() and cairo_font_options_get_antialias().

New features may be added to a cairo_font_options_t in the future. For this reason, cairo_font_options_copy(), cairo_font_options_equal(), cairo_font_options_merge(), and cairo_font_options_hash() should be used to copy, check for equality, merge, or compute a hash value of cairo_font_options_t objects.

Since: 1.0

Definition at line 1149 of file cairo.h.

◆ cairo_font_slant_t

cairo_font_slant_t: @CAIRO_FONT_SLANT_NORMAL: Upright font style, since 1.0 @CAIRO_FONT_SLANT_ITALIC: Italic font style, since 1.0 @CAIRO_FONT_SLANT_OBLIQUE: Oblique font style, since 1.0

Specifies variants of a font face based on their slant.

Since: 1.0

◆ cairo_font_type_t

cairo_font_type_t: @CAIRO_FONT_TYPE_TOY: The font was created using cairo's toy font api (Since: 1.2) @CAIRO_FONT_TYPE_FT: The font is of type FreeType (Since: 1.2) @CAIRO_FONT_TYPE_WIN32: The font is of type Win32 (Since: 1.2) @CAIRO_FONT_TYPE_QUARTZ: The font is of type Quartz (Since: 1.6, in 1.2 and 1.4 it was named CAIRO_FONT_TYPE_ATSUI) @CAIRO_FONT_TYPE_USER: The font was create using cairo's user font api (Since: 1.8)

cairo_font_type_t is used to describe the type of a given font face or scaled font. The font types are also known as "font backends" within cairo.

The type of a font face is determined by the function used to create it, which will generally be of the form <function>cairo_<emphasis>type</emphasis>_font_face_create()</function>. The font face type can be queried with cairo_font_face_get_type()

The various cairo_font_face_t functions can be used with a font face of any type.

The type of a scaled font is determined by the type of the font face passed to cairo_scaled_font_create(). The scaled font type can be queried with cairo_scaled_font_get_type()

The various cairo_scaled_font_t functions can be used with scaled fonts of any type, but some font backends also provide type-specific functions that must only be called with a scaled font of the appropriate type. These functions have names that begin with <function>cairo_<emphasis>type</emphasis>_scaled_font()</function> such as cairo_ft_scaled_font_lock_face().

The behavior of calling a type-specific function with a scaled font of the wrong type is undefined.

New entries may be added in future versions.

Since: 1.2

◆ cairo_font_weight_t

cairo_font_weight_t: @CAIRO_FONT_WEIGHT_NORMAL: Normal font weight, since 1.0 @CAIRO_FONT_WEIGHT_BOLD: Bold font weight, since 1.0

Specifies variants of a font face based on their weight.

Since: 1.0

◆ cairo_format_t

cairo_format_t: @CAIRO_FORMAT_INVALID: no such format exists or is supported. @CAIRO_FORMAT_ARGB32: each pixel is a 32-bit quantity, with alpha in the upper 8 bits, then red, then green, then blue. The 32-bit quantities are stored native-endian. Pre-multiplied alpha is used. (That is, 50% transparent red is 0x80800000, not 0x80ff0000.) (Since 1.0) @CAIRO_FORMAT_RGB24: each pixel is a 32-bit quantity, with the upper 8 bits unused. Red, Green, and Blue are stored in the remaining 24 bits in that order. (Since 1.0) @CAIRO_FORMAT_A8: each pixel is a 8-bit quantity holding an alpha value. (Since 1.0) @CAIRO_FORMAT_A1: each pixel is a 1-bit quantity holding an alpha value. Pixels are packed together into 32-bit quantities. The ordering of the bits matches the endianness of the platform. On a big-endian machine, the first pixel is in the uppermost bit, on a little-endian machine the first pixel is in the least-significant bit. (Since 1.0) @CAIRO_FORMAT_RGB16_565: each pixel is a 16-bit quantity with red in the upper 5 bits, then green in the middle 6 bits, and blue in the lower 5 bits. (Since 1.2) @CAIRO_FORMAT_RGB30: like RGB24 but with 10bpc. (Since 1.12)

cairo_format_t is used to identify the memory format of image data.

New entries may be added in future versions.

Since: 1.0

◆ cairo_hint_metrics_t

cairo_hint_metrics_t: @CAIRO_HINT_METRICS_DEFAULT: Hint metrics in the default manner for the font backend and target device, since 1.0 @CAIRO_HINT_METRICS_OFF: Do not hint font metrics, since 1.0 @CAIRO_HINT_METRICS_ON: Hint font metrics, since 1.0

Specifies whether to hint font metrics; hinting font metrics means quantizing them so that they are integer values in device space. Doing this improves the consistency of letter and line spacing, however it also means that text will be laid out differently at different zoom factors.

Since: 1.0

◆ cairo_hint_style_t

cairo_hint_style_t: @CAIRO_HINT_STYLE_DEFAULT: Use the default hint style for font backend and target device, since 1.0 @CAIRO_HINT_STYLE_NONE: Do not hint outlines, since 1.0 @CAIRO_HINT_STYLE_SLIGHT: Hint outlines slightly to improve contrast while retaining good fidelity to the original shapes, since 1.0 @CAIRO_HINT_STYLE_MEDIUM: Hint outlines with medium strength giving a compromise between fidelity to the original shapes and contrast, since 1.0 @CAIRO_HINT_STYLE_FULL: Hint outlines to maximize contrast, since 1.0

Specifies the type of hinting to do on font outlines. Hinting is the process of fitting outlines to the pixel grid in order to improve the appearance of the result. Since hinting outlines involves distorting them, it also reduces the faithfulness to the original outline shapes. Not all of the outline hinting styles are supported by all font backends.

New entries may be added in future versions.

Since: 1.0

◆ cairo_line_cap_t

cairo_line_cap_t: @CAIRO_LINE_CAP_BUTT: start(stop) the line exactly at the start(end) point (Since 1.0) @CAIRO_LINE_CAP_ROUND: use a round ending, the center of the circle is the end point (Since 1.0) @CAIRO_LINE_CAP_SQUARE: use squared ending, the center of the square is the end point (Since 1.0)

Specifies how to render the endpoints of the path when stroking.

The default line cap style is CAIRO_LINE_CAP_BUTT.

Since: 1.0

◆ cairo_line_join_t

cairo_line_join_t: @CAIRO_LINE_JOIN_MITER: use a sharp (angled) corner, see cairo_set_miter_limit() (Since 1.0) @CAIRO_LINE_JOIN_ROUND: use a rounded join, the center of the circle is the joint point (Since 1.0) @CAIRO_LINE_JOIN_BEVEL: use a cut-off join, the join is cut off at half the line width from the joint point (Since 1.0)

Specifies how to render the junction of two lines when stroking.

The default line join style is CAIRO_LINE_JOIN_MITER.

Since: 1.0

◆ cairo_matrix_t

typedef struct _cairo_matrix cairo_matrix_t

cairo_matrix_t: @xx: xx component of the affine transformation @yx: yx component of the affine transformation @xy: xy component of the affine transformation @yy: yy component of the affine transformation @x0: X translation component of the affine transformation @y0: Y translation component of the affine transformation

A cairo_matrix_t holds an affine transformation, such as a scale, rotation, shear, or a combination of those. The transformation of a point (x, y) is given by: <programlisting> x_new = xx * x + xy * y + x0; y_new = yx * x + yy * y + y0; </programlisting>

Since: 1.0

◆ cairo_operator_t

cairo_operator_t: @CAIRO_OPERATOR_CLEAR: clear destination layer (bounded) (Since 1.0) @CAIRO_OPERATOR_SOURCE: replace destination layer (bounded) (Since 1.0) @CAIRO_OPERATOR_OVER: draw source layer on top of destination layer (bounded) (Since 1.0) @CAIRO_OPERATOR_IN: draw source where there was destination content (unbounded) (Since 1.0) @CAIRO_OPERATOR_OUT: draw source where there was no destination content (unbounded) (Since 1.0) @CAIRO_OPERATOR_ATOP: draw source on top of destination content and only there (Since 1.0) @CAIRO_OPERATOR_DEST: ignore the source (Since 1.0) @CAIRO_OPERATOR_DEST_OVER: draw destination on top of source (Since 1.0) @CAIRO_OPERATOR_DEST_IN: leave destination only where there was source content (unbounded) (Since 1.0) @CAIRO_OPERATOR_DEST_OUT: leave destination only where there was no source content (Since 1.0) @CAIRO_OPERATOR_DEST_ATOP: leave destination on top of source content and only there (unbounded) (Since 1.0) @CAIRO_OPERATOR_XOR: source and destination are shown where there is only one of them (Since 1.0) @CAIRO_OPERATOR_ADD: source and destination layers are accumulated (Since 1.0) @CAIRO_OPERATOR_SATURATE: like over, but assuming source and dest are disjoint geometries (Since 1.0) @CAIRO_OPERATOR_MULTIPLY: source and destination layers are multiplied. This causes the result to be at least as dark as the darker inputs. (Since 1.10) @CAIRO_OPERATOR_SCREEN: source and destination are complemented and multiplied. This causes the result to be at least as light as the lighter inputs. (Since 1.10) @CAIRO_OPERATOR_OVERLAY: multiplies or screens, depending on the lightness of the destination color. (Since 1.10) @CAIRO_OPERATOR_DARKEN: replaces the destination with the source if it is darker, otherwise keeps the source. (Since 1.10) @CAIRO_OPERATOR_LIGHTEN: replaces the destination with the source if it is lighter, otherwise keeps the source. (Since 1.10) @CAIRO_OPERATOR_COLOR_DODGE: brightens the destination color to reflect the source color. (Since 1.10) @CAIRO_OPERATOR_COLOR_BURN: darkens the destination color to reflect the source color. (Since 1.10) @CAIRO_OPERATOR_HARD_LIGHT: Multiplies or screens, dependent on source color. (Since 1.10) @CAIRO_OPERATOR_SOFT_LIGHT: Darkens or lightens, dependent on source color. (Since 1.10) @CAIRO_OPERATOR_DIFFERENCE: Takes the difference of the source and destination color. (Since 1.10) @CAIRO_OPERATOR_EXCLUSION: Produces an effect similar to difference, but with lower contrast. (Since 1.10) @CAIRO_OPERATOR_HSL_HUE: Creates a color with the hue of the source and the saturation and luminosity of the target. (Since 1.10) @CAIRO_OPERATOR_HSL_SATURATION: Creates a color with the saturation of the source and the hue and luminosity of the target. Painting with this mode onto a gray area produces no change. (Since 1.10) @CAIRO_OPERATOR_HSL_COLOR: Creates a color with the hue and saturation of the source and the luminosity of the target. This preserves the gray levels of the target and is useful for coloring monochrome images or tinting color images. (Since 1.10) @CAIRO_OPERATOR_HSL_LUMINOSITY: Creates a color with the luminosity of the source and the hue and saturation of the target. This produces an inverse effect to @CAIRO_OPERATOR_HSL_COLOR. (Since 1.10)

cairo_operator_t is used to set the compositing operator for all cairo drawing operations.

The default operator is CAIRO_OPERATOR_OVER.

The operators marked as <firstterm>unbounded</firstterm> modify their destination even outside of the mask layer (that is, their effect is not bound by the mask layer). However, their effect can still be limited by way of clipping.

To keep things simple, the operator descriptions here document the behavior for when both source and destination are either fully transparent or fully opaque. The actual implementation works for translucent layers too. For a more detailed explanation of the effects of each operator, including the mathematical definitions, see <ulink url="https://cairographics.org/operators/">https://cairographics.org/operators/</ulink>.

Since: 1.0

◆ cairo_path_data_t

cairo_path_data_t:

cairo_path_data_t is used to represent the path data inside a cairo_path_t.

The data structure is designed to try to balance the demands of efficiency and ease-of-use. A path is represented as an array of cairo_path_data_t, which is a union of headers and points.

Each portion of the path is represented by one or more elements in the array, (one header followed by 0 or more points). The length value of the header is the number of array elements for the current portion including the header, (ie. length == 1 + # of points), and where the number of points for each element type is as follows:

<programlisting> CAIRO_PATH_MOVE_TO: 1 point CAIRO_PATH_LINE_TO: 1 point CAIRO_PATH_CURVE_TO: 3 points CAIRO_PATH_CLOSE_PATH: 0 points </programlisting>

The semantics and ordering of the coordinate values are consistent with cairo_move_to(), cairo_line_to(), cairo_curve_to(), and cairo_close_path().

Here is sample code for iterating through a cairo_path_t:

<informalexample><programlisting> int i; cairo_path_t *path; cairo_path_data_t *data;   path = cairo_copy_path (cr);   for (i=0; i < path->num_data; i += path->data[i].header.length) { data = &path->data[i]; switch (data->header.type) { case CAIRO_PATH_MOVE_TO: do_move_to_things (data[1].point.x, data[1].point.y); break; case CAIRO_PATH_LINE_TO: do_line_to_things (data[1].point.x, data[1].point.y); break; case CAIRO_PATH_CURVE_TO: do_curve_to_things (data[1].point.x, data[1].point.y, data[2].point.x, data[2].point.y, data[3].point.x, data[3].point.y); break; case CAIRO_PATH_CLOSE_PATH: do_close_path_things (); break; } } cairo_path_destroy (path); </programlisting></informalexample>

As of cairo 1.4, cairo does not mind if there are more elements in a portion of the path than needed. Such elements can be used by users of the cairo API to hold extra values in the path data structure. For this reason, it is recommended that applications always use <literal>data->header.length</literal> to iterate over the path data, instead of hardcoding the number of elements for each element type.

Since: 1.0

Definition at line 1978 of file cairo.h.

◆ cairo_path_data_type_t

cairo_path_data_type_t: @CAIRO_PATH_MOVE_TO: A move-to operation, since 1.0 @CAIRO_PATH_LINE_TO: A line-to operation, since 1.0 @CAIRO_PATH_CURVE_TO: A curve-to operation, since 1.0 @CAIRO_PATH_CLOSE_PATH: A close-path operation, since 1.0

cairo_path_data_t is used to describe the type of one portion of a path when represented as a cairo_path_t. See cairo_path_data_t for details.

Since: 1.0

◆ cairo_path_t

typedef struct cairo_path cairo_path_t

cairo_path_t: @status: the current error status @data: the elements in the path @num_data: the number of elements in the data array

A data structure for holding a path. This data structure serves as the return value for cairo_copy_path() and cairo_copy_path_flat() as well the input value for cairo_append_path().

See cairo_path_data_t for hints on how to iterate over the actual data within the path.

The num_data member gives the number of elements in the data array. This number is larger than the number of independent path portions (defined in cairo_path_data_type_t), since the data includes both headers and coordinates for each portion.

Since: 1.0

◆ cairo_pattern_t

cairo_pattern_t:

A cairo_pattern_t represents a source when drawing onto a surface. There are different subtypes of cairo_pattern_t, for different types of sources; for example, cairo_pattern_create_rgb() creates a pattern for a solid opaque color.

Other than various <function>cairo_pattern_create_<emphasis>type</emphasis>()</function> functions, some of the pattern types can be implicitly created using various <function>cairo_set_source_<emphasis>type</emphasis>()</function> functions; for example cairo_set_source_rgb().

The type of a pattern can be queried with cairo_pattern_get_type().

Memory management of cairo_pattern_t is done with cairo_pattern_reference() and cairo_pattern_destroy().

Since: 1.0

Definition at line 107 of file cairo.h.

◆ cairo_pattern_type_t

cairo_pattern_type_t: @CAIRO_PATTERN_TYPE_SOLID: The pattern is a solid (uniform) color. It may be opaque or translucent, since 1.2. @CAIRO_PATTERN_TYPE_SURFACE: The pattern is a based on a surface (an image), since 1.2. @CAIRO_PATTERN_TYPE_LINEAR: The pattern is a linear gradient, since 1.2. @CAIRO_PATTERN_TYPE_RADIAL: The pattern is a radial gradient, since 1.2. @CAIRO_PATTERN_TYPE_MESH: The pattern is a mesh, since 1.12. @CAIRO_PATTERN_TYPE_RASTER_SOURCE: The pattern is a user pattern providing raster data, since 1.12.

cairo_pattern_type_t is used to describe the type of a given pattern.

The type of a pattern is determined by the function used to create it. The cairo_pattern_create_rgb() and cairo_pattern_create_rgba() functions create SOLID patterns. The remaining cairo_pattern_createfunctions map to pattern types in obvious ways.

The pattern type can be queried with cairo_pattern_get_type()

Most cairo_pattern_t functions can be called with a pattern of any type, (though trying to change the extend or filter for a solid pattern will have no effect). A notable exception is cairo_pattern_add_color_stop_rgb() and cairo_pattern_add_color_stop_rgba() which must only be called with gradient patterns (either LINEAR or RADIAL). Otherwise the pattern will be shutdown and put into an error state.

New entries may be added in future versions.

Since: 1.2

◆ cairo_raster_source_acquire_func_t

typedef cairo_surface_t*(* cairo_raster_source_acquire_func_t) (cairo_pattern_t *pattern, void *callback_data, cairo_surface_t *target, const cairo_rectangle_int_t *extents)

cairo_raster_source_acquire_func_t: @pattern: the pattern being rendered from @callback_data: the user data supplied during creation @target: the rendering target surface @extents: rectangular region of interest in pixels in sample space

cairo_raster_source_acquire_func_t is the type of function which is called when a pattern is being rendered from. It should create a surface that provides the pixel data for the region of interest as defined by extents, though the surface itself does not have to be limited to that area. For convenience the surface should probably be of image type, created with cairo_surface_create_similar_image() for the target (which enables the number of copies to be reduced during transfer to the device). Another option, might be to return a similar surface to the target for explicit handling by the application of a set of cached sources on the device. The region of sample data provided should be defined using cairo_surface_set_device_offset() to specify the top-left corner of the sample data (along with width and height of the surface).

Returns: a cairo_surface_t

Since: 1.12

Definition at line 2628 of file cairo.h.

◆ cairo_raster_source_copy_func_t

typedef cairo_status_t(* cairo_raster_source_copy_func_t) (cairo_pattern_t *pattern, void *callback_data, const cairo_pattern_t *other)

cairo_raster_source_copy_func_t: @pattern: the cairo_pattern_t that was copied to @callback_data: the user data supplied during creation @other: the cairo_pattern_t being used as the source for the copy

cairo_raster_source_copy_func_t is the type of function which is called when the pattern gets copied as a normal part of rendering.

Return value: CAIRO_STATUS_SUCCESS on success, or one of the cairo_status_t error codes for failure.

Since: 1.12

Definition at line 2686 of file cairo.h.

◆ cairo_raster_source_finish_func_t

typedef void(* cairo_raster_source_finish_func_t) (cairo_pattern_t *pattern, void *callback_data)

cairo_raster_source_finish_func_t: @pattern: the pattern being rendered from @callback_data: the user data supplied during creation

cairo_raster_source_finish_func_t is the type of function which is called when the pattern (or a copy thereof) is no longer required.

Since: 1.12

Definition at line 2701 of file cairo.h.

◆ cairo_raster_source_release_func_t

typedef void(* cairo_raster_source_release_func_t) (cairo_pattern_t *pattern, void *callback_data, cairo_surface_t *surface)

cairo_raster_source_release_func_t: @pattern: the pattern being rendered from @callback_data: the user data supplied during creation @surface: the surface created during acquire

cairo_raster_source_release_func_t is the type of function which is called when the pixel data is no longer being access by the pattern for the rendering operation. Typically this function will simply destroy the surface created during acquire.

Since: 1.12

Definition at line 2647 of file cairo.h.

◆ cairo_raster_source_snapshot_func_t

typedef cairo_status_t(* cairo_raster_source_snapshot_func_t) (cairo_pattern_t *pattern, void *callback_data)

cairo_raster_source_snapshot_func_t: @pattern: the pattern being rendered from @callback_data: the user data supplied during creation

cairo_raster_source_snapshot_func_t is the type of function which is called when the pixel data needs to be preserved for later use during printing. This pattern will be accessed again later, and it is expected to provide the pixel data that was current at the time of snapshotting.

Return value: CAIRO_STATUS_SUCCESS on success, or one of the cairo_status_t error codes for failure.

Since: 1.12

Definition at line 2668 of file cairo.h.

◆ cairo_read_func_t

typedef cairo_status_t(* cairo_read_func_t) (void *closure, unsigned char *data, unsigned int length)

cairo_read_func_t: @closure: the input closure @data: the buffer into which to read the data @length: the amount of data to read

cairo_read_func_t is the type of function which is called when a backend needs to read data from an input stream. It is passed the closure which was specified by the user at the time the read function was registered, the buffer to read the data into and the length of the data in bytes. The read function should return CAIRO_STATUS_SUCCESS if all the data was successfully read, CAIRO_STATUS_READ_ERROR otherwise.

Returns: the status code of the read operation

Since: 1.0

Definition at line 467 of file cairo.h.

◆ cairo_rectangle_int_t

cairo_rectangle_int_t: @x: X coordinate of the left side of the rectangle @y: Y coordinate of the the top side of the rectangle @width: width of the rectangle @height: height of the rectangle

A data structure for holding a rectangle with integer coordinates.

Since: 1.10

◆ cairo_rectangle_list_t

cairo_rectangle_list_t: @status: Error status of the rectangle list @rectangles: Array containing the rectangles @num_rectangles: Number of rectangles in this list

A data structure for holding a dynamically allocated array of rectangles.

Since: 1.4

◆ cairo_rectangle_t

cairo_rectangle_t: @x: X coordinate of the left side of the rectangle @y: Y coordinate of the the top side of the rectangle @width: width of the rectangle @height: height of the rectangle

A data structure for holding a rectangle.

Since: 1.4

◆ cairo_region_overlap_t

cairo_region_overlap_t: @CAIRO_REGION_OVERLAP_IN: The contents are entirely inside the region. (Since 1.10) @CAIRO_REGION_OVERLAP_OUT: The contents are entirely outside the region. (Since 1.10) @CAIRO_REGION_OVERLAP_PART: The contents are partially inside and partially outside the region. (Since 1.10)

Used as the return value for cairo_region_contains_rectangle().

Since: 1.10

◆ cairo_region_t

typedef struct _cairo_region cairo_region_t

cairo_region_t:

A cairo_region_t represents a set of integer-aligned rectangles.

It allows set-theoretical operations like cairo_region_union() and cairo_region_intersect() to be performed on them.

Memory management of cairo_region_t is done with cairo_region_reference() and cairo_region_destroy().

Since: 1.10

Definition at line 3060 of file cairo.h.

◆ cairo_scaled_font_t

cairo_scaled_font_t:

A cairo_scaled_font_t is a font scaled to a particular size and device resolution. A cairo_scaled_font_t is most useful for low-level font usage where a library or application wants to cache a reference to a scaled font to speed up the computation of metrics.

There are various types of scaled fonts, depending on the <firstterm>font backend</firstterm> they use. The type of a scaled font can be queried using cairo_scaled_font_get_type().

Memory management of cairo_scaled_font_t is done with cairo_scaled_font_reference() and cairo_scaled_font_destroy().

Since: 1.0

Definition at line 1038 of file cairo.h.

◆ cairo_status_t

cairo_status_t: @CAIRO_STATUS_SUCCESS: no error has occurred (Since 1.0) @CAIRO_STATUS_NO_MEMORY: out of memory (Since 1.0) @CAIRO_STATUS_INVALID_RESTORE: cairo_restore() called without matching cairo_save() (Since 1.0) @CAIRO_STATUS_INVALID_POP_GROUP: no saved group to pop, i.e. cairo_pop_group() without matching cairo_push_group() (Since 1.0) @CAIRO_STATUS_NO_CURRENT_POINT: no current point defined (Since 1.0) @CAIRO_STATUS_INVALID_MATRIX: invalid matrix (not invertible) (Since 1.0) @CAIRO_STATUS_INVALID_STATUS: invalid value for an input cairo_status_t (Since 1.0) @CAIRO_STATUS_NULL_POINTER: NULL pointer (Since 1.0) @CAIRO_STATUS_INVALID_STRING: input string not valid UTF-8 (Since 1.0) @CAIRO_STATUS_INVALID_PATH_DATA: input path data not valid (Since 1.0) @CAIRO_STATUS_READ_ERROR: error while reading from input stream (Since 1.0) @CAIRO_STATUS_WRITE_ERROR: error while writing to output stream (Since 1.0) @CAIRO_STATUS_SURFACE_FINISHED: target surface has been finished (Since 1.0) @CAIRO_STATUS_SURFACE_TYPE_MISMATCH: the surface type is not appropriate for the operation (Since 1.0) @CAIRO_STATUS_PATTERN_TYPE_MISMATCH: the pattern type is not appropriate for the operation (Since 1.0) @CAIRO_STATUS_INVALID_CONTENT: invalid value for an input cairo_content_t (Since 1.0) @CAIRO_STATUS_INVALID_FORMAT: invalid value for an input cairo_format_t (Since 1.0) @CAIRO_STATUS_INVALID_VISUAL: invalid value for an input Visual* (Since 1.0) @CAIRO_STATUS_FILE_NOT_FOUND: file not found (Since 1.0) @CAIRO_STATUS_INVALID_DASH: invalid value for a dash setting (Since 1.0) @CAIRO_STATUS_INVALID_DSC_COMMENT: invalid value for a DSC comment (Since 1.2) @CAIRO_STATUS_INVALID_INDEX: invalid index passed to getter (Since 1.4) @CAIRO_STATUS_CLIP_NOT_REPRESENTABLE: clip region not representable in desired format (Since 1.4) @CAIRO_STATUS_TEMP_FILE_ERROR: error creating or writing to a temporary file (Since 1.6) @CAIRO_STATUS_INVALID_STRIDE: invalid value for stride (Since 1.6) @CAIRO_STATUS_FONT_TYPE_MISMATCH: the font type is not appropriate for the operation (Since 1.8) @CAIRO_STATUS_USER_FONT_IMMUTABLE: the user-font is immutable (Since 1.8) @CAIRO_STATUS_USER_FONT_ERROR: error occurred in a user-font callback function (Since 1.8) @CAIRO_STATUS_NEGATIVE_COUNT: negative number used where it is not allowed (Since 1.8) @CAIRO_STATUS_INVALID_CLUSTERS: input clusters do not represent the accompanying text and glyph array (Since 1.8) @CAIRO_STATUS_INVALID_SLANT: invalid value for an input cairo_font_slant_t (Since 1.8) @CAIRO_STATUS_INVALID_WEIGHT: invalid value for an input cairo_font_weight_t (Since 1.8) @CAIRO_STATUS_INVALID_SIZE: invalid value (typically too big) for the size of the input (surface, pattern, etc.) (Since 1.10) @CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED: user-font method not implemented (Since 1.10) @CAIRO_STATUS_DEVICE_TYPE_MISMATCH: the device type is not appropriate for the operation (Since 1.10) @CAIRO_STATUS_DEVICE_ERROR: an operation to the device caused an unspecified error (Since 1.10) @CAIRO_STATUS_INVALID_MESH_CONSTRUCTION: a mesh pattern construction operation was used outside of a cairo_mesh_pattern_begin_patch()/cairo_mesh_pattern_end_patch() pair (Since 1.12) @CAIRO_STATUS_DEVICE_FINISHED: target device has been finished (Since 1.12) @CAIRO_STATUS_JBIG2_GLOBAL_MISSING: CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID has been used on at least one image but no image provided CAIRO_MIME_TYPE_JBIG2_GLOBAL (Since 1.14) @CAIRO_STATUS_PNG_ERROR: error occurred in libpng while reading from or writing to a PNG file (Since 1.16) @CAIRO_STATUS_FREETYPE_ERROR: error occurred in libfreetype (Since 1.16) @CAIRO_STATUS_WIN32_GDI_ERROR: error occurred in the Windows Graphics Device Interface (Since 1.16) @CAIRO_STATUS_TAG_ERROR: invalid tag name, attributes, or nesting (Since 1.16) @CAIRO_STATUS_LAST_STATUS: this is a special value indicating the number of status values defined in this enumeration. When using this value, note that the version of cairo at run-time may have additional status values defined than the value of this symbol at compile-time. (Since 1.10)

cairo_status_t is used to indicate errors that can occur when using Cairo. In some cases it is returned directly by functions. but when using cairo_t, the last error, if any, is stored in the context and can be retrieved with cairo_status().

New entries may be added in future versions. Use cairo_status_to_string() to get a human-readable representation of an error message.

Since: 1.0

◆ cairo_subpixel_order_t

cairo_subpixel_order_t: @CAIRO_SUBPIXEL_ORDER_DEFAULT: Use the default subpixel order for for the target device, since 1.0 @CAIRO_SUBPIXEL_ORDER_RGB: Subpixel elements are arranged horizontally with red at the left, since 1.0 @CAIRO_SUBPIXEL_ORDER_BGR: Subpixel elements are arranged horizontally with blue at the left, since 1.0 @CAIRO_SUBPIXEL_ORDER_VRGB: Subpixel elements are arranged vertically with red at the top, since 1.0 @CAIRO_SUBPIXEL_ORDER_VBGR: Subpixel elements are arranged vertically with blue at the top, since 1.0

The subpixel order specifies the order of color elements within each pixel on the display device when rendering with an antialiasing mode of CAIRO_ANTIALIAS_SUBPIXEL.

Since: 1.0

◆ cairo_surface_observer_callback_t

typedef void(* cairo_surface_observer_callback_t) (cairo_surface_t *observer, cairo_surface_t *target, void *data)

Definition at line 2258 of file cairo.h.

◆ cairo_surface_t

cairo_surface_t:

A cairo_surface_t represents an image, either as the destination of a drawing operation or as source when drawing onto another surface. To draw to a cairo_surface_t, create a cairo context with the surface as the target, using cairo_create().

There are different subtypes of cairo_surface_t for different drawing backends; for example, cairo_image_surface_create() creates a bitmap image in memory. The type of a surface can be queried with cairo_surface_get_type().

The initial contents of a surface after creation depend upon the manner of its creation. If cairo creates the surface and backing storage for the user, it will be initially cleared; for example, cairo_image_surface_create() and cairo_surface_create_similar(). Alternatively, if the user passes in a reference to some backing storage and asks cairo to wrap that in a cairo_surface_t, then the contents are not modified; for example, cairo_image_surface_create_for_data() and cairo_xlib_surface_create().

Memory management of cairo_surface_t is done with cairo_surface_reference() and cairo_surface_destroy().

Since: 1.0

Definition at line 107 of file cairo.h.

◆ cairo_surface_type_t

cairo_surface_type_t: @CAIRO_SURFACE_TYPE_IMAGE: The surface is of type image, since 1.2 @CAIRO_SURFACE_TYPE_PDF: The surface is of type pdf, since 1.2 @CAIRO_SURFACE_TYPE_PS: The surface is of type ps, since 1.2 @CAIRO_SURFACE_TYPE_XLIB: The surface is of type xlib, since 1.2 @CAIRO_SURFACE_TYPE_XCB: The surface is of type xcb, since 1.2 @CAIRO_SURFACE_TYPE_GLITZ: The surface is of type glitz, since 1.2 @CAIRO_SURFACE_TYPE_QUARTZ: The surface is of type quartz, since 1.2 @CAIRO_SURFACE_TYPE_WIN32: The surface is of type win32, since 1.2 @CAIRO_SURFACE_TYPE_BEOS: The surface is of type beos, since 1.2 @CAIRO_SURFACE_TYPE_DIRECTFB: The surface is of type directfb, since 1.2 @CAIRO_SURFACE_TYPE_SVG: The surface is of type svg, since 1.2 @CAIRO_SURFACE_TYPE_OS2: The surface is of type os2, since 1.4 @CAIRO_SURFACE_TYPE_WIN32_PRINTING: The surface is a win32 printing surface, since 1.6 @CAIRO_SURFACE_TYPE_QUARTZ_IMAGE: The surface is of type quartz_image, since 1.6 @CAIRO_SURFACE_TYPE_SCRIPT: The surface is of type script, since 1.10 @CAIRO_SURFACE_TYPE_QT: The surface is of type Qt, since 1.10 @CAIRO_SURFACE_TYPE_RECORDING: The surface is of type recording, since 1.10 @CAIRO_SURFACE_TYPE_VG: The surface is a OpenVG surface, since 1.10 @CAIRO_SURFACE_TYPE_GL: The surface is of type OpenGL, since 1.10 @CAIRO_SURFACE_TYPE_DRM: The surface is of type Direct Render Manager, since 1.10 @CAIRO_SURFACE_TYPE_TEE: The surface is of type 'tee' (a multiplexing surface), since 1.10 @CAIRO_SURFACE_TYPE_XML: The surface is of type XML (for debugging), since 1.10 @CAIRO_SURFACE_TYPE_SUBSURFACE: The surface is a subsurface created with cairo_surface_create_for_rectangle(), since 1.10 @CAIRO_SURFACE_TYPE_COGL: This surface is of type Cogl, since 1.12

cairo_surface_type_t is used to describe the type of a given surface. The surface types are also known as "backends" or "surface backends" within cairo.

The type of a surface is determined by the function used to create it, which will generally be of the form <function>cairo_<emphasis>type</emphasis>_surface_create()</function>, (though see cairo_surface_create_similar() as well).

The surface type can be queried with cairo_surface_get_type()

The various cairo_surface_t functions can be used with surfaces of any type, but some backends also provide type-specific functions that must only be called with a surface of the appropriate type. These functions have names that begin with <literal>cairo_<emphasis>type</emphasis>_surface</literal> such as cairo_image_surface_get_width().

The behavior of calling a type-specific function with a surface of the wrong type is undefined.

New entries may be added in future versions.

Since: 1.2

◆ cairo_t

typedef struct _cairo cairo_t

cairo_t:

A cairo_t contains the current state of the rendering device, including coordinates of yet to be drawn shapes.

Cairo contexts, as cairo_t objects are named, are central to cairo and all drawing with cairo is always done to a cairo_t object.

Memory management of cairo_t is done with cairo_reference() and cairo_destroy().

Since: 1.0

Definition at line 107 of file cairo.h.

◆ cairo_text_cluster_flags_t

cairo_text_cluster_flags_t: @CAIRO_TEXT_CLUSTER_FLAG_BACKWARD: The clusters in the cluster array map to glyphs in the glyph array from end to start. (Since 1.8)

Specifies properties of a text cluster mapping.

Since: 1.8

◆ cairo_user_data_key_t

cairo_user_data_key_t: @unused: not used; ignore.

cairo_user_data_key_t is used for attaching user data to cairo data structures. The actual contents of the struct is never used, and there is no need to initialize the object; only the unique address of a #cairo_data_key_t object is used. Typically, you would just use the address of a static #cairo_data_key_t object.

Since: 1.0

◆ cairo_user_scaled_font_init_func_t

typedef cairo_status_t(* cairo_user_scaled_font_init_func_t) (cairo_scaled_font_t *scaled_font, cairo_t *cr, cairo_font_extents_t *extents)

cairo_user_scaled_font_init_func_t: @scaled_font: the scaled-font being created @cr: a cairo context, in font space @extents: font extents to fill in, in font space

cairo_user_scaled_font_init_func_t is the type of function which is called when a scaled-font needs to be created for a user font-face.

The cairo context @cr is not used by the caller, but is prepared in font space, similar to what the cairo contexts passed to the render_glyph method will look like. The callback can use this context for extents computation for example. After the callback is called, @cr is checked for any error status.

The @extents argument is where the user font sets the font extents for @scaled_font. It is in font space, which means that for most cases its ascent and descent members should add to 1.0. @extents is preset to hold a value of 1.0 for ascent, height, and max_x_advance, and 0.0 for descent and max_y_advance members.

The callback is optional. If not set, default font extents as described in the previous paragraph will be used.

Note that @scaled_font is not fully initialized at this point and trying to use it for text operations in the callback will result in deadlock.

Returns: CAIRO_STATUS_SUCCESS upon success, or an error status on error.

Since: 1.8

Definition at line 1729 of file cairo.h.

◆ cairo_user_scaled_font_render_glyph_func_t

typedef cairo_status_t(* cairo_user_scaled_font_render_glyph_func_t) (cairo_scaled_font_t *scaled_font, unsigned long glyph, cairo_t *cr, cairo_text_extents_t *extents)

cairo_user_scaled_font_render_glyph_func_t: @scaled_font: user scaled-font @glyph: glyph code to render @cr: cairo context to draw to, in font space @extents: glyph extents to fill in, in font space

cairo_user_scaled_font_render_glyph_func_t is the type of function which is called when a user scaled-font needs to render a glyph.

The callback is mandatory, and expected to draw the glyph with code @glyph to the cairo context @cr. @cr is prepared such that the glyph drawing is done in font space. That is, the matrix set on @cr is the scale matrix of @scaled_font, The @extents argument is where the user font sets the font extents for @scaled_font. However, if user prefers to draw in user space, they can achieve that by changing the matrix on @cr. All cairo rendering operations to @cr are permitted, however, the result is undefined if any source other than the default source on @cr is used. That means, glyph bitmaps should be rendered using cairo_mask() instead of cairo_paint().

Other non-default settings on @cr include a font size of 1.0 (given that it is set up to be in font space), and font options corresponding to @scaled_font.

The @extents argument is preset to have <literal>x_bearing</literal>, <literal>width</literal>, and <literal>y_advance</literal> of zero, <literal>y_bearing</literal> set to <literal>-font_extents.ascent</literal>, <literal>height</literal> to <literal>font_extents.ascent+font_extents.descent</literal>, and <literal>x_advance</literal> to <literal>font_extents.max_x_advance</literal>. The only field user needs to set in majority of cases is <literal>x_advance</literal>. If the <literal>width</literal> field is zero upon the callback returning (which is its preset value), the glyph extents are automatically computed based on the drawings done to @cr. This is in most cases exactly what the desired behavior is. However, if for any reason the callback sets the extents, it must be ink extents, and include the extents of all drawing done to @cr in the callback.

Returns: CAIRO_STATUS_SUCCESS upon success, or CAIRO_STATUS_USER_FONT_ERROR or any other error status on error.

Since: 1.8

Definition at line 1776 of file cairo.h.

◆ cairo_user_scaled_font_text_to_glyphs_func_t

typedef cairo_status_t(* cairo_user_scaled_font_text_to_glyphs_func_t) (cairo_scaled_font_t *scaled_font, const char *utf8, int utf8_len, cairo_glyph_t **glyphs, int *num_glyphs, cairo_text_cluster_t **clusters, int *num_clusters, cairo_text_cluster_flags_t *cluster_flags)

cairo_user_scaled_font_text_to_glyphs_func_t: @scaled_font: the scaled-font being created @utf8: a string of text encoded in UTF-8 @utf8_len: length of @utf8 in bytes @glyphs: pointer to array of glyphs to fill, in font space @num_glyphs: pointer to number of glyphs @clusters: pointer to array of cluster mapping information to fill, or NULL @num_clusters: pointer to number of clusters @cluster_flags: pointer to location to store cluster flags corresponding to the output @clusters

cairo_user_scaled_font_text_to_glyphs_func_t is the type of function which is called to convert input text to an array of glyphs. This is used by the cairo_show_text() operation.

Using this callback the user-font has full control on glyphs and their positions. That means, it allows for features like ligatures and kerning, as well as complex <firstterm>shaping</firstterm> required for scripts like Arabic and Indic.

The @num_glyphs argument is preset to the number of glyph entries available in the @glyphs buffer. If the @glyphs buffer is NULL, the value of @num_glyphs will be zero. If the provided glyph array is too short for the conversion (or for convenience), a new glyph array may be allocated using cairo_glyph_allocate() and placed in @glyphs. Upon return, @num_glyphs should contain the number of generated glyphs. If the value @glyphs points at has changed after the call, the caller will free the allocated glyph array using cairo_glyph_free(). The caller will also free the original value of @glyphs, so the callback shouldn't do so. The callback should populate the glyph indices and positions (in font space) assuming that the text is to be shown at the origin.

If @clusters is not NULL, @num_clusters and @cluster_flags are also non-NULL, and cluster mapping should be computed. The semantics of how cluster array allocation works is similar to the glyph array. That is, if @clusters initially points to a non-NULL value, that array may be used as a cluster buffer, and @num_clusters points to the number of cluster entries available there. If the provided cluster array is too short for the conversion (or for convenience), a new cluster array may be allocated using cairo_text_cluster_allocate() and placed in @clusters. In this case, the original value of @clusters will still be freed by the caller. Upon return, @num_clusters should contain the number of generated clusters. If the value @clusters points at has changed after the call, the caller will free the allocated cluster array using cairo_text_cluster_free().

The callback is optional. If @num_glyphs is negative upon the callback returning or if the return value is CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED, the unicode_to_glyph callback is tried. See cairo_user_scaled_font_unicode_to_glyph_func_t.

Note: While cairo does not impose any limitation on glyph indices, some applications may assume that a glyph index fits in a 16-bit unsigned integer. As such, it is advised that user-fonts keep their glyphs in the 0 to 65535 range. Furthermore, some applications may assume that glyph 0 is a special glyph-not-found glyph. User-fonts are advised to use glyph 0 for such purposes and do not use that glyph value for other purposes.

Returns: CAIRO_STATUS_SUCCESS upon success, CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED if fallback options should be tried, or CAIRO_STATUS_USER_FONT_ERROR or any other error status on error.

Since: 1.8

Definition at line 1846 of file cairo.h.

◆ cairo_user_scaled_font_unicode_to_glyph_func_t

typedef cairo_status_t(* cairo_user_scaled_font_unicode_to_glyph_func_t) (cairo_scaled_font_t *scaled_font, unsigned long unicode, unsigned long *glyph_index)

cairo_user_scaled_font_unicode_to_glyph_func_t: @scaled_font: the scaled-font being created @unicode: input unicode character code-point @glyph_index: output glyph index

cairo_user_scaled_font_unicode_to_glyph_func_t is the type of function which is called to convert an input Unicode character to a single glyph. This is used by the cairo_show_text() operation.

This callback is used to provide the same functionality as the text_to_glyphs callback does (see cairo_user_scaled_font_text_to_glyphs_func_t) but has much less control on the output, in exchange for increased ease of use. The inherent assumption to using this callback is that each character maps to one glyph, and that the mapping is context independent. It also assumes that glyphs are positioned according to their advance width. These mean no ligatures, kerning, or complex scripts can be implemented using this callback.

The callback is optional, and only used if text_to_glyphs callback is not set or fails to return glyphs. If this callback is not set or if it returns CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED, an identity mapping from Unicode code-points to glyph indices is assumed.

Note: While cairo does not impose any limitation on glyph indices, some applications may assume that a glyph index fits in a 16-bit unsigned integer. As such, it is advised that user-fonts keep their glyphs in the 0 to 65535 range. Furthermore, some applications may assume that glyph 0 is a special glyph-not-found glyph. User-fonts are advised to use glyph 0 for such purposes and do not use that glyph value for other purposes.

Returns: CAIRO_STATUS_SUCCESS upon success, CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED if fallback options should be tried, or CAIRO_STATUS_USER_FONT_ERROR or any other error status on error.

Since: 1.8

Definition at line 1893 of file cairo.h.

◆ cairo_write_func_t

typedef cairo_status_t(* cairo_write_func_t) (void *closure, const unsigned char *data, unsigned int length)

cairo_write_func_t: @closure: the output closure @data: the buffer containing the data to write @length: the amount of data to write

cairo_write_func_t is the type of function which is called when a backend needs to write data to an output stream. It is passed the closure which was specified by the user at the time the write function was registered, the data to write and the length of the data in bytes. The write function should return CAIRO_STATUS_SUCCESS if all the data was successfully written, CAIRO_STATUS_WRITE_ERROR otherwise.

Returns: the status code of the write operation

Since: 1.0

Definition at line 445 of file cairo.h.

Enumeration Type Documentation

◆ _cairo_antialias

cairo_antialias_t: @CAIRO_ANTIALIAS_DEFAULT: Use the default antialiasing for the subsystem and target device, since 1.0 @CAIRO_ANTIALIAS_NONE: Use a bilevel alpha mask, since 1.0 @CAIRO_ANTIALIAS_GRAY: Perform single-color antialiasing (using shades of gray for black text on a white background, for example), since 1.0 @CAIRO_ANTIALIAS_SUBPIXEL: Perform antialiasing by taking advantage of the order of subpixel elements on devices such as LCD panels, since 1.0 @CAIRO_ANTIALIAS_FAST: Hint that the backend should perform some antialiasing but prefer speed over quality, since 1.12 @CAIRO_ANTIALIAS_GOOD: The backend should balance quality against performance, since 1.12 @CAIRO_ANTIALIAS_BEST: Hint that the backend should render at the highest quality, sacrificing speed if necessary, since 1.12

Specifies the type of antialiasing to do when rendering text or shapes.

As it is not necessarily clear from the above what advantages a particular antialias method provides, since 1.12, there is also a set of hints: @CAIRO_ANTIALIAS_FAST: Allow the backend to degrade raster quality for speed @CAIRO_ANTIALIAS_GOOD: A balance between speed and quality @CAIRO_ANTIALIAS_BEST: A high-fidelity, but potentially slow, raster mode

These make no guarantee on how the backend will perform its rasterisation (if it even rasterises!), nor that they have any differing effect other than to enable some form of antialiasing. In the case of glyph rendering, @CAIRO_ANTIALIAS_FAST and @CAIRO_ANTIALIAS_GOOD will be mapped to @CAIRO_ANTIALIAS_GRAY, with @CAIRO_ANTALIAS_BEST being equivalent to @CAIRO_ANTIALIAS_SUBPIXEL.

The interpretation of @CAIRO_ANTIALIAS_DEFAULT is left entirely up to the backend, typically this will be similar to @CAIRO_ANTIALIAS_GOOD.

Since: 1.0

Enumerator
CAIRO_ANTIALIAS_DEFAULT 
CAIRO_ANTIALIAS_NONE 
CAIRO_ANTIALIAS_GRAY 
CAIRO_ANTIALIAS_SUBPIXEL 
CAIRO_ANTIALIAS_FAST 
CAIRO_ANTIALIAS_GOOD 
CAIRO_ANTIALIAS_BEST 
CAIRO_ANTIALIAS_DEFAULT 
CAIRO_ANTIALIAS_NONE 
CAIRO_ANTIALIAS_GRAY 
CAIRO_ANTIALIAS_SUBPIXEL 
CAIRO_ANTIALIAS_FAST 
CAIRO_ANTIALIAS_GOOD 
CAIRO_ANTIALIAS_BEST 
CAIRO_ANTIALIAS_DEFAULT 
CAIRO_ANTIALIAS_NONE 
CAIRO_ANTIALIAS_GRAY 
CAIRO_ANTIALIAS_SUBPIXEL 
CAIRO_ANTIALIAS_FAST 
CAIRO_ANTIALIAS_GOOD 
CAIRO_ANTIALIAS_BEST 

Definition at line 709 of file cairo.h.

◆ _cairo_content

cairo_content_t: @CAIRO_CONTENT_COLOR: The surface will hold color content only. (Since 1.0) @CAIRO_CONTENT_ALPHA: The surface will hold alpha content only. (Since 1.0) @CAIRO_CONTENT_COLOR_ALPHA: The surface will hold color and alpha content. (Since 1.0)

cairo_content_t is used to describe the content that a surface will contain, whether color information, alpha information (translucence vs. opacity), or both.

Note: The large values here are designed to keep cairo_content_t values distinct from cairo_format_t values so that the implementation can detect the error if users confuse the two types.

Since: 1.0

Enumerator
CAIRO_CONTENT_COLOR 
CAIRO_CONTENT_ALPHA 
CAIRO_CONTENT_COLOR_ALPHA 
CAIRO_CONTENT_COLOR 
CAIRO_CONTENT_ALPHA 
CAIRO_CONTENT_COLOR_ALPHA 
CAIRO_CONTENT_COLOR 
CAIRO_CONTENT_ALPHA 
CAIRO_CONTENT_COLOR_ALPHA 

Definition at line 379 of file cairo.h.

◆ _cairo_device_type

cairo_device_type_t: @CAIRO_DEVICE_TYPE_DRM: The device is of type Direct Render Manager, since 1.10 @CAIRO_DEVICE_TYPE_GL: The device is of type OpenGL, since 1.10 @CAIRO_DEVICE_TYPE_SCRIPT: The device is of type script, since 1.10 @CAIRO_DEVICE_TYPE_XCB: The device is of type xcb, since 1.10 @CAIRO_DEVICE_TYPE_XLIB: The device is of type xlib, since 1.10 @CAIRO_DEVICE_TYPE_XML: The device is of type XML, since 1.10 @CAIRO_DEVICE_TYPE_COGL: The device is of type cogl, since 1.12 @CAIRO_DEVICE_TYPE_WIN32: The device is of type win32, since 1.12 @CAIRO_DEVICE_TYPE_INVALID: The device is invalid, since 1.10

cairo_device_type_t is used to describe the type of a given device. The devices types are also known as "backends" within cairo.

The device type can be queried with cairo_device_get_type()

The various cairo_device_t functions can be used with devices of any type, but some backends also provide type-specific functions that must only be called with a device of the appropriate type. These functions have names that begin with <literal>cairo_<emphasis>type</emphasis>_device</literal> such as cairo_xcb_device_debug_cap_xrender_version().

The behavior of calling a type-specific function with a device of the wrong type is undefined.

New entries may be added in future versions.

Since: 1.10

Enumerator
CAIRO_DEVICE_TYPE_DRM 
CAIRO_DEVICE_TYPE_GL 
CAIRO_DEVICE_TYPE_SCRIPT 
CAIRO_DEVICE_TYPE_XCB 
CAIRO_DEVICE_TYPE_XLIB 
CAIRO_DEVICE_TYPE_XML 
CAIRO_DEVICE_TYPE_COGL 
CAIRO_DEVICE_TYPE_WIN32 
CAIRO_DEVICE_TYPE_INVALID 
CAIRO_DEVICE_TYPE_DRM 
CAIRO_DEVICE_TYPE_GL 
CAIRO_DEVICE_TYPE_SCRIPT 
CAIRO_DEVICE_TYPE_XCB 
CAIRO_DEVICE_TYPE_XLIB 
CAIRO_DEVICE_TYPE_XML 
CAIRO_DEVICE_TYPE_COGL 
CAIRO_DEVICE_TYPE_WIN32 
CAIRO_DEVICE_TYPE_INVALID 
CAIRO_DEVICE_TYPE_DRM 
CAIRO_DEVICE_TYPE_GL 
CAIRO_DEVICE_TYPE_SCRIPT 
CAIRO_DEVICE_TYPE_XCB 
CAIRO_DEVICE_TYPE_XLIB 
CAIRO_DEVICE_TYPE_XML 
CAIRO_DEVICE_TYPE_COGL 
CAIRO_DEVICE_TYPE_WIN32 
CAIRO_DEVICE_TYPE_INVALID 

Definition at line 2163 of file cairo.h.

◆ _cairo_extend

cairo_extend_t: @CAIRO_EXTEND_NONE: pixels outside of the source pattern are fully transparent (Since 1.0) @CAIRO_EXTEND_REPEAT: the pattern is tiled by repeating (Since 1.0) @CAIRO_EXTEND_REFLECT: the pattern is tiled by reflecting at the edges (Since 1.0; but only implemented for surface patterns since 1.6) @CAIRO_EXTEND_PAD: pixels outside of the pattern copy the closest pixel from the source (Since 1.2; but only implemented for surface patterns since 1.6)

cairo_extend_t is used to describe how pattern color/alpha will be determined for areas "outside" the pattern's natural area, (for example, outside the surface bounds or outside the gradient geometry).

Mesh patterns are not affected by the extend mode.

The default extend mode is CAIRO_EXTEND_NONE for surface patterns and CAIRO_EXTEND_PAD for gradient patterns.

New entries may be added in future versions.

Since: 1.0

Enumerator
CAIRO_EXTEND_NONE 
CAIRO_EXTEND_REPEAT 
CAIRO_EXTEND_REFLECT 
CAIRO_EXTEND_PAD 
CAIRO_EXTEND_NONE 
CAIRO_EXTEND_REPEAT 
CAIRO_EXTEND_REFLECT 
CAIRO_EXTEND_PAD 
CAIRO_EXTEND_NONE 
CAIRO_EXTEND_REPEAT 
CAIRO_EXTEND_REFLECT 
CAIRO_EXTEND_PAD 

Definition at line 2916 of file cairo.h.

◆ _cairo_fill_rule

cairo_fill_rule_t: @CAIRO_FILL_RULE_WINDING: If the path crosses the ray from left-to-right, counts +1. If the path crosses the ray from right to left, counts -1. (Left and right are determined from the perspective of looking along the ray from the starting point.) If the total count is non-zero, the point will be filled. (Since 1.0) @CAIRO_FILL_RULE_EVEN_ODD: Counts the total number of intersections, without regard to the orientation of the contour. If the total number of intersections is odd, the point will be filled. (Since 1.0)

cairo_fill_rule_t is used to select how paths are filled. For both fill rules, whether or not a point is included in the fill is determined by taking a ray from that point to infinity and looking at intersections with the path. The ray can be in any direction, as long as it doesn't pass through the end point of a segment or have a tricky intersection such as intersecting tangent to the path. (Note that filling is not actually implemented in this way. This is just a description of the rule that is applied.)

The default fill rule is CAIRO_FILL_RULE_WINDING.

New entries may be added in future versions.

Since: 1.0

Enumerator
CAIRO_FILL_RULE_WINDING 
CAIRO_FILL_RULE_EVEN_ODD 
CAIRO_FILL_RULE_WINDING 
CAIRO_FILL_RULE_EVEN_ODD 
CAIRO_FILL_RULE_WINDING 
CAIRO_FILL_RULE_EVEN_ODD 

Definition at line 753 of file cairo.h.

◆ _cairo_filter

cairo_filter_t: @CAIRO_FILTER_FAST: A high-performance filter, with quality similar to CAIRO_FILTER_NEAREST (Since 1.0) @CAIRO_FILTER_GOOD: A reasonable-performance filter, with quality similar to CAIRO_FILTER_BILINEAR (Since 1.0) @CAIRO_FILTER_BEST: The highest-quality available, performance may not be suitable for interactive use. (Since 1.0) @CAIRO_FILTER_NEAREST: Nearest-neighbor filtering (Since 1.0) @CAIRO_FILTER_BILINEAR: Linear interpolation in two dimensions (Since 1.0) @CAIRO_FILTER_GAUSSIAN: This filter value is currently unimplemented, and should not be used in current code. (Since 1.0)

cairo_filter_t is used to indicate what filtering should be applied when reading pixel values from patterns. See cairo_pattern_set_filter() for indicating the desired filter to be used with a particular pattern.

Since: 1.0

Enumerator
CAIRO_FILTER_FAST 
CAIRO_FILTER_GOOD 
CAIRO_FILTER_BEST 
CAIRO_FILTER_NEAREST 
CAIRO_FILTER_BILINEAR 
CAIRO_FILTER_GAUSSIAN 
CAIRO_FILTER_FAST 
CAIRO_FILTER_GOOD 
CAIRO_FILTER_BEST 
CAIRO_FILTER_NEAREST 
CAIRO_FILTER_BILINEAR 
CAIRO_FILTER_GAUSSIAN 
CAIRO_FILTER_FAST 
CAIRO_FILTER_GOOD 
CAIRO_FILTER_BEST 
CAIRO_FILTER_NEAREST 
CAIRO_FILTER_BILINEAR 
CAIRO_FILTER_GAUSSIAN 

Definition at line 2949 of file cairo.h.

◆ _cairo_font_slant

cairo_font_slant_t: @CAIRO_FONT_SLANT_NORMAL: Upright font style, since 1.0 @CAIRO_FONT_SLANT_ITALIC: Italic font style, since 1.0 @CAIRO_FONT_SLANT_OBLIQUE: Oblique font style, since 1.0

Specifies variants of a font face based on their slant.

Since: 1.0

Enumerator
CAIRO_FONT_SLANT_NORMAL 
CAIRO_FONT_SLANT_ITALIC 
CAIRO_FONT_SLANT_OBLIQUE 
CAIRO_FONT_SLANT_NORMAL 
CAIRO_FONT_SLANT_ITALIC 
CAIRO_FONT_SLANT_OBLIQUE 
CAIRO_FONT_SLANT_NORMAL 
CAIRO_FONT_SLANT_ITALIC 
CAIRO_FONT_SLANT_OBLIQUE 

Definition at line 1263 of file cairo.h.

◆ _cairo_font_type

cairo_font_type_t: @CAIRO_FONT_TYPE_TOY: The font was created using cairo's toy font api (Since: 1.2) @CAIRO_FONT_TYPE_FT: The font is of type FreeType (Since: 1.2) @CAIRO_FONT_TYPE_WIN32: The font is of type Win32 (Since: 1.2) @CAIRO_FONT_TYPE_QUARTZ: The font is of type Quartz (Since: 1.6, in 1.2 and 1.4 it was named CAIRO_FONT_TYPE_ATSUI) @CAIRO_FONT_TYPE_USER: The font was create using cairo's user font api (Since: 1.8)

cairo_font_type_t is used to describe the type of a given font face or scaled font. The font types are also known as "font backends" within cairo.

The type of a font face is determined by the function used to create it, which will generally be of the form <function>cairo_<emphasis>type</emphasis>_font_face_create()</function>. The font face type can be queried with cairo_font_face_get_type()

The various cairo_font_face_t functions can be used with a font face of any type.

The type of a scaled font is determined by the type of the font face passed to cairo_scaled_font_create(). The scaled font type can be queried with cairo_scaled_font_get_type()

The various cairo_scaled_font_t functions can be used with scaled fonts of any type, but some font backends also provide type-specific functions that must only be called with a scaled font of the appropriate type. These functions have names that begin with <function>cairo_<emphasis>type</emphasis>_scaled_font()</function> such as cairo_ft_scaled_font_lock_face().

The behavior of calling a type-specific function with a scaled font of the wrong type is undefined.

New entries may be added in future versions.

Since: 1.2

Enumerator
CAIRO_FONT_TYPE_TOY 
CAIRO_FONT_TYPE_FT 
CAIRO_FONT_TYPE_WIN32 
CAIRO_FONT_TYPE_QUARTZ 
CAIRO_FONT_TYPE_USER 
CAIRO_FONT_TYPE_TOY 
CAIRO_FONT_TYPE_FT 
CAIRO_FONT_TYPE_WIN32 
CAIRO_FONT_TYPE_QUARTZ 
CAIRO_FONT_TYPE_USER 
CAIRO_FONT_TYPE_TOY 
CAIRO_FONT_TYPE_FT 
CAIRO_FONT_TYPE_WIN32 
CAIRO_FONT_TYPE_QUARTZ 
CAIRO_FONT_TYPE_USER 

Definition at line 1572 of file cairo.h.

◆ _cairo_font_weight

cairo_font_weight_t: @CAIRO_FONT_WEIGHT_NORMAL: Normal font weight, since 1.0 @CAIRO_FONT_WEIGHT_BOLD: Bold font weight, since 1.0

Specifies variants of a font face based on their weight.

Since: 1.0

Enumerator
CAIRO_FONT_WEIGHT_NORMAL 
CAIRO_FONT_WEIGHT_BOLD 
CAIRO_FONT_WEIGHT_NORMAL 
CAIRO_FONT_WEIGHT_BOLD 
CAIRO_FONT_WEIGHT_NORMAL 
CAIRO_FONT_WEIGHT_BOLD 

Definition at line 1278 of file cairo.h.

◆ _cairo_format

cairo_format_t: @CAIRO_FORMAT_INVALID: no such format exists or is supported. @CAIRO_FORMAT_ARGB32: each pixel is a 32-bit quantity, with alpha in the upper 8 bits, then red, then green, then blue. The 32-bit quantities are stored native-endian. Pre-multiplied alpha is used. (That is, 50% transparent red is 0x80800000, not 0x80ff0000.) (Since 1.0) @CAIRO_FORMAT_RGB24: each pixel is a 32-bit quantity, with the upper 8 bits unused. Red, Green, and Blue are stored in the remaining 24 bits in that order. (Since 1.0) @CAIRO_FORMAT_A8: each pixel is a 8-bit quantity holding an alpha value. (Since 1.0) @CAIRO_FORMAT_A1: each pixel is a 1-bit quantity holding an alpha value. Pixels are packed together into 32-bit quantities. The ordering of the bits matches the endianness of the platform. On a big-endian machine, the first pixel is in the uppermost bit, on a little-endian machine the first pixel is in the least-significant bit. (Since 1.0) @CAIRO_FORMAT_RGB16_565: each pixel is a 16-bit quantity with red in the upper 5 bits, then green in the middle 6 bits, and blue in the lower 5 bits. (Since 1.2) @CAIRO_FORMAT_RGB30: like RGB24 but with 10bpc. (Since 1.12)

cairo_format_t is used to identify the memory format of image data.

New entries may be added in future versions.

Since: 1.0

Enumerator
CAIRO_FORMAT_INVALID 
CAIRO_FORMAT_ARGB32 
CAIRO_FORMAT_RGB24 
CAIRO_FORMAT_A8 
CAIRO_FORMAT_A1 
CAIRO_FORMAT_RGB16_565 
CAIRO_FORMAT_RGB30 
CAIRO_FORMAT_INVALID 
CAIRO_FORMAT_ARGB32 
CAIRO_FORMAT_RGB24 
CAIRO_FORMAT_A8 
CAIRO_FORMAT_A1 
CAIRO_FORMAT_RGB16_565 
CAIRO_FORMAT_RGB30 
CAIRO_FORMAT_INVALID 
CAIRO_FORMAT_ARGB32 
CAIRO_FORMAT_RGB24 
CAIRO_FORMAT_A8 
CAIRO_FORMAT_A1 
CAIRO_FORMAT_RGB16_565 
CAIRO_FORMAT_RGB30 

Definition at line 416 of file cairo.h.

◆ _cairo_hint_metrics

cairo_hint_metrics_t: @CAIRO_HINT_METRICS_DEFAULT: Hint metrics in the default manner for the font backend and target device, since 1.0 @CAIRO_HINT_METRICS_OFF: Do not hint font metrics, since 1.0 @CAIRO_HINT_METRICS_ON: Hint font metrics, since 1.0

Specifies whether to hint font metrics; hinting font metrics means quantizing them so that they are integer values in device space. Doing this improves the consistency of letter and line spacing, however it also means that text will be laid out differently at different zoom factors.

Since: 1.0

Enumerator
CAIRO_HINT_METRICS_DEFAULT 
CAIRO_HINT_METRICS_OFF 
CAIRO_HINT_METRICS_ON 
CAIRO_HINT_METRICS_DEFAULT 
CAIRO_HINT_METRICS_OFF 
CAIRO_HINT_METRICS_ON 
CAIRO_HINT_METRICS_DEFAULT 
CAIRO_HINT_METRICS_OFF 
CAIRO_HINT_METRICS_ON 

Definition at line 1357 of file cairo.h.

◆ _cairo_hint_style

cairo_hint_style_t: @CAIRO_HINT_STYLE_DEFAULT: Use the default hint style for font backend and target device, since 1.0 @CAIRO_HINT_STYLE_NONE: Do not hint outlines, since 1.0 @CAIRO_HINT_STYLE_SLIGHT: Hint outlines slightly to improve contrast while retaining good fidelity to the original shapes, since 1.0 @CAIRO_HINT_STYLE_MEDIUM: Hint outlines with medium strength giving a compromise between fidelity to the original shapes and contrast, since 1.0 @CAIRO_HINT_STYLE_FULL: Hint outlines to maximize contrast, since 1.0

Specifies the type of hinting to do on font outlines. Hinting is the process of fitting outlines to the pixel grid in order to improve the appearance of the result. Since hinting outlines involves distorting them, it also reduces the faithfulness to the original outline shapes. Not all of the outline hinting styles are supported by all font backends.

New entries may be added in future versions.

Since: 1.0

Enumerator
CAIRO_HINT_STYLE_DEFAULT 
CAIRO_HINT_STYLE_NONE 
CAIRO_HINT_STYLE_SLIGHT 
CAIRO_HINT_STYLE_MEDIUM 
CAIRO_HINT_STYLE_FULL 
CAIRO_HINT_STYLE_DEFAULT 
CAIRO_HINT_STYLE_NONE 
CAIRO_HINT_STYLE_SLIGHT 
CAIRO_HINT_STYLE_MEDIUM 
CAIRO_HINT_STYLE_FULL 
CAIRO_HINT_STYLE_DEFAULT 
CAIRO_HINT_STYLE_NONE 
CAIRO_HINT_STYLE_SLIGHT 
CAIRO_HINT_STYLE_MEDIUM 
CAIRO_HINT_STYLE_FULL 

Definition at line 1334 of file cairo.h.

◆ _cairo_line_cap

cairo_line_cap_t: @CAIRO_LINE_CAP_BUTT: start(stop) the line exactly at the start(end) point (Since 1.0) @CAIRO_LINE_CAP_ROUND: use a round ending, the center of the circle is the end point (Since 1.0) @CAIRO_LINE_CAP_SQUARE: use squared ending, the center of the square is the end point (Since 1.0)

Specifies how to render the endpoints of the path when stroking.

The default line cap style is CAIRO_LINE_CAP_BUTT.

Since: 1.0

Enumerator
CAIRO_LINE_CAP_BUTT 
CAIRO_LINE_CAP_ROUND 
CAIRO_LINE_CAP_SQUARE 
CAIRO_LINE_CAP_BUTT 
CAIRO_LINE_CAP_ROUND 
CAIRO_LINE_CAP_SQUARE 
CAIRO_LINE_CAP_BUTT 
CAIRO_LINE_CAP_ROUND 
CAIRO_LINE_CAP_SQUARE 

Definition at line 776 of file cairo.h.

◆ _cairo_line_join

cairo_line_join_t: @CAIRO_LINE_JOIN_MITER: use a sharp (angled) corner, see cairo_set_miter_limit() (Since 1.0) @CAIRO_LINE_JOIN_ROUND: use a rounded join, the center of the circle is the joint point (Since 1.0) @CAIRO_LINE_JOIN_BEVEL: use a cut-off join, the join is cut off at half the line width from the joint point (Since 1.0)

Specifies how to render the junction of two lines when stroking.

The default line join style is CAIRO_LINE_JOIN_MITER.

Since: 1.0

Enumerator
CAIRO_LINE_JOIN_MITER 
CAIRO_LINE_JOIN_ROUND 
CAIRO_LINE_JOIN_BEVEL 
CAIRO_LINE_JOIN_MITER 
CAIRO_LINE_JOIN_ROUND 
CAIRO_LINE_JOIN_BEVEL 
CAIRO_LINE_JOIN_MITER 
CAIRO_LINE_JOIN_ROUND 
CAIRO_LINE_JOIN_BEVEL 

Definition at line 800 of file cairo.h.

◆ _cairo_operator

cairo_operator_t: @CAIRO_OPERATOR_CLEAR: clear destination layer (bounded) (Since 1.0) @CAIRO_OPERATOR_SOURCE: replace destination layer (bounded) (Since 1.0) @CAIRO_OPERATOR_OVER: draw source layer on top of destination layer (bounded) (Since 1.0) @CAIRO_OPERATOR_IN: draw source where there was destination content (unbounded) (Since 1.0) @CAIRO_OPERATOR_OUT: draw source where there was no destination content (unbounded) (Since 1.0) @CAIRO_OPERATOR_ATOP: draw source on top of destination content and only there (Since 1.0) @CAIRO_OPERATOR_DEST: ignore the source (Since 1.0) @CAIRO_OPERATOR_DEST_OVER: draw destination on top of source (Since 1.0) @CAIRO_OPERATOR_DEST_IN: leave destination only where there was source content (unbounded) (Since 1.0) @CAIRO_OPERATOR_DEST_OUT: leave destination only where there was no source content (Since 1.0) @CAIRO_OPERATOR_DEST_ATOP: leave destination on top of source content and only there (unbounded) (Since 1.0) @CAIRO_OPERATOR_XOR: source and destination are shown where there is only one of them (Since 1.0) @CAIRO_OPERATOR_ADD: source and destination layers are accumulated (Since 1.0) @CAIRO_OPERATOR_SATURATE: like over, but assuming source and dest are disjoint geometries (Since 1.0) @CAIRO_OPERATOR_MULTIPLY: source and destination layers are multiplied. This causes the result to be at least as dark as the darker inputs. (Since 1.10) @CAIRO_OPERATOR_SCREEN: source and destination are complemented and multiplied. This causes the result to be at least as light as the lighter inputs. (Since 1.10) @CAIRO_OPERATOR_OVERLAY: multiplies or screens, depending on the lightness of the destination color. (Since 1.10) @CAIRO_OPERATOR_DARKEN: replaces the destination with the source if it is darker, otherwise keeps the source. (Since 1.10) @CAIRO_OPERATOR_LIGHTEN: replaces the destination with the source if it is lighter, otherwise keeps the source. (Since 1.10) @CAIRO_OPERATOR_COLOR_DODGE: brightens the destination color to reflect the source color. (Since 1.10) @CAIRO_OPERATOR_COLOR_BURN: darkens the destination color to reflect the source color. (Since 1.10) @CAIRO_OPERATOR_HARD_LIGHT: Multiplies or screens, dependent on source color. (Since 1.10) @CAIRO_OPERATOR_SOFT_LIGHT: Darkens or lightens, dependent on source color. (Since 1.10) @CAIRO_OPERATOR_DIFFERENCE: Takes the difference of the source and destination color. (Since 1.10) @CAIRO_OPERATOR_EXCLUSION: Produces an effect similar to difference, but with lower contrast. (Since 1.10) @CAIRO_OPERATOR_HSL_HUE: Creates a color with the hue of the source and the saturation and luminosity of the target. (Since 1.10) @CAIRO_OPERATOR_HSL_SATURATION: Creates a color with the saturation of the source and the hue and luminosity of the target. Painting with this mode onto a gray area produces no change. (Since 1.10) @CAIRO_OPERATOR_HSL_COLOR: Creates a color with the hue and saturation of the source and the luminosity of the target. This preserves the gray levels of the target and is useful for coloring monochrome images or tinting color images. (Since 1.10) @CAIRO_OPERATOR_HSL_LUMINOSITY: Creates a color with the luminosity of the source and the hue and saturation of the target. This produces an inverse effect to @CAIRO_OPERATOR_HSL_COLOR. (Since 1.10)

cairo_operator_t is used to set the compositing operator for all cairo drawing operations.

The default operator is CAIRO_OPERATOR_OVER.

The operators marked as <firstterm>unbounded</firstterm> modify their destination even outside of the mask layer (that is, their effect is not bound by the mask layer). However, their effect can still be limited by way of clipping.

To keep things simple, the operator descriptions here document the behavior for when both source and destination are either fully transparent or fully opaque. The actual implementation works for translucent layers too. For a more detailed explanation of the effects of each operator, including the mathematical definitions, see <ulink url="https://cairographics.org/operators/">https://cairographics.org/operators/</ulink>.

Since: 1.0

Enumerator
CAIRO_OPERATOR_CLEAR 
CAIRO_OPERATOR_SOURCE 
CAIRO_OPERATOR_OVER 
CAIRO_OPERATOR_IN 
CAIRO_OPERATOR_OUT 
CAIRO_OPERATOR_ATOP 
CAIRO_OPERATOR_DEST 
CAIRO_OPERATOR_DEST_OVER 
CAIRO_OPERATOR_DEST_IN 
CAIRO_OPERATOR_DEST_OUT 
CAIRO_OPERATOR_DEST_ATOP 
CAIRO_OPERATOR_XOR 
CAIRO_OPERATOR_ADD 
CAIRO_OPERATOR_SATURATE 
CAIRO_OPERATOR_MULTIPLY 
CAIRO_OPERATOR_SCREEN 
CAIRO_OPERATOR_OVERLAY 
CAIRO_OPERATOR_DARKEN 
CAIRO_OPERATOR_LIGHTEN 
CAIRO_OPERATOR_COLOR_DODGE 
CAIRO_OPERATOR_COLOR_BURN 
CAIRO_OPERATOR_HARD_LIGHT 
CAIRO_OPERATOR_SOFT_LIGHT 
CAIRO_OPERATOR_DIFFERENCE 
CAIRO_OPERATOR_EXCLUSION 
CAIRO_OPERATOR_HSL_HUE 
CAIRO_OPERATOR_HSL_SATURATION 
CAIRO_OPERATOR_HSL_COLOR 
CAIRO_OPERATOR_HSL_LUMINOSITY 
CAIRO_OPERATOR_CLEAR 
CAIRO_OPERATOR_SOURCE 
CAIRO_OPERATOR_OVER 
CAIRO_OPERATOR_IN 
CAIRO_OPERATOR_OUT 
CAIRO_OPERATOR_ATOP 
CAIRO_OPERATOR_DEST 
CAIRO_OPERATOR_DEST_OVER 
CAIRO_OPERATOR_DEST_IN 
CAIRO_OPERATOR_DEST_OUT 
CAIRO_OPERATOR_DEST_ATOP 
CAIRO_OPERATOR_XOR 
CAIRO_OPERATOR_ADD 
CAIRO_OPERATOR_SATURATE 
CAIRO_OPERATOR_MULTIPLY 
CAIRO_OPERATOR_SCREEN 
CAIRO_OPERATOR_OVERLAY 
CAIRO_OPERATOR_DARKEN 
CAIRO_OPERATOR_LIGHTEN 
CAIRO_OPERATOR_COLOR_DODGE 
CAIRO_OPERATOR_COLOR_BURN 
CAIRO_OPERATOR_HARD_LIGHT 
CAIRO_OPERATOR_SOFT_LIGHT 
CAIRO_OPERATOR_DIFFERENCE 
CAIRO_OPERATOR_EXCLUSION 
CAIRO_OPERATOR_HSL_HUE 
CAIRO_OPERATOR_HSL_SATURATION 
CAIRO_OPERATOR_HSL_COLOR 
CAIRO_OPERATOR_HSL_LUMINOSITY 
CAIRO_OPERATOR_CLEAR 
CAIRO_OPERATOR_SOURCE 
CAIRO_OPERATOR_OVER 
CAIRO_OPERATOR_IN 
CAIRO_OPERATOR_OUT 
CAIRO_OPERATOR_ATOP 
CAIRO_OPERATOR_DEST 
CAIRO_OPERATOR_DEST_OVER 
CAIRO_OPERATOR_DEST_IN 
CAIRO_OPERATOR_DEST_OUT 
CAIRO_OPERATOR_DEST_ATOP 
CAIRO_OPERATOR_XOR 
CAIRO_OPERATOR_ADD 
CAIRO_OPERATOR_SATURATE 
CAIRO_OPERATOR_MULTIPLY 
CAIRO_OPERATOR_SCREEN 
CAIRO_OPERATOR_OVERLAY 
CAIRO_OPERATOR_DARKEN 
CAIRO_OPERATOR_LIGHTEN 
CAIRO_OPERATOR_COLOR_DODGE 
CAIRO_OPERATOR_COLOR_BURN 
CAIRO_OPERATOR_HARD_LIGHT 
CAIRO_OPERATOR_SOFT_LIGHT 
CAIRO_OPERATOR_DIFFERENCE 
CAIRO_OPERATOR_EXCLUSION 
CAIRO_OPERATOR_HSL_HUE 
CAIRO_OPERATOR_HSL_SATURATION 
CAIRO_OPERATOR_HSL_COLOR 
CAIRO_OPERATOR_HSL_LUMINOSITY 

Definition at line 613 of file cairo.h.

◆ _cairo_path_data_type

cairo_path_data_type_t: @CAIRO_PATH_MOVE_TO: A move-to operation, since 1.0 @CAIRO_PATH_LINE_TO: A line-to operation, since 1.0 @CAIRO_PATH_CURVE_TO: A curve-to operation, since 1.0 @CAIRO_PATH_CLOSE_PATH: A close-path operation, since 1.0

cairo_path_data_t is used to describe the type of one portion of a path when represented as a cairo_path_t. See cairo_path_data_t for details.

Since: 1.0

Enumerator
CAIRO_PATH_MOVE_TO 
CAIRO_PATH_LINE_TO 
CAIRO_PATH_CURVE_TO 
CAIRO_PATH_CLOSE_PATH 
CAIRO_PATH_MOVE_TO 
CAIRO_PATH_LINE_TO 
CAIRO_PATH_CURVE_TO 
CAIRO_PATH_CLOSE_PATH 
CAIRO_PATH_MOVE_TO 
CAIRO_PATH_LINE_TO 
CAIRO_PATH_CURVE_TO 
CAIRO_PATH_CLOSE_PATH 

Definition at line 1993 of file cairo.h.

◆ _cairo_pattern_type

cairo_pattern_type_t: @CAIRO_PATTERN_TYPE_SOLID: The pattern is a solid (uniform) color. It may be opaque or translucent, since 1.2. @CAIRO_PATTERN_TYPE_SURFACE: The pattern is a based on a surface (an image), since 1.2. @CAIRO_PATTERN_TYPE_LINEAR: The pattern is a linear gradient, since 1.2. @CAIRO_PATTERN_TYPE_RADIAL: The pattern is a radial gradient, since 1.2. @CAIRO_PATTERN_TYPE_MESH: The pattern is a mesh, since 1.12. @CAIRO_PATTERN_TYPE_RASTER_SOURCE: The pattern is a user pattern providing raster data, since 1.12.

cairo_pattern_type_t is used to describe the type of a given pattern.

The type of a pattern is determined by the function used to create it. The cairo_pattern_create_rgb() and cairo_pattern_create_rgba() functions create SOLID patterns. The remaining cairo_pattern_createfunctions map to pattern types in obvious ways.

The pattern type can be queried with cairo_pattern_get_type()

Most cairo_pattern_t functions can be called with a pattern of any type, (though trying to change the extend or filter for a solid pattern will have no effect). A notable exception is cairo_pattern_add_color_stop_rgb() and cairo_pattern_add_color_stop_rgba() which must only be called with gradient patterns (either LINEAR or RADIAL). Otherwise the pattern will be shutdown and put into an error state.

New entries may be added in future versions.

Since: 1.2

Enumerator
CAIRO_PATTERN_TYPE_SOLID 
CAIRO_PATTERN_TYPE_SURFACE 
CAIRO_PATTERN_TYPE_LINEAR 
CAIRO_PATTERN_TYPE_RADIAL 
CAIRO_PATTERN_TYPE_MESH 
CAIRO_PATTERN_TYPE_RASTER_SOURCE 
CAIRO_PATTERN_TYPE_SOLID 
CAIRO_PATTERN_TYPE_SURFACE 
CAIRO_PATTERN_TYPE_LINEAR 
CAIRO_PATTERN_TYPE_RADIAL 
CAIRO_PATTERN_TYPE_MESH 
CAIRO_PATTERN_TYPE_RASTER_SOURCE 
CAIRO_PATTERN_TYPE_SOLID 
CAIRO_PATTERN_TYPE_SURFACE 
CAIRO_PATTERN_TYPE_LINEAR 
CAIRO_PATTERN_TYPE_RADIAL 
CAIRO_PATTERN_TYPE_MESH 
CAIRO_PATTERN_TYPE_RASTER_SOURCE 

Definition at line 2824 of file cairo.h.

◆ _cairo_region_overlap

cairo_region_overlap_t: @CAIRO_REGION_OVERLAP_IN: The contents are entirely inside the region. (Since 1.10) @CAIRO_REGION_OVERLAP_OUT: The contents are entirely outside the region. (Since 1.10) @CAIRO_REGION_OVERLAP_PART: The contents are partially inside and partially outside the region. (Since 1.10)

Used as the return value for cairo_region_contains_rectangle().

Since: 1.10

Enumerator
CAIRO_REGION_OVERLAP_IN 
CAIRO_REGION_OVERLAP_OUT 
CAIRO_REGION_OVERLAP_PART 
CAIRO_REGION_OVERLAP_IN 
CAIRO_REGION_OVERLAP_OUT 
CAIRO_REGION_OVERLAP_PART 
CAIRO_REGION_OVERLAP_IN 
CAIRO_REGION_OVERLAP_OUT 
CAIRO_REGION_OVERLAP_PART 

Definition at line 3091 of file cairo.h.

◆ _cairo_status

cairo_status_t: @CAIRO_STATUS_SUCCESS: no error has occurred (Since 1.0) @CAIRO_STATUS_NO_MEMORY: out of memory (Since 1.0) @CAIRO_STATUS_INVALID_RESTORE: cairo_restore() called without matching cairo_save() (Since 1.0) @CAIRO_STATUS_INVALID_POP_GROUP: no saved group to pop, i.e. cairo_pop_group() without matching cairo_push_group() (Since 1.0) @CAIRO_STATUS_NO_CURRENT_POINT: no current point defined (Since 1.0) @CAIRO_STATUS_INVALID_MATRIX: invalid matrix (not invertible) (Since 1.0) @CAIRO_STATUS_INVALID_STATUS: invalid value for an input cairo_status_t (Since 1.0) @CAIRO_STATUS_NULL_POINTER: NULL pointer (Since 1.0) @CAIRO_STATUS_INVALID_STRING: input string not valid UTF-8 (Since 1.0) @CAIRO_STATUS_INVALID_PATH_DATA: input path data not valid (Since 1.0) @CAIRO_STATUS_READ_ERROR: error while reading from input stream (Since 1.0) @CAIRO_STATUS_WRITE_ERROR: error while writing to output stream (Since 1.0) @CAIRO_STATUS_SURFACE_FINISHED: target surface has been finished (Since 1.0) @CAIRO_STATUS_SURFACE_TYPE_MISMATCH: the surface type is not appropriate for the operation (Since 1.0) @CAIRO_STATUS_PATTERN_TYPE_MISMATCH: the pattern type is not appropriate for the operation (Since 1.0) @CAIRO_STATUS_INVALID_CONTENT: invalid value for an input cairo_content_t (Since 1.0) @CAIRO_STATUS_INVALID_FORMAT: invalid value for an input cairo_format_t (Since 1.0) @CAIRO_STATUS_INVALID_VISUAL: invalid value for an input Visual* (Since 1.0) @CAIRO_STATUS_FILE_NOT_FOUND: file not found (Since 1.0) @CAIRO_STATUS_INVALID_DASH: invalid value for a dash setting (Since 1.0) @CAIRO_STATUS_INVALID_DSC_COMMENT: invalid value for a DSC comment (Since 1.2) @CAIRO_STATUS_INVALID_INDEX: invalid index passed to getter (Since 1.4) @CAIRO_STATUS_CLIP_NOT_REPRESENTABLE: clip region not representable in desired format (Since 1.4) @CAIRO_STATUS_TEMP_FILE_ERROR: error creating or writing to a temporary file (Since 1.6) @CAIRO_STATUS_INVALID_STRIDE: invalid value for stride (Since 1.6) @CAIRO_STATUS_FONT_TYPE_MISMATCH: the font type is not appropriate for the operation (Since 1.8) @CAIRO_STATUS_USER_FONT_IMMUTABLE: the user-font is immutable (Since 1.8) @CAIRO_STATUS_USER_FONT_ERROR: error occurred in a user-font callback function (Since 1.8) @CAIRO_STATUS_NEGATIVE_COUNT: negative number used where it is not allowed (Since 1.8) @CAIRO_STATUS_INVALID_CLUSTERS: input clusters do not represent the accompanying text and glyph array (Since 1.8) @CAIRO_STATUS_INVALID_SLANT: invalid value for an input cairo_font_slant_t (Since 1.8) @CAIRO_STATUS_INVALID_WEIGHT: invalid value for an input cairo_font_weight_t (Since 1.8) @CAIRO_STATUS_INVALID_SIZE: invalid value (typically too big) for the size of the input (surface, pattern, etc.) (Since 1.10) @CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED: user-font method not implemented (Since 1.10) @CAIRO_STATUS_DEVICE_TYPE_MISMATCH: the device type is not appropriate for the operation (Since 1.10) @CAIRO_STATUS_DEVICE_ERROR: an operation to the device caused an unspecified error (Since 1.10) @CAIRO_STATUS_INVALID_MESH_CONSTRUCTION: a mesh pattern construction operation was used outside of a cairo_mesh_pattern_begin_patch()/cairo_mesh_pattern_end_patch() pair (Since 1.12) @CAIRO_STATUS_DEVICE_FINISHED: target device has been finished (Since 1.12) @CAIRO_STATUS_JBIG2_GLOBAL_MISSING: CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID has been used on at least one image but no image provided CAIRO_MIME_TYPE_JBIG2_GLOBAL (Since 1.14) @CAIRO_STATUS_PNG_ERROR: error occurred in libpng while reading from or writing to a PNG file (Since 1.16) @CAIRO_STATUS_FREETYPE_ERROR: error occurred in libfreetype (Since 1.16) @CAIRO_STATUS_WIN32_GDI_ERROR: error occurred in the Windows Graphics Device Interface (Since 1.16) @CAIRO_STATUS_TAG_ERROR: invalid tag name, attributes, or nesting (Since 1.16) @CAIRO_STATUS_LAST_STATUS: this is a special value indicating the number of status values defined in this enumeration. When using this value, note that the version of cairo at run-time may have additional status values defined than the value of this symbol at compile-time. (Since 1.10)

cairo_status_t is used to indicate errors that can occur when using Cairo. In some cases it is returned directly by functions. but when using cairo_t, the last error, if any, is stored in the context and can be retrieved with cairo_status().

New entries may be added in future versions. Use cairo_status_to_string() to get a human-readable representation of an error message.

Since: 1.0

Enumerator
CAIRO_STATUS_SUCCESS 
CAIRO_STATUS_NO_MEMORY 
CAIRO_STATUS_INVALID_RESTORE 
CAIRO_STATUS_INVALID_POP_GROUP 
CAIRO_STATUS_NO_CURRENT_POINT 
CAIRO_STATUS_INVALID_MATRIX 
CAIRO_STATUS_INVALID_STATUS 
CAIRO_STATUS_NULL_POINTER 
CAIRO_STATUS_INVALID_STRING 
CAIRO_STATUS_INVALID_PATH_DATA 
CAIRO_STATUS_READ_ERROR 
CAIRO_STATUS_WRITE_ERROR 
CAIRO_STATUS_SURFACE_FINISHED 
CAIRO_STATUS_SURFACE_TYPE_MISMATCH 
CAIRO_STATUS_PATTERN_TYPE_MISMATCH 
CAIRO_STATUS_INVALID_CONTENT 
CAIRO_STATUS_INVALID_FORMAT 
CAIRO_STATUS_INVALID_VISUAL 
CAIRO_STATUS_FILE_NOT_FOUND 
CAIRO_STATUS_INVALID_DASH 
CAIRO_STATUS_INVALID_DSC_COMMENT 
CAIRO_STATUS_INVALID_INDEX 
CAIRO_STATUS_CLIP_NOT_REPRESENTABLE 
CAIRO_STATUS_TEMP_FILE_ERROR 
CAIRO_STATUS_INVALID_STRIDE 
CAIRO_STATUS_FONT_TYPE_MISMATCH 
CAIRO_STATUS_USER_FONT_IMMUTABLE 
CAIRO_STATUS_USER_FONT_ERROR 
CAIRO_STATUS_NEGATIVE_COUNT 
CAIRO_STATUS_INVALID_CLUSTERS 
CAIRO_STATUS_INVALID_SLANT 
CAIRO_STATUS_INVALID_WEIGHT 
CAIRO_STATUS_INVALID_SIZE 
CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED 
CAIRO_STATUS_DEVICE_TYPE_MISMATCH 
CAIRO_STATUS_DEVICE_ERROR 
CAIRO_STATUS_INVALID_MESH_CONSTRUCTION 
CAIRO_STATUS_DEVICE_FINISHED 
CAIRO_STATUS_JBIG2_GLOBAL_MISSING 
CAIRO_STATUS_PNG_ERROR 
CAIRO_STATUS_FREETYPE_ERROR 
CAIRO_STATUS_WIN32_GDI_ERROR 
CAIRO_STATUS_TAG_ERROR 
CAIRO_STATUS_LAST_STATUS 
CAIRO_STATUS_SUCCESS 
CAIRO_STATUS_NO_MEMORY 
CAIRO_STATUS_INVALID_RESTORE 
CAIRO_STATUS_INVALID_POP_GROUP 
CAIRO_STATUS_NO_CURRENT_POINT 
CAIRO_STATUS_INVALID_MATRIX 
CAIRO_STATUS_INVALID_STATUS 
CAIRO_STATUS_NULL_POINTER 
CAIRO_STATUS_INVALID_STRING 
CAIRO_STATUS_INVALID_PATH_DATA 
CAIRO_STATUS_READ_ERROR 
CAIRO_STATUS_WRITE_ERROR 
CAIRO_STATUS_SURFACE_FINISHED 
CAIRO_STATUS_SURFACE_TYPE_MISMATCH 
CAIRO_STATUS_PATTERN_TYPE_MISMATCH 
CAIRO_STATUS_INVALID_CONTENT 
CAIRO_STATUS_INVALID_FORMAT 
CAIRO_STATUS_INVALID_VISUAL 
CAIRO_STATUS_FILE_NOT_FOUND 
CAIRO_STATUS_INVALID_DASH 
CAIRO_STATUS_INVALID_DSC_COMMENT 
CAIRO_STATUS_INVALID_INDEX 
CAIRO_STATUS_CLIP_NOT_REPRESENTABLE 
CAIRO_STATUS_TEMP_FILE_ERROR 
CAIRO_STATUS_INVALID_STRIDE 
CAIRO_STATUS_FONT_TYPE_MISMATCH 
CAIRO_STATUS_USER_FONT_IMMUTABLE 
CAIRO_STATUS_USER_FONT_ERROR 
CAIRO_STATUS_NEGATIVE_COUNT 
CAIRO_STATUS_INVALID_CLUSTERS 
CAIRO_STATUS_INVALID_SLANT 
CAIRO_STATUS_INVALID_WEIGHT 
CAIRO_STATUS_INVALID_SIZE 
CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED 
CAIRO_STATUS_DEVICE_TYPE_MISMATCH 
CAIRO_STATUS_DEVICE_ERROR 
CAIRO_STATUS_INVALID_MESH_CONSTRUCTION 
CAIRO_STATUS_DEVICE_FINISHED 
CAIRO_STATUS_JBIG2_GLOBAL_MISSING 
CAIRO_STATUS_PNG_ERROR 
CAIRO_STATUS_FREETYPE_ERROR 
CAIRO_STATUS_WIN32_GDI_ERROR 
CAIRO_STATUS_TAG_ERROR 
CAIRO_STATUS_LAST_STATUS 
CAIRO_STATUS_SUCCESS 
CAIRO_STATUS_NO_MEMORY 
CAIRO_STATUS_INVALID_RESTORE 
CAIRO_STATUS_INVALID_POP_GROUP 
CAIRO_STATUS_NO_CURRENT_POINT 
CAIRO_STATUS_INVALID_MATRIX 
CAIRO_STATUS_INVALID_STATUS 
CAIRO_STATUS_NULL_POINTER 
CAIRO_STATUS_INVALID_STRING 
CAIRO_STATUS_INVALID_PATH_DATA 
CAIRO_STATUS_READ_ERROR 
CAIRO_STATUS_WRITE_ERROR 
CAIRO_STATUS_SURFACE_FINISHED 
CAIRO_STATUS_SURFACE_TYPE_MISMATCH 
CAIRO_STATUS_PATTERN_TYPE_MISMATCH 
CAIRO_STATUS_INVALID_CONTENT 
CAIRO_STATUS_INVALID_FORMAT 
CAIRO_STATUS_INVALID_VISUAL 
CAIRO_STATUS_FILE_NOT_FOUND 
CAIRO_STATUS_INVALID_DASH 
CAIRO_STATUS_INVALID_DSC_COMMENT 
CAIRO_STATUS_INVALID_INDEX 
CAIRO_STATUS_CLIP_NOT_REPRESENTABLE 
CAIRO_STATUS_TEMP_FILE_ERROR 
CAIRO_STATUS_INVALID_STRIDE 
CAIRO_STATUS_FONT_TYPE_MISMATCH 
CAIRO_STATUS_USER_FONT_IMMUTABLE 
CAIRO_STATUS_USER_FONT_ERROR 
CAIRO_STATUS_NEGATIVE_COUNT 
CAIRO_STATUS_INVALID_CLUSTERS 
CAIRO_STATUS_INVALID_SLANT 
CAIRO_STATUS_INVALID_WEIGHT 
CAIRO_STATUS_INVALID_SIZE 
CAIRO_STATUS_USER_FONT_NOT_IMPLEMENTED 
CAIRO_STATUS_DEVICE_TYPE_MISMATCH 
CAIRO_STATUS_DEVICE_ERROR 
CAIRO_STATUS_INVALID_MESH_CONSTRUCTION 
CAIRO_STATUS_DEVICE_FINISHED 
CAIRO_STATUS_JBIG2_GLOBAL_MISSING 
CAIRO_STATUS_PNG_ERROR 
CAIRO_STATUS_FREETYPE_ERROR 
CAIRO_STATUS_WIN32_GDI_ERROR 
CAIRO_STATUS_TAG_ERROR 
CAIRO_STATUS_LAST_STATUS 

Definition at line 314 of file cairo.h.

◆ _cairo_subpixel_order

cairo_subpixel_order_t: @CAIRO_SUBPIXEL_ORDER_DEFAULT: Use the default subpixel order for for the target device, since 1.0 @CAIRO_SUBPIXEL_ORDER_RGB: Subpixel elements are arranged horizontally with red at the left, since 1.0 @CAIRO_SUBPIXEL_ORDER_BGR: Subpixel elements are arranged horizontally with blue at the left, since 1.0 @CAIRO_SUBPIXEL_ORDER_VRGB: Subpixel elements are arranged vertically with red at the top, since 1.0 @CAIRO_SUBPIXEL_ORDER_VBGR: Subpixel elements are arranged vertically with blue at the top, since 1.0

The subpixel order specifies the order of color elements within each pixel on the display device when rendering with an antialiasing mode of CAIRO_ANTIALIAS_SUBPIXEL.

Since: 1.0

Enumerator
CAIRO_SUBPIXEL_ORDER_DEFAULT 
CAIRO_SUBPIXEL_ORDER_RGB 
CAIRO_SUBPIXEL_ORDER_BGR 
CAIRO_SUBPIXEL_ORDER_VRGB 
CAIRO_SUBPIXEL_ORDER_VBGR 
CAIRO_SUBPIXEL_ORDER_DEFAULT 
CAIRO_SUBPIXEL_ORDER_RGB 
CAIRO_SUBPIXEL_ORDER_BGR 
CAIRO_SUBPIXEL_ORDER_VRGB 
CAIRO_SUBPIXEL_ORDER_VBGR 
CAIRO_SUBPIXEL_ORDER_DEFAULT 
CAIRO_SUBPIXEL_ORDER_RGB 
CAIRO_SUBPIXEL_ORDER_BGR 
CAIRO_SUBPIXEL_ORDER_VRGB 
CAIRO_SUBPIXEL_ORDER_VBGR 

Definition at line 1302 of file cairo.h.

◆ _cairo_surface_type

cairo_surface_type_t: @CAIRO_SURFACE_TYPE_IMAGE: The surface is of type image, since 1.2 @CAIRO_SURFACE_TYPE_PDF: The surface is of type pdf, since 1.2 @CAIRO_SURFACE_TYPE_PS: The surface is of type ps, since 1.2 @CAIRO_SURFACE_TYPE_XLIB: The surface is of type xlib, since 1.2 @CAIRO_SURFACE_TYPE_XCB: The surface is of type xcb, since 1.2 @CAIRO_SURFACE_TYPE_GLITZ: The surface is of type glitz, since 1.2 @CAIRO_SURFACE_TYPE_QUARTZ: The surface is of type quartz, since 1.2 @CAIRO_SURFACE_TYPE_WIN32: The surface is of type win32, since 1.2 @CAIRO_SURFACE_TYPE_BEOS: The surface is of type beos, since 1.2 @CAIRO_SURFACE_TYPE_DIRECTFB: The surface is of type directfb, since 1.2 @CAIRO_SURFACE_TYPE_SVG: The surface is of type svg, since 1.2 @CAIRO_SURFACE_TYPE_OS2: The surface is of type os2, since 1.4 @CAIRO_SURFACE_TYPE_WIN32_PRINTING: The surface is a win32 printing surface, since 1.6 @CAIRO_SURFACE_TYPE_QUARTZ_IMAGE: The surface is of type quartz_image, since 1.6 @CAIRO_SURFACE_TYPE_SCRIPT: The surface is of type script, since 1.10 @CAIRO_SURFACE_TYPE_QT: The surface is of type Qt, since 1.10 @CAIRO_SURFACE_TYPE_RECORDING: The surface is of type recording, since 1.10 @CAIRO_SURFACE_TYPE_VG: The surface is a OpenVG surface, since 1.10 @CAIRO_SURFACE_TYPE_GL: The surface is of type OpenGL, since 1.10 @CAIRO_SURFACE_TYPE_DRM: The surface is of type Direct Render Manager, since 1.10 @CAIRO_SURFACE_TYPE_TEE: The surface is of type 'tee' (a multiplexing surface), since 1.10 @CAIRO_SURFACE_TYPE_XML: The surface is of type XML (for debugging), since 1.10 @CAIRO_SURFACE_TYPE_SUBSURFACE: The surface is a subsurface created with cairo_surface_create_for_rectangle(), since 1.10 @CAIRO_SURFACE_TYPE_COGL: This surface is of type Cogl, since 1.12

cairo_surface_type_t is used to describe the type of a given surface. The surface types are also known as "backends" or "surface backends" within cairo.

The type of a surface is determined by the function used to create it, which will generally be of the form <function>cairo_<emphasis>type</emphasis>_surface_create()</function>, (though see cairo_surface_create_similar() as well).

The surface type can be queried with cairo_surface_get_type()

The various cairo_surface_t functions can be used with surfaces of any type, but some backends also provide type-specific functions that must only be called with a surface of the appropriate type. These functions have names that begin with <literal>cairo_<emphasis>type</emphasis>_surface</literal> such as cairo_image_surface_get_width().

The behavior of calling a type-specific function with a surface of the wrong type is undefined.

New entries may be added in future versions.

Since: 1.2

Enumerator
CAIRO_SURFACE_TYPE_IMAGE 
CAIRO_SURFACE_TYPE_PDF 
CAIRO_SURFACE_TYPE_PS 
CAIRO_SURFACE_TYPE_XLIB 
CAIRO_SURFACE_TYPE_XCB 
CAIRO_SURFACE_TYPE_GLITZ 
CAIRO_SURFACE_TYPE_QUARTZ 
CAIRO_SURFACE_TYPE_WIN32 
CAIRO_SURFACE_TYPE_BEOS 
CAIRO_SURFACE_TYPE_DIRECTFB 
CAIRO_SURFACE_TYPE_SVG 
CAIRO_SURFACE_TYPE_OS2 
CAIRO_SURFACE_TYPE_WIN32_PRINTING 
CAIRO_SURFACE_TYPE_QUARTZ_IMAGE 
CAIRO_SURFACE_TYPE_SCRIPT 
CAIRO_SURFACE_TYPE_QT 
CAIRO_SURFACE_TYPE_RECORDING 
CAIRO_SURFACE_TYPE_VG 
CAIRO_SURFACE_TYPE_GL 
CAIRO_SURFACE_TYPE_DRM 
CAIRO_SURFACE_TYPE_TEE 
CAIRO_SURFACE_TYPE_XML 
CAIRO_SURFACE_TYPE_SKIA 
CAIRO_SURFACE_TYPE_SUBSURFACE 
CAIRO_SURFACE_TYPE_COGL 
CAIRO_SURFACE_TYPE_IMAGE 
CAIRO_SURFACE_TYPE_PDF 
CAIRO_SURFACE_TYPE_PS 
CAIRO_SURFACE_TYPE_XLIB 
CAIRO_SURFACE_TYPE_XCB 
CAIRO_SURFACE_TYPE_GLITZ 
CAIRO_SURFACE_TYPE_QUARTZ 
CAIRO_SURFACE_TYPE_WIN32 
CAIRO_SURFACE_TYPE_BEOS 
CAIRO_SURFACE_TYPE_DIRECTFB 
CAIRO_SURFACE_TYPE_SVG 
CAIRO_SURFACE_TYPE_OS2 
CAIRO_SURFACE_TYPE_WIN32_PRINTING 
CAIRO_SURFACE_TYPE_QUARTZ_IMAGE 
CAIRO_SURFACE_TYPE_SCRIPT 
CAIRO_SURFACE_TYPE_QT 
CAIRO_SURFACE_TYPE_RECORDING 
CAIRO_SURFACE_TYPE_VG 
CAIRO_SURFACE_TYPE_GL 
CAIRO_SURFACE_TYPE_DRM 
CAIRO_SURFACE_TYPE_TEE 
CAIRO_SURFACE_TYPE_XML 
CAIRO_SURFACE_TYPE_SKIA 
CAIRO_SURFACE_TYPE_SUBSURFACE 
CAIRO_SURFACE_TYPE_COGL 
CAIRO_SURFACE_TYPE_IMAGE 
CAIRO_SURFACE_TYPE_PDF 
CAIRO_SURFACE_TYPE_PS 
CAIRO_SURFACE_TYPE_XLIB 
CAIRO_SURFACE_TYPE_XCB 
CAIRO_SURFACE_TYPE_GLITZ 
CAIRO_SURFACE_TYPE_QUARTZ 
CAIRO_SURFACE_TYPE_WIN32 
CAIRO_SURFACE_TYPE_BEOS 
CAIRO_SURFACE_TYPE_DIRECTFB 
CAIRO_SURFACE_TYPE_SVG 
CAIRO_SURFACE_TYPE_OS2 
CAIRO_SURFACE_TYPE_WIN32_PRINTING 
CAIRO_SURFACE_TYPE_QUARTZ_IMAGE 
CAIRO_SURFACE_TYPE_SCRIPT 
CAIRO_SURFACE_TYPE_QT 
CAIRO_SURFACE_TYPE_RECORDING 
CAIRO_SURFACE_TYPE_VG 
CAIRO_SURFACE_TYPE_GL 
CAIRO_SURFACE_TYPE_DRM 
CAIRO_SURFACE_TYPE_TEE 
CAIRO_SURFACE_TYPE_XML 
CAIRO_SURFACE_TYPE_SKIA 
CAIRO_SURFACE_TYPE_SUBSURFACE 
CAIRO_SURFACE_TYPE_COGL 

Definition at line 2397 of file cairo.h.

◆ _cairo_text_cluster_flags

cairo_text_cluster_flags_t: @CAIRO_TEXT_CLUSTER_FLAG_BACKWARD: The clusters in the cluster array map to glyphs in the glyph array from end to start. (Since 1.8)

Specifies properties of a text cluster mapping.

Since: 1.8

Enumerator
CAIRO_TEXT_CLUSTER_FLAG_BACKWARD 
CAIRO_TEXT_CLUSTER_FLAG_BACKWARD 
CAIRO_TEXT_CLUSTER_FLAG_BACKWARD 

Definition at line 1160 of file cairo.h.

◆ cairo_surface_observer_mode_t

cairo_surface_observer_mode_t: @CAIRO_SURFACE_OBSERVER_NORMAL: no recording is done @CAIRO_SURFACE_OBSERVER_RECORD_OPERATIONS: operations are recorded

Whether operations should be recorded.

Since: 1.12

Enumerator
CAIRO_SURFACE_OBSERVER_NORMAL 
CAIRO_SURFACE_OBSERVER_RECORD_OPERATIONS 
CAIRO_SURFACE_OBSERVER_NORMAL 
CAIRO_SURFACE_OBSERVER_RECORD_OPERATIONS 
CAIRO_SURFACE_OBSERVER_NORMAL 
CAIRO_SURFACE_OBSERVER_RECORD_OPERATIONS 

Definition at line 2249 of file cairo.h.

Function Documentation

◆ cairo_append_path()

void cairo_append_path ( cairo_t cr,
const cairo_path_t path 
)

cairo_append_path: @cr: a cairo context @path: path to be appended

Append the @path onto the current path. The @path may be either the return value from one of cairo_copy_path() or cairo_copy_path_flat() or it may be constructed manually. See cairo_path_t for details on how the path data structure should be initialized, and note that <literal>path->status</literal> must be initialized to CAIRO_STATUS_SUCCESS.

Since: 1.0

Definition at line 4292 of file cairo.c.

◆ cairo_arc()

void cairo_arc ( cairo_t cr,
double  xc,
double  yc,
double  radius,
double  angle1,
double  angle2 
)

cairo_arc: @cr: a cairo context @xc: X position of the center of the arc @yc: Y position of the center of the arc @radius: the radius of the arc @angle1: the start angle, in radians @angle2: the end angle, in radians

Adds a circular arc of the given @radius to the current path. The arc is centered at (@xc, @yc), begins at @angle1 and proceeds in the direction of increasing angles to end at @angle2. If @angle2 is less than @angle1 it will be progressively increased by <literal>2*M_PI</literal> until it is greater than @angle1.

If there is a current point, an initial line segment will be added to the path to connect the current point to the beginning of the arc. If this initial line is undesired, it can be avoided by calling cairo_new_sub_path() before calling cairo_arc().

Angles are measured in radians. An angle of 0.0 is in the direction of the positive X axis (in user space). An angle of <literal>M_PI/2.0</literal> radians (90 degrees) is in the direction of the positive Y axis (in user space). Angles increase in the direction from the positive X axis toward the positive Y axis. So with the default transformation matrix, angles increase in a clockwise direction.

(To convert from degrees to radians, use <literal>degrees * (M_PI / 180.)</literal>.)

This function gives the arc in the direction of increasing angles; see cairo_arc_negative() to get the arc in the direction of decreasing angles.

The arc is circular in user space. To achieve an elliptical arc, you can scale the current transformation matrix by different amounts in the X and Y directions. For example, to draw an ellipse in the box given by @x, @y, @width, @height:

<informalexample><programlisting> cairo_save (cr); cairo_translate (cr, x + width / 2., y + height / 2.); cairo_scale (cr, width / 2., height / 2.); cairo_arc (cr, 0., 0., 1., 0., 2 * M_PI); cairo_restore (cr); </programlisting></informalexample>

Since: 1.0

Definition at line 1841 of file cairo.c.

◆ cairo_arc_negative()

void cairo_arc_negative ( cairo_t cr,
double  xc,
double  yc,
double  radius,
double  angle1,
double  angle2 
)

cairo_arc_negative: @cr: a cairo context @xc: X position of the center of the arc @yc: Y position of the center of the arc @radius: the radius of the arc @angle1: the start angle, in radians @angle2: the end angle, in radians

Adds a circular arc of the given @radius to the current path. The arc is centered at (@xc, @yc), begins at @angle1 and proceeds in the direction of decreasing angles to end at @angle2. If @angle2 is greater than @angle1 it will be progressively decreased by <literal>2*M_PI</literal> until it is less than @angle1.

See cairo_arc() for more details. This function differs only in the direction of the arc between the two angles.

Since: 1.0

Definition at line 1886 of file cairo.c.

◆ cairo_clip()

void cairo_clip ( cairo_t cr)

cairo_clip: @cr: a cairo context

Establishes a new clip region by intersecting the current clip region with the current path as it would be filled by cairo_fill() and according to the current fill rule (see cairo_set_fill_rule()).

After cairo_clip(), the current path will be cleared from the cairo context.

The current clip region affects all drawing operations by effectively masking out any changes to the surface that are outside the current clip region.

Calling cairo_clip() can only make the clip region smaller, never larger. But the current clip is part of the graphics state, so a temporary restriction of the clip region can be achieved by calling cairo_clip() within a cairo_save()/cairo_restore() pair. The only other means of increasing the size of the clip region is cairo_reset_clip().

Since: 1.0

Definition at line 2706 of file cairo.c.

◆ cairo_clip_extents()

void cairo_clip_extents ( cairo_t cr,
double *  x1,
double *  y1,
double *  x2,
double *  y2 
)

cairo_clip_extents: @cr: a cairo context @x1: left of the resulting extents @y1: top of the resulting extents @x2: right of the resulting extents @y2: bottom of the resulting extents

Computes a bounding box in user coordinates covering the area inside the current clip.

Since: 1.4

Definition at line 2801 of file cairo.c.

◆ cairo_clip_preserve()

void cairo_clip_preserve ( cairo_t cr)

cairo_clip_preserve: @cr: a cairo context

Establishes a new clip region by intersecting the current clip region with the current path as it would be filled by cairo_fill() and according to the current fill rule (see cairo_set_fill_rule()).

Unlike cairo_clip(), cairo_clip_preserve() preserves the path within the cairo context.

The current clip region affects all drawing operations by effectively masking out any changes to the surface that are outside the current clip region.

Calling cairo_clip_preserve() can only make the clip region smaller, never larger. But the current clip is part of the graphics state, so a temporary restriction of the clip region can be achieved by calling cairo_clip_preserve() within a cairo_save()/cairo_restore() pair. The only other means of increasing the size of the clip region is cairo_reset_clip().

Since: 1.0

Definition at line 2743 of file cairo.c.

◆ cairo_close_path()

void cairo_close_path ( cairo_t cr)

cairo_close_path: @cr: a cairo context

Adds a line segment to the path from the current point to the beginning of the current sub-path, (the most recent point passed to cairo_move_to()), and closes this sub-path. After this call the current point will be at the joined endpoint of the sub-path.

The behavior of cairo_close_path() is distinct from simply calling cairo_line_to() with the equivalent coordinate in the case of stroking. When a closed sub-path is stroked, there are no caps on the ends of the sub-path. Instead, there is a line join connecting the final and initial segments of the sub-path.

If there is no current point before the call to cairo_close_path(), this function will have no effect.

Note: As of cairo version 1.2.4 any call to cairo_close_path() will place an explicit MOVE_TO element into the path immediately after the CLOSE_PATH element, (which can be seen in cairo_copy_path() for example). This can simplify path processing in some cases as it may not be necessary to save the "last move_to point" during processing as the MOVE_TO immediately after the CLOSE_PATH will provide that point.

Since: 1.0

Definition at line 2139 of file cairo.c.

◆ cairo_copy_clip_rectangle_list()

cairo_rectangle_list_t* cairo_copy_clip_rectangle_list ( cairo_t cr)

cairo_copy_clip_rectangle_list: @cr: a cairo context

Gets the current clip region as a list of rectangles in user coordinates. Never returns NULL.

The status in the list may be CAIRO_STATUS_CLIP_NOT_REPRESENTABLE to indicate that the clip region cannot be represented as a list of user-space rectangles. The status may have other values to indicate other errors.

Returns: the current clip region as a list of rectangles in user coordinates, which should be destroyed using cairo_rectangle_list_destroy().

Since: 1.4

Definition at line 2875 of file cairo.c.

◆ cairo_copy_page()

void cairo_copy_page ( cairo_t cr)

cairo_copy_page: @cr: a cairo context

Emits the current page for backends that support multiple pages, but doesn't clear it, so, the contents of the current page will be retained for the next page too. Use cairo_show_page() if you want to get an empty page after the emission.

This is a convenience function that simply calls cairo_surface_copy_page() on @cr's target.

Since: 1.0

Definition at line 2469 of file cairo.c.

◆ cairo_copy_path()

cairo_path_t* cairo_copy_path ( cairo_t cr)

cairo_copy_path: @cr: a cairo context

Creates a copy of the current path and returns it to the user as a cairo_path_t. See cairo_path_data_t for hints on how to iterate over the returned data structure.

This function will always return a valid pointer, but the result will have no data (<literal>data==NULL</literal> and <literal>num_data==0</literal>), if either of the following conditions hold:

<orderedlist> <listitem>If there is insufficient memory to copy the path. In this case <literal>path->status</literal> will be set to CAIRO_STATUS_NO_MEMORY.</listitem> <listitem>If @cr is already in an error state. In this case <literal>path->status</literal> will contain the same status that would be returned by cairo_status().</listitem> </orderedlist>

Return value: the copy of the current path. The caller owns the returned object and should call cairo_path_destroy() when finished with it.

Since: 1.0

Definition at line 4225 of file cairo.c.

◆ cairo_copy_path_flat()

cairo_path_t* cairo_copy_path_flat ( cairo_t cr)

cairo_copy_path_flat: @cr: a cairo context

Gets a flattened copy of the current path and returns it to the user as a cairo_path_t. See cairo_path_data_t for hints on how to iterate over the returned data structure.

This function is like cairo_copy_path() except that any curves in the path will be approximated with piecewise-linear approximations, (accurate to within the current tolerance value). That is, the result is guaranteed to not have any elements of type CAIRO_PATH_CURVE_TO which will instead be replaced by a series of CAIRO_PATH_LINE_TO elements.

This function will always return a valid pointer, but the result will have no data (<literal>data==NULL</literal> and <literal>num_data==0</literal>), if either of the following conditions hold:

<orderedlist> <listitem>If there is insufficient memory to copy the path. In this case <literal>path->status</literal> will be set to CAIRO_STATUS_NO_MEMORY.</listitem> <listitem>If @cr is already in an error state. In this case <literal>path->status</literal> will contain the same status that would be returned by cairo_status().</listitem> </orderedlist>

Return value: the copy of the current path. The caller owns the returned object and should call cairo_path_destroy() when finished with it.

Since: 1.0

Definition at line 4269 of file cairo.c.

◆ cairo_create()

cairo_t* cairo_create ( cairo_surface_t target)

cairo_create: @target: target surface for the context

Creates a new cairo_t with all graphics state parameters set to default values and with @target as a target surface. The target surface should be constructed with a backend-specific function such as cairo_image_surface_create() (or any other <function>cairo_<emphasis>backend</emphasis>_surface_create()</function> variant).

This function references @target, so you can immediately call cairo_surface_destroy() on it if you don't need to maintain a separate reference to it.

Return value: a newly allocated cairo_t with a reference count of 1. The initial reference count should be released with cairo_destroy() when you are done using the cairo_t. This function never returns NULL. If memory cannot be allocated, a special cairo_t object will be returned on which cairo_status() returns CAIRO_STATUS_NO_MEMORY. If you attempt to target a surface which does not support writing (such as #cairo_mime_surface_t) then a CAIRO_STATUS_WRITE_ERROR will be raised. You can use this object normally, but no drawing will be done.

Since: 1.0

Definition at line 446 of file cairo.c.

◆ cairo_curve_to()

void cairo_curve_to ( cairo_t cr,
double  x1,
double  y1,
double  x2,
double  y2,
double  x3,
double  y3 
)

cairo_curve_to: @cr: a cairo context @x1: the X coordinate of the first control point @y1: the Y coordinate of the first control point @x2: the X coordinate of the second control point @y2: the Y coordinate of the second control point @x3: the X coordinate of the end of the curve @y3: the Y coordinate of the end of the curve

Adds a cubic Bézier spline to the path from the current point to position (@x3, @y3) in user-space coordinates, using (@x1, @y1) and (@x2, @y2) as the control points. After this call the current point will be (@x3, @y3).

If there is no current point before the call to cairo_curve_to() this function will behave as if preceded by a call to cairo_move_to(@cr, @x1, @y1).

Since: 1.0

Definition at line 1771 of file cairo.c.

◆ cairo_debug_reset_static_data()

void cairo_debug_reset_static_data ( void  )

cairo_debug_reset_static_data:

Resets all static data within cairo to its original state, (ie. identical to the state at the time of program invocation). For example, all caches within cairo will be flushed empty.

This function is intended to be useful when using memory-checking tools such as valgrind. When valgrind's memcheck analyzes a cairo-using program without a call to cairo_debug_reset_static_data(), it will report all data reachable via cairo's static objects as "still reachable". Calling cairo_debug_reset_static_data() just prior to program termination will make it easier to get squeaky clean reports from valgrind.

WARNING: It is only safe to call this function when there are no active cairo objects remaining, (ie. the appropriate destroy functions have been called as necessary). If there are active cairo objects, this call is likely to cause a crash, (eg. an assertion failure due to a hash table being destroyed when non-empty).

Since: 1.0

Definition at line 63 of file cairo-debug.c.

◆ cairo_destroy()

void cairo_destroy ( cairo_t cr)

cairo_destroy: @cr: a cairo_t

Decreases the reference count on @cr by one. If the result is zero, then @cr and all associated resources are freed. See cairo_reference().

Since: 1.0

Definition at line 519 of file cairo.c.

◆ cairo_device_acquire()

cairo_status_t cairo_device_acquire ( cairo_device_t device)

cairo_device_acquire: @device: a cairo_device_t

Acquires the @device for the current thread. This function will block until no other thread has acquired the device.

If the return value is CAIRO_STATUS_SUCCESS, you successfully acquired the device. From now on your thread owns the device and no other thread will be able to acquire it until a matching call to cairo_device_release(). It is allowed to recursively acquire the device multiple times from the same thread.

<note>

You must never acquire two different devices at the same time unless this is explicitly allowed. Otherwise the possibility of deadlocks exist.

As various Cairo functions can acquire devices when called, these functions may also cause deadlocks when you call them with an acquired device. So you must not have a device acquired when calling them. These functions are marked in the documentation.

</note>

Return value: CAIRO_STATUS_SUCCESS on success or an error code if the device is in an error state and could not be acquired. After a successful call to cairo_device_acquire(), a matching call to cairo_device_release() is required.

Since: 1.10

Definition at line 414 of file cairo-device.c.

◆ cairo_device_destroy()

void cairo_device_destroy ( cairo_device_t device)

cairo_device_destroy: @device: a cairo_device_t

Decreases the reference count on @device by one. If the result is zero, then @device and all associated resources are freed. See cairo_device_reference().

This function may acquire devices if the last reference was dropped.

Since: 1.10

Definition at line 332 of file cairo-device.c.

◆ cairo_device_finish()

void cairo_device_finish ( cairo_device_t device)

cairo_device_finish: @device: the cairo_device_t to finish

This function finishes the device and drops all references to external resources. All surfaces, fonts and other objects created for this @device will be finished, too. Further operations on the @device will not affect the @device but will instead trigger a CAIRO_STATUS_DEVICE_FINISHED error.

When the last call to cairo_device_destroy() decreases the reference count to zero, cairo will call cairo_device_finish() if it hasn't been called already, before freeing the resources associated with the device.

This function may acquire devices.

Since: 1.10

Definition at line 295 of file cairo-device.c.

◆ cairo_device_flush()

void cairo_device_flush ( cairo_device_t device)

cairo_device_flush: @device: a cairo_device_t

Finish any pending operations for the device and also restore any temporary modifications cairo has made to the device's state. This function must be called before switching from using the device with Cairo to operating on it directly with native APIs. If the device doesn't support direct access, then this function does nothing.

This function may acquire devices.

Since: 1.10

Definition at line 257 of file cairo-device.c.

◆ cairo_device_get_reference_count()

unsigned int cairo_device_get_reference_count ( cairo_device_t device)

cairo_device_get_reference_count: @device: a cairo_device_t

Returns the current reference count of @device.

Return value: the current reference count of @device. If the object is a nil object, 0 will be returned.

Since: 1.10

Definition at line 485 of file cairo-device.c.

◆ cairo_device_get_type()

cairo_device_type_t cairo_device_get_type ( cairo_device_t device)

cairo_device_get_type: @device: a cairo_device_t

This function returns the type of the device. See cairo_device_type_t for available types.

Return value: The type of @device.

Since: 1.10

Definition at line 372 of file cairo-device.c.

◆ cairo_device_get_user_data()

void* cairo_device_get_user_data ( cairo_device_t device,
const cairo_user_data_key_t key 
)

cairo_device_get_user_data: @device: a cairo_device_t @key: the address of the cairo_user_data_key_t the user data was attached to

Return user data previously attached to @device using the specified key. If no user data has been attached with the given key this function returns NULL.

Return value: the user data previously attached or NULL.

Since: 1.10

Definition at line 509 of file cairo-device.c.

◆ cairo_device_observer_elapsed()

double cairo_device_observer_elapsed ( cairo_device_t device)

Definition at line 2018 of file cairo-surface-observer.c.

◆ cairo_device_observer_fill_elapsed()

double cairo_device_observer_fill_elapsed ( cairo_device_t device)

Definition at line 2063 of file cairo-surface-observer.c.

◆ cairo_device_observer_glyphs_elapsed()

double cairo_device_observer_glyphs_elapsed ( cairo_device_t device)

Definition at line 2093 of file cairo-surface-observer.c.

◆ cairo_device_observer_mask_elapsed()

double cairo_device_observer_mask_elapsed ( cairo_device_t device)

Definition at line 2048 of file cairo-surface-observer.c.

◆ cairo_device_observer_paint_elapsed()

double cairo_device_observer_paint_elapsed ( cairo_device_t device)

Definition at line 2033 of file cairo-surface-observer.c.

◆ cairo_device_observer_print()

cairo_status_t cairo_device_observer_print ( cairo_device_t device,
cairo_write_func_t  write_func,
void closure 
)

Definition at line 1997 of file cairo-surface-observer.c.

◆ cairo_device_observer_stroke_elapsed()

double cairo_device_observer_stroke_elapsed ( cairo_device_t device)

Definition at line 2078 of file cairo-surface-observer.c.

◆ cairo_device_reference()

cairo_device_t* cairo_device_reference ( cairo_device_t device)

cairo_device_reference: @device: a cairo_device_t

Increases the reference count on @device by one. This prevents @device from being destroyed until a matching call to cairo_device_destroy() is made.

Use cairo_device_get_reference_count() to get the number of references to a cairo_device_t.

Return value: the referenced cairo_device_t.

Since: 1.10

Definition at line 205 of file cairo-device.c.

◆ cairo_device_release()

void cairo_device_release ( cairo_device_t device)

cairo_device_release: @device: a cairo_device_t

Releases a @device previously acquired using cairo_device_acquire(). See that function for details.

Since: 1.10

Definition at line 445 of file cairo-device.c.

◆ cairo_device_set_user_data()

cairo_status_t cairo_device_set_user_data ( cairo_device_t device,
const cairo_user_data_key_t key,
void user_data,
cairo_destroy_func_t  destroy 
)

cairo_device_set_user_data: @device: a cairo_device_t @key: the address of a cairo_user_data_key_t to attach the user data to @user_data: the user data to attach to the cairo_device_t @destroy: a cairo_destroy_func_t which will be called when the cairo_t is destroyed or when new user data is attached using the same key.

Attach user data to @device. To remove user data from a surface, call this function with the key that was used to set it and NULL for @data.

Return value: CAIRO_STATUS_SUCCESS or CAIRO_STATUS_NO_MEMORY if a slot could not be allocated for the user data.

Since: 1.10

Definition at line 535 of file cairo-device.c.

◆ cairo_device_status()

cairo_status_t cairo_device_status ( cairo_device_t device)

cairo_device_status: @device: a cairo_device_t

Checks whether an error has previously occurred for this device.

Return value: CAIRO_STATUS_SUCCESS on success or an error code if the device is in an error state.

Since: 1.10

Definition at line 233 of file cairo-device.c.

◆ cairo_device_to_user()

void cairo_device_to_user ( cairo_t cr,
double *  x,
double *  y 
)

cairo_device_to_user: @cr: a cairo @x: X value of coordinate (in/out parameter) @y: Y value of coordinate (in/out parameter)

Transform a coordinate from device space to user space by multiplying the given point by the inverse of the current transformation matrix (CTM).

Since: 1.0

Definition at line 1609 of file cairo.c.

◆ cairo_device_to_user_distance()

void cairo_device_to_user_distance ( cairo_t cr,
double *  dx,
double *  dy 
)

cairo_device_to_user_distance: @cr: a cairo context @dx: X component of a distance vector (in/out parameter) @dy: Y component of a distance vector (in/out parameter)

Transform a distance vector from device space to user space. This function is similar to cairo_device_to_user() except that the translation components of the inverse CTM will be ignored when transforming (@dx,@dy).

Since: 1.0

Definition at line 1632 of file cairo.c.

◆ cairo_fill()

void cairo_fill ( cairo_t cr)

cairo_fill: @cr: a cairo context

A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled). After cairo_fill(), the current path will be cleared from the cairo context. See cairo_set_fill_rule() and cairo_fill_preserve().

Since: 1.0

Definition at line 2415 of file cairo.c.

◆ cairo_fill_extents()

void cairo_fill_extents ( cairo_t cr,
double *  x1,
double *  y1,
double *  x2,
double *  y2 
)

cairo_fill_extents: @cr: a cairo context @x1: left of the resulting extents @y1: top of the resulting extents @x2: right of the resulting extents @y2: bottom of the resulting extents

Computes a bounding box in user coordinates covering the area that would be affected, (the "inked" area), by a cairo_fill() operation given the current path and fill parameters. If the current path is empty, returns an empty rectangle ((0,0), (0,0)). Surface dimensions and clipping are not taken into account.

Contrast with cairo_path_extents(), which is similar, but returns non-zero extents for some paths with no inked area, (such as a simple line segment).

Note that cairo_fill_extents() must necessarily do more work to compute the precise inked areas in light of the fill rule, so cairo_path_extents() may be more desirable for sake of performance if the non-inked path extents are desired.

See cairo_fill(), cairo_set_fill_rule() and cairo_fill_preserve().

Since: 1.0

Definition at line 2658 of file cairo.c.

◆ cairo_fill_preserve()

void cairo_fill_preserve ( cairo_t cr)

cairo_fill_preserve: @cr: a cairo context

A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled). Unlike cairo_fill(), cairo_fill_preserve() preserves the path within the cairo context.

See cairo_set_fill_rule() and cairo_fill().

Since: 1.0

Definition at line 2441 of file cairo.c.

◆ cairo_font_extents()

void cairo_font_extents ( cairo_t cr,
cairo_font_extents_t extents 
)

cairo_font_extents: @cr: a cairo_t @extents: a cairo_font_extents_t object into which the results will be stored.

Gets the font extents for the currently selected font.

Since: 1.0

Definition at line 3066 of file cairo.c.

◆ cairo_font_face_destroy()

void cairo_font_face_destroy ( cairo_font_face_t font_face)

cairo_font_face_destroy: @font_face: a cairo_font_face_t

Decreases the reference count on @font_face by one. If the result is zero, then @font_face and all associated resources are freed. See cairo_font_face_reference().

Since: 1.0

Definition at line 171 of file cairo-font-face.c.

◆ cairo_font_face_get_reference_count()

unsigned int cairo_font_face_get_reference_count ( cairo_font_face_t font_face)

cairo_font_face_get_reference_count: @font_face: a cairo_font_face_t

Returns the current reference count of @font_face.

Return value: the current reference count of @font_face. If the object is a nil object, 0 will be returned.

Since: 1.4

Definition at line 227 of file cairo-font-face.c.

◆ cairo_font_face_get_type()

cairo_font_type_t cairo_font_face_get_type ( cairo_font_face_t font_face)

cairo_font_face_get_type: @font_face: a font face

This function returns the type of the backend used to create a font face. See cairo_font_type_t for available types.

Return value: The type of @font_face.

Since: 1.2

Definition at line 207 of file cairo-font-face.c.

◆ cairo_font_face_get_user_data()

void* cairo_font_face_get_user_data ( cairo_font_face_t font_face,
const cairo_user_data_key_t key 
)

cairo_font_face_get_user_data: @font_face: a cairo_font_face_t @key: the address of the cairo_user_data_key_t the user data was attached to

Return user data previously attached to @font_face using the specified key. If no user data has been attached with the given key this function returns NULL.

Return value: the user data previously attached or NULL.

Since: 1.0

Definition at line 269 of file cairo-font-face.c.

◆ cairo_font_face_reference()

cairo_font_face_t* cairo_font_face_reference ( cairo_font_face_t font_face)

cairo_font_face_reference: @font_face: a cairo_font_face_t, (may be NULL in which case this function does nothing).

Increases the reference count on @font_face by one. This prevents @font_face from being destroyed until a matching call to cairo_font_face_destroy() is made.

Use cairo_font_face_get_reference_count() to get the number of references to a cairo_font_face_t.

Return value: the referenced cairo_font_face_t.

Since: 1.0

Definition at line 122 of file cairo-font-face.c.

◆ cairo_font_face_set_user_data()

cairo_status_t cairo_font_face_set_user_data ( cairo_font_face_t font_face,
const cairo_user_data_key_t key,
void user_data,
cairo_destroy_func_t  destroy 
)

cairo_font_face_set_user_data: @font_face: a cairo_font_face_t @key: the address of a cairo_user_data_key_t to attach the user data to @user_data: the user data to attach to the font face @destroy: a cairo_destroy_func_t which will be called when the font face is destroyed or when new user data is attached using the same key.

Attach user data to @font_face. To remove user data from a font face, call this function with the key that was used to set it and NULL for @data.

Return value: CAIRO_STATUS_SUCCESS or CAIRO_STATUS_NO_MEMORY if a slot could not be allocated for the user data.

Since: 1.0

Definition at line 296 of file cairo-font-face.c.

◆ cairo_font_face_status()

cairo_status_t cairo_font_face_status ( cairo_font_face_t font_face)

cairo_font_face_status: @font_face: a cairo_font_face_t

Checks whether an error has previously occurred for this font face

Return value: CAIRO_STATUS_SUCCESS or another error such as CAIRO_STATUS_NO_MEMORY.

Since: 1.0

Definition at line 249 of file cairo-font-face.c.

◆ cairo_font_options_copy()

cairo_font_options_t* cairo_font_options_copy ( const cairo_font_options_t original)

cairo_font_options_copy: @original: a cairo_font_options_t

Allocates a new font options object copying the option values from @original.

Return value: a newly allocated cairo_font_options_t. Free with cairo_font_options_destroy(). This function always returns a valid pointer; if memory cannot be allocated, then a special error object is returned where all operations on the object do nothing. You can check for this with cairo_font_options_status().

Since: 1.0

Definition at line 139 of file cairo-font-options.c.

◆ cairo_font_options_create()

cairo_font_options_t* cairo_font_options_create ( void  )

cairo_font_options_create:

Allocates a new font options object with all options initialized to default values.

Return value: a newly allocated cairo_font_options_t. Free with cairo_font_options_destroy(). This function always returns a valid pointer; if memory cannot be allocated, then a special error object is returned where all operations on the object do nothing. You can check for this with cairo_font_options_status().

Since: 1.0

Definition at line 108 of file cairo-font-options.c.

◆ cairo_font_options_destroy()

void cairo_font_options_destroy ( cairo_font_options_t options)

cairo_font_options_destroy: @options: a cairo_font_options_t

Destroys a cairo_font_options_t object created with cairo_font_options_create() or cairo_font_options_copy().

Since: 1.0

Definition at line 173 of file cairo-font-options.c.

◆ cairo_font_options_equal()

cairo_bool_t cairo_font_options_equal ( const cairo_font_options_t options,
const cairo_font_options_t other 
)

cairo_font_options_equal: @options: a cairo_font_options_t @other: another cairo_font_options_t

Compares two font options objects for equality.

Return value: TRUE if all fields of the two font options objects match. Note that this function will return FALSE if either object is in error.

Since: 1.0

Definition at line 274 of file cairo-font-options.c.

◆ cairo_font_options_get_antialias()

cairo_antialias_t cairo_font_options_get_antialias ( const cairo_font_options_t options)

cairo_font_options_get_antialias: @options: a cairo_font_options_t

Gets the antialiasing mode for the font options object.

Return value: the antialiasing mode

Since: 1.0

Definition at line 362 of file cairo-font-options.c.

◆ cairo_font_options_get_hint_metrics()

cairo_hint_metrics_t cairo_font_options_get_hint_metrics ( const cairo_font_options_t options)

cairo_font_options_get_hint_metrics: @options: a cairo_font_options_t

Gets the metrics hinting mode for the font options object. See the documentation for cairo_hint_metrics_t for full details.

Return value: the metrics hinting mode for the font options object

Since: 1.0

Definition at line 565 of file cairo-font-options.c.

◆ cairo_font_options_get_hint_style()

cairo_hint_style_t cairo_font_options_get_hint_style ( const cairo_font_options_t options)

cairo_font_options_get_hint_style: @options: a cairo_font_options_t

Gets the hint style for font outlines for the font options object. See the documentation for cairo_hint_style_t for full details.

Return value: the hint style for the font options object

Since: 1.0

Definition at line 522 of file cairo-font-options.c.

◆ cairo_font_options_get_subpixel_order()

cairo_subpixel_order_t cairo_font_options_get_subpixel_order ( const cairo_font_options_t options)

cairo_font_options_get_subpixel_order: @options: a cairo_font_options_t

Gets the subpixel order for the font options object. See the documentation for cairo_subpixel_order_t for full details.

Return value: the subpixel order for the font options object

Since: 1.0

Definition at line 406 of file cairo-font-options.c.

◆ cairo_font_options_get_variations()

const char* cairo_font_options_get_variations ( cairo_font_options_t options)

cairo_font_options_get_variations: @options: a cairo_font_options_t

Gets the OpenType font variations for the font options object. See cairo_font_options_set_variations() for details about the string format.

Return value: the font variations for the font options object. The returned string belongs to the @options and must not be modified. It is valid until either the font options object is destroyed or the font variations in this object is modified with cairo_font_options_set_variations().

Since: 1.16

Definition at line 619 of file cairo-font-options.c.

◆ cairo_font_options_hash()

unsigned long cairo_font_options_hash ( const cairo_font_options_t options)

cairo_font_options_hash: @options: a cairo_font_options_t

Compute a hash for the font options object; this value will be useful when storing an object containing a cairo_font_options_t in a hash table.

Return value: the hash value for the font options object. The return value can be cast to a 32-bit type if a 32-bit hash value is needed.

Since: 1.0

Definition at line 312 of file cairo-font-options.c.

◆ cairo_font_options_merge()

void cairo_font_options_merge ( cairo_font_options_t options,
const cairo_font_options_t other 
)

cairo_font_options_merge: @options: a cairo_font_options_t @other: another cairo_font_options_t

Merges non-default options from @other into @options, replacing existing values. This operation can be thought of as somewhat similar to compositing @other onto @options with the operation of CAIRO_OPERATOR_OVER.

Since: 1.0

Definition at line 218 of file cairo-font-options.c.

◆ cairo_font_options_set_antialias()

void cairo_font_options_set_antialias ( cairo_font_options_t options,
cairo_antialias_t  antialias 
)

cairo_font_options_set_antialias: @options: a cairo_font_options_t @antialias: the new antialiasing mode

Sets the antialiasing mode for the font options object. This specifies the type of antialiasing to do when rendering text.

Since: 1.0

Definition at line 341 of file cairo-font-options.c.

◆ cairo_font_options_set_hint_metrics()

void cairo_font_options_set_hint_metrics ( cairo_font_options_t options,
cairo_hint_metrics_t  hint_metrics 
)

cairo_font_options_set_hint_metrics: @options: a cairo_font_options_t @hint_metrics: the new metrics hinting mode

Sets the metrics hinting mode for the font options object. This controls whether metrics are quantized to integer values in device units. See the documentation for cairo_hint_metrics_t for full details.

Since: 1.0

Definition at line 543 of file cairo-font-options.c.

◆ cairo_font_options_set_hint_style()

void cairo_font_options_set_hint_style ( cairo_font_options_t options,
cairo_hint_style_t  hint_style 
)

cairo_font_options_set_hint_style: @options: a cairo_font_options_t @hint_style: the new hint style

Sets the hint style for font outlines for the font options object. This controls whether to fit font outlines to the pixel grid, and if so, whether to optimize for fidelity or contrast. See the documentation for cairo_hint_style_t for full details.

Since: 1.0

Definition at line 500 of file cairo-font-options.c.

◆ cairo_font_options_set_subpixel_order()

void cairo_font_options_set_subpixel_order ( cairo_font_options_t options,
cairo_subpixel_order_t  subpixel_order 
)

cairo_font_options_set_subpixel_order: @options: a cairo_font_options_t @subpixel_order: the new subpixel order

Sets the subpixel order for the font options object. The subpixel order specifies the order of color elements within each pixel on the display device when rendering with an antialiasing mode of CAIRO_ANTIALIAS_SUBPIXEL. See the documentation for cairo_subpixel_order_t for full details.

Since: 1.0

Definition at line 384 of file cairo-font-options.c.

◆ cairo_font_options_set_variations()

void cairo_font_options_set_variations ( cairo_font_options_t options,
const char *  variations 
)

cairo_font_options_set_variations: @options: a cairo_font_options_t @variations: the new font variations, or NULL

Sets the OpenType font variations for the font options object. Font variations are specified as a string with a format that is similar to the CSS font-variation-settings. The string contains a comma-separated list of axis assignments, which each assignment consists of a 4-character axis name and a value, separated by whitespace and optional equals sign.

Examples:

wght=200,wdth=140.5

wght 200 , wdth 140.5

Since: 1.16

Definition at line 594 of file cairo-font-options.c.

◆ cairo_font_options_status()

cairo_status_t cairo_font_options_status ( cairo_font_options_t options)

cairo_font_options_status: @options: a cairo_font_options_t

Checks whether an error has previously occurred for this font options object

Return value: CAIRO_STATUS_SUCCESS or CAIRO_STATUS_NO_MEMORY

Since: 1.0

Definition at line 194 of file cairo-font-options.c.

◆ cairo_format_stride_for_width()

int cairo_format_stride_for_width ( cairo_format_t  format,
int  width 
)

cairo_format_stride_for_width: @format: A cairo_format_t value @width: The desired width of an image surface to be created.

This function provides a stride value that will respect all alignment requirements of the accelerated image-rendering code within cairo. Typical usage will be of the form:

<informalexample><programlisting> int stride; unsigned char *data; cairo_surface_t *surface;

stride = cairo_format_stride_for_width (format, width); data = malloc (stride * height); surface = cairo_image_surface_create_for_data (data, format, width, height, stride); </programlisting></informalexample>

Return value: the appropriate stride to use given the desired format and width, or -1 if either the format is invalid or the width too large.

Since: 1.6

Definition at line 443 of file cairo-image-surface.c.

◆ cairo_get_antialias()

cairo_antialias_t cairo_get_antialias ( cairo_t cr)

cairo_get_antialias: @cr: a cairo context

Gets the current shape antialiasing mode, as set by cairo_set_antialias().

Return value: the current shape antialiasing mode.

Since: 1.0

Definition at line 3940 of file cairo.c.

◆ cairo_get_current_point()

void cairo_get_current_point ( cairo_t cr,
double *  x_ret,
double *  y_ret 
)

cairo_get_current_point: @cr: a cairo context @x: return value for X coordinate of the current point @y: return value for Y coordinate of the current point

Gets the current point of the current path, which is conceptually the final point reached by the path so far.

The current point is returned in the user-space coordinate system. If there is no defined current point or if @cr is in an error status, @x and @y will both be set to 0.0. It is possible to check this in advance with cairo_has_current_point().

Most path construction functions alter the current point. See the following for details on how they affect the current point: cairo_new_path(), cairo_new_sub_path(), cairo_append_path(), cairo_close_path(), cairo_move_to(), cairo_line_to(), cairo_curve_to(), cairo_rel_move_to(), cairo_rel_line_to(), cairo_rel_curve_to(), cairo_arc(), cairo_arc_negative(), cairo_rectangle(), cairo_text_path(), cairo_glyph_path(), cairo_stroke_to_path().

Some functions use and alter the current point but do not otherwise change current path: cairo_show_text().

Some functions unset the current path and as a result, current point: cairo_fill(), cairo_stroke().

Since: 1.0

Definition at line 4001 of file cairo.c.

◆ cairo_get_dash()

void cairo_get_dash ( cairo_t cr,
double *  dashes,
double *  offset 
)

cairo_get_dash: @cr: a cairo_t @dashes: return value for the dash array, or NULL @offset: return value for the current dash offset, or NULL

Gets the current dash array. If not NULL, @dashes should be big enough to hold at least the number of values returned by cairo_get_dash_count().

Since: 1.4

Definition at line 1341 of file cairo.c.

◆ cairo_get_dash_count()

int cairo_get_dash_count ( cairo_t cr)

cairo_get_dash_count: @cr: a cairo_t

This function returns the length of the dash array in @cr (0 if dashing is not currently in effect).

See also cairo_set_dash() and cairo_get_dash().

Return value: the length of the dash array, or 0 if no dash array set.

Since: 1.4

Definition at line 1316 of file cairo.c.

◆ cairo_get_fill_rule()

cairo_fill_rule_t cairo_get_fill_rule ( cairo_t cr)

cairo_get_fill_rule: @cr: a cairo context

Gets the current fill rule, as set by cairo_set_fill_rule().

Return value: the current fill rule.

Since: 1.0

Definition at line 4030 of file cairo.c.

◆ cairo_get_font_face()

cairo_font_face_t* cairo_get_font_face ( cairo_t cr)

cairo_get_font_face: @cr: a cairo_t

Gets the current font face for a cairo_t.

Return value: the current font face. This object is owned by cairo. To keep a reference to it, you must call cairo_font_face_reference().

This function never returns NULL. If memory cannot be allocated, a special "nil" cairo_font_face_t object will be returned on which cairo_font_face_status() returns CAIRO_STATUS_NO_MEMORY. Using this nil object will cause its error state to propagate to other objects it is passed to, (for example, calling cairo_set_font_face() with a nil font will trigger an error that will shutdown the cairo_t object).

Since: 1.0

Definition at line 3131 of file cairo.c.

◆ cairo_get_font_matrix()

void cairo_get_font_matrix ( cairo_t cr,
cairo_matrix_t matrix 
)

cairo_get_font_matrix: @cr: a cairo_t @matrix: return value for the matrix

Stores the current font matrix into @matrix. See cairo_set_font_matrix().

Since: 1.0

Definition at line 3211 of file cairo.c.

◆ cairo_get_font_options()

void cairo_get_font_options ( cairo_t cr,
cairo_font_options_t options 
)

cairo_get_font_options: @cr: a cairo_t @options: a cairo_font_options_t object into which to store the retrieved options. All existing values are overwritten

Retrieves font rendering options set via cairo_set_font_options. Note that the returned options do not include any options derived from the underlying surface; they are literally the options passed to cairo_set_font_options().

Since: 1.0

Definition at line 3269 of file cairo.c.

◆ cairo_get_group_target()

cairo_surface_t* cairo_get_group_target ( cairo_t cr)

cairo_get_group_target: @cr: a cairo context

Gets the current destination surface for the context. This is either the original target surface as passed to cairo_create() or the target surface for the current group as started by the most recent call to cairo_push_group() or cairo_push_group_with_content().

This function will always return a valid pointer, but the result can be a "nil" surface if @cr is already in an error state, (ie. cairo_status() <literal>!=</literal> CAIRO_STATUS_SUCCESS). A nil surface is indicated by cairo_surface_status() <literal>!=</literal> CAIRO_STATUS_SUCCESS.

Return value: the target surface. This object is owned by cairo. To keep a reference to it, you must call cairo_surface_reference().

Since: 1.2

Definition at line 4188 of file cairo.c.

◆ cairo_get_line_cap()

cairo_line_cap_t cairo_get_line_cap ( cairo_t cr)

cairo_get_line_cap: @cr: a cairo context

Gets the current line cap style, as set by cairo_set_line_cap().

Return value: the current line cap style.

Since: 1.0

Definition at line 4072 of file cairo.c.

◆ cairo_get_line_join()

cairo_line_join_t cairo_get_line_join ( cairo_t cr)

cairo_get_line_join: @cr: a cairo context

Gets the current line join style, as set by cairo_set_line_join().

Return value: the current line join style.

Since: 1.0

Definition at line 4091 of file cairo.c.

◆ cairo_get_line_width()

double cairo_get_line_width ( cairo_t cr)

cairo_get_line_width: @cr: a cairo context

This function returns the current line width value exactly as set by cairo_set_line_width(). Note that the value is unchanged even if the CTM has changed between the calls to cairo_set_line_width() and cairo_get_line_width().

Return value: the current line width.

Since: 1.0

Definition at line 4052 of file cairo.c.

◆ cairo_get_matrix()

void cairo_get_matrix ( cairo_t cr,
cairo_matrix_t matrix 
)

cairo_get_matrix: @cr: a cairo context @matrix: return value for the matrix

Stores the current transformation matrix (CTM) into @matrix.

Since: 1.0

Definition at line 4128 of file cairo.c.

◆ cairo_get_miter_limit()

double cairo_get_miter_limit ( cairo_t cr)

cairo_get_miter_limit: @cr: a cairo context

Gets the current miter limit, as set by cairo_set_miter_limit().

Return value: the current miter limit.

Since: 1.0

Definition at line 4110 of file cairo.c.

◆ cairo_get_operator()

cairo_operator_t cairo_get_operator ( cairo_t cr)

cairo_get_operator: @cr: a cairo context

Gets the current compositing operator for a cairo context.

Return value: the current compositing operator.

Since: 1.0

Definition at line 3879 of file cairo.c.

◆ cairo_get_reference_count()

unsigned int cairo_get_reference_count ( cairo_t cr)

cairo_get_reference_count: @cr: a cairo_t

Returns the current reference count of @cr.

Return value: the current reference count of @cr. If the object is a nil object, 0 will be returned.

Since: 1.4

Definition at line 597 of file cairo.c.

◆ cairo_get_scaled_font()

cairo_scaled_font_t* cairo_get_scaled_font ( cairo_t cr)

cairo_get_scaled_font: @cr: a cairo_t

Gets the current scaled font for a cairo_t.

Return value: the current scaled font. This object is owned by cairo. To keep a reference to it, you must call cairo_scaled_font_reference().

This function never returns NULL. If memory cannot be allocated, a special "nil" cairo_scaled_font_t object will be returned on which cairo_scaled_font_status() returns CAIRO_STATUS_NO_MEMORY. Using this nil object will cause its error state to propagate to other objects it is passed to, (for example, calling cairo_set_scaled_font() with a nil font will trigger an error that will shutdown the cairo_t object).

Since: 1.4

Definition at line 3343 of file cairo.c.

◆ cairo_get_source()

cairo_pattern_t* cairo_get_source ( cairo_t cr)

cairo_get_source: @cr: a cairo context

Gets the current source pattern for @cr.

Return value: the current source pattern. This object is owned by cairo. To keep a reference to it, you must call cairo_pattern_reference().

Since: 1.0

Definition at line 1047 of file cairo.c.

◆ cairo_get_target()

cairo_surface_t* cairo_get_target ( cairo_t cr)

cairo_get_target: @cr: a cairo context

Gets the target surface for the cairo context as passed to cairo_create().

This function will always return a valid pointer, but the result can be a "nil" surface if @cr is already in an error state, (ie. cairo_status() <literal>!=</literal> CAIRO_STATUS_SUCCESS). A nil surface is indicated by cairo_surface_status() <literal>!=</literal> CAIRO_STATUS_SUCCESS.

Return value: the target surface. This object is owned by cairo. To keep a reference to it, you must call cairo_surface_reference().

Since: 1.0

Definition at line 4158 of file cairo.c.

◆ cairo_get_tolerance()

double cairo_get_tolerance ( cairo_t cr)

cairo_get_tolerance: @cr: a cairo context

Gets the current tolerance value, as set by cairo_set_tolerance().

Return value: the current tolerance value.

Since: 1.0

Definition at line 3919 of file cairo.c.

◆ cairo_get_user_data()

void* cairo_get_user_data ( cairo_t cr,
const cairo_user_data_key_t key 
)

cairo_get_user_data: @cr: a cairo_t @key: the address of the cairo_user_data_key_t the user data was attached to

Return user data previously attached to @cr using the specified key. If no user data has been attached with the given key this function returns NULL.

Return value: the user data previously attached or NULL.

Since: 1.4

Definition at line 548 of file cairo.c.

◆ cairo_glyph_allocate()

cairo_glyph_t* cairo_glyph_allocate ( int  num_glyphs)

cairo_glyph_allocate: @num_glyphs: number of glyphs to allocate

Allocates an array of cairo_glyph_t's. This function is only useful in implementations of cairo_user_scaled_font_text_to_glyphs_func_t where the user needs to allocate an array of glyphs that cairo will free. For all other uses, user can use their own allocation method for glyphs.

This function returns NULL if @num_glyphs is not positive, or if out of memory. That means, the NULL return value signals out-of-memory only if @num_glyphs was positive.

Returns: the newly allocated array of glyphs that should be freed using cairo_glyph_free()

Since: 1.8

Definition at line 204 of file cairo-misc.c.

◆ cairo_glyph_extents()

void cairo_glyph_extents ( cairo_t cr,
const cairo_glyph_t glyphs,
int  num_glyphs,
cairo_text_extents_t extents 
)

cairo_glyph_extents: @cr: a cairo_t @glyphs: an array of cairo_glyph_t objects @num_glyphs: the number of elements in @glyphs @extents: a cairo_text_extents_t object into which the results will be stored

Gets the extents for an array of glyphs. The extents describe a user-space rectangle that encloses the "inked" portion of the glyphs, (as they would be drawn by cairo_show_glyphs()). Additionally, the x_advance and y_advance values indicate the amount by which the current point would be advanced by cairo_show_glyphs().

Note that whitespace glyphs do not contribute to the size of the rectangle (extents.width and extents.height).

Since: 1.0

Definition at line 3443 of file cairo.c.

◆ cairo_glyph_free()

void cairo_glyph_free ( cairo_glyph_t glyphs)

cairo_glyph_free: @glyphs: array of glyphs to free, or NULL

Frees an array of cairo_glyph_t's allocated using cairo_glyph_allocate(). This function is only useful to free glyph array returned by cairo_scaled_font_text_to_glyphs() where cairo returns an array of glyphs that the user will free. For all other uses, user can use their own allocation method for glyphs.

Since: 1.8

Definition at line 227 of file cairo-misc.c.

◆ cairo_glyph_path()

void cairo_glyph_path ( cairo_t cr,
const cairo_glyph_t glyphs,
int  num_glyphs 
)

cairo_glyph_path: @cr: a cairo context @glyphs: array of glyphs to show @num_glyphs: number of glyphs to show

Adds closed paths for the glyphs to the current path. The generated path if filled, achieves an effect similar to that of cairo_show_glyphs().

Since: 1.0

Definition at line 3843 of file cairo.c.

◆ cairo_has_current_point()

cairo_bool_t cairo_has_current_point ( cairo_t cr)

cairo_has_current_point: @cr: a cairo context

Returns whether a current point is defined on the current path. See cairo_get_current_point() for details on the current point.

Return value: whether a current point is defined.

Since: 1.6

Definition at line 3960 of file cairo.c.

◆ cairo_identity_matrix()

void cairo_identity_matrix ( cairo_t cr)

cairo_identity_matrix: @cr: a cairo context

Resets the current transformation matrix (CTM) by setting it equal to the identity matrix. That is, the user-space and device-space axes will be aligned and one user-space unit will transform to one device-space unit.

Since: 1.0

Definition at line 1539 of file cairo.c.

◆ cairo_image_surface_create()

cairo_surface_t* cairo_image_surface_create ( cairo_format_t  format,
int  width,
int  height 
)

cairo_image_surface_create: @format: format of pixels in the surface to create @width: width of the surface, in pixels @height: height of the surface, in pixels

Creates an image surface of the specified format and dimensions. Initially the surface contents are set to 0. (Specifically, within each pixel, each color or alpha channel belonging to format will be 0. The contents of bits within a pixel, but not belonging to the given format are undefined).

Return value: a pointer to the newly created surface. The caller owns the surface and should call cairo_surface_destroy() when done with it.

This function always returns a valid pointer, but it will return a pointer to a "nil" surface if an error such as out of memory occurs. You can use cairo_surface_status() to check for this.

Since: 1.0

Definition at line 390 of file cairo-image-surface.c.

◆ cairo_image_surface_create_for_data()

cairo_surface_t* cairo_image_surface_create_for_data ( unsigned char *  data,
cairo_format_t  format,
int  width,
int  height,
int  stride 
)

cairo_image_surface_create_for_data: @data: a pointer to a buffer supplied by the application in which to write contents. This pointer must be suitably aligned for any kind of variable, (for example, a pointer returned by malloc). @format: the format of pixels in the buffer @width: the width of the image to be stored in the buffer @height: the height of the image to be stored in the buffer @stride: the number of bytes between the start of rows in the buffer as allocated. This value should always be computed by cairo_format_stride_for_width() before allocating the data buffer.

Creates an image surface for the provided pixel data. The output buffer must be kept around until the cairo_surface_t is destroyed or cairo_surface_finish() is called on the surface. The initial contents of @data will be used as the initial image contents; you must explicitly clear the buffer, using, for example, cairo_rectangle() and cairo_fill() if you want it cleared.

Note that the stride may be larger than width*bytes_per_pixel to provide proper alignment for each pixel and row. This alignment is required to allow high-performance rendering within cairo. The correct way to obtain a legal stride value is to call cairo_format_stride_for_width() with the desired format and maximum image width value, and then use the resulting stride value to allocate the data and to create the image surface. See cairo_format_stride_for_width() for example code.

Return value: a pointer to the newly created surface. The caller owns the surface and should call cairo_surface_destroy() when done with it.

This function always returns a valid pointer, but it will return a pointer to a "nil" surface in the case of an error such as out of memory or an invalid stride value. In case of invalid stride value the error status of the returned surface will be CAIRO_STATUS_INVALID_STRIDE. You can use cairo_surface_status() to check for this.

See cairo_surface_set_user_data() for a means of attaching a destroy-notification fallback to the surface if necessary.

Since: 1.0

Definition at line 507 of file cairo-image-surface.c.

◆ cairo_image_surface_create_from_png()

cairo_surface_t* cairo_image_surface_create_from_png ( const char *  filename)

cairo_image_surface_create_from_png: @filename: name of PNG file to load. On Windows this filename is encoded in UTF-8.

Creates a new image surface and initializes the contents to the given PNG file.

Return value: a new cairo_surface_t initialized with the contents of the PNG file, or a "nil" surface if any error occurred. A nil surface can be checked for with cairo_surface_status(surface) which may return one of the following values:

CAIRO_STATUS_NO_MEMORY CAIRO_STATUS_FILE_NOT_FOUND CAIRO_STATUS_READ_ERROR CAIRO_STATUS_PNG_ERROR

Alternatively, you can allow errors to propagate through the drawing operations and check the status on the context upon completion using cairo_status().

Since: 1.0

Definition at line 764 of file cairo-png.c.

◆ cairo_image_surface_create_from_png_stream()

cairo_surface_t* cairo_image_surface_create_from_png_stream ( cairo_read_func_t  read_func,
void closure 
)

cairo_image_surface_create_from_png_stream: @read_func: function called to read the data of the file @closure: data to pass to @read_func.

Creates a new image surface from PNG data read incrementally via the @read_func function.

Return value: a new cairo_surface_t initialized with the contents of the PNG file or a "nil" surface if the data read is not a valid PNG image or memory could not be allocated for the operation. A nil surface can be checked for with cairo_surface_status(surface) which may return one of the following values:

CAIRO_STATUS_NO_MEMORY CAIRO_STATUS_READ_ERROR CAIRO_STATUS_PNG_ERROR

Alternatively, you can allow errors to propagate through the drawing operations and check the status on the context upon completion using cairo_status().

Since: 1.0

Definition at line 824 of file cairo-png.c.

◆ cairo_image_surface_get_data()

unsigned char* cairo_image_surface_get_data ( cairo_surface_t surface)

cairo_image_surface_get_data: @surface: a cairo_image_surface_t

Get a pointer to the data of the image surface, for direct inspection or modification.

A call to cairo_surface_flush() is required before accessing the pixel data to ensure that all pending drawing operations are finished. A call to cairo_surface_mark_dirty() is required after the data is modified.

Return value: a pointer to the image data of this surface or NULL if @surface is not an image surface, or if cairo_surface_finish() has been called.

Since: 1.2

Definition at line 563 of file cairo-image-surface.c.

◆ cairo_image_surface_get_format()

cairo_format_t cairo_image_surface_get_format ( cairo_surface_t surface)

cairo_image_surface_get_format: @surface: a cairo_image_surface_t

Get the format of the surface.

Return value: the format of the surface

Since: 1.2

Definition at line 587 of file cairo-image-surface.c.

◆ cairo_image_surface_get_height()

int cairo_image_surface_get_height ( cairo_surface_t surface)

cairo_image_surface_get_height: @surface: a cairo_image_surface_t

Get the height of the image surface in pixels.

Return value: the height of the surface in pixels.

Since: 1.0

Definition at line 635 of file cairo-image-surface.c.

◆ cairo_image_surface_get_stride()

int cairo_image_surface_get_stride ( cairo_surface_t surface)

cairo_image_surface_get_stride: @surface: a cairo_image_surface_t

Get the stride of the image surface in bytes

Return value: the stride of the image surface in bytes (or 0 if @surface is not an image surface). The stride is the distance in bytes from the beginning of one row of the image data to the beginning of the next row.

Since: 1.2

Definition at line 662 of file cairo-image-surface.c.

◆ cairo_image_surface_get_width()

int cairo_image_surface_get_width ( cairo_surface_t surface)

cairo_image_surface_get_width: @surface: a cairo_image_surface_t

Get the width of the image surface in pixels.

Return value: the width of the surface in pixels.

Since: 1.0

Definition at line 611 of file cairo-image-surface.c.

◆ cairo_in_clip()

cairo_bool_t cairo_in_clip ( cairo_t cr,
double  x,
double  y 
)

cairo_in_clip: @cr: a cairo context @x: X coordinate of the point to test @y: Y coordinate of the point to test

Tests whether the given point is inside the area that would be visible through the current clip, i.e. the area that would be filled by a cairo_paint() operation.

See cairo_clip(), and cairo_clip_preserve().

Return value: A non-zero value if the point is inside, or zero if outside.

Since: 1.10

Definition at line 2842 of file cairo.c.

◆ cairo_in_fill()

cairo_bool_t cairo_in_fill ( cairo_t cr,
double  x,
double  y 
)

cairo_in_fill: @cr: a cairo context @x: X coordinate of the point to test @y: Y coordinate of the point to test

Tests whether the given point is inside the area that would be affected by a cairo_fill() operation given the current path and filling parameters. Surface dimensions and clipping are not taken into account.

See cairo_fill(), cairo_set_fill_rule() and cairo_fill_preserve().

Return value: A non-zero value if the point is inside, or zero if outside.

Since: 1.0

Definition at line 2561 of file cairo.c.

◆ cairo_in_stroke()

cairo_bool_t cairo_in_stroke ( cairo_t cr,
double  x,
double  y 
)

cairo_in_stroke: @cr: a cairo context @x: X coordinate of the point to test @y: Y coordinate of the point to test

Tests whether the given point is inside the area that would be affected by a cairo_stroke() operation given the current path and stroking parameters. Surface dimensions and clipping are not taken into account.

See cairo_stroke(), cairo_set_line_width(), cairo_set_line_join(), cairo_set_line_cap(), cairo_set_dash(), and cairo_stroke_preserve().

Return value: A non-zero value if the point is inside, or zero if outside.

Since: 1.0

Definition at line 2527 of file cairo.c.

◆ cairo_line_to()

void cairo_line_to ( cairo_t cr,
double  x,
double  y 
)

cairo_line_to: @cr: a cairo context @x: the X coordinate of the end of the new line @y: the Y coordinate of the end of the new line

Adds a line to the path from the current point to position (@x, @y) in user-space coordinates. After this call the current point will be (@x, @y).

If there is no current point before the call to cairo_line_to() this function will behave as cairo_move_to(@cr, @x, @y).

Since: 1.0

Definition at line 1736 of file cairo.c.

◆ cairo_mask()

void cairo_mask ( cairo_t cr,
cairo_pattern_t pattern 
)

cairo_mask: @cr: a cairo context @pattern: a cairo_pattern_t

A drawing operator that paints the current source using the alpha channel of @pattern as a mask. (Opaque areas of @pattern are painted with the source, transparent areas are not painted.)

Since: 1.0

Definition at line 2265 of file cairo.c.

◆ cairo_mask_surface()

void cairo_mask_surface ( cairo_t cr,
cairo_surface_t surface,
double  surface_x,
double  surface_y 
)

cairo_mask_surface: @cr: a cairo context @surface: a cairo_surface_t @surface_x: X coordinate at which to place the origin of @surface @surface_y: Y coordinate at which to place the origin of @surface

A drawing operator that paints the current source using the alpha channel of @surface as a mask. (Opaque areas of @surface are painted with the source, transparent areas are not painted.)

Since: 1.0

Definition at line 2304 of file cairo.c.

◆ cairo_matrix_init()

void cairo_matrix_init ( cairo_matrix_t matrix,
double  xx,
double  yx,
double  xy,
double  yy,
double  x0,
double  y0 
)

cairo_matrix_init: @matrix: a cairo_matrix_t @xx: xx component of the affine transformation @yx: yx component of the affine transformation @xy: xy component of the affine transformation @yy: yy component of the affine transformation @x0: X translation component of the affine transformation @y0: Y translation component of the affine transformation

Sets @matrix to be the affine transformation given by @xx, @yx, @xy, @yy, @x0, @y0. The transformation is given by: <programlisting> x_new = xx * x + xy * y + x0; y_new = yx * x + yy * y + y0; </programlisting>

Since: 1.0

Definition at line 111 of file cairo-matrix.c.

◆ cairo_matrix_init_identity()

void cairo_matrix_init_identity ( cairo_matrix_t matrix)

cairo_matrix_init_identity: @matrix: a cairo_matrix_t

Modifies @matrix to be an identity transformation.

Since: 1.0

Definition at line 81 of file cairo-matrix.c.

◆ cairo_matrix_init_rotate()

void cairo_matrix_init_rotate ( cairo_matrix_t matrix,
double  radians 
)

cairo_matrix_init_rotate: @matrix: a cairo_matrix_t @radians: angle of rotation, in radians. The direction of rotation is defined such that positive angles rotate in the direction from the positive X axis toward the positive Y axis. With the default axis orientation of cairo, positive angles rotate in a clockwise direction.

Initialized @matrix to a transformation that rotates by @radians.

Since: 1.0

Definition at line 266 of file cairo-matrix.c.

◆ cairo_matrix_init_scale()

void cairo_matrix_init_scale ( cairo_matrix_t matrix,
double  sx,
double  sy 
)

cairo_matrix_init_scale: @matrix: a cairo_matrix_t @sx: scale factor in the X direction @sy: scale factor in the Y direction

Initializes @matrix to a transformation that scales by @sx and @sy in the X and Y dimensions, respectively.

Since: 1.0

Definition at line 219 of file cairo-matrix.c.

◆ cairo_matrix_init_translate()

void cairo_matrix_init_translate ( cairo_matrix_t matrix,
double  tx,
double  ty 
)

cairo_matrix_init_translate: @matrix: a cairo_matrix_t @tx: amount to translate in the X direction @ty: amount to translate in the Y direction

Initializes @matrix to a transformation that translates by @tx and @ty in the X and Y dimensions, respectively.

Since: 1.0

Definition at line 173 of file cairo-matrix.c.

◆ cairo_matrix_invert()

cairo_status_t cairo_matrix_invert ( cairo_matrix_t matrix)

cairo_matrix_invert: @matrix: a cairo_matrix_t

Changes @matrix to be the inverse of its original value. Not all transformation matrices have inverses; if the matrix collapses points together (it is <firstterm>degenerate</firstterm>), then it has no inverse and this function will fail.

Returns: If @matrix has an inverse, modifies @matrix to be the inverse matrix and returns CAIRO_STATUS_SUCCESS. Otherwise, returns CAIRO_STATUS_INVALID_MATRIX.

Since: 1.0

Definition at line 586 of file cairo-matrix.c.

◆ cairo_matrix_multiply()

void cairo_matrix_multiply ( cairo_matrix_t result,
const cairo_matrix_t a,
const cairo_matrix_t b 
)

cairo_matrix_multiply:

Returns
: a cairo_matrix_t in which to store the result : a cairo_matrix_t : a cairo_matrix_t

Multiplies the affine transformations in and together and stores the result in

Returns
. The effect of the resulting transformation is to first apply the transformation in to the coordinates and then apply the transformation in to the coordinates.

It is allowable for

Returns
to be identical to either or .

Since: 1.0

Definition at line 331 of file cairo-matrix.c.

◆ cairo_matrix_rotate()

void cairo_matrix_rotate ( cairo_matrix_t matrix,
double  radians 
)

cairo_matrix_rotate: @matrix: a cairo_matrix_t @radians: angle of rotation, in radians. The direction of rotation is defined such that positive angles rotate in the direction from the positive X axis toward the positive Y axis. With the default axis orientation of cairo, positive angles rotate in a clockwise direction.

Applies rotation by @radians to the transformation in @matrix. The effect of the new transformation is to first rotate the coordinates by @radians, then apply the original transformation to the coordinates.

Since: 1.0

Definition at line 299 of file cairo-matrix.c.

◆ cairo_matrix_scale()

void cairo_matrix_scale ( cairo_matrix_t matrix,
double  sx,
double  sy 
)

cairo_matrix_scale: @matrix: a cairo_matrix_t @sx: scale factor in the X direction @sy: scale factor in the Y direction

Applies scaling by @sx, @sy to the transformation in @matrix. The effect of the new transformation is to first scale the coordinates by @sx and @sy, then apply the original transformation to the coordinates.

Since: 1.0

Definition at line 242 of file cairo-matrix.c.

◆ cairo_matrix_transform_distance()

void cairo_matrix_transform_distance ( const cairo_matrix_t matrix,
double *  dx,
double *  dy 
)

cairo_matrix_transform_distance: @matrix: a cairo_matrix_t @dx: X component of a distance vector. An in/out parameter @dy: Y component of a distance vector. An in/out parameter

Transforms the distance vector (@dx,@dy) by @matrix. This is similar to cairo_matrix_transform_point() except that the translation components of the transformation are ignored. The calculation of the returned vector is as follows:

<programlisting> dx2 = dx1 * a + dy1 * c; dy2 = dx1 * b + dy1 * d; </programlisting>

Affine transformations are position invariant, so the same vector always transforms to the same vector. If (@x1,@y1) transforms to (@x2,@y2) then (@x1+@dx1,@y1+@dy1) will transform to (@x1+@dx2,@y1+@dy2) for all values of @x1 and @x2.

Since: 1.0

Definition at line 387 of file cairo-matrix.c.

◆ cairo_matrix_transform_point()

void cairo_matrix_transform_point ( const cairo_matrix_t matrix,
double *  x,
double *  y 
)

cairo_matrix_transform_point: @matrix: a cairo_matrix_t @x: X position. An in/out parameter @y: Y position. An in/out parameter

Transforms the point (@x, @y) by @matrix.

Since: 1.0

Definition at line 410 of file cairo-matrix.c.

◆ cairo_matrix_translate()

void cairo_matrix_translate ( cairo_matrix_t matrix,
double  tx,
double  ty 
)

cairo_matrix_translate: @matrix: a cairo_matrix_t @tx: amount to translate in the X direction @ty: amount to translate in the Y direction

Applies a translation by @tx, @ty to the transformation in @matrix. The effect of the new transformation is to first translate the coordinates by @tx and @ty, then apply the original transformation to the coordinates.

Since: 1.0

Definition at line 197 of file cairo-matrix.c.

◆ cairo_mesh_pattern_begin_patch()

void cairo_mesh_pattern_begin_patch ( cairo_pattern_t pattern)

cairo_mesh_pattern_begin_patch: @pattern: a cairo_pattern_t

Begin a patch in a mesh pattern.

After calling this function, the patch shape should be defined with cairo_mesh_pattern_move_to(), cairo_mesh_pattern_line_to() and cairo_mesh_pattern_curve_to().

After defining the patch, cairo_mesh_pattern_end_patch() must be called before using @pattern as a source or mask.

Note: If @pattern is not a mesh pattern then @pattern will be put into an error status with a status of CAIRO_STATUS_PATTERN_TYPE_MISMATCH. If @pattern already has a current patch, it will be put into an error status with a status of CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.

Since: 1.12

Definition at line 1239 of file cairo-pattern.c.

◆ cairo_mesh_pattern_curve_to()

void cairo_mesh_pattern_curve_to ( cairo_pattern_t pattern,
double  x1,
double  y1,
double  x2,
double  y2,
double  x3,
double  y3 
)

cairo_mesh_pattern_curve_to: @pattern: a cairo_pattern_t @x1: the X coordinate of the first control point @y1: the Y coordinate of the first control point @x2: the X coordinate of the second control point @y2: the Y coordinate of the second control point @x3: the X coordinate of the end of the curve @y3: the Y coordinate of the end of the curve

Adds a cubic Bézier spline to the current patch from the current point to position (@x3, @y3) in pattern-space coordinates, using (@x1, @y1) and (@x2, @y2) as the control points.

If the current patch has no current point before the call to cairo_mesh_pattern_curve_to(), this function will behave as if preceded by a call to cairo_mesh_pattern_move_to(@pattern, @x1, @y1).

After this call the current point will be (@x3, @y3).

Note: If @pattern is not a mesh pattern then @pattern will be put into an error status with a status of CAIRO_STATUS_PATTERN_TYPE_MISMATCH. If @pattern has no current patch or the current patch already has 4 sides, @pattern will be put into an error status with a status of CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.

Since: 1.12

Definition at line 1424 of file cairo-pattern.c.

◆ cairo_mesh_pattern_end_patch()

void cairo_mesh_pattern_end_patch ( cairo_pattern_t pattern)

cairo_mesh_pattern_end_patch: @pattern: a cairo_pattern_t

Indicates the end of the current patch in a mesh pattern.

If the current patch has less than 4 sides, it is closed with a straight line from the current point to the first point of the patch as if cairo_mesh_pattern_line_to() was used.

Note: If @pattern is not a mesh pattern then @pattern will be put into an error status with a status of CAIRO_STATUS_PATTERN_TYPE_MISMATCH. If @pattern has no current patch or the current patch has no current point, @pattern will be put into an error status with a status of CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.

Since: 1.12

Definition at line 1340 of file cairo-pattern.c.

◆ cairo_mesh_pattern_get_control_point()

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 
)

cairo_mesh_pattern_get_control_point: @pattern: a cairo_pattern_t @patch_num: the patch number to return data for @point_num: the control point number to return data for @x: return value for the x coordinate of the control point, or NULL @y: return value for the y coordinate of the control point, or NULL

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

@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

Definition at line 4620 of file cairo-pattern.c.

◆ cairo_mesh_pattern_get_corner_color_rgba()

cairo_status_t cairo_mesh_pattern_get_corner_color_rgba ( cairo_pattern_t pattern,
unsigned int  patch_num,
unsigned int  corner_num,
double *  red,
double *  green,
double *  blue,
double *  alpha 
)

cairo_mesh_pattern_get_corner_color_rgba: @pattern: a cairo_pattern_t @patch_num: the patch number to return data for @corner_num: the corner number to return data for @red: return value for red component of color, or NULL @green: return value for green component of color, or NULL @blue: return value for blue component of color, or NULL @alpha: return value for alpha component of color, or NULL

Gets the color information in corner @corner_num of patch @patch_num for a mesh pattern.

@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 @corner_num are from 0 to 3 and identify the corners as explained in cairo_pattern_create_mesh().

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

Since: 1.12

Definition at line 4554 of file cairo-pattern.c.

◆ cairo_mesh_pattern_get_patch_count()

cairo_status_t cairo_mesh_pattern_get_patch_count ( cairo_pattern_t pattern,
unsigned int count 
)

cairo_mesh_pattern_get_patch_count: @pattern: a cairo_pattern_t @count: return value for the number patches, or NULL

Gets the number of patches specified in the given mesh pattern.

The number only includes patches which have been finished by calling cairo_mesh_pattern_end_patch(). For example it will be 0 during the definition of the first patch.

Return value: CAIRO_STATUS_SUCCESS, or CAIRO_STATUS_PATTERN_TYPE_MISMATCH if @pattern is not a mesh pattern.

Since: 1.12

Definition at line 4418 of file cairo-pattern.c.

◆ cairo_mesh_pattern_get_path()

cairo_path_t* cairo_mesh_pattern_get_path ( cairo_pattern_t pattern,
unsigned int  patch_num 
)

cairo_mesh_pattern_get_path: @pattern: a cairo_pattern_t @patch_num: the patch number to return data for

Gets path defining the patch @patch_num for a mesh pattern.

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

Return value: the path defining the patch, or a path with status CAIRO_STATUS_INVALID_INDEX if @patch_num or @point_num is not valid for @pattern. If @pattern is not a mesh pattern, a path with status CAIRO_STATUS_PATTERN_TYPE_MISMATCH is returned.

Since: 1.12

Definition at line 4458 of file cairo-pattern.c.

◆ cairo_mesh_pattern_line_to()

void cairo_mesh_pattern_line_to ( cairo_pattern_t pattern,
double  x,
double  y 
)

cairo_mesh_pattern_line_to: @pattern: a cairo_pattern_t @x: the X coordinate of the end of the new line @y: the Y coordinate of the end of the new line

Adds a line to the current patch from the current point to position (@x, @y) in pattern-space coordinates.

If there is no current point before the call to cairo_mesh_pattern_line_to() this function will behave as cairo_mesh_pattern_move_to(@pattern, @x, @y).

After this call the current point will be (@x, @y).

Note: If @pattern is not a mesh pattern then @pattern will be put into an error status with a status of CAIRO_STATUS_PATTERN_TYPE_MISMATCH. If @pattern has no current patch or the current patch already has 4 sides, @pattern will be put into an error status with a status of CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.

Since: 1.12

Definition at line 1508 of file cairo-pattern.c.

◆ cairo_mesh_pattern_move_to()

void cairo_mesh_pattern_move_to ( cairo_pattern_t pattern,
double  x,
double  y 
)

cairo_mesh_pattern_move_to: @pattern: a cairo_pattern_t @x: the X coordinate of the new position @y: the Y coordinate of the new position

Define the first point of the current patch in a mesh pattern.

After this call the current point will be (@x, @y).

Note: If @pattern is not a mesh pattern then @pattern will be put into an error status with a status of CAIRO_STATUS_PATTERN_TYPE_MISMATCH. If @pattern has no current patch or the current patch already has at least one side, @pattern will be put into an error status with a status of CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.

Since: 1.12

Definition at line 1574 of file cairo-pattern.c.

◆ cairo_mesh_pattern_set_control_point()

void cairo_mesh_pattern_set_control_point ( cairo_pattern_t pattern,
unsigned int  point_num,
double  x,
double  y 
)

cairo_mesh_pattern_set_control_point: @pattern: a cairo_pattern_t @point_num: the control point to set the position for @x: the X coordinate of the control point @y: the Y coordinate of the control point

Set an internal control point of the current patch.

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

Note: If @pattern is not a mesh pattern then @pattern will be put into an error status with a status of CAIRO_STATUS_PATTERN_TYPE_MISMATCH. If @point_num is not valid, @pattern will be put into an error status with a status of CAIRO_STATUS_INVALID_INDEX. If @pattern has no current patch, @pattern will be put into an error status with a status of CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.

Since: 1.12

Definition at line 1627 of file cairo-pattern.c.

◆ cairo_mesh_pattern_set_corner_color_rgb()

void cairo_mesh_pattern_set_corner_color_rgb ( cairo_pattern_t pattern,
unsigned int  corner_num,
double  red,
double  green,
double  blue 
)

cairo_mesh_pattern_set_corner_color_rgb: @pattern: a cairo_pattern_t @corner_num: the corner to set the color for @red: red component of color @green: green component of color @blue: blue component of color

Sets the color of a corner of the current patch in a mesh pattern.

The color is specified in the same way as in cairo_set_source_rgb().

Valid values for @corner_num are from 0 to 3 and identify the corners as explained in cairo_pattern_create_mesh().

Note: If @pattern is not a mesh pattern then @pattern will be put into an error status with a status of CAIRO_STATUS_PATTERN_TYPE_MISMATCH. If @corner_num is not valid, @pattern will be put into an error status with a status of CAIRO_STATUS_INVALID_INDEX. If @pattern has no current patch, @pattern will be put into an error status with a status of CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.

Since: 1.12

Definition at line 1754 of file cairo-pattern.c.

◆ cairo_mesh_pattern_set_corner_color_rgba()

void cairo_mesh_pattern_set_corner_color_rgba ( cairo_pattern_t pattern,
unsigned int  corner_num,
double  red,
double  green,
double  blue,
double  alpha 
)

cairo_mesh_pattern_set_corner_color_rgba: @pattern: a cairo_pattern_t @corner_num: the corner to set the color for @red: red component of color @green: green component of color @blue: blue component of color @alpha: alpha component of color

Sets the color of a corner of the current patch in a mesh pattern.

The color is specified in the same way as in cairo_set_source_rgba().

Valid values for @corner_num are from 0 to 3 and identify the corners as explained in cairo_pattern_create_mesh().

Note: If @pattern is not a mesh pattern then @pattern will be put into an error status with a status of CAIRO_STATUS_PATTERN_TYPE_MISMATCH. If @corner_num is not valid, @pattern will be put into an error status with a status of CAIRO_STATUS_INVALID_INDEX. If @pattern has no current patch, @pattern will be put into an error status with a status of CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.

Since: 1.12

Definition at line 1788 of file cairo-pattern.c.

◆ cairo_move_to()

void cairo_move_to ( cairo_t cr,
double  x,
double  y 
)

cairo_move_to: @cr: a cairo context @x: the X coordinate of the new position @y: the Y coordinate of the new position

Begin a new sub-path. After this call the current point will be (@x, @y).

Since: 1.0

Definition at line 1706 of file cairo.c.

◆ cairo_new_path()

void cairo_new_path ( cairo_t cr)

cairo_new_path: @cr: a cairo context

Clears the current path. After this call there will be no path and no current point.

Since: 1.0

Definition at line 1650 of file cairo.c.

◆ cairo_new_sub_path()

void cairo_new_sub_path ( cairo_t cr)

cairo_new_sub_path: @cr: a cairo context

Begin a new sub-path. Note that the existing path is not affected. After this call there will be no current point.

In many cases, this call is not needed since new sub-paths are frequently started with cairo_move_to().

A call to cairo_new_sub_path() is particularly useful when beginning a new sub-path with one of the cairo_arc() calls. This makes things easier as it is no longer necessary to manually compute the arc's initial coordinates for a call to cairo_move_to().

Since: 1.2

Definition at line 1682 of file cairo.c.

◆ cairo_paint()

void cairo_paint ( cairo_t cr)

cairo_paint: @cr: a cairo context

A drawing operator that paints the current source everywhere within the current clip region.

Since: 1.0

Definition at line 2213 of file cairo.c.

◆ cairo_paint_with_alpha()

void cairo_paint_with_alpha ( cairo_t cr,
double  alpha 
)

cairo_paint_with_alpha: @cr: a cairo context @alpha: alpha value, between 0 (transparent) and 1 (opaque)

A drawing operator that paints the current source everywhere within the current clip region using a mask of constant alpha value @alpha. The effect is similar to cairo_paint(), but the drawing is faded out using the alpha value.

Since: 1.0

Definition at line 2239 of file cairo.c.

◆ cairo_path_destroy()

void cairo_path_destroy ( cairo_path_t path)

cairo_path_destroy: @path: a path previously returned by either cairo_copy_path() or cairo_copy_path_flat().

Immediately releases all memory associated with @path. After a call to cairo_path_destroy() the @path pointer is no longer valid and should not be used further.

Note: cairo_path_destroy() should only be called with a pointer to a cairo_path_t returned by a cairo function. Any path that is created manually (ie. outside of cairo) should be destroyed manually as well.

Since: 1.0

Definition at line 366 of file cairo-path.c.

◆ cairo_path_extents()

void cairo_path_extents ( cairo_t cr,
double *  x1,
double *  y1,
double *  x2,
double *  y2 
)

cairo_path_extents: @cr: a cairo context @x1: left of the resulting extents @y1: top of the resulting extents @x2: right of the resulting extents @y2: bottom of the resulting extents

Computes a bounding box in user-space coordinates covering the points on the current path. If the current path is empty, returns an empty rectangle ((0,0), (0,0)). Stroke parameters, fill rule, surface dimensions and clipping are not taken into account.

Contrast with cairo_fill_extents() and cairo_stroke_extents() which return the extents of only the area that would be "inked" by the corresponding drawing operations.

The result of cairo_path_extents() is defined as equivalent to the limit of cairo_stroke_extents() with CAIRO_LINE_CAP_ROUND as the line width approaches 0.0, (but never reaching the empty-rectangle returned by cairo_stroke_extents() for a line width of 0.0).

Specifically, this means that zero-area sub-paths such as cairo_move_to();cairo_line_to() segments, (even degenerate cases where the coordinates to both calls are identical), will be considered as contributing to the extents. However, a lone cairo_move_to() will not contribute to the results of cairo_path_extents().

Since: 1.6

Definition at line 2184 of file cairo.c.

◆ cairo_pattern_add_color_stop_rgb()

void cairo_pattern_add_color_stop_rgb ( cairo_pattern_t pattern,
double  offset,
double  red,
double  green,
double  blue 
)

cairo_pattern_add_color_stop_rgb: @pattern: a cairo_pattern_t @offset: an offset in the range [0.0 .. 1.0] @red: red component of color @green: green component of color @blue: blue component of color

Adds an opaque color stop to a gradient pattern. The offset specifies the location along the gradient's control vector. For example, a linear gradient's control vector is from (x0,y0) to (x1,y1) while a radial gradient's control vector is from any point on the start circle to the corresponding point on the end circle.

The color is specified in the same way as in cairo_set_source_rgb().

If two (or more) stops are specified with identical offset values, they will be sorted according to the order in which the stops are added, (stops added earlier will compare less than stops added later). This can be useful for reliably making sharp color transitions instead of the typical blend.

Note: If the pattern is not a gradient pattern, (eg. a linear or radial pattern), then the pattern will be put into an error status with a status of CAIRO_STATUS_PATTERN_TYPE_MISMATCH.

Since: 1.0

Definition at line 1900 of file cairo-pattern.c.

◆ cairo_pattern_add_color_stop_rgba()

void cairo_pattern_add_color_stop_rgba ( cairo_pattern_t pattern,
double  offset,
double  red,
double  green,
double  blue,
double  alpha 
)

cairo_pattern_add_color_stop_rgba: @pattern: a cairo_pattern_t @offset: an offset in the range [0.0 .. 1.0] @red: red component of color @green: green component of color @blue: blue component of color @alpha: alpha component of color

Adds a translucent color stop to a gradient pattern. The offset specifies the location along the gradient's control vector. For example, a linear gradient's control vector is from (x0,y0) to (x1,y1) while a radial gradient's control vector is from any point on the start circle to the corresponding point on the end circle.

The color is specified in the same way as in cairo_set_source_rgba().

If two (or more) stops are specified with identical offset values, they will be sorted according to the order in which the stops are added, (stops added earlier will compare less than stops added later). This can be useful for reliably making sharp color transitions instead of the typical blend.

Note: If the pattern is not a gradient pattern, (eg. a linear or radial pattern), then the pattern will be put into an error status with a status of CAIRO_STATUS_PATTERN_TYPE_MISMATCH.

Since: 1.0

Definition at line 1939 of file cairo-pattern.c.

◆ cairo_pattern_create_for_surface()

cairo_pattern_t* cairo_pattern_create_for_surface ( cairo_surface_t surface)

cairo_pattern_create_for_surface: @surface: the surface

Create a new cairo_pattern_t for the given surface.

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

Definition at line 726 of file cairo-pattern.c.

◆ cairo_pattern_create_linear()

cairo_pattern_t* cairo_pattern_create_linear ( double  x0,
double  y0,
double  x1,
double  y1 
)

cairo_pattern_create_linear: @x0: x coordinate of the start point @y0: y coordinate of the start point @x1: x coordinate of the end point @y1: y coordinate of the end point

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

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

Definition at line 786 of file cairo-pattern.c.

◆ cairo_pattern_create_mesh()

cairo_pattern_t* cairo_pattern_create_mesh ( void  )

cairo_pattern_create_mesh:

Create a new mesh pattern.

Mesh patterns are tensor-product patch meshes (type 7 shadings in PDF). Mesh patterns may also be used to create other types of shadings that are special cases of tensor-product patch meshes such as Coons patch meshes (type 6 shading in PDF) and Gouraud-shaded triangle meshes (type 4 and 5 shadings in PDF).

Mesh patterns consist of one or more tensor-product patches, which should be defined before using the mesh pattern. Using a mesh pattern with a partially defined patch as source or mask will put the context in an error status with a status of CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.

A tensor-product patch is defined by 4 Bézier curves (side 0, 1, 2, 3) and by 4 additional control points (P0, P1, P2, P3) that provide further control over the patch and complete the definition of the tensor-product patch. The corner C0 is the first point of the patch.

Degenerate sides are permitted so straight lines may be used. A zero length line on one side may be used to create 3 sided patches.

<informalexample><screen> C1 Side 1 C2 +------------—+ | | | P1 P2 | | | Side 0 | | Side 2

P0 P3

+------------—+ C0 Side 3 C3 </screen></informalexample>

Each patch is constructed by first calling cairo_mesh_pattern_begin_patch(), then cairo_mesh_pattern_move_to() to specify the first point in the patch (C0). Then the sides are specified with calls to cairo_mesh_pattern_curve_to() and cairo_mesh_pattern_line_to().

The four additional control points (P0, P1, P2, P3) in a patch can be specified with cairo_mesh_pattern_set_control_point().

At each corner of the patch (C0, C1, C2, C3) a color may be specified with cairo_mesh_pattern_set_corner_color_rgb() or cairo_mesh_pattern_set_corner_color_rgba(). Any corner whose color is not explicitly specified defaults to transparent black.

A Coons patch is a special case of the tensor-product patch where the control points are implicitly defined by the sides of the patch. The default value for any control point not specified is the implicit value for a Coons patch, i.e. if no control points are specified the patch is a Coons patch.

A triangle is a special case of the tensor-product patch where the control points are implicitly defined by the sides of the patch, all the sides are lines and one of them has length 0, i.e. if the patch is specified using just 3 lines, it is a triangle. If the corners connected by the 0-length side have the same color, the patch is a Gouraud-shaded triangle.

Patches may be oriented differently to the above diagram. For example the first point could be at the top left. The diagram only shows the relationship between the sides, corners and control points. Regardless of where the first point is located, when specifying colors, corner 0 will always be the first point, corner 1 the point between side 0 and side 1 etc.

Calling cairo_mesh_pattern_end_patch() completes the current patch. If less than 4 sides have been defined, the first missing side is defined as a line from the current point to the first point of the patch (C0) and the other sides are degenerate lines from C0 to C0. The corners between the added sides will all be coincident with C0 of the patch and their color will be set to be the same as the color of C0.

Additional patches may be added with additional calls to cairo_mesh_pattern_begin_patch()/cairo_mesh_pattern_end_patch().

<informalexample><programlisting> cairo_pattern_t *pattern = cairo_pattern_create_mesh ();

/&ast; Add a Coons patch &ast;/ cairo_mesh_pattern_begin_patch (pattern); cairo_mesh_pattern_move_to (pattern, 0, 0); cairo_mesh_pattern_curve_to (pattern, 30, -30, 60, 30, 100, 0); cairo_mesh_pattern_curve_to (pattern, 60, 30, 130, 60, 100, 100); cairo_mesh_pattern_curve_to (pattern, 60, 70, 30, 130, 0, 100); cairo_mesh_pattern_curve_to (pattern, 30, 70, -30, 30, 0, 0); cairo_mesh_pattern_set_corner_color_rgb (pattern, 0, 1, 0, 0); cairo_mesh_pattern_set_corner_color_rgb (pattern, 1, 0, 1, 0); cairo_mesh_pattern_set_corner_color_rgb (pattern, 2, 0, 0, 1); cairo_mesh_pattern_set_corner_color_rgb (pattern, 3, 1, 1, 0); cairo_mesh_pattern_end_patch (pattern);

/&ast; Add a Gouraud-shaded triangle &ast;/ cairo_mesh_pattern_begin_patch (pattern) cairo_mesh_pattern_move_to (pattern, 100, 100); cairo_mesh_pattern_line_to (pattern, 130, 130); cairo_mesh_pattern_line_to (pattern, 130, 70); cairo_mesh_pattern_set_corner_color_rgb (pattern, 0, 1, 0, 0); cairo_mesh_pattern_set_corner_color_rgb (pattern, 1, 0, 1, 0); cairo_mesh_pattern_set_corner_color_rgb (pattern, 2, 0, 0, 1); cairo_mesh_pattern_end_patch (pattern) </programlisting></informalexample>

When two patches overlap, the last one that has been added is drawn over the first one.

When a patch folds over itself, points are sorted depending on their parameter coordinates inside the patch. The v coordinate ranges from 0 to 1 when moving from side 3 to side 1; the u coordinate ranges from 0 to 1 when going from side 0 to side

  1. Points with higher v coordinate hide points with lower v coordinate. When two points have the same v coordinate, the one with higher u coordinate is above. This means that points nearer to side 1 are above points nearer to side 3; when this is not sufficient to decide which point is above (for example when both points belong to side 1 or side 3) points nearer to side 2 are above points nearer to side 0.

For a complete definition of tensor-product patches, see the PDF specification (ISO32000), which describes the parametrization in detail.

Note: The coordinates are always 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.12

Definition at line 1018 of file cairo-pattern.c.

◆ cairo_pattern_create_radial()

cairo_pattern_t* cairo_pattern_create_radial ( double  cx0,
double  cy0,
double  radius0,
double  cx1,
double  cy1,
double  radius1 
)

cairo_pattern_create_radial: @cx0: x coordinate for the center of the start circle @cy0: y coordinate for the center of the start circle @radius0: radius of the start circle @cx1: x coordinate for the center of the end circle @cy1: y coordinate for the center of the end circle @radius1: radius of the end circle

Creates a new radial gradient cairo_pattern_t between the two circles defined by (cx0, cy0, radius0) and (cx1, cy1, radius1). 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().

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

Definition at line 839 of file cairo-pattern.c.

◆ cairo_pattern_create_raster_source()

cairo_pattern_t* cairo_pattern_create_raster_source ( void user_data,
cairo_content_t  content,
int  width,
int  height 
)

cairo_pattern_create_raster_source: @user_data: the user data to be passed to all callbacks @content: content type for the pixel data that will be returned. Knowing the content type ahead of time is used for analysing the operation and picking the appropriate rendering path. @width: maximum size of the sample area @height: maximum size of the sample area

Creates a new user pattern for providing pixel data.

Use the setter functions to associate callbacks with the returned pattern. The only mandatory callback is acquire.

Return value: a newly created cairo_pattern_t. Free with cairo_pattern_destroy() when you are done using it.

Since: 1.12

Definition at line 157 of file cairo-raster-source-pattern.c.

◆ cairo_pattern_create_rgb()

cairo_pattern_t* cairo_pattern_create_rgb ( double  red,
double  green,
double  blue 
)

cairo_pattern_create_rgb: @red: red component of the color @green: green component of the color @blue: blue component of the color

Creates a new cairo_pattern_t corresponding to an opaque color. The color components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.

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

Definition at line 660 of file cairo-pattern.c.

◆ cairo_pattern_create_rgba()

cairo_pattern_t* cairo_pattern_create_rgba ( double  red,
double  green,
double  blue,
double  alpha 
)

cairo_pattern_create_rgba: @red: red component of the color @green: green component of the color @blue: blue component of the color @alpha: alpha component of the color

Creates a new cairo_pattern_t corresponding to a translucent color. The color components are floating point numbers in the range 0 to

  1. If the values passed in are outside that range, they will be clamped.

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

Definition at line 690 of file cairo-pattern.c.

◆ cairo_pattern_destroy()

void cairo_pattern_destroy ( cairo_pattern_t pattern)

cairo_pattern_destroy: @pattern: a cairo_pattern_t

Decreases the reference count on @pattern by one. If the result is zero, then @pattern and all associated resources are freed. See cairo_pattern_reference().

Since: 1.0

Definition at line 1119 of file cairo-pattern.c.

◆ cairo_pattern_get_color_stop_count()

cairo_status_t cairo_pattern_get_color_stop_count ( cairo_pattern_t pattern,
int count 
)

cairo_pattern_get_color_stop_count: @pattern: a cairo_pattern_t @count: return value for the number of color stops, or NULL

Gets the number of color stops specified in the given gradient pattern.

Return value: CAIRO_STATUS_SUCCESS, or CAIRO_STATUS_PATTERN_TYPE_MISMATCH if @pattern is not a gradient pattern.

Since: 1.4

Definition at line 4293 of file cairo-pattern.c.

◆ cairo_pattern_get_color_stop_rgba()

cairo_status_t cairo_pattern_get_color_stop_rgba ( cairo_pattern_t pattern,
int  index,
double *  offset,
double *  red,
double *  green,
double *  blue,
double *  alpha 
)

cairo_pattern_get_color_stop_rgba: @pattern: a cairo_pattern_t @index: index of the stop to return data for @offset: return value for the offset of the stop, or NULL @red: return value for red component of color, or NULL @green: return value for green component of color, or NULL @blue: return value for blue component of color, or NULL @alpha: return value for alpha component of color, or NULL

Gets the color and offset information at the given @index for a gradient pattern. Values of @index range from 0 to n-1 where n is the number returned by cairo_pattern_get_color_stop_count().

Return value: CAIRO_STATUS_SUCCESS, or CAIRO_STATUS_INVALID_INDEX if @index is not valid for the given pattern. If the pattern is not a gradient pattern, CAIRO_STATUS_PATTERN_TYPE_MISMATCH is returned.

Since: 1.4

Definition at line 4247 of file cairo-pattern.c.

◆ cairo_pattern_get_extend()

cairo_extend_t cairo_pattern_get_extend ( cairo_pattern_t pattern)

cairo_pattern_get_extend: @pattern: a cairo_pattern_t

Gets the current extend mode for a pattern. See cairo_extend_t for details on the semantics of each extend strategy.

Return value: the current extend strategy used for drawing the pattern.

Since: 1.0

Definition at line 2126 of file cairo-pattern.c.

◆ cairo_pattern_get_filter()

cairo_filter_t cairo_pattern_get_filter ( cairo_pattern_t pattern)

cairo_pattern_get_filter: @pattern: a cairo_pattern_t

Gets the current filter for a pattern. See cairo_filter_t for details on each filter.

Return value: the current filter used for resizing the pattern.

Since: 1.0

Definition at line 2083 of file cairo-pattern.c.

◆ cairo_pattern_get_linear_points()

cairo_status_t cairo_pattern_get_linear_points ( cairo_pattern_t pattern,
double *  x0,
double *  y0,
double *  x1,
double *  y1 
)

cairo_pattern_get_linear_points: @pattern: a cairo_pattern_t @x0: return value for the x coordinate of the first point, or NULL @y0: return value for the y coordinate of the first point, or NULL @x1: return value for the x coordinate of the second point, or NULL @y1: return value for the y coordinate of the second point, or NULL

Gets the gradient endpoints for a linear gradient.

Return value: CAIRO_STATUS_SUCCESS, or CAIRO_STATUS_PATTERN_TYPE_MISMATCH if @pattern is not a linear gradient pattern.

Since: 1.4

Definition at line 4328 of file cairo-pattern.c.

◆ cairo_pattern_get_matrix()

void cairo_pattern_get_matrix ( cairo_pattern_t pattern,
cairo_matrix_t matrix 
)

cairo_pattern_get_matrix: @pattern: a cairo_pattern_t @matrix: return value for the matrix

Stores the pattern's transformation matrix into @matrix.

Since: 1.0

Definition at line 2034 of file cairo-pattern.c.

◆ cairo_pattern_get_radial_circles()

cairo_status_t cairo_pattern_get_radial_circles ( cairo_pattern_t pattern,
double *  x0,
double *  y0,
double *  r0,
double *  x1,
double *  y1,
double *  r1 
)

cairo_pattern_get_radial_circles: @pattern: a cairo_pattern_t @x0: return value for the x coordinate of the center of the first circle, or NULL @y0: return value for the y coordinate of the center of the first circle, or NULL @r0: return value for the radius of the first circle, or NULL @x1: return value for the x coordinate of the center of the second circle, or NULL @y1: return value for the y coordinate of the center of the second circle, or NULL @r1: return value for the radius of the second circle, or NULL

Gets the gradient endpoint circles for a radial gradient, each specified as a center coordinate and a radius.

Return value: CAIRO_STATUS_SUCCESS, or CAIRO_STATUS_PATTERN_TYPE_MISMATCH if @pattern is not a radial gradient pattern.

Since: 1.4

Definition at line 4372 of file cairo-pattern.c.

◆ cairo_pattern_get_reference_count()

unsigned int cairo_pattern_get_reference_count ( cairo_pattern_t pattern)

cairo_pattern_get_reference_count: @pattern: a cairo_pattern_t

Returns the current reference count of @pattern.

Return value: the current reference count of @pattern. If the object is a nil object, 0 will be returned.

Since: 1.4

Definition at line 1155 of file cairo-pattern.c.

◆ cairo_pattern_get_rgba()

cairo_status_t cairo_pattern_get_rgba ( cairo_pattern_t pattern,
double *  red,
double *  green,
double *  blue,
double *  alpha 
)

cairo_pattern_get_rgba: @pattern: a cairo_pattern_t @red: return value for red component of color, or NULL @green: return value for green component of color, or NULL @blue: return value for blue component of color, or NULL @alpha: return value for alpha component of color, or NULL

Gets the solid color for a solid color pattern.

Return value: CAIRO_STATUS_SUCCESS, or CAIRO_STATUS_PATTERN_TYPE_MISMATCH if the pattern is not a solid color pattern.

Since: 1.4

Definition at line 4164 of file cairo-pattern.c.

◆ cairo_pattern_get_surface()

cairo_status_t cairo_pattern_get_surface ( cairo_pattern_t pattern,
cairo_surface_t **  surface 
)

cairo_pattern_get_surface: @pattern: a cairo_pattern_t @surface: return value for surface of pattern, or NULL

Gets the surface of a surface pattern. The reference returned in @surface is owned by the pattern; the caller should call cairo_surface_reference() if the surface is to be retained.

Return value: CAIRO_STATUS_SUCCESS, or CAIRO_STATUS_PATTERN_TYPE_MISMATCH if the pattern is not a surface pattern.

Since: 1.4

Definition at line 4207 of file cairo-pattern.c.

◆ cairo_pattern_get_type()

cairo_pattern_type_t cairo_pattern_get_type ( cairo_pattern_t pattern)

cairo_pattern_get_type: @pattern: a cairo_pattern_t

Get the pattern's type. See cairo_pattern_type_t for available types.

Return value: The type of @pattern.

Since: 1.2

Definition at line 1084 of file cairo-pattern.c.

◆ cairo_pattern_get_user_data()

void* cairo_pattern_get_user_data ( cairo_pattern_t pattern,
const cairo_user_data_key_t key 
)

cairo_pattern_get_user_data: @pattern: a cairo_pattern_t @key: the address of the cairo_user_data_key_t the user data was attached to

Return user data previously attached to @pattern using the specified key. If no user data has been attached with the given key this function returns NULL.

Return value: the user data previously attached or NULL.

Since: 1.4

Definition at line 1179 of file cairo-pattern.c.

◆ cairo_pattern_reference()

cairo_pattern_t* cairo_pattern_reference ( cairo_pattern_t pattern)

cairo_pattern_reference: @pattern: a cairo_pattern_t

Increases the reference count on @pattern by one. This prevents @pattern from being destroyed until a matching call to cairo_pattern_destroy() is made.

Use cairo_pattern_get_reference_count() to get the number of references to a cairo_pattern_t.

Return value: the referenced cairo_pattern_t.

Since: 1.0

Definition at line 1058 of file cairo-pattern.c.

◆ cairo_pattern_set_extend()

void cairo_pattern_set_extend ( cairo_pattern_t pattern,
cairo_extend_t  extend 
)

cairo_pattern_set_extend: @pattern: a cairo_pattern_t @extend: a cairo_extend_t describing how the area outside of the pattern will be drawn

Sets the mode to be used for drawing outside the area of a pattern. See cairo_extend_t for details on the semantics of each extend strategy.

The default extend mode is CAIRO_EXTEND_NONE for surface patterns and CAIRO_EXTEND_PAD for gradient patterns.

Since: 1.0

Definition at line 2104 of file cairo-pattern.c.

◆ cairo_pattern_set_filter()

void cairo_pattern_set_filter ( cairo_pattern_t pattern,
cairo_filter_t  filter 
)

cairo_pattern_set_filter: @pattern: a cairo_pattern_t @filter: a cairo_filter_t describing the filter to use for resizing the pattern

Sets the filter to be used for resizing when using this pattern. See cairo_filter_t for details on each filter.

<informalexample><programlisting> cairo_set_source_surface (cr, image, x, y); cairo_pattern_set_filter (cairo_get_source (cr), CAIRO_FILTER_NEAREST); </programlisting></informalexample>

Since: 1.0

Definition at line 2062 of file cairo-pattern.c.

◆ cairo_pattern_set_matrix()

void cairo_pattern_set_matrix ( cairo_pattern_t pattern,
const cairo_matrix_t matrix 
)

cairo_pattern_set_matrix: @pattern: a cairo_pattern_t @matrix: a cairo_matrix_t

Sets the pattern's transformation matrix to @matrix. This matrix is a transformation from user space to pattern space.

When a pattern is first created it always has the identity matrix for its transformation matrix, which means that pattern space is initially identical to user space.

Important: Please note that the direction of this transformation matrix is from user space to pattern space. This means that if you imagine the flow from a pattern to user space (and on to device space), then coordinates in that flow will be transformed by the inverse of the pattern matrix.

For example, if you want to make a pattern appear twice as large as it does by default the correct code to use is:

<informalexample><programlisting> cairo_matrix_init_scale (&matrix, 0.5, 0.5); cairo_pattern_set_matrix (pattern, &matrix); </programlisting></informalexample>

Meanwhile, using values of 2.0 rather than 0.5 in the code above would cause the pattern to appear at half of its default size.

Also, please note the discussion of the user-space locking semantics of cairo_set_source().

Since: 1.0

Definition at line 2002 of file cairo-pattern.c.

◆ cairo_pattern_set_user_data()

cairo_status_t cairo_pattern_set_user_data ( cairo_pattern_t pattern,
const cairo_user_data_key_t key,
void user_data,
cairo_destroy_func_t  destroy 
)

cairo_pattern_set_user_data: @pattern: a cairo_pattern_t @key: the address of a cairo_user_data_key_t to attach the user data to @user_data: the user data to attach to the cairo_pattern_t @destroy: a cairo_destroy_func_t which will be called when the cairo_t is destroyed or when new user data is attached using the same key.

Attach user data to @pattern. To remove user data from a surface, call this function with the key that was used to set it and NULL for @data.

Return value: CAIRO_STATUS_SUCCESS or CAIRO_STATUS_NO_MEMORY if a slot could not be allocated for the user data.

Since: 1.4

Definition at line 1205 of file cairo-pattern.c.

◆ cairo_pattern_status()

cairo_status_t cairo_pattern_status ( cairo_pattern_t pattern)

cairo_pattern_status: @pattern: a cairo_pattern_t

Checks whether an error has previously occurred for this pattern.

Return value: CAIRO_STATUS_SUCCESS, CAIRO_STATUS_NO_MEMORY, CAIRO_STATUS_INVALID_MATRIX, CAIRO_STATUS_PATTERN_TYPE_MISMATCH, or CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.

Since: 1.0

Definition at line 1103 of file cairo-pattern.c.

◆ cairo_pop_group()

cairo_pattern_t* cairo_pop_group ( cairo_t cr)

cairo_pop_group: @cr: a cairo context

Terminates the redirection begun by a call to cairo_push_group() or cairo_push_group_with_content() and returns a new pattern containing the results of all drawing operations performed to the group.

The cairo_pop_group() function calls cairo_restore(), (balancing a call to cairo_save() by the push_group function), so that any changes to the graphics state will not be visible outside the group.

Return value: a newly created (surface) pattern containing the results of all drawing operations performed to the group. The caller owns the returned object and should call cairo_pattern_destroy() when finished with it.

Since: 1.2

Definition at line 766 of file cairo.c.

◆ cairo_pop_group_to_source()

void cairo_pop_group_to_source ( cairo_t cr)

cairo_pop_group_to_source: @cr: a cairo context

Terminates the redirection begun by a call to cairo_push_group() or cairo_push_group_with_content() and installs the resulting pattern as the source pattern in the given cairo context.

The behavior of this function is equivalent to the sequence of operations:

<informalexample><programlisting> cairo_pattern_t *group = cairo_pop_group (cr); cairo_set_source (cr, group); cairo_pattern_destroy (group); </programlisting></informalexample>

but is more convenient as their is no need for a variable to store the short-lived pointer to the pattern.

The cairo_pop_group() function calls cairo_restore(), (balancing a call to cairo_save() by the push_group function), so that any changes to the graphics state will not be visible outside the group.

Since: 1.2

Definition at line 809 of file cairo.c.

◆ cairo_push_group()

void cairo_push_group ( cairo_t cr)

cairo_push_group: @cr: a cairo context

Temporarily redirects drawing to an intermediate surface known as a group. The redirection lasts until the group is completed by a call to cairo_pop_group() or cairo_pop_group_to_source(). These calls provide the result of any drawing to the group as a pattern, (either as an explicit object, or set as the source pattern).

This group functionality can be convenient for performing intermediate compositing. One common use of a group is to render objects as opaque within the group, (so that they occlude each other), and then blend the result with translucence onto the destination.

Groups can be nested arbitrarily deep by making balanced calls to cairo_push_group()/cairo_pop_group(). Each call pushes/pops the new target group onto/from a stack.

The cairo_push_group() function calls cairo_save() so that any changes to the graphics state will not be visible outside the group, (the pop_group functions call cairo_restore()).

By default the intermediate group will have a content type of CAIRO_CONTENT_COLOR_ALPHA. Other content types can be chosen for the group by using cairo_push_group_with_content() instead.

As an example, here is how one might fill and stroke a path with translucence, but without any portion of the fill being visible under the stroke:

<informalexample><programlisting> cairo_push_group (cr); cairo_set_source (cr, fill_pattern); cairo_fill_preserve (cr); cairo_set_source (cr, stroke_pattern); cairo_stroke (cr); cairo_pop_group_to_source (cr); cairo_paint_with_alpha (cr, alpha); </programlisting></informalexample>

Since: 1.2

Definition at line 706 of file cairo.c.

◆ cairo_push_group_with_content()

void cairo_push_group_with_content ( cairo_t cr,
cairo_content_t  content 
)

cairo_push_group_with_content: @cr: a cairo context @content: a cairo_content_t indicating the type of group that will be created

Temporarily redirects drawing to an intermediate surface known as a group. The redirection lasts until the group is completed by a call to cairo_pop_group() or cairo_pop_group_to_source(). These calls provide the result of any drawing to the group as a pattern, (either as an explicit object, or set as the source pattern).

The group will have a content type of @content. The ability to control this content type is the only distinction between this function and cairo_push_group() which you should see for a more detailed description of group rendering.

Since: 1.2

Definition at line 731 of file cairo.c.

◆ cairo_raster_source_pattern_get_acquire()

void cairo_raster_source_pattern_get_acquire ( cairo_pattern_t abstract_pattern,
cairo_raster_source_acquire_func_t acquire,
cairo_raster_source_release_func_t release 
)

cairo_raster_source_pattern_get_acquire: @pattern: the pattern to query @acquire: return value for the current acquire callback @release: return value for the current release callback

Queries the current acquire and release callbacks.

Since: 1.12

Definition at line 280 of file cairo-raster-source-pattern.c.

◆ cairo_raster_source_pattern_get_callback_data()

void* cairo_raster_source_pattern_get_callback_data ( cairo_pattern_t abstract_pattern)

cairo_raster_source_pattern_get_callback_data: @pattern: the pattern to update

Queries the current user data.

Return value: the current user-data passed to each callback

Since: 1.12

Definition at line 224 of file cairo-raster-source-pattern.c.

◆ cairo_raster_source_pattern_get_copy()

cairo_raster_source_copy_func_t cairo_raster_source_pattern_get_copy ( cairo_pattern_t abstract_pattern)

cairo_raster_source_pattern_get_copy: @pattern: the pattern to query

Queries the current copy callback.

Return value: the current copy callback

Since: 1.12

Definition at line 376 of file cairo-raster-source-pattern.c.

◆ cairo_raster_source_pattern_get_finish()

cairo_raster_source_finish_func_t cairo_raster_source_pattern_get_finish ( cairo_pattern_t abstract_pattern)

cairo_raster_source_pattern_get_finish: @pattern: the pattern to query

Queries the current finish callback.

Return value: the current finish callback

Since: 1.12

Definition at line 421 of file cairo-raster-source-pattern.c.

◆ cairo_raster_source_pattern_get_snapshot()

cairo_raster_source_snapshot_func_t cairo_raster_source_pattern_get_snapshot ( cairo_pattern_t abstract_pattern)

cairo_raster_source_pattern_get_snapshot: @pattern: the pattern to query

Queries the current snapshot callback.

Return value: the current snapshot callback

Since: 1.12

Definition at line 331 of file cairo-raster-source-pattern.c.

◆ cairo_raster_source_pattern_set_acquire()

void cairo_raster_source_pattern_set_acquire ( cairo_pattern_t abstract_pattern,
cairo_raster_source_acquire_func_t  acquire,