Index of values


A
add_color_stop_rgb [Cairo.Pattern]
Adds an opaque color stop to a gradient pattern.
add_color_stop_rgba [Cairo.Pattern]
Adds a translucent color stop to a gradient pattern.
append [Cairo.Path]
Append the path onto the current path.
arc [Cairo]
arc xc yc radius angle1 angle2 adds a circular arc of the given radius to the current path.
arc_negative [Cairo]
arc_negative xc yc radius angle1 angle2 adds a circular arc of the given radius to the current path.

B
begin_page_setup [Cairo.PS.Dsc]
This function indicates that subsequent calls to Cairo.PS.Dsc.comment should direct comments to the PageSetup section of the PostScript output.
begin_setup [Cairo.PS.Dsc]
This function indicates that subsequent calls to Cairo.PS.Dsc.comment should direct comments to the Setup section of the PostScript output.

C
clear [Cairo.Path]
Clears the current path.
clip [Cairo]
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).
clip_extents [Cairo]
Computes a bounding box in user coordinates covering the area inside the current clip.
clip_preserve [Cairo]
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).
clip_rectangle_list [Cairo]
Gets the current clip region as a list of rectangles in user coordinates.
clip_reset [Cairo]
Reset the current clip region to its original, unrestricted state.
close [Cairo.Path]
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.
comment [Cairo.PS.Dsc]
Emit a comment into the PostScript output for the given surface.
copy [Cairo.Path]
Creates a copy of the current path.
copy [Cairo.Font_options]
copy original allocates a new font options object copying the option values from original.
copy_flat [Cairo.Path]
Gets a flattened copy of the current path.
copy_page [Cairo.Surface]
Emits the current page for backends that support multiple pages, but doesn't clear it, so that the contents of the current page will be retained for the next page.
copy_page [Cairo]
copy_page cr 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.
create [Cairo_gtk]
create drawable creates a Cairo context for drawing to drawable.
create [Cairo.SVG]
Creates a SVG surface of the specified size in points to be written to fname.
create [Cairo.PS]
Creates a PostScript surface of the specified size in points to be written to fname.
create [Cairo.PNG]
create filename creates a new image surface and initializes the contents to the given PNG file.
create [Cairo.PDF]
Creates a PDF surface of the specified size in points to be written to fname.
create [Cairo.Image]
Creates an image surface of the specified format and dimensions.
create [Cairo.Scaled_font]
create font_face font_matrix ctm options creates a Cairo.Scaled_font.t object from a font face and matrices that describe the size of the font and the environment in which it will be used.
create [Cairo.Font_face]
create family slant weight creates a font face from a triplet of family, slant, and weight.
create [Cairo.Font_options]
Allocates a new font options object with all options initialized to default values.
create [Cairo]
create target creates a new context with all graphics state parameters set to default values and with target as a target surface.
create_for_data32 [Cairo.Image]
create_for_data32 ?width ?height ?alpha data same as Cairo.Image.create_for_data8 except that the stride will necessarily be according to the bigarray 1st dimension (so that matrix coordinates correspond to pixels) and the width and height will be by default taken from the bigarray 1st and 2nd dimensions respectively.
create_for_data8 [Cairo.Image]
create_for_data8 data format ?stride width height creates an image surface for the provided pixel data.
create_for_stream [Cairo.SVG]
Creates a SVG surface of the specified size in points to be written incrementally to the stream represented by output.
create_for_stream [Cairo.PS]
Creates a PostScript surface of the specified size in points to be written incrementally to the stream represented by output.
create_for_stream [Cairo.PDF]
Creates a PDF surface of the specified size in points to be written incrementally to the stream represented by output.
create_for_surface [Cairo.Pattern]
Create a new Cairo.Pattern.t for the given surface.
create_from_stream [Cairo.PNG]
Creates a new image surface from PNG data read incrementally via the input function.
create_linear [Cairo.Pattern]
Create a new linear gradient Cairo.Pattern.t along the line defined by (x0, y0) and (x1, y1).
create_radial [Cairo.Pattern]
Creates a new radial gradient Cairo.Pattern.t between the two circles defined by (cx0, cy0, radius0) and (cx1, cy1, radius1).
create_rgb [Cairo.Pattern]
Creates a new Cairo.Pattern.t corresponding to an opaque color.
create_rgba [Cairo.Pattern]
Creates a new Cairo.Pattern.t corresponding to a translucent color.
create_similar [Cairo.Surface]
create_similar other content width height create a new surface that is as compatible as possible with the existing surface other.
curve_to [Cairo]
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.

D
device_to_user [Cairo]
Transform a coordinate from device space to user space by multiplying the given point by the inverse of the current transformation matrix (CTM).
device_to_user_distance [Cairo]
device_to_user_distance cr dx dy transform a distance vector from device space to user space.

E
extents [Cairo.Path]
Computes a bounding box in user-space coordinates covering the points on the current path.
extents [Cairo.Scaled_font]
extents sf gets the metrics for sf.
extents [Cairo.Glyph]
Gets the extents for an array of glyphs.

F
fill [Cairo]
A drawing operator that fills the current path according to the current fill rule (each sub-path is implicitly closed before being filled).
fill_extents [Cairo]
Computes a bounding box in user coordinates covering the area that would be affected (the "inked" area) by a fill operation given the current path and fill parameters.
fill_preserve [Cairo]
A drawing operator that fills the current path according to the current fill rule (each sub-path is implicitly closed before being filled).
finish [Cairo.Surface]
This function finishes the surface and drops all references to external resources.
flush [Cairo.Surface]
Do any pending drawing for the surface and also restore any temporary modification's cairo has made to the surface's state.
fold [Cairo.Path]
fold cr f folds f over all elements of the path.
font_extents [Cairo]
Gets the font extents for the currently selected font.

G
get [Cairo.Scaled_font]
Gets the current scaled font for a cairo_t.
get [Cairo.Font_face]
Gets the current font face for a Cairo.context.
get [Cairo.Font_options]
Retrieves font rendering options set via Cairo.Font_options.set.
get_antialias [Cairo.Font_options]
Gets the antialiasing mode for the font options object.
get_antialias [Cairo]
Gets the current shape antialiasing mode, as set by Cairo.set_antialias.
get_color_stop_count [Cairo.Pattern]
Return the number of color stops specified in the given gradient pattern.
get_color_stop_rgba [Cairo.Pattern]
Gets the color and offset information at the given index for a gradient pattern.
get_content [Cairo.Surface]
This function returns the content type of surface which indicates whether the surface contains color and/or alpha information.
get_ctm [Cairo.Scaled_font]
get_ctm scaled_font returns the CTM with which scaled_font was created.
get_current_point [Cairo.Path]
get_current_point cr gets the (x,y) coordinates of the current point of the current path, which is conceptually the final point reached by the path so far.
get_dash [Cairo]
Gets the current dash array (( [| |], 0.) if dashing is not currently in effect).
get_data32 [Cairo.Image]
Get the data of the image surface (shared), for direct inspection or modification.
get_data8 [Cairo.Image]
Get the data of the image surface (shared), for direct inspection or modification.
get_device_offset [Cairo.Surface]
This function returns the previous device offset set by Cairo.Surface.set_device_offset.
get_eps [Cairo.PS]
Check whether the PostScript surface will output Encapsulated PostScript.
get_extend [Cairo.Pattern]
Gets the current extend mode for a pattern.
get_fallback_resolution [Cairo.Surface]
This function returns the previous fallback resolution set by Cairo.Surface.set_fallback_resolution, or default fallback resolution if never set.
get_family [Cairo.Font_face]
Gets the familly name of a toy font.
get_fill_rule [Cairo]
Gets the current fill rule, as set by set_fill_rule.
get_filter [Cairo.Pattern]
Gets the current filter for a pattern.
get_font_face [Cairo.Scaled_font]
Gets the font face that this scaled font was created for.
get_font_matrix [Cairo.Scaled_font]
get_font_matrix scaled_font return the font matrix with which scaled_font was created.
get_font_matrix [Cairo]
Returns the current font matrix.
get_font_options [Cairo.Surface]
get_font_options surface retrieves the default font rendering options for the surface.
get_font_options [Cairo.Scaled_font]
get_font_options scaled_font returns the font options with which scaled_font was created.
get_format [Cairo.Image]
Get the format of the surface.
get_height [Cairo.Image]
Get the height of the image surface in pixels.
get_hint_metrics [Cairo.Font_options]
Gets the metrics hinting mode for the font options object.
get_hint_style [Cairo.Font_options]
Gets the hint style for font outlines for the font options object.
get_levels [Cairo.PS]
Retrieves the list of supported levels.
get_line_cap [Cairo]
Gets the current line cap style, as set by Cairo.set_line_cap.
get_line_join [Cairo]
Gets the current line join style, as set by Cairo.set_line_join.
get_line_width [Cairo]
This function returns the current line width value exactly as set by Cairo.set_line_width.
get_linear_points [Cairo.Pattern]
Gets the gradient endpoints for a linear gradient.
get_matrix [Cairo.Pattern]
Returns the pattern's transformation matrix.
get_matrix [Cairo]
Return the current transformation matrix (CTM).
get_miter_limit [Cairo]
Gets the current miter limit, as set by Cairo.set_miter_limit.
get_operator [Cairo]
Gets the current compositing operator for a cairo context.
get_radial_circles [Cairo.Pattern]
Gets the gradient endpoint circles for a radial gradient, each specified as a center coordinate and a radius.
get_rgba [Cairo.Pattern]
Return the solid color for a solid color pattern.
get_scale_matrix [Cairo.Scaled_font]
get_scale_matrix scaled_font returns the scale matrix of scaled_font.
get_slant [Cairo.Font_face]
Gets the slant a toy font.
get_source [Cairo]
get_source cr gets the current source pattern for cr.
get_stride [Cairo.Image]
Get the stride of the image surface in bytes.
get_subpixel_order [Cairo.Font_options]
Gets the subpixel order for the font options object.
get_surface [Cairo.Pattern]
Gets the surface of a surface pattern.
get_target [Cairo.Group]
Gets the current destination surface for the context.
get_target [Cairo]
Gets the target surface for the cairo context as passed to create.
get_tolerance [Cairo]
Gets the current tolerance value, as set by Cairo.set_tolerance.
get_type [Cairo.Surface]
This function returns the type of the backend used to create a surface.
get_type [Cairo.Scaled_font]
This function returns the type of the backend used to create a scaled font.
get_type [Cairo.Font_face]
This function returns the type of the backend used to create a font face.
get_versions [Cairo.SVG]
Retrieve the list of supported versions.
get_weight [Cairo.Font_face]
Gets the weight a toy font.
get_width [Cairo.Image]
Get the width of the image surface in pixels.
glyph [Cairo.Path]
Adds closed paths for the glyphs to the current path.
glyph_extents [Cairo.Scaled_font]
glyph_extents scaled_font glyphs gets the extents for an array of glyphs.

H
has_show_text_glyphs [Cairo.Surface]
Returns whether the surface supports sophisticated Cairo.Glyph.show_text operations.

I
identity_matrix [Cairo]
Resets the current transformation matrix (CTM) by setting it equal to the identity matrix.
in_fill [Cairo]
Tests whether the given point is inside the area that would be affected by a fill operation given the current path and filling parameters.
in_stroke [Cairo]
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.
init_identity [Cairo.Matrix]
init_identity() returns the identity transformation.
init_rotate [Cairo.Matrix]
init_rotate radians returns a a transformation that rotates by radians.
init_scale [Cairo.Matrix]
init_scale sx sy return a transformation that scales by sx and sy in the X and Y dimensions, respectively.
init_translate [Cairo.Matrix]
init_translate tx ty return a transformation that translates by tx and ty in the X and Y dimensions, respectively.
invert [Cairo.Matrix]
invert matrix changes matrix to be the inverse of it's original value.

L
level_to_string [Cairo.PS]
level_to_string level return the string representation of the given level id.
line_to [Cairo]
Adds a line to the path from the current point to position (x, y) in user-space coordinates.

M
make [Cairo.Font_options]
Convenience function to create an options object with properties set.
mark_dirty [Cairo.Surface]
Tells cairo that drawing has been done to surface using means other than cairo, and that cairo should reread any cached areas.
mark_dirty_rectangle [Cairo.Surface]
Like Cairo.Surface.mark_dirty, but drawing has been done only to the specified rectangle, so that cairo can retain cached contents for other parts of the surface.
mask [Cairo]
mask cr pattern: a drawing operator that paints the current source using the alpha channel of pattern as a mask.
mask_surface [Cairo]
mask_surface cr surface x y: a drawing operator that paints the current source using the alpha channel of surface as a mask.
merge [Cairo.Font_options]
merge options other merges non-default options from other into options, replacing existing values.
move_to [Cairo]
Begin a new sub-path.
multiply [Cairo.Matrix]
multiply a b multiplies the affine transformations in a and b together and return the result.

O
of_array [Cairo.Path]
output_ppm [Cairo.Image]
Convenience function to write the subarray of size (width, height) representing an image to the PPM format.

P
paint [Cairo]
A drawing operator that paints the current source everywhere within the current clip region.
pop [Cairo.Group]
Terminates the redirection begun by a call to Cairo.Group.push and returns a new pattern containing the results of all drawing operations performed to the group.
pop_to_source [Cairo.Group]
Terminates the redirection begun by a call to Group.push and installs the resulting pattern as the source pattern in the given cairo context.
push [Cairo.Group]
Temporarily redirects drawing to an intermediate surface known as a group.

R
rectangle [Cairo_gtk]
rectangle cr r adds the rectangle r to the current path of cr.
rectangle [Cairo]
Adds a closed sub-path rectangle of the given size to the current path at position (x, y) in user-space coordinates.
region [Cairo_gtk]
region cr r adds the region r to the current path of cr.
rel_curve_to [Cairo]
Relative-coordinate version of Cairo.curve_to.
rel_line_to [Cairo]
Relative-coordinate version of Cairo.line_to.
rel_move_to [Cairo]
Begin a new sub-path.
restore [Cairo]
restore cr restores cr to the state saved by a preceding call to save and removes that state from the stack of saved states.
restrict_to_level [Cairo.PS]
restrict_to_level level restricts the generated PostSript file to level.
restrict_to_version [Cairo.SVG]
Restricts the generated SVG file to version.
rotate [Cairo.Matrix]
rotate matrix radians applies rotation by radians to the transformation in matrix.
rotate [Cairo]
Modifies the current transformation matrix (CTM) by rotating the user-space axes by angle radians.

S
save [Cairo]
save cr makes a copy of the current state of cr and saves it on an internal stack of saved states for cr.
scale [Cairo.Matrix]
scale matrix sx sy applies scaling by sx, sy to the transformation in matrix.
scale [Cairo]
scale sx sy modifies the current transformation matrix (CTM) by scaling the X and Y user-space axes by sx and sy respectively.
select_font_face [Cairo]
select_font_face cr family ?slant ?weight selects a family and style of font from a simplified description as a family name, slant and weight.
set [Cairo.Scaled_font]
Replaces the current font face, font matrix, and font options in the with those of the Cairo.Scaled_font.t.
set [Cairo.Font_face]
Replaces the current Cairo.Font_face.t object in the Cairo.context with font_face.
set [Cairo.Font_options]
set_font_options cr opt sets a set of custom font rendering options for cr.
set_antialias [Cairo.Font_options]
Sets the antialiasing mode for the font options object.
set_antialias [Cairo]
Set the antialiasing mode of the rasterizer used for drawing shapes.
set_dash [Cairo]
set_dash cr dashes sets the dash pattern to be used by Cairo.stroke.
set_device_offset [Cairo.Surface]
Sets an offset that is added to the device coordinates determined by the CTM when drawing to surface.
set_eps [Cairo.PS]
If eps is true, the PostScript surface will output Encapsulated PostScript.
set_extend [Cairo.Pattern]
Sets the mode to be used for drawing outside the area of a pattern.
set_fallback_resolution [Cairo.Surface]
set_fallback_resolution surface x_pixels_per_inch y_pixels_per_inch sets the horizontal and vertical resolution for image fallbacks.
set_fill_rule [Cairo]
set_fill_rule cr fill_rule sets the current fill rule within the cairo context cr.
set_filter [Cairo.Pattern]
Sets the filter to be used for resizing when using this pattern.
set_font_matrix [Cairo]
set_font_matrix cr matrix sets the current font matrix to matrix.
set_font_size [Cairo]
set_font_size cr size sets the current font matrix to a scale by a factor of size, replacing any font matrix previously set with set_font_size or Cairo.set_font_matrix.
set_hint_metrics [Cairo.Font_options]
Sets the metrics hinting mode for the font options object.
set_hint_style [Cairo.Font_options]
Sets the hint style for font outlines for the font options object.
set_line_cap [Cairo]
set_line_cap cr line_cap sets the current line cap style within the cairo context cr.
set_line_join [Cairo]
Sets the current line join style within the cairo context.
set_line_width [Cairo]
Sets the current line width within the cairo context.
set_matrix [Cairo.Pattern]
Sets the pattern's transformation matrix to matrix.
set_matrix [Cairo]
set_matrix cr matrix Modifies the current transformation matrix (CTM) by setting it equal to matrix.
set_miter_limit [Cairo]
Sets the current miter limit within the cairo context.
set_operator [Cairo]
Sets the compositing operator to be used for all drawing operations.
set_size [Cairo.PS]
Changes the size of a PostScript surface for the current (and subsequent) pages.
set_size [Cairo.PDF]
Changes the size of a PDF surface for the current (and subsequent) pages.
set_source [Cairo]
set_source cr source sets the source pattern within cr to source.
set_source_color [Cairo_gtk]
set_source_color cr color sets the specified color as the source color of cr.
set_source_pixbuf [Cairo_gtk]
Sets the given pixbuf as the source pattern for the Cairo context.
set_source_rgb [Cairo]
set_source_rgb cr r g b sets the source pattern within cr to an opaque color.
set_source_rgba [Cairo]
set_source_rgba cr r g b a sets the source pattern within cr to a translucent color.
set_source_surface [Cairo]
set_source_surface cr surface x y is a convenience for creating a pattern from surface and setting it as the source in cr with set_source.
set_subpixel_order [Cairo.Font_options]
Sets the subpixel order for the font options object.
set_tolerance [Cairo]
Sets the tolerance used when converting paths into trapezoids.
show [Cairo.Glyph]
A drawing operator that generates the shape from an array of glyphs, rendered according to the current font face, font size (font matrix), and font options.
show_page [Cairo.Surface]
Emits and clears the current page for backends that support multiple pages.
show_page [Cairo]
show_page cr emits and clears the current page for backends that support multiple pages.
show_text [Cairo.Glyph]
show_text cr utf8 glyphs clusters cluster_flags: This operation has rendering effects similar to Cairo.Glyph.show but, if the target surface supports it, uses the provided text and cluster mapping to embed the text for the glyphs shown in the output.
show_text [Cairo]
A drawing operator that generates the shape from a string of UTF-8 characters, rendered according to the current font_face, font_size (font_matrix), and font_options.
status_to_string [Cairo]
Provides a human-readable description of a status.
stroke [Cairo]
A drawing operator that strokes the current path according to the current line width, line join, line cap, and dash settings.
stroke_extents [Cairo]
Computes a bounding box in user coordinates covering the area that would be affected (the "inked" area) by a Cairo.stroke operation operation given the current path and stroke parameters.
stroke_preserve [Cairo]
Like Cairo.stroke except that it preserves the path within the cairo context.
sub [Cairo.Path]
Begin a new sub-path.

T
text [Cairo.Path]
text cr utf8 adds closed paths for text to the current path.
text_extents [Cairo.Scaled_font]
text_extents scaled_font utf8 gets the extents for a string of text.
text_extents [Cairo]
text_extents cr utf8 gets the extents for a string of text.
text_to_glyphs [Cairo.Scaled_font]
text_to_glyphs scaled_font x y utf8 converts UTF-8 text to an array of glyphs, optionally with cluster mapping, that can be used to render later using scaled_font.
to_array [Cairo.Path]
transform [Cairo]
transform cr matrix modifies the current transformation matrix (CTM) by applying matrix as an additional transformation.
transform_distance [Cairo.Matrix]
transform_distance matrix dx dy transforms the distance vector (dx,dy) by matrix.
transform_point [Cairo.Matrix]
transform_point matrix x y transforms the point (x, y) by matrix.
translate [Cairo.Matrix]
translate matrix tx ty applies a translation by tx, ty to the transformation in matrix.
translate [Cairo]
translate cr tx ty modifies the current transformation matrix (CTM) by translating the user-space origin by (tx, ty).

U
user_to_device [Cairo]
user_to_device cr x y transform a coordinate from user space to device space by multiplying the given point by the current transformation matrix (CTM).
user_to_device_distance [Cairo]
user_to_device_distance cr dx dy transform a distance vector from user space to device space.

V
version_to_string [Cairo.SVG]
Get the string representation of the given version id.

W
write [Cairo.PNG]
write surface filename writes the contents of surface to a new file filename as a PNG image.
write_to_stream [Cairo.PNG]
Writes the image surface using the output function.