# Enums

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`

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

  New in version 1.13.

  `DEFAULT`

    Use the default antialiasing for the subsystem and target device

  `NONE`

    Use a bilevel alpha mask

  `GRAY`

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

  `SUBPIXEL`

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

  `FAST`

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

  `GOOD`

    The backend should balance quality against performance.

  `BEST`

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

class `cairo.``Content`

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

  New in version 1.13.

  `COLOR`

    The surface will hold color content only.

  `ALPHA`

    The surface will hold alpha content only.

  `COLOR_ALPHA`

    The surface will hold color and alpha content.

class `cairo.``Extend`

  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` and `PAD` for `Gradient` patterns.

  New in version 1.13.

  `NONE`

    pixels outside of the source pattern are fully transparent

  `REPEAT`

    the pattern is tiled by repeating

  `REFLECT`

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

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

class `cairo.``FillRule`

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

  New in version 1.13.

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

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

class `cairo.``Filter`

  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.

  New in version 1.13.

  `FAST`

    A high-performance filter, with quality similar FILTER_NEAREST

  `GOOD`

    A reasonable-performance filter, with quality similar to FILTER_BILINEAR

  `BEST`

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

  `NEAREST`

    Nearest-neighbor filtering

  `BILINEAR`

    Linear interpolation in two dimensions

  `GAUSSIAN`

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

class `cairo.``FontSlant`

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

  New in version 1.13.

  `NORMAL`

    Upright font style

  `ITALIC`

    Italic font style

  `OBLIQUE`

    Oblique font style

class `cairo.``FontWeight`

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

  New in version 1.13.

  `NORMAL`

    Normal font weight

  `BOLD`

    Bold font weight

class `cairo.``Format`

  These constants are used to identify the memory format of `ImageSurface` data.

  New entries may be added in future versions.

  New in version 1.13.

  `stride_for_width`(width)

    Parameters: | width (int) – the desired width of an `ImageSurface` to 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.
    Return type: | int

    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 under `cairo.ImageSurface.format_stride_for_width()`.

    New in version 1.14.

  `INVALID`

    no such format exists or is supported.

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

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

  `A8`

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

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

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

  `RGB30`

    like `RGB24` but with 10bpc.

class `cairo.``HintMetrics`

  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.

  New in version 1.13.

  `DEFAULT`

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

  `OFF`

    Do not hint font metrics

  `ON`

    Hint font metrics

class `cairo.``HintStyle`

  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.

  New in version 1.13.

  `DEFAULT`

    Use the default hint style for font backend and target device

  `NONE`

    Do not hint outlines

  `SLIGHT`

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

  `MEDIUM`

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

  `FULL`

    Hint outlines to maximize contrast

class `cairo.``LineCap`

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

  The default line cap style is `BUTT`

  New in version 1.13.

  `BUTT`

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

  `ROUND`

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

  `SQUARE`

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

class `cairo.``LineJoin`

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

  The default line join style is `MITER`

  New in version 1.13.

  `MITER`

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

  `ROUND`

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

  `BEVEL`

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

class `cairo.``Operator`

  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.

  New in version 1.13.

  `CLEAR`

    clear destination layer (bounded)

  `SOURCE`

    replace destination layer (bounded)

  `OVER`

    draw source layer on top of destination layer (bounded)

  `IN`

    draw source where there was destination content (unbounded)

  `OUT`

    draw source where there was no destination content (unbounded)

  `ATOP`

    draw source on top of destination content and only there

  `DEST`

    ignore the source

  `DEST_OVER`

    draw destination on top of source

  `DEST_IN`

    leave destination only where there was source content (unbounded)

  `DEST_OUT`

    leave destination only where there was no source content

  `DEST_ATOP`

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

  `XOR`

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

  `ADD`

    source and destination layers are accumulated

  `SATURATE`

    like over, but assuming source and dest are disjoint geometries

  `MULTIPLY`

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

  `SCREEN`

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

  `OVERLAY`

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

  `DARKEN`

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

  `LIGHTEN`

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

  `COLOR_DODGE`

    brightens the destination color to reflect the source color.

  `COLOR_BURN`

    darkens the destination color to reflect the source color.

  `HARD_LIGHT`

    Multiplies or screens, dependent on source color.

  `SOFT_LIGHT`

    Darkens or lightens, dependent on source color.

  `DIFFERENCE`

    Takes the difference of the source and destination color.

  `EXCLUSION`

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

  `HSL_HUE`

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

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

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

  `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 `HSL_COLOR`

class `cairo.``PathDataType`

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

  New in version 1.13.

  `MOVE_TO`

    A move-to operation

  `LINE_TO`

    A line-to operation

  `CURVE_TO`

    A curve-to operation

  `CLOSE_PATH`

    A close-path operation

class `cairo.``PSLevel`

  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.

  New in version 1.13.

  `LEVEL_2`

    The language level 2 of the PostScript specification.

  `LEVEL_3`

    The language level 3 of the PostScript specification.

class `cairo.``PDFVersion`

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

  New in version 1.13.

  `VERSION_1_4`

    The version 1.4 of the PDF specification.

  `VERSION_1_5`

    The version 1.5 of the PDF specification.

class `cairo.``SVGVersion`

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

  New in version 1.13.

  `VERSION_1_1`

    The version 1.1 of the SVG specification.

  `VERSION_1_2`

    The version 1.2 of the SVG specification.

class `cairo.``SubpixelOrder`

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

  New in version 1.13.

  `DEFAULT`

    Use the default subpixel order for for the target device

  `RGB`

    Subpixel elements are arranged horizontally with red at the left

  `BGR`

    Subpixel elements are arranged horizontally with blue at the left

  `VRGB`

    Subpixel elements are arranged vertically with red at the top

  `VBGR`

    Subpixel elements are arranged vertically with blue at the top

class `cairo.``RegionOverlap`

  New in version 1.13.

  `IN`

    The contents are entirely inside the region.

  `OUT`

    The contents are entirely outside the region.

  `PART`

    The contents are partially inside and partially outside the region.

class `cairo.``Status`

  New in version 1.13.

  `SUCCESS`
  `NO_MEMORY`
  `INVALID_RESTORE`
  `INVALID_POP_GROUP`
  `NO_CURRENT_POINT`
  `INVALID_MATRIX`
  `INVALID_STATUS`
  `NULL_POINTER`
  `INVALID_STRING`
  `INVALID_PATH_DATA`
  `READ_ERROR`
  `WRITE_ERROR`
  `SURFACE_FINISHED`
  `SURFACE_TYPE_MISMATCH`
  `PATTERN_TYPE_MISMATCH`
  `INVALID_CONTENT`
  `INVALID_FORMAT`
  `INVALID_VISUAL`
  `FILE_NOT_FOUND`
  `INVALID_DASH`
  `INVALID_DSC_COMMENT`
  `INVALID_INDEX`
  `CLIP_NOT_REPRESENTABLE`
  `TEMP_FILE_ERROR`
  `INVALID_STRIDE`
  `FONT_TYPE_MISMATCH`
  `USER_FONT_IMMUTABLE`
  `USER_FONT_ERROR`
  `NEGATIVE_COUNT`
  `INVALID_CLUSTERS`
  `INVALID_SLANT`
  `INVALID_WEIGHT`
  `INVALID_SIZE`
  `USER_FONT_NOT_IMPLEMENTED`
  `DEVICE_TYPE_MISMATCH`
  `DEVICE_ERROR`
  `INVALID_MESH_CONSTRUCTION`
  `DEVICE_FINISHED`
  `LAST_STATUS`
  `JBIG2_GLOBAL_MISSING`

    New in version 1.14.

class `cairo.``ScriptMode`

  A set of script output variants.

  New in version 1.14.

  `ASCII`

    the output will be in readable text (default)

  `BINARY`

    the output will use byte codes.

class `cairo.``TextClusterFlags`

  Specifies properties of a text cluster mapping.

  New in version 1.14.

  `BACKWARD`

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

class `cairo.``SurfaceObserverMode`

  Whether operations should be recorded.

  New in version 1.14.

  `NORMAL`

    no recording is done

  `RECORD_OPERATIONS`

    operations are recorded