cairo.types

Undocumented in source.

Members

Aliases

Antialias
alias Antialias = cairo_antialias_t
Bool
alias Bool = cairo_bool_t
ColorMode
alias ColorMode = cairo_color_mode_t
Content
alias Content = cairo_content_t
DestroyFunc
alias DestroyFunc = void delegate()

#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.

DeviceType
alias DeviceType = cairo_device_type_t
Dither
alias Dither = cairo_dither_t
Extend
alias Extend = cairo_extend_t
FillRule
alias FillRule = cairo_fill_rule_t
Filter
alias Filter = cairo_filter_t
FontExtents
alias FontExtents = cairo_font_extents_t
FontSlant
alias FontSlant = cairo_font_slant_t
FontType
alias FontType = cairo_font_type_t
FontWeight
alias FontWeight = cairo_font_weight_t
Format
alias Format = cairo_format_t
HintMetrics
alias HintMetrics = cairo_hint_metrics_t
HintStyle
alias HintStyle = cairo_hint_style_t
LineCap
alias LineCap = cairo_line_cap_t
LineJoin
alias LineJoin = cairo_line_join_t
Operator
alias Operator = cairo_operator_t
PathDataType
alias PathDataType = cairo_path_data_type_t
PatternType
alias PatternType = cairo_pattern_type_t
PdfMetadata
alias PdfMetadata = cairo_pdf_metadata_t
PdfOutlineFlags
alias PdfOutlineFlags = cairo_pdf_outline_flags_t
PdfVersion
alias PdfVersion = cairo_pdf_version_t
PsLevel
alias PsLevel = cairo_ps_level_t
RasterSourceAcquireFunc
alias RasterSourceAcquireFunc = cairo.surface.Surface delegate(cairo.pattern.Pattern pattern, cairo.surface.Surface target, cairo.rectangle_int.RectangleInt extents)

#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.Surface.createSimilarImage 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.Surface.setDeviceOffset to specify the top-left corner of the sample data (along with width and height of the surface).

RasterSourceCopyFunc
alias RasterSourceCopyFunc = cairo.types.Status delegate(cairo.pattern.Pattern pattern, cairo.pattern.Pattern other)

#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.

RasterSourceFinishFunc
alias RasterSourceFinishFunc = void delegate(cairo.pattern.Pattern pattern)

#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.

RasterSourceReleaseFunc
alias RasterSourceReleaseFunc = void delegate(cairo.pattern.Pattern pattern, cairo.surface.Surface surface)

#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.

RasterSourceSnapshotFunc
alias RasterSourceSnapshotFunc = cairo.types.Status delegate(cairo.pattern.Pattern pattern)

#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.

ReadFunc
alias ReadFunc = cairo.types.Status delegate(ubyte[] data)

#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.types.Status.Success if all the data was successfully read, cairo.types.Status.ReadError otherwise.

RegionOverlap
alias RegionOverlap = cairo_region_overlap_t
ScriptMode
alias ScriptMode = cairo_script_mode_t
Status
alias Status = cairo_status_t
SubpixelOrder
alias SubpixelOrder = cairo_subpixel_order_t
SurfaceObserverCallback
alias SurfaceObserverCallback = void delegate(cairo.surface.Surface observer, cairo.surface.Surface target)

A generic callback function for surface operations.

SurfaceObserverMode
alias SurfaceObserverMode = cairo_surface_observer_mode_t
SurfaceType
alias SurfaceType = cairo_surface_type_t
SvgUnit
alias SvgUnit = cairo_svg_unit_t
SvgVersion
alias SvgVersion = cairo_svg_version_t
TextClusterFlags
alias TextClusterFlags = cairo_text_cluster_flags_t
TextExtents
alias TextExtents = cairo_text_extents_t
UserDataKey
alias UserDataKey = cairo_user_data_key_t
UserScaledFontInitFunc
alias UserScaledFontInitFunc = cairo.types.Status delegate(cairo.scaled_font.ScaledFont scaledFont, cairo.context.Context cr, cairo.types.FontExtents extents)

#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.

UserScaledFontRenderGlyphFunc
alias UserScaledFontRenderGlyphFunc = cairo.types.Status delegate(cairo.scaled_font.ScaledFont scaledFont, gulong glyph, cairo.context.Context cr, cairo.types.TextExtents extents)

#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.

UserScaledFontUnicodeToGlyphFunc
alias UserScaledFontUnicodeToGlyphFunc = cairo.types.Status delegate(cairo.scaled_font.ScaledFont scaledFont, gulong unicode, out gulong glyphIndex)

#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.context.Context.showText operation.

WriteFunc
alias WriteFunc = cairo.types.Status delegate(ubyte[] data)

#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.types.Status.Success if all the data was successfully written, cairo.types.Status.WriteError otherwise.

Manifest constants

COLOR_PALETTE_DEFAULT
enum COLOR_PALETTE_DEFAULT;

The default color palette index.

MIME_TYPE_CCITT_FAX
enum MIME_TYPE_CCITT_FAX;

Group 3 or Group 4 CCITT facsimile encoding (International Telecommunication Union, Recommendations T.4 and T.6.)

MIME_TYPE_CCITT_FAX_PARAMS
enum MIME_TYPE_CCITT_FAX_PARAMS;

Decode parameters for Group 3 or Group 4 CCITT facsimile encoding. See [CCITT Fax Images]ccitt.

MIME_TYPE_EPS
enum MIME_TYPE_EPS;

Encapsulated PostScript file. Encapsulated PostScript File Format Specification

MIME_TYPE_EPS_PARAMS
enum MIME_TYPE_EPS_PARAMS;

Embedding parameters Encapsulated PostScript data. See [Embedding EPS files]eps.

MIME_TYPE_JBIG2
enum MIME_TYPE_JBIG2;

Joint Bi-level Image Experts Group image coding standard (ISO/IEC 11544).

MIME_TYPE_JBIG2_GLOBAL
enum MIME_TYPE_JBIG2_GLOBAL;

Joint Bi-level Image Experts Group image coding standard (ISO/IEC 11544) global segment.

MIME_TYPE_JBIG2_GLOBAL_ID
enum MIME_TYPE_JBIG2_GLOBAL_ID;

An unique identifier shared by a JBIG2 global segment and all JBIG2 images that depend on the global segment.

MIME_TYPE_JP2
enum MIME_TYPE_JP2;

The Joint Photographic Experts Group (JPEG) 2000 image coding standard (ISO/IEC 15444-1).

MIME_TYPE_JPEG
enum MIME_TYPE_JPEG;

The Joint Photographic Experts Group (JPEG) image coding standard (ISO/IEC 10918-1).

MIME_TYPE_PNG
enum MIME_TYPE_PNG;

The Portable Network Graphics image file format (ISO/IEC 15948).

MIME_TYPE_UNIQUE_ID
enum MIME_TYPE_UNIQUE_ID;

Unique identifier for a surface (cairo specific MIME type). All surfaces with the same unique identifier will only be embedded once.

MIME_TYPE_URI
enum MIME_TYPE_URI;

URI for an image file (unofficial MIME type).

PDF_OUTLINE_ROOT
enum PDF_OUTLINE_ROOT;

The root outline item in cairo.global.pdfSurfaceAddOutline.

TAG_CONTENT
enum TAG_CONTENT;

Create a content tag.

TAG_CONTENT_REF
enum TAG_CONTENT_REF;

Create a content reference tag.

TAG_DEST
enum TAG_DEST;

Create a destination for a hyperlink. Destination tag attributes are detailed at Destinationsdest.

TAG_LINK
enum TAG_LINK;

Create hyperlink. Link tag attributes are detailed at Linkslink.