Enums — Pycairo documentation (original) (raw)

Before Pycairo 1.13 most of the enum values defined here where only available as constants on the module level. See Legacy Constants.

class cairo.Antialias(value: int)

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

Added in version 1.13.

BEST_: Antialias_ = Ellipsis

Hint that the backend should render at the highest quality, sacrificing speed if necessary.

DEFAULT_: Antialias_ = Ellipsis

Use the default antialiasing for the subsystem and target device

FAST_: Antialias_ = Ellipsis

Hint that the backend should perform some antialiasing but prefer speed over quality.

GOOD_: Antialias_ = Ellipsis

The backend should balance quality against performance.

GRAY_: Antialias_ = Ellipsis

Perform single-color antialiasing (using shades of gray for black text on a white background, for example).

NONE_: Antialias_ = Ellipsis

Use a bilevel alpha mask

SUBPIXEL_: Antialias_ = Ellipsis

Perform antialiasing by taking advantage of the order of subpixel elements on devices such as LCD panels.

class cairo.Content(value: int)

These constants are used to describe the content that a Surfacewill contain, whether color information, alpha information (translucence vs. opacity), or both.

Added in version 1.13.

ALPHA_: Content_ = Ellipsis

The surface will hold alpha content only.

COLOR_: Content_ = Ellipsis

The surface will hold color content only.

COLOR_ALPHA_: Content_ = Ellipsis

The surface will hold color and alpha content.

class cairo.Extend(value: int)

These constants are 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).

The default extend mode is NONE for SurfacePattern andPAD for Gradient patterns.

Added in version 1.13.

NONE_: Extend_ = Ellipsis

pixels outside of the source pattern are fully transparent

PAD_: Extend_ = Ellipsis

pixels outside of the pattern copy the closest pixel from the source (Since 1.2; but only implemented for surface patterns since 1.6)

REFLECT_: Extend_ = Ellipsis

the pattern is tiled by reflecting at the edges (Implemented for surface patterns since 1.6)

REPEAT_: Extend_ = Ellipsis

the pattern is tiled by repeating

class cairo.FillRule(value: int)

These constants are 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 WINDING.

Added in version 1.13.

EVEN_ODD_: FillRule_ = Ellipsis

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.

WINDING_: FillRule_ = Ellipsis

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.

class cairo.Filter(value: int)

These constants are used to indicate what filtering should be applied when reading pixel values from patterns. See Pattern.set_filter() for indicating the desired filter to be used with a particular pattern.

Added in version 1.13.

BEST_: Filter_ = Ellipsis

The highest-quality available, performance may not be suitable for interactive use.

BILINEAR_: Filter_ = Ellipsis

Linear interpolation in two dimensions

FAST_: Filter_ = Ellipsis

A high-performance filter, with quality similar FILTER_NEAREST

GAUSSIAN_: Filter_ = Ellipsis

This filter value is currently unimplemented, and should not be used in current code.

GOOD_: Filter_ = Ellipsis

A reasonable-performance filter, with quality similar to_FILTER_BILINEAR_

NEAREST_: Filter_ = Ellipsis

Nearest-neighbor filtering

class cairo.FontSlant(value: int)

These constants specify variants of a FontFace based on their slant.

Added in version 1.13.

ITALIC_: FontSlant_ = Ellipsis

Italic font style

NORMAL_: FontSlant_ = Ellipsis

Upright font style

OBLIQUE_: FontSlant_ = Ellipsis

Oblique font style

class cairo.FontWeight(value: int)

These constants specify variants of a FontFace based on their weight.

Added in version 1.13.

BOLD_: FontWeight_ = Ellipsis

Bold font weight

NORMAL_: FontWeight_ = Ellipsis

Normal font weight

class cairo.Format(value: int)

These constants are used to identify the memory format ofImageSurface data.

New entries may be added in future versions.

Added in version 1.13.

stride_for_width(width: int) → int 

Parameters:

width – the desired width of an ImageSurfaceto be created.

Returns:

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

This method 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:

format = cairo.Format.RGB24 stride = format.stride_for_width(width) surface = cairo.ImageSurface.create_for_data( data, format, width, height, stride)

Also available undercairo.ImageSurface.format_stride_for_width().

Added in version 1.14.

A1_: Format_ = Ellipsis

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

A8_: Format_ = Ellipsis

each pixel is a 8-bit quantity holding an alpha value.

ARGB32_: Format_ = Ellipsis

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

INVALID_: Format_ = Ellipsis

no such format exists or is supported.

RGB16_565_: Format_ = Ellipsis

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.

RGB24_: Format_ = Ellipsis

each pixel is a 32-bit quantity, with the upper 8 bits unused. [1] Red, Green, and Blue are stored in the remaining 24 bits in that order.

RGB30_: Format_ = Ellipsis

like RGB24 but with 10bpc.

RGB96F_: Format_ = Ellipsis

3 floats, R, G, B.

Added in version 1.23: Only available with cairo 1.17.2+

RGBA128F_: Format_ = Ellipsis

4 floats, R, G, B, A.

Added in version 1.23: Only available with cairo 1.17.2+

class cairo.HintMetrics(value: int)

These constants specify 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.

Added in version 1.13.

DEFAULT_: HintMetrics_ = Ellipsis

Hint metrics in the default manner for the font backend and target device

OFF_: HintMetrics_ = Ellipsis

“Do not hint font metrics

ON_: HintMetrics_ = Ellipsis

Hint font metrics

class cairo.HintStyle(value: int)

These constants specify 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.

Added in version 1.13.

DEFAULT_: HintStyle_ = Ellipsis

Use the default hint style for font backend and target device

FULL_: HintStyle_ = Ellipsis

Hint outlines to maximize contrast

MEDIUM_: HintStyle_ = Ellipsis

Hint outlines with medium strength giving a compromise between fidelity to the original shapes and contrast

NONE_: HintStyle_ = Ellipsis

Do not hint outlines

SLIGHT_: HintStyle_ = Ellipsis

Hint outlines slightly to improve contrast while retaining good fidelity to the original shapes.

class cairo.LineCap(value: int)

These constants specify how to render the endpoints of the path when stroking.

The default line cap style is BUTT

Added in version 1.13.

BUTT_: LineCap_ = Ellipsis

start(stop) the line exactly at the start(end) point

ROUND_: LineCap_ = Ellipsis

use a round ending, the center of the circle is the end point

SQUARE_: LineCap_ = Ellipsis

use squared ending, the center of the square is the end point

class cairo.LineJoin(value: int)

These constants specify how to render the junction of two lines when stroking.

The default line join style is MITER

Added in version 1.13.

BEVEL_: LineJoin_ = Ellipsis

use a cut-off join, the join is cut off at half the line width from the joint point

MITER_: LineJoin_ = Ellipsis

use a sharp (angled) corner, see Context.set_miter_limit()

ROUND_: LineJoin_ = Ellipsis

use a rounded join, the center of the circle is the joint point

class cairo.Operator(value: int)

These constants are used to set the compositing operator for all cairo drawing operations.

The default operator is OVER.

The operators marked as unbounded 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 https://cairographics.org/operators.

Added in version 1.13.

ADD_: Operator_ = Ellipsis

source and destination layers are accumulated

ATOP_: Operator_ = Ellipsis

draw source on top of destination content and only there

CLEAR_: Operator_ = Ellipsis

clear destination layer (bounded)

COLOR_BURN_: Operator_ = Ellipsis

darkens the destination color to reflect the source color.

COLOR_DODGE_: Operator_ = Ellipsis

brightens the destination color to reflect the source color.

DARKEN_: Operator_ = Ellipsis

replaces the destination with the source if it is darker, otherwise keeps the source.

DEST_: Operator_ = Ellipsis

ignore the source

DEST_ATOP_: Operator_ = Ellipsis

leave destination on top of source content and only there (unbounded)

DEST_IN_: Operator_ = Ellipsis

leave destination only where there was source content (unbounded)

DEST_OUT_: Operator_ = Ellipsis

leave destination only where there was no source content

DEST_OVER_: Operator_ = Ellipsis

draw destination on top of source

DIFFERENCE_: Operator_ = Ellipsis

Takes the difference of the source and destination color.

EXCLUSION_: Operator_ = Ellipsis

Produces an effect similar to difference, but with lower contrast.

HARD_LIGHT_: Operator_ = Ellipsis

Multiplies or screens, dependent on source color.

HSL_COLOR_: Operator_ = Ellipsis

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.

HSL_HUE_: Operator_ = Ellipsis

Creates a color with the hue of the source and the saturation and luminosity of the target.

HSL_LUMINOSITY_: Operator_ = Ellipsis

Creates a color with the luminosity of the source and the hue and saturation of the target. This produces an inverse effect toHSL_COLOR

HSL_SATURATION_: Operator_ = Ellipsis

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.

IN_: Operator_ = Ellipsis

draw source where there was destination content (unbounded)

LIGHTEN_: Operator_ = Ellipsis

replaces the destination with the source if it is lighter, otherwise keeps the source.

MULTIPLY_: Operator_ = Ellipsis

source and destination layers are multiplied. This causes the result to be at least as dark as the darker inputs.

OUT_: Operator_ = Ellipsis

draw source where there was no destination content (unbounded)

OVER_: Operator_ = Ellipsis

draw source layer on top of destination layer (bounded)

OVERLAY_: Operator_ = Ellipsis

multiplies or screens, depending on the lightness of the destination color.

SATURATE_: Operator_ = Ellipsis

like over, but assuming source and dest are disjoint geometries

SCREEN_: Operator_ = Ellipsis

source and destination are complemented and multiplied. This causes the result to be at least as light as the lighter inputs.

SOFT_LIGHT_: Operator_ = Ellipsis

Darkens or lightens, dependent on source color.

SOURCE_: Operator_ = Ellipsis

replace destination layer (bounded)

XOR_: Operator_ = Ellipsis

source and destination are shown where there is only one of them

class cairo.PathDataType(value: int)

These constants are used to describe the type of one portion of a path when represented as a Path.

Added in version 1.13.

CLOSE_PATH_: PathDataType_ = Ellipsis

A close-path operation

CURVE_TO_: PathDataType_ = Ellipsis

A curve-to operation

LINE_TO_: PathDataType_ = Ellipsis

A line-to operation

MOVE_TO_: PathDataType_ = Ellipsis

A move-to operation

class cairo.PSLevel(value: int)

These constants are used to describe the language level of the PostScript Language Reference that a generated PostScript file will conform to. Note: the constants are only defined when cairo has been compiled with PS support enabled.

Added in version 1.13.

LEVEL_2_: PSLevel_ = Ellipsis

The language level 2 of the PostScript specification.

LEVEL_3_: PSLevel_ = Ellipsis

The language level 3 of the PostScript specification.

class cairo.PDFVersion(value: int)

These constants are used to describe the version number of the PDF specification that a generated PDF file will conform to.

Added in version 1.13.

VERSION_1_4_: PDFVersion_ = Ellipsis

The version 1.4 of the PDF specification.

VERSION_1_5_: PDFVersion_ = Ellipsis

The version 1.5 of the PDF specification.

VERSION_1_6_: PDFVersion_ = Ellipsis

The version 1.6 of the PDF specification.

Added in version 1.23.0: Only available with cairo 1.17.6+

VERSION_1_7_: PDFVersion_ = Ellipsis

The version 1.7 of the PDF specification.

Added in version 1.23.0: Only available with cairo 1.17.6+

class cairo.SVGVersion(value: int)

These constants are used to describe the version number of the SVG specification that a generated SVG file will conform to.

Added in version 1.13.

VERSION_1_1_: SVGVersion_ = Ellipsis

The version 1.1 of the SVG specification.

VERSION_1_2_: SVGVersion_ = Ellipsis

The version 1.2 of the SVG specification.

class cairo.SubpixelOrder(value: int)

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

Added in version 1.13.

BGR_: SubpixelOrder_ = Ellipsis

Subpixel elements are arranged horizontally with blue at the left

DEFAULT_: SubpixelOrder_ = Ellipsis

Use the default subpixel order for for the target device

RGB_: SubpixelOrder_ = Ellipsis

Subpixel elements are arranged horizontally with red at the left

VBGR_: SubpixelOrder_ = Ellipsis

Subpixel elements are arranged vertically with blue at the top

VRGB_: SubpixelOrder_ = Ellipsis

Subpixel elements are arranged vertically with red at the top

class cairo.RegionOverlap(value: int)

Added in version 1.13.

IN_: RegionOverlap_ = Ellipsis

The contents are entirely inside the region.

OUT_: RegionOverlap_ = Ellipsis

The contents are entirely outside the region.

PART_: RegionOverlap_ = Ellipsis

The contents are partially inside and partially outside the region.

class cairo.Status(value: int)

Added in version 1.13.

CLIP_NOT_REPRESENTABLE_: Status_ = Ellipsis

DEVICE_ERROR_: Status_ = Ellipsis

DEVICE_FINISHED_: Status_ = Ellipsis

DEVICE_TYPE_MISMATCH_: Status_ = Ellipsis

FILE_NOT_FOUND_: Status_ = Ellipsis

FONT_TYPE_MISMATCH_: Status_ = Ellipsis

INVALID_CLUSTERS_: Status_ = Ellipsis

INVALID_CONTENT_: Status_ = Ellipsis

INVALID_DASH_: Status_ = Ellipsis

INVALID_FORMAT_: Status_ = Ellipsis

INVALID_INDEX_: Status_ = Ellipsis

INVALID_MATRIX_: Status_ = Ellipsis

INVALID_MESH_CONSTRUCTION_: Status_ = Ellipsis

INVALID_PATH_DATA_: Status_ = Ellipsis

INVALID_POP_GROUP_: Status_ = Ellipsis

INVALID_RESTORE_: Status_ = Ellipsis

INVALID_SIZE_: Status_ = Ellipsis

INVALID_SLANT_: Status_ = Ellipsis

INVALID_STATUS_: Status_ = Ellipsis

INVALID_STRIDE_: Status_ = Ellipsis

INVALID_STRING_: Status_ = Ellipsis

INVALID_VISUAL_: Status_ = Ellipsis

INVALID_WEIGHT_: Status_ = Ellipsis

JBIG2_GLOBAL_MISSING_: Status_ = Ellipsis

Added in version 1.14.

LAST_STATUS_: Status_ = Ellipsis

NEGATIVE_COUNT_: Status_ = Ellipsis

NO_CURRENT_POINT_: Status_ = Ellipsis

NO_MEMORY_: Status_ = Ellipsis

NULL_POINTER_: Status_ = Ellipsis

PATTERN_TYPE_MISMATCH_: Status_ = Ellipsis

READ_ERROR_: Status_ = Ellipsis

SUCCESS_: Status_ = Ellipsis

SURFACE_FINISHED_: Status_ = Ellipsis

SURFACE_TYPE_MISMATCH_: Status_ = Ellipsis

TEMP_FILE_ERROR_: Status_ = Ellipsis

USER_FONT_ERROR_: Status_ = Ellipsis

USER_FONT_IMMUTABLE_: Status_ = Ellipsis

USER_FONT_NOT_IMPLEMENTED_: Status_ = Ellipsis

WRITE_ERROR_: Status_ = Ellipsis

TAG_ERROR_: Status_ = Ellipsis

Added in version 1.18.0: Only available with cairo 1.15.10+

FREETYPE_ERROR_: Status_ = Ellipsis

Added in version 1.18.0: Only available with cairo 1.15.10+

PNG_ERROR_: Status_ = Ellipsis

Added in version 1.18.0: Only available with cairo 1.15.10+

WIN32_GDI_ERROR_: Status_ = Ellipsis

Added in version 1.18.0: Only available with cairo 1.15.10+

DWRITE_ERROR_: Status_ = Ellipsis

Added in version 1.23.0: Only available with cairo 1.17.6+

SVG_FONT_ERROR_: Status_ = Ellipsis

Added in version 1.25.0: Only available with cairo 1.17.8+

class cairo.ScriptMode(value: int)

A set of script output variants.

Added in version 1.14.

ASCII_: ScriptMode_ = Ellipsis

the output will be in readable text (default)

BINARY_: ScriptMode_ = Ellipsis

the output will use byte codes.

class cairo.TextClusterFlags(value: int)

Specifies properties of a text cluster mapping.

Added in version 1.14.

BACKWARD_: TextClusterFlags_ = Ellipsis

The clusters in the cluster array map to glyphs in the glyph array from end to start.

class cairo.SurfaceObserverMode(value: int)

Whether operations should be recorded.

Added in version 1.14.

NORMAL_: SurfaceObserverMode_ = Ellipsis

no recording is done

RECORD_OPERATIONS_: SurfaceObserverMode_ = Ellipsis

operations are recorded

class cairo.PDFOutlineFlags(value: int)

PDFOutlineFlags is used by the PDFSurface.add_outline()method to specify the attributes of an outline item. These flags may be bitwise-or’d to produce any combination of flags.

Added in version 1.18.0: Only available with cairo 1.15.10+

OPEN_: PDFOutlineFlags_ = Ellipsis

The outline item defaults to open in the PDF viewer

BOLD_: PDFOutlineFlags_ = Ellipsis

The outline item is displayed by the viewer in bold text

ITALIC_: PDFOutlineFlags_ = Ellipsis

The outline item is displayed by the viewer in italic text

class cairo.SVGUnit(value: int)

SVGUnit is used to describe the units valid for coordinates and lengths in the SVG specification.