Safe Haskell	None
Language	Haskell2010

Reanimate.Parameters

Description

Parameters define the global context of an animation. They are set once before an animation is rendered and may not change during rendering.

Synopsis

data Raster
- = RasterNone
- | RasterAuto
- | RasterInkscape
- | RasterRSvg
- | RasterMagick
type Width = Int
type Height = Int
type FPS = Int
pRaster :: Raster
pFPS :: FPS
pWidth :: Width
pHeight :: Height
pNoExternals :: Bool
pRootDirectory :: FilePath
setRaster :: Raster -> IO ()
setFPS :: FPS -> IO ()
setWidth :: Width -> IO ()
setHeight :: Height -> IO ()
setNoExternals :: Bool -> IO ()
setRootDirectory :: FilePath -> IO ()

Documentation

data Raster Source #

Raster engines turn SVG images into pixels.

Constructors

RasterNone	Do not use any external raster engine. Rely on the browser or ffmpeg.
RasterAuto	Scan for installed raster engines and pick the fastest one.
RasterInkscape	Use Inkscape to raster SVG images.
RasterRSvg	Use rsvg-convert to raster SVG images.
RasterMagick	Use imagemagick to raster SVG images.

Instances

Instances details

Eq Raster Source #
Instance details Defined in Reanimate.Parameters Methods (==) :: Raster -> Raster -> Bool # (/=) :: Raster -> Raster -> Bool #
Show Raster Source #
Instance details Defined in Reanimate.Parameters Methods showsPrec :: Int -> Raster -> ShowS # show :: Raster -> String # showList :: [Raster] -> ShowS #

type Width = Int Source #

Width of animation in pixels.

type Height = Int Source #

Height of animation in pixels.

type FPS = Int Source #

Framerate of animation in frames per second.

pRaster :: Raster Source #

Selected raster engine.

pFPS :: FPS Source #

Selected framerate.

pWidth :: Width Source #

Width of animation in pixel.

pHeight :: Height Source #

Height of animation in pixel.

pNoExternals :: Bool Source #

This parameter determined whether or not external tools are allowed. If this flag is True then tools such as latex and blender will not be invoked.

pRootDirectory :: FilePath Source #

Root directory of animation. Images and other data has to be placed here if they are referenced in an SVG image.

setRaster :: Raster -> IO () Source #

Set raster engine.

setFPS :: FPS -> IO () Source #

Set desired framerate.

setWidth :: Width -> IO () Source #

Set desired width of animation in pixel.

setHeight :: Height -> IO () Source #

Set desired height of animation in pixel.

setNoExternals :: Bool -> IO () Source #

Set whether external tools are allowed.

setRootDirectory :: FilePath -> IO () Source #

Set the root animation directory.