Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the available kiva backends #646

Merged
merged 1 commit into from
Mar 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Enable Documentation
enable/toolkit_selection.rst

kiva/overview.rst
kiva/backends.rst
kiva/quickref.rst
kiva/fonts.rst

Expand Down
50 changes: 50 additions & 0 deletions docs/source/kiva/backends.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Kiva Backends
=============

GUI-capable
-----------
Each of these backends can be used to draw the contents of windows in a
graphical user interface.

kiva.agg/image
~~~~~~~~~~~~~~
This is a wrapper of the popular Anti-Grain Geometry C++ library. It is the
current default backend.

cairo
~~~~~
A backend based on the `Cairo graphics library <https://www.cairographics.org/>`_.

celiagg
~~~~~~~
A newer wrapper of Anti-Grain Geometry which is maintained outside of
kiva/enable.

gl
~~
OpenGL drawing. This backend is quite limited compared to others.

qpainter
~~~~~~~~
Qt ``QPainter`` drawing. This is only availble with the Qt toolkit.

quartz
~~~~~~
macOS Quartz graphics (ie `CGContext <https://developer.apple.com/documentation/coregraphics/cgcontext>`_).
This is only available on macOS.

File-only
---------
Each of these backends can be used to create an output file.

pdf
~~~
A backend which writes PDF files.

ps
~~
A backend which writes PostScript files.

svg
~~~
A backend which writes SVG files.