Diagrams.Backend.Braille

A rendering backend for Braille diagrams using Rasterific, implemented natively in Haskell (making it easy to use on any platform).

To invoke the Braille backend, you have three options.

• You can use the Diagrams.Backend.Braille.CmdLine module to create standalone executables which output images when invoked.
• You can use the renderBraille function provided by this module, which gives you more flexible programmatic control over when and how images are output (making it easy to, for example, write a single program that outputs multiple images, or one that outputs images dynamically based on user input, and so on).
• For the most flexibility (e.g. if you want access to the resulting Braille value directly in memory without writing it to disk), you can manually invoke the renderDia method from the Backend instance for Braille. In particular, renderDia has the generic type

renderDia :: b -> Options b v n -> QDiagram b v n m -> Result b v n

(omitting a few type class constraints). b represents the backend type, v the vector space, n the numeric field, and m the type of monoidal query annotations on the diagram. Options and Result are associated data and type families, respectively, which yield the type of option records and rendering results specific to any particular backend. For b ~ Braille, v ~ V2, and n ~ n, we have

data Options Braille V2 n = BrailleOptions
       { _size      :: SizeSpec2D n -- ^ The requested size of the output
       }

type family Result Braille V2 n = String

So the type of renderDia resolves to

renderDia :: Braille -> Options Braille V2 n -> QDiagram Braille V2 n m -> String

which you could call like renderDia Braille (BrailleOptions (mkWidth 80)) myDiagram.

Braille backend

data Braille

Constructors

Braille

Instances

Eq Braille

Methods

(==) :: Braille -> Braille -> Bool

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

Ord Braille

Methods

compare :: Braille -> Braille -> Ordering

(<) :: Braille -> Braille -> Bool

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

(>) :: Braille -> Braille -> Bool

(>=) :: Braille -> Braille -> Bool

max :: Braille -> Braille -> Braille

min :: Braille -> Braille -> Braille

Read Braille

Methods

readsPrec :: Int -> ReadS Braille

readList :: ReadS [Braille]

readPrec :: ReadPrec Braille

readListPrec :: ReadPrec [Braille]

Show Braille

Methods

showsPrec :: Int -> Braille -> ShowS

show :: Braille -> String

showList :: [Braille] -> ShowS

TypeableFloat n => Backend Braille V2 n

Associated Types

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

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

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

Methods

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

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

TypeableFloat n => Renderable (Text n) Braille

Methods

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

TypeableFloat n => Renderable (DImage n Embedded) Braille

Methods

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

TypeableFloat n => Renderable (Path V2 n) Braille

Methods

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

Show n => Show (Options Braille V2 n)

Methods

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

show :: Options Braille V2 n -> String

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

Monoid (Render Braille V2 n)

Methods

mempty :: Render Braille V2 n

mappend :: Render Braille V2 n -> Render Braille V2 n -> Render Braille V2 n

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

Hashable n => Hashable (Options Braille V2 n)

Methods

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

hash :: Options Braille V2 n -> Int

type V Braille

type V Braille = V2

type N Braille

type N Braille = Double

data Options Braille V2

data Options Braille V2 = BrailleOptions {

• _sizeSpec :: SizeSpec V2 n

}

data Render Braille V2

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

type Result Braille V2 n

type Result Braille V2 n = String

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

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

type MainOpts (QDiagram B V2 n Any)

type MainOpts (QDiagram B V2 n Any) = DiagramOpts

type B = Braille

data family Options b (v :: * -> *) n :: *

Backend-specific rendering options.

Instances

Show n => Show (Options Braille V2 n)

Methods

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

show :: Options Braille V2 n -> String

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

Hashable n => Hashable (Options Braille V2 n)

Methods

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

hash :: Options Braille V2 n -> Int

data Options NullBackend

data Options NullBackend

data Options Braille V2

data Options Braille V2 = BrailleOptions {

• _sizeSpec :: SizeSpec V2 n

}

Rendering

rasterBraille :: (Monoid m, Semigroup m, RealFloat n, Typeable * n) => SizeSpec V2 n -> QDiagram Braille V2 n m -> String

renderBraille :: TypeableFloat n => FilePath -> SizeSpec V2 n -> QDiagram Braille V2 n Any -> IO ()

Render a Braille diagram to a file with the given size. The format is determined by the extension (.png, .tif, .bmp, .jpg and .pdf supported.

size :: ((~) (* -> *) (V a) v, (~) * (N a) n, Enveloped a, HasBasis v) => a -> v n

The smallest positive axis-parallel vector that bounds the envelope of an object.