# Changelog

Since version 1.11.0 Pycairo uses Semantic Versioning i.e. the newest version is the latest stable one.

## 1.16.2 - 2018-02-10

- setup.py: Some fixes for Debian pybuild quirks. #98

## 1.16.1 - 2018-02-06

- setup.py: correctly install pkgconfig into /usr/lib* again. To make JHBuild on Fedora work the following patch is needed: https://bugzilla.gnome.org/show_bug.cgi?id=793216

## 1.16.0 - 2018-02-05

- Add a `get_include()` function which returns the compiler include path needed for interfacing with the Pycairo C API #92

- Note for packagers: The default header installation path has changed, but a compat header is installed to the old location to prevent breakage in case anyone has hardcoded the old path instead of using pkg-config. Just in case anyone is wondering why there are two header files now.

## 1.15.6 - 2018-01-30

- Experimental PyPy and PyPy3 support #90

## 1.15.5 - 2018-01-29

- Support Unicode paths under Windows with cairo 1.15.10+ #pr-87

- Don’t include the pkg-config file when building a wheel #83

## 1.15.4 - 2017-11-08

Fixes:

  - Fix some enum conversation errors with (unused) large and negative values. #pr-81

Tests:

  - Fix a rare test error #pr-80 (Sergei Trofimovich)

## 1.15.3 - 2017-09-17

Fixes:

  - setup.py: Install pkgconfig file into /usr/share/pkgconfig to work around JHBuild on Fedora not picking it up.

  - Fix tests on big endian machines. #75

  - Support building with MSVC #pr-72 (Chun-wei Fan)

Tests:

  - Test MSVC builds on appveyor

## 1.15.2 - 2017-09-03

Fixes:

  - setup.py: Install pkgconfig file to the same library prefix that Python uses. (/usr/lib64 instead of /usr/lib under Fedora for example) #70 #pr-71 (Sander Sweers)

## 1.15.1 - 2017-08-19

Fixes:

  - Improved support for Python filesystem paths including `os.PathLike`. See `pathlike` for details.

  - Various minor fixes

Changes:

  - Expose `cairo.Path`

Tests:

  - Improved test coverage from ~70% to ~90%

## 1.15.0 - 2017-07-24

New Features:

  - Add `Surface.map_to_image()` and `Surface.unmap_image()` #51

  - Add `RasterSourcePattern` #48

  - Add `Glyph` #53

  - Add `Rectangle` #54

  - Add `TextCluster` #61

  - Add `ScaledFont.text_to_glyphs()` and `ScaledFont.glyph_extents()`

  - Add `Context.show_text_glyphs()`

  - Add `TextExtents` #62

Changes:

  - Pycairo instances wrapping the same underlying cairo object now hash and compare equally e.g. `context.get_target() == context.get_target()`

  - Functions which returned a cairo error with `Status.NO_MEMORY` no longer raise `MemoryError`, but a subclass of `Error` and `MemoryError`. Similarly errors with `Status.READ_ERROR` and `Status.WRITE_ERROR` no longer raise `IOError`, but a subclass of `Error` and `IOError`. #55

  - Some functions which previously returned a tuple now return a tuple subclass like `Rectangle`, `Glyph`, `TextCluster` and `TextExtents`

## 1.14.1 - 2017-07-24

Fixes:

  - Fix a crash with `Surface.get_device()` #57

## 1.14.0 - 2017-07-12

General:

  - Requires at least cairo 1.13.1 (The snapshop in Ubuntu 14.04)

Tests:

  - Optional Hypothesis tests.

New Features:

  - Add `Surface.set_device_scale()` and `Surface.get_device_scale()`. #pr-44 (Sander Sweers)

  - Add `Device` #pr-45

  - Add `Surface.get_device()` #pr-45

  - Add `ScriptDevice` and `ScriptMode` #pr-46

  - Add `ScriptSurface` #17

  - Add `Status.JBIG2_GLOBAL_MISSING`

  - Add `Format.stride_for_width()`

  - Add `TextClusterFlags` and `SurfaceObserverMode`

  - Add `Gradient.get_color_stops_rgba()`

  - Add `TeeSurface`

  - Add `MeshPattern`

## 1.13.4 - 2017-07-12

Fixes:

  - Fix a rare crash with `get_data()` under Python 3 (1.13.3 regression).

## 1.13.3 - 2017-06-01

Fixes:

  - Fix ImageSurface leaking in case `get_data()` is used under Python 3. #41

Documentation:

  - Add Pillow to ImageSurface example. #pr-40 (Stuart Axon)

  - Describe Freetype-py intergration. #25 #pr-43 (Hin-Tak Leung)

## 1.13.2 - 2017-05-21

Fixes:

  - Fix pip failing to install pycairo in some cases. #39

Testing:

  - Added continuous testing for Windows using MSYS2 and appveyor. #19

## 1.13.1 - 2017-05-07

Fixes:

  - setup.py install: Fix generated pkg-config file if `--home` or `--user` is specified. #34

  - Fix a build error on macOS Sierra. #pr-36 (Nicolas P. Rougier)

  - examples: Fix snippet examples when .pyc files are present. #35

Documentation:

  - Add Pyglet integration example. #pr-33 (Stuart Axon)

## 1.13.0 - 2017-05-03

New Features:

  - The buffer returned by `ImageSurface.get_data()` under Python 2 now implements the character buffer interface to make it work with pygame.image.frombuffer(). #pr-29

  - All C enum types now have their own corresponding Python enum type: `Antialias`, `Content`, `Extend`, `FillRule`, `Filter`, `FontSlant`, `FontWeight`, `Format`, `HintMetrics`, `HintStyle`, `LineCap`, `LineJoin`, `Operator`, `PDFVersion`, `PSLevel`, `PathDataType`, `RegionOverlap`, `SVGVersion`, `Status`, `SubpixelOrder`. #26

    All relevant constants are now an alias to attributes of those types e.g. `ANTIALIAS_DEFAULT` is the same as `Antialias.DEFAULT`.

    All functions returning enum values now return instances of the new types e.g. `Context.get_antialias()` returns a `Antialias`.

    `Error.status` is now a `Status`.

  - All included examples now work with Python 2 & 3

  - All included examples using GTK+ have been ported to GTK+ 3/PyGObject 3

Fixes:

  - Fix the signature of the `ImageSurface` buffer interface for Python 2 (int -> Py_ssize_t)

  - setup.py: Ensure “-fno-strict-aliasing” is used with Python 2.

Testing:

  - Added travis-ci tests for flake8 and sphinx. #pr-30, #pr-32

  - The test suite now has optional tests for numpy and pygame integration.

## 1.12.0 - 2017-04-18

General:

  - Require cairo 1.12.0

  - Use C90 and enforce it on travis-ci. #5, #fdo-22940

Constants:

  - Add various new cairo.OPERATOR_*, cairo.ANTIALIAS_* and cairo.FORMAT_* constants. #1

  - Add `HAS_MIME_SURFACE` and cairo.MIME_TYPE_*. #7, #fdo-58771

  - Add cairo.PDF_VERSION_*. #pr-16

  - Add cairo.SVG_VERSION_*

`Error`:

  - Add a `Error.status` attribute exposing cairo.STATUS_*

  - Add `CairoError` alias for `Error` for cairocffi compatibility

`Matrix`:

  - Expose matrix components as read/write properties. e.g. `Matrix.xx`

  - Fix type checking of the multiplication operator under Python 3. #8, #fdo-89162 (Lawrence D’Oliveiro)

`Surface`:

  - Add `Surface.set_mime_data()`. #7, #fdo-58771

  - Add `Surface.get_mime_data()`. #7, #fdo-58771

  - Add `Surface.supports_mime_type()`. #7, #fdo-58771

  - Add `Surface.create_for_rectangle()`. #pr-13

  - Add `Surface.create_similar_image()`. #pr-15

  - Add `Surface.has_show_text_glyphs()`

  - Fix crash when the surface wrapper gets deallocated before the surface object. #11

`Context`:

  - Add `Context.in_clip()`. #pr-14

`PDFSurface`:

  - Add `PDFSurface.restrict_to_version()`. #pr-16

  - Add `PDFSurface.get_versions()`. #pr-16

  - Add `PDFSurface.version_to_string()`. #pr-16

`SVGSurface`:

  - Add `SVGSurface.restrict_to_version()`

  - Add `SVGSurface.get_versions()`

  - Add `SVGSurface.version_to_string()`

`XCBSurface`:

  - Add `XCBSurface.set_size()`

`PSSurface`:

  - Add `PSSurface.get_levels()`

  - Add `PSSurface.level_to_string()`

`Pattern`:

  - Add `Pattern.set_filter()`

  - Add `Pattern.get_filter()`

`RecordingSurface`:

  - Add `RecordingSurface.get_extents()`

`FontOptions`:

  - Implement `__eq__` and `__ne__`

  - Add `FontOptions.copy()`

  - Add `FontOptions.hash()`

  - Add `FontOptions.equal()`

  - Add `FontOptions.merge()`

`ScaledFont`:

  - Add `ScaledFont.get_ctm()`

  - Add `ScaledFont.get_font_matrix()`

  - Add `ScaledFont.get_font_options()`

## 1.11.1 - 2017-04-12

This release fixes an ABI breakage. I missed that the original pycairo master had already broken ABI compared to 1.10.0.

## 1.11.0 - 2017-04-09

This version is based on the Python 2 version of pycairo 1.10.0 and is API/ABI compatible with both py2cairo 1.10.0 and py3cairo 1.10.0.

General Changes:

  - Requires cairo 1.10.2+

  - Switch to semantic versioning

  - Switch build system to distutils/setup.py (xpyb integration can be enabled with passing `--enable-xpyb` to setup.py build)

  - Moved to GitHub: https://github.com/pygobject/pycairo

New Features:

  - Python 3 support (API/ABI compatible with py3cairo 1.10.0) including support for `cairo.Error`, `cairo.ImageSurface.get_data()` and `cairo.ImageSurface.create_for_data()`, which were missing in py3cairo.

  - `cairo.RecordingSurface` (#fdo-36854, Torsten Landschoff)

  - `cairo.Region`, `cairo.RectangleInt` and cairo.REGION_OVERLAP_* (#fdo-44336, Bug Fly)

Bug Fixes:

  - Fix crash when read()/write() methods of file objects passed to pycairo raise exceptions.

  - Fix possible value truncation of handles passed to Win32Surface and Win32PrintingSurface on 64bit Windows. #fdo-57493

## 1.10.0 - 2011-05-01

General Changes:

  py2cairo 1.10.0 requires cairo 1.10.0 (or later).

New Constants:

  cairo.FORMAT_RGB16_565

Bug Fixes:

  - context.get_source().get_surface() fails #fdo-33013

  - Add support for ‘./waf configure –libdir=XXX’ #fdo-30230

Documentation Changes:

  - Upgrade to using Sphinx 1.0.7.

  - Include html documentation in the pycairo archive file.

Build Changes:

  - Update waf to 1.6.3

  - Remove setup.py

Other Changes:

  - Improve/simplify unicode filename support.

  - Improve/simplify unicode text support.

## 1.8.10 - 2010-05-20

General Changes:

  Pycairo 1.8.10 requires cairo 1.8.10 (or later).

New Classes/Types:

  - Win32PrintingSurface

  - XCBSurface - add XCB support using xpyb

Bug Fixes:

  - Fix for libtool 2.2 (#fdo-27974).

  - Mingw32 and pypy fixes (#fdo-25203).

Other Changes:

  Tests updated.

The Win32PrintingSurface and XCBSurface changes mean that pycairo 1.8.10 is not binary compatible with pycairo 1.8.8. So modules that use the pycairo C API (like pygtk) will need to be recompiled to use pycairo 1.8.10.

## 1.8.8 - 2009-08-26

General Changes:

  - Pycairo 1.8.8 requires cairo 1.8.8 (or later).

  - Move from CVS to git.

  - Add support for the waf build tool.

Updated Methods:

  - The PDF/PS/SVGSurface constructors now accept None as a filename.

## 1.8.6 - 2009-06-25

General Changes:

  Pycairo 1.8.6 requires cairo 1.8.6 (or later)

Bug Fixes:

  - ImageSurface.create_from_png _read_func fix

  - ToyFontFace type fix

  - #fdo-19221: restore cairo.Matrix ‘*’ operator to the way it originally worked.

Other Changes:

  Documentation completed.

## 1.8.4 - 2009-03-19

General Changes:

  Pycairo 1.8.4 requires cairo 1.8.4 (or later) and Python 2.6

Bug Fixes:

  - 20674: Add get/set_extend for Gradient Patterns

New Classes:

  cairo.ToyFontFace

New Methods:
  Pattern.get_extend
  Pattern.set_extend
  ToyFontFace.get_family
  ToyFontFace.get_slant
  ToyFontFace.get_weight
Deleted Methods:
  SurfacePattern.get_extend
  SurfacePattern.set_extend
Other Changes:

  Threading for surfaces with stream functions has been reenabled. Documentation updates.

## 1.8.2 - 2009-01-15

Pycairo 1.8.0 resulted in crashes for some applications using threads. So upgrading to 1.8.2 is recommended for threaded applications.

Bug Fixes:

  - #fdo-19287: Threading support results in crashes in cairo.ImageSurface

New Methods:

  Context.set_scaled_font

API Changes:

  Matrix multiplication:

      old code: matrix3 = matrix1 * matrix2
      new equivalent code: matrix3 = matrix1.multiply(matrix2)
      matrix3 = matrix1 * matrix2
      is now equivalent to matrix3 = matrix2.multiply(matrix1)
      which is consistent with standard matrix multiplication.

## 1.8.0 - 2008-12-15

General Changes:

  Pycairo 1.8.0 requires cairo 1.8.0 (or later). Add documentation (available separately)

Bug Fixes:

  - #fdo-18101: Add support for threading

  - #fdo-18947: cairo.SurfacePattern should INCREF the used surface

New Methods:
  ScaledFont.get_scale_matrix
  Surface.mark_dirty_rectangle
  Surface.set_fallback_resolution
New Constants:
  cairo.EXTEND_PAD
  cairo.HAS_IMAGE_SURFACE
  cairo.HAS_USER_FONT
API Changes:

  - Surface.mark_dirty: no longer accepts keyword arguments with default values.

  - PycairoPattern_FromPattern (C API): has a new ‘base’ argument - to fix #fdo-18947.

Other Changes:

  Allow unknown cairo Pattern/Surface types to use the pycairo base Pattern/Surface type.

## 1.6.4 - 2008-08-18

General changes:
  Pycairo 1.6.4 requires cairo 1.6.4 (or later).

    requires Python 2.5 (or later).

Bug fixes:

  #fdo-16112: Fix win32 ‘python setup.py …’ build – use double quotes

New Methods:
  Context.has_current_point
  Context.path_extents
  ImageSurface.format_stride_for_width
  PSSurface.get_eps
  PSSurface.set_eps
  PSSurface.ps_level_to_string
  PSSurface.restrict_to_level
  Surface.copy_page
  Surface.show_page
New Constants:

  cairo.PS_LEVEL_2, cairo.PS_LEVEL_3

Other changes:

  test/pygame-test1.py, test/pygame-test2.py : pygame tests

  examples/cairo_snippets/snippets/ellipse.py : Update so line-width is a constant width in device-space not user-space

## 1.4.12 - 2007-12-13

General changes:

  Pycairo 1.4.12 requires cairo 1.4.12 (or later). requires Python 2.4 (or later).

Bug fixes:

  - #fdo-10006: update autogen.sh to support automake >= 1.10

  - #fdo-13460: use python-config to get python includes

Other changes:

  - allow cairo.Context to be subclassed

  - create a ‘doc’ subdirectory and start a FAQ file

## 1.4.0 - 2007-03-14

General changes:

  Pycairo 1.4.0 requires cairo 1.4.0 (or later).

New methods:
  Context.clip_extents
  Context.copy_clip_rectangles
  Context.get_dash
  Context.get_dash_count
  Context.get_scaled_font
  Context.glyph_extents
  Context.glyph_path
  Context.show_glyphs
  LinearGradient.get_linear_points
  RadialGradient.get_radial_circles
  SolidPattern.get_rgba
  SurfacePattern.get_surface
Deleted methods:

  ImageSurface.create_for_array Remove Numeric Python support, since Numeric has been made obsolete by numpy, and numpy data can be read using ImageSurface.create_for_data.

Other changes:

  the module cairo.gtk has been removed (pygtk 2.7.0 onwards has cairo support built in).

## 1.2.6 - 2006-11-27

- Pycairo 1.2.6 requires cairo 1.2.6 (or later).

- mingw32 compiler fixes (Cedric Gustin)

- setup.py improvements (Cedric Gustin)

- ImageSurface.get_data() new method added ImageSurface.get_data_as_rgba() method removed

## 1.2.2 - 2006-08-21

- Pycairo requires cairo 1.2.2 (or later).

- setup.py has been updated to allow installation by executing $ python setup.py install

- examples/cairo_snippets/snippets/gradient_mask.py A new example to demonstrate pattern masks.

- The cairo.svg module has been removed because:

  1. Cairo does not include SVG parsing, so this module does not belong in pycairo.

  2. libsvg-cairo (the underlying C library) is unmaintained.

## 1.2.0 - 2006-07-03

General changes:

  Pycairo has been updated to work with cairo 1.2.0.

New methods:
  Surface.set_fallback_resolution
  Surface_get_content
  ImageSurface_get_format
  Image_surface_get_stride
Deleted methods:
  PDFSurface.set_dpi, PSSurface.set_dpi, SVGSurface.set_dpi

    - replaced by Surface.set_fallback_resolution

Other changes:

  cairo.FORMAT_RGB16_565 added

## 1.1.6 - 2006-05-29

General changes:

  Pycairo has been updated to work with cairo 1.1.6.

New objects:

  SVGSurface

New methods:
  Context.get_group_target
  Context.new_sub_path
  Context.pop_group
  Context.pop_group_to_source
  Context.push_group
  Context.push_group_with_content
  FontOptions.get_antialias
  FontOptions.get_hint_metrics
  FontOptions.get_hint_style
  FontOptions.get_subpixel_order
  FontOptions.set_antialias
  FontOptions.set_hint_metrics
  FontOptions.set_hint_style
  FontOptions.set_subpixel_order
  PDFSurface.set_size
  PSSurface.dsc_begin_page_setup
  PSSurface.dsc_begin_setup
  PSSurface.dsc_comment
  PSSurface.set_size
  ScaledFont.get_font_face
  ScaledFont.text_extents
  Surface.get_device_offset
  XlibSurface.get_depth
Updated methods:

  PDFSurface()/PSSurface() - can now write to file-like objects (like StringIO).

  surface.write_to_png() and ImageSurface.create_from_png() can now write to file-like objects (like StringIO).

  select_font_face, show_text, text_extents and text_path now accept unicode objects.

Other changes:

  misc bug fixes.

New examples:
  examples/cairo_snippets/snippets_svg.py
  examples/cairo_snippets/snippets/ellipse.py
  examples/cairo_snippets/snippets/group.py
  examples/svg/svgconvert.py

## 1.0.2 - 2005-10-11

General changes:

  Pycairo has been updated to work with cairo 1.0.2.

New cairo functions supported:

  cairo.ImageSurface.create_for_data()

Updated functions:

  ctx.set_source_rgba (r, g, b, a=1.0) now supports a default alpha argument

Other changes:

  cairo.Matrix now supports the Python sequence protocol, so you can do: xx, yx, xy, yy, x0, y0 = matrix

## 1.0.0 - 2005-08-31

General changes:

  Pycairo has been updated to work with cairo 1.0.0.

New cairo functions supported:
  cairo.cairo_version()
  cairo.cairo_version_string()
  PSSurface.set_dpi()
Patterns are now implemented in a class hierarchy, the new constructors are:
  cairo.SolidPattern (r, g, b, a=1.0)
  cairo.SurfacePattern (surface)
  cairo.LinearGradient (x0, y0, x1, y1)
  cairo.RadialGradient (cx0, cy0, radius0, cx1, cy1, radius1)
Updated functions:

  Surface.write_to_png() now accepts a file object as well as a filename

Updated examples:

  The gtk examples now work with pygtk >= 2.7.0 without requiring the cairo.gtk module

Bug Fixes:

  fix “initializer element is not constant” compiler warnings

## 0.9.0 - 2005-08-10

General changes:

  Pycairo has been updated to work with cairo 0.9.0.

New cairo functions supported:
  cairo_get_antialias
  cairo_set_antialias
  cairo_surface_mark_dirty_rectangle
  cairo_surface_flush
Bug Fixes:

  - double buffering now works with the cairo.gtk module

## 0.6.0 - 2005-08-01

This version has many changes which update Pycairo to the new cairo API. The change list is not duplicated here, instead see the cairo/NEWS file for full details of all these API changes.

Pycairo method names that were different from the underlying cairo function names have been changed to make Pycairo more closely follow cairo and so enable the cairo documentation to be used for writing Pycairo programs. NOTES has been updated to list the differences between the C API and the Pycairo API.

Context.copy_path() has been implemented, it returns a Path instance which supports the iterator protocol.

Python 2.3 is now required.

New examples:

  examples/warpedtext.py: shows usage of the Path iterator

  examples/cairo_snippets/: shows many of the ‘cairo-demo/cairo_snippets’ examples

  examples/gtk/png_view.py: example using cairo.ImageSurface.create_from_png()

General changes:

  Pycairo has been updated to work with cairo 0.6.0, including using cairo’s new error handling scheme.

New features:

  cairo.CONTENT_COLOR, cairo.ALPHA, cairo.COLOR_ALPHA have been added for working with surfaces.

  A new class cairo.FontOptions has been added.

  cairo.ImageSurface.create_from_png() now accepts a filename string or a file object

  New wrapper functions have been added for cairo_get_font_options, cairo_set_font_options and cairo_surface_get_font_options.

## 0.5.1 - 2005-06-22

New features:

  - new class cairo.Win32Surface (Niki Spahiev)

  - cairo.HAS_WIN32_SURFACE, cairo.HAS_PS_SURFACE etc are defined to give access to the values from cairo-features.h

Fixes:

  - fix cairo_mask, cairo_mask_surface and cairo_stroke_preserve wrappers

  - compile properly against GTK+ 2.7 (Gustavo Carneiro)

  - other small fixes, including fixes for gcc 4.0 warnings

## 0.4.0 - 2005-03-10

New cairo bindings:
  cairo_font_extents
Bindings removed:
  cairo_font_set_transform
  cairo_font_current_transform
New examples:

  gtk/hangman.py

Other:

  Changed version numbering to correspond directly with the Cairo version Pycairo was developed to work with. So, for example, Pycairo version 0.4.0 represents the Pycairo version that has been developed and tested with Cairo 0.4.0.

## 0.1.4 - 2005-01-14

The Pycairo license has changed so that it is now dual-licensed under the LGPL and the MPL, the same as Cairo itself. For details see the COPYING file as well as COPYING-LGPL-2.1 and COPYING-MPL-1.1.

New cairo bindings:
  cairo_pdf_surface_create
  cairo_set_target_pdf
New libsvg-cairo bindings:
  svg_cairo_parse
  svg_cairo_parse_buffer
  svg_cairo_render
  svg_cairo_get_size
Other:

  - Added –without-pygtk configure option.

  - Renamed the Pycairo API _new() functions to _wrap() to allow _new() to

  - be used for python __new__ functions.

  - New examples: svg2png.py and svgview.py.

## 0.1.3 - 2004-11-24

After the recent server compromise we discarded all unsigned snapshots. That left us without a pycairo snapshot.

Additionally, there were no tags in the source repository so I couldn’t recreate the 0.1.2 snapshot, so here’s a new 0.1.3 snapshot.

I apologize if I botched the version number or left something significant out of this announcement—I’m not the one who will usually be doing pycairo maintenance.

New bindings:
  current_path
  current_path_flat
  current_font_extents
Changes:

  fill_extents,stroke_extents: Remove unnecessary args and change from a method to an attribute.

Other:

  Added two new examples: context-subclass.py and warpedtext.py