Fractal.GRUFF

Support library for rendering animations of the Mandelbrot Set fractal using the gruff executable.

An example program might have a structure similar to:

import Fractal.GRUFF

animation :: Animation
animation = ...

main :: IO ()
main = defaultMain animation

with its output fed to the gruff executable.

See also:

• the ruff package for feature location algorithms; and
• the gruff-examples package for concrete examples.

Documentation

type Animation = [(Image, FilePath)]

Animation specification

data Image

Image specification.

Constructors

Image

Fields

• imageWindow :: !Window
• imageViewport :: !Viewport
• imageLocation :: !Location
• imageColours :: !Colours
• imageLabels :: [Label]
• imageLines :: [Line]

Instances

Eq Image

Methods

(==) :: Image -> Image -> Bool

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

Read Image

Methods

readsPrec :: Int -> ReadS Image

readList :: ReadS [Image]

readPrec :: ReadPrec Image

readListPrec :: ReadPrec [Image]

Show Image

Methods

showsPrec :: Int -> Image -> ShowS

show :: Image -> String

showList :: [Image] -> ShowS

data Window

Window specification.

Constructors

Window

Fields

• width :: !Int
• height :: !Int
• supersamples :: !Double

Instances

Eq Window

Methods

(==) :: Window -> Window -> Bool

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

Read Window

Methods

readsPrec :: Int -> ReadS Window

readList :: ReadS [Window]

readPrec :: ReadPrec Window

readListPrec :: ReadPrec [Window]

Show Window

Methods

showsPrec :: Int -> Window -> ShowS

show :: Window -> String

showList :: [Window] -> ShowS

data Viewport

Viewport specification

Constructors

Viewport

Fields

• aspect :: !Double
• orient :: !Double

Instances

Eq Viewport

Methods

(==) :: Viewport -> Viewport -> Bool

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

Read Viewport

Methods

readsPrec :: Int -> ReadS Viewport

readList :: ReadS [Viewport]

readPrec :: ReadPrec Viewport

readListPrec :: ReadPrec [Viewport]

Show Viewport

Methods

showsPrec :: Int -> Viewport -> ShowS

show :: Viewport -> String

showList :: [Viewport] -> ShowS

data Location

Location specification (center of view).

Constructors

Location

Fields

• center :: !(Complex Rational)
• radius :: !Double

Instances

Eq Location

Methods

(==) :: Location -> Location -> Bool

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

Read Location

Methods

readsPrec :: Int -> ReadS Location

readList :: ReadS [Location]

readPrec :: ReadPrec Location

readListPrec :: ReadPrec [Location]

Show Location

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

data Colours

Colour specification.

Constructors

Colours

Fields

• colourInterior :: !Colour
• colourBoundary :: !Colour
• colourExterior :: !Colour

Instances

Eq Colours

Methods

(==) :: Colours -> Colours -> Bool

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

Read Colours

Methods

readsPrec :: Int -> ReadS Colours

readList :: ReadS [Colours]

readPrec :: ReadPrec Colours

readListPrec :: ReadPrec [Colours]

Show Colours

Methods

showsPrec :: Int -> Colours -> ShowS

show :: Colours -> String

showList :: [Colours] -> ShowS

data Colour

RGB colour data (each channel between 0 and 1).

Constructors

Colour !Double !Double !Double

Instances

Eq Colour

Methods

(==) :: Colour -> Colour -> Bool

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

Read Colour

Methods

readsPrec :: Int -> ReadS Colour

readList :: ReadS [Colour]

readPrec :: ReadPrec Colour

readListPrec :: ReadPrec [Colour]

Show Colour

Methods

showsPrec :: Int -> Colour -> ShowS

show :: Colour -> String

showList :: [Colour] -> ShowS

data Label

Labels can be added to points in the complex plane.

Constructors

Label

Fields

• labelCoords :: !(Complex Rational)
• labelColour :: !Colour
• labelText :: String

Instances

Eq Label

Methods

(==) :: Label -> Label -> Bool

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

Read Label

Methods

readsPrec :: Int -> ReadS Label

readList :: ReadS [Label]

readPrec :: ReadPrec Label

readListPrec :: ReadPrec [Label]

Show Label

Methods

showsPrec :: Int -> Label -> ShowS

show :: Label -> String

showList :: [Label] -> ShowS

labelAppend :: Complex Rational -> Colour -> String -> Image -> Image

Append a label to an image.

labelPrepend :: Complex Rational -> Colour -> String -> Image -> Image

Prepend a label to an image.

data Line

Constructors

Line

Fields

• lineSegments :: [(Complex Rational, Complex Rational)]
• lineColour :: !Colour

Instances

Eq Line

Methods

(==) :: Line -> Line -> Bool

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

Read Line

Methods

readsPrec :: Int -> ReadS Line

readList :: ReadS [Line]

readPrec :: ReadPrec Line

readListPrec :: ReadPrec [Line]

Show Line

Methods

showsPrec :: Int -> Line -> ShowS

show :: Line -> String

showList :: [Line] -> ShowS

fromScreenCoords :: (Fractional r, Real r) => Window -> Viewport -> Location -> Complex Double -> Complex r

Transform a point from screen coordinates.

toScreenCoords :: Real r => Window -> Viewport -> Location -> Complex r -> Complex Double

Transform a point to screen coordinates.

defaultMain :: Animation -> IO ()

Serialize an animation to stdout.