Diagrams.Backend.Rasterific.CmdLine

Convenient creation of command-line-driven executables for rendering diagrams using the Rasterific backend. Create png, tif, bmp, jpg or animated GIF files.

• defaultMain creates an executable which can render a single diagram at various options.
• multiMain is like defaultMain but allows for a list of diagrams from which the user can choose one to render.
• animMain is like defaultMain but for animations instead of diagrams.
• gifMain creates an executable to generate an animated GIF.
• mainWith is a generic form that does all of the above but with a slightly scarier type. See Diagrams.Backend.CmdLine. This form can also take a function type that has a suitable final result (any of arguments to the above types) and Parseable arguments.

If you want to generate diagrams programmatically---i.e. if you want to do anything more complex than what the below functions provide---you have several options.

• Use a function with mainWith. This may require making Parseable instances for custom argument types.
• Make a new Mainable instance. This may require a newtype wrapper on your diagram type to avoid the existing instances. This gives you more control over argument parsing, intervening steps, and diagram creation.
• Build option records and pass them along with a diagram to mainRender from Diagrams.Backend.CmdLine.
• You can use renderRasterific to render a diagram to a file directly; see Diagrams.Backend.Rasterific.
• A more flexible approach is to directly call renderDia; see Diagrams.Backend.Rasterific for more information.

For a tutorial on command-line diagram creation see http://projects.haskell.org/diagrams/doc/cmdline.html.

General form of main

mainWith :: (Mainable d, Parseable (MainOpts d)) => d -> IO ()

Main entry point for command-line diagram creation. This is the method that users will call from their program main. For instance an expected user program would take the following form.

import Diagrams.Prelude
import Diagrams.Backend.TheBestBackend.CmdLine

d :: Diagram B R2
d = ...

main = mainWith d

Most backends should be able to use the default implementation. A different implementation should be used to handle more complex interactions with the user.

Supported forms of main

defaultMain :: Diagram Rasterific -> IO ()

multiMain :: [(String, Diagram Rasterific)] -> IO ()

animMain :: Animation Rasterific V2 Double -> IO ()

animMain is like defaultMain, but renders an animation instead of a diagram. It takes as input an animation and produces a command-line program which will crudely "render" the animation by rendering one image for each frame, named by extending the given output file name by consecutive integers. For example if the given output file name is foo/blah.png, the frames will be saved in foo/blah001.png, foo/blah002.png, and so on (the number of padding digits used depends on the total number of frames). It is up to the user to take these images and stitch them together into an actual animation format (using, e.g. ffmpeg).

Of course, this is a rather crude method of rendering animations; more sophisticated methods will likely be added in the future.

The --fpu option can be used to control how many frames will be output for each second (unit time) of animation.

gifMain :: [(Diagram Rasterific, GifDelay)] -> IO ()

GIF support

data GifOpts

Extra options for animated GIFs.

Constructors

GifOpts

Fields

• _dither :: Bool
• _noLooping :: Bool
• _loopRepeat :: Maybe Int

Instances

Parseable GifOpts

Command line parser for GifOpts. --dither turn dithering on. --looping-off turn looping off, i.e play GIF once. --loop-repeat number of times to repeat the GIF after the first playing. this option is only used if --looping-off is not set.

Methods

parser :: Parser GifOpts

Backend tokens

data Rasterific

This data declaration is simply used as a token to distinguish the Rasterific backend: (1) when calling functions where the type inference engine would otherwise have no way to know which backend you wanted to use, and (2) as an argument to the Backend and Renderable type classes.

Instances

Eq Rasterific

Methods

(==) :: Rasterific -> Rasterific -> Bool

(/=) :: Rasterific -> Rasterific -> Bool

Ord Rasterific

Methods

compare :: Rasterific -> Rasterific -> Ordering

(<) :: Rasterific -> Rasterific -> Bool

(<=) :: Rasterific -> Rasterific -> Bool

(>) :: Rasterific -> Rasterific -> Bool

(>=) :: Rasterific -> Rasterific -> Bool

max :: Rasterific -> Rasterific -> Rasterific

min :: Rasterific -> Rasterific -> Rasterific

Read Rasterific

Methods

readsPrec :: Int -> ReadS Rasterific

readList :: ReadS [Rasterific]

readPrec :: ReadPrec Rasterific

readListPrec :: ReadPrec [Rasterific]

Show Rasterific

Methods

showsPrec :: Int -> Rasterific -> ShowS

show :: Rasterific -> String

showList :: [Rasterific] -> ShowS

TypeableFloat n => Backend Rasterific V2 n

Associated Types

data Render Rasterific (V2 :: * -> *) n :: *

type Result Rasterific (V2 :: * -> *) n :: *

data Options Rasterific (V2 :: * -> *) n :: *

Methods

adjustDia :: (Additive V2, Monoid' m, Num n) => Rasterific -> Options Rasterific V2 n -> QDiagram Rasterific V2 n m -> (Options Rasterific V2 n, Transformation V2 n, QDiagram Rasterific V2 n m)

renderRTree :: Rasterific -> Options Rasterific V2 n -> RTree Rasterific V2 n Annotation -> Result Rasterific V2 n

TypeableFloat n => Renderable (Text n) Rasterific

Methods

render :: Rasterific -> Text n -> Render Rasterific (V (Text n)) (N (Text n))

TypeableFloat n => Renderable (DImage n Embedded) Rasterific

Methods

render :: Rasterific -> DImage n Embedded -> Render Rasterific (V (DImage n Embedded)) (N (DImage n Embedded))

TypeableFloat n => Renderable (Path V2 n) Rasterific

Methods

render :: Rasterific -> Path V2 n -> Render Rasterific (V (Path V2 n)) (N (Path V2 n))

Show n => Show (Options Rasterific V2 n)

Methods

showsPrec :: Int -> Options Rasterific V2 n -> ShowS

show :: Options Rasterific V2 n -> String

showList :: [Options Rasterific V2 n] -> ShowS

Monoid (Render Rasterific V2 n)

Methods

mempty :: Render Rasterific V2 n

mappend :: Render Rasterific V2 n -> Render Rasterific V2 n -> Render Rasterific V2 n

mconcat :: [Render Rasterific V2 n] -> Render Rasterific V2 n

Hashable n => Hashable (Options Rasterific V2 n)

Methods

hashWithSalt :: Int -> Options Rasterific V2 n -> Int

hash :: Options Rasterific V2 n -> Int

type V Rasterific

type V Rasterific = V2

type N Rasterific

type N Rasterific = Double

data Options Rasterific V2

data Options Rasterific V2 = RasterificOptions {

• _sizeSpec :: SizeSpec V2 n

}

data Render Rasterific V2

data Render Rasterific V2 = R (RenderM n ())

type Result Rasterific V2 n

type Result Rasterific V2 n = Image PixelRGBA8

type MainOpts [(String, QDiagram Rasterific V2 n Any)]

type MainOpts [(String, QDiagram Rasterific V2 n Any)] = (MainOpts (QDiagram Rasterific V2 n Any), DiagramMultiOpts)

type MainOpts [(QDiagram Rasterific V2 n Any, GifDelay)]

type MainOpts [(QDiagram Rasterific V2 n Any, GifDelay)] = (DiagramOpts, GifOpts)

type MainOpts (Animation Rasterific V2 n)

type MainOpts (Animation Rasterific V2 n) = ((DiagramOpts, DiagramAnimOpts), DiagramLoopOpts)

type MainOpts (QDiagram Rasterific V2 n Any)

type MainOpts (QDiagram Rasterific V2 n Any) = (DiagramOpts, DiagramLoopOpts)

type B = Rasterific

Orphan instances

TypeableFloat n => Mainable [(String, QDiagram Rasterific V2 n Any)]

Associated Types

type MainOpts [(String, QDiagram Rasterific V2 n Any)] :: *

Methods

mainArgs :: [(String, QDiagram Rasterific V2 n Any)] -> IO (MainOpts [(String, QDiagram Rasterific V2 n Any)])

mainRender :: MainOpts [(String, QDiagram Rasterific V2 n Any)] -> [(String, QDiagram Rasterific V2 n Any)] -> IO ()

mainWith :: [(String, QDiagram Rasterific V2 n Any)] -> IO ()

TypeableFloat n => Mainable [(QDiagram Rasterific V2 n Any, GifDelay)]

Associated Types

type MainOpts [(QDiagram Rasterific V2 n Any, GifDelay)] :: *

Methods

mainArgs :: [(QDiagram Rasterific V2 n Any, GifDelay)] -> IO (MainOpts [(QDiagram Rasterific V2 n Any, GifDelay)])

mainRender :: MainOpts [(QDiagram Rasterific V2 n Any, GifDelay)] -> [(QDiagram Rasterific V2 n Any, GifDelay)] -> IO ()

mainWith :: [(QDiagram Rasterific V2 n Any, GifDelay)] -> IO ()

TypeableFloat n => Mainable (Animation Rasterific V2 n)

Associated Types

type MainOpts (Animation Rasterific V2 n) :: *

Methods

mainArgs :: Animation Rasterific V2 n -> IO (MainOpts (Animation Rasterific V2 n))

mainRender :: MainOpts (Animation Rasterific V2 n) -> Animation Rasterific V2 n -> IO ()

mainWith :: Animation Rasterific V2 n -> IO ()

TypeableFloat n => Mainable (QDiagram Rasterific V2 n Any)

Associated Types

type MainOpts (QDiagram Rasterific V2 n Any) :: *

Methods

mainArgs :: QDiagram Rasterific V2 n Any -> IO (MainOpts (QDiagram Rasterific V2 n Any))

mainRender :: MainOpts (QDiagram Rasterific V2 n Any) -> QDiagram Rasterific V2 n Any -> IO ()

mainWith :: QDiagram Rasterific V2 n Any -> IO ()