diagrams-gi-cairo: Cairo backend for diagrams drawing EDSL

[ bsd3, graphics, library ] [ Propose Tags ]

A full-featured backend for rendering diagrams using the cairo rendering engine. This is intended to be a drop-in replacement for diagrams-cairo, built on top of the more up-to-date gi-cairo package.

This ultimately depends on a C library, via Haskell's FFI, and can be difficult to install on some platforms. If you are just looking for a quick way to visualize diagrams, try the diagrams-svg backend; if you want raster output like PNG, try the diagrams-rasterific backend; if you want to embed diagrams in LaTeX documents, try diagrams-pgf.

Diagrams.Backend.Cairo.CmdLine - if you're just getting started with diagrams, begin here.
Diagrams.Backend.Cairo - look at this next. The general API for the cairo backend.
Diagrams.Backend.Cairo.Internal - the implementation guts of the cairo backend. Users should normally not need to import this module.
Diagrams.Backend.Cairo.List - render diagrams to two-dimensional lists of colors (i.e. pixels).
Diagrams.Backend.Cairo.Ptr - render diagrams to buffers in memory.

[Skip to Readme]

Modules

Diagrams
- Backend
  - Diagrams.Backend.Cairo
    - Diagrams.Backend.Cairo.CmdLine
    - Diagrams.Backend.Cairo.Internal
    - Diagrams.Backend.Cairo.List
    - Diagrams.Backend.Cairo.Ptr
    - Diagrams.Backend.Cairo.Text

Downloads

diagrams-gi-cairo-1.4.2.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

BrentYorgey

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	1.4.2
Change log	CHANGELOG.md
Dependencies	array, base (>=4.14 && <4.18), bytestring, colour, containers, diagrams-core, diagrams-lib, filepath, gi-cairo, gi-cairo-connector, gi-cairo-render, gi-pango, gi-pangocairo, hashable, JuicyPixels, mtl, optparse-applicative, split, statestack, text, unix, vector [details]
License	BSD-3-Clause
Author	Brent Yorgey
Maintainer	diagrams-discuss@googlegroups.com
Category	Graphics
Home page	http://projects.haskell.org/diagrams
Bug tracker	http://github.com/diagrams/diagrams-cairo/issues
Source repo	head: git clone http://github.com/diagrams/diagrams-cairo.git
Uploaded	by BrentYorgey at 2022-12-06T14:44:44Z
Distributions	NixOS:1.4.2
Downloads	36 total (4 in the last 30 days)
Rating	(no votes yet) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs not available [build log] All reported builds failed as of 2022-12-06 [all 2 reports]

Readme for diagrams-gi-cairo-1.4.2

[back to package description]

diagrams-cairo is a rendering backend for diagrams, a powerful, flexible, declarative domain-specific language for creating vector graphics, using the Haskell programming language.

diagrams-cairo is implemented using the cairo rendering engine and is a fully-featured, officially supported backend for diagrams.

Installation

cabal update && cabal install gtk2hs-buildtools diagrams-cairo

Basic usage

A simple example that uses diagrams-cairo to draw a blue circle:

{-# LANGUAGE NoMonomorphismRestriction #-}
{-# LANGUAGE FlexibleContexts          #-}
{-# LANGUAGE TypeFamilies              #-}

import Diagrams.Prelude
import Diagrams.Backend.Cairo.CmdLine

d :: Diagram B
d = circle 1 # fc blue

main = mainWith (pad 1.1 d)

Save this to file named Circle.hs and compile it:

ghc --make Circle.hs

This will generate an executable which, when run, outputs a blue circle to some file. Run the executable with the --help option to find out more about how to call it.

$ ./Circle --help
./Circle

Usage: ./Circle [-w|--width WIDTH] [-h|--height HEIGHT] [-o|--output OUTPUT]
                [--loop] [-s|--src ARG] [-i|--interval INTERVAL]
  Command-line diagram generation.

Available options:
  -?,--help                Show this help text
  -w,--width WIDTH         Desired WIDTH of the output image
  -h,--height HEIGHT       Desired HEIGHT of the output image
  -o,--output OUTPUT       OUTPUT file
  -l,--loop                Run in a self-recompiling loop
  -s,--src ARG             Source file to watch
  -i,--interval INTERVAL   When running in a loop, check for changes every INTERVAL seconds.
ommand-line diagram generation.

The output type will be automatically determined from the file extension. Currently PNG, PDF, PS, and SVG are supported.

$ ./Circle -o circle.png -w 400

The command above generates a PNG file with a width of 400px.

Advanced usage

Instead of just creating a standalone executable, the cairo backend can also be called from within a larger program. For more information, see the Diagram.Backend.Cairo module.