Graphics.Rendering.MiniTypeset.Layout

A simple layout engine to render text (and later also mathematics).

Relative position and size constants (mathematical coordinate system!)

subSupSize :: Double

supPos :: Double

subPos :: Double

underlinePos :: Double

overlinePos :: Double

strikeThroughPos :: Double

horizLineWidth :: Double

abovePos :: Double

belowPos :: Double

Subscript size indexing

newtype SizeIndex

0 is the default size, 1 is smaller, 2 is even smaller, etc (each subscript

Constructors

SizeIndex Int

Instances

Eq SizeIndex

Defined in Graphics.Rendering.MiniTypeset.Layout

Methods

(==) :: SizeIndex -> SizeIndex -> Bool

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

Ord SizeIndex

Defined in Graphics.Rendering.MiniTypeset.Layout

Methods

compare :: SizeIndex -> SizeIndex -> Ordering

(<) :: SizeIndex -> SizeIndex -> Bool

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

(>) :: SizeIndex -> SizeIndex -> Bool

(>=) :: SizeIndex -> SizeIndex -> Bool

max :: SizeIndex -> SizeIndex -> SizeIndex

min :: SizeIndex -> SizeIndex -> SizeIndex

Show SizeIndex

Defined in Graphics.Rendering.MiniTypeset.Layout

Methods

showsPrec :: Int -> SizeIndex -> ShowS

show :: SizeIndex -> String

showList :: [SizeIndex] -> ShowS

succSizeIndex :: SizeIndex -> SizeIndex

calculateSizeHeight :: Height -> SizeIndex -> Int

The layout data type

data Layout ident style

This data type is the output of the layout engine. The `identifying' part is retained, because everything is still relative, and only during the rendering will positions become absolute. See dryrunLayout

Constructors

LoutGlyph !Pos !style !Col !Char !MultiFontGlyph

LoutGroup !Box [Layout ident style]

LoutBox !Box (Layout ident style)

LoutOfs !Pos (Layout ident style)

LoutIdent !ident (Layout ident style)

LoutDecor !LayoutDecoration (Layout ident style)

LoutEmpty

Instances

(Show style, Show ident) => Show (Layout ident style)

Defined in Graphics.Rendering.MiniTypeset.Layout

Methods

showsPrec :: Int -> Layout ident style -> ShowS

show :: Layout ident style -> String

showList :: [Layout ident style] -> ShowS

Translate (Layout ident style)

Defined in Graphics.Rendering.MiniTypeset.Layout

Methods

translate :: Pos -> Layout ident style -> Layout ident style

data LayoutDecoration

Constructors

HorizLine

Fields

• _hlineCol :: !Col
• _hlineVAlign :: !VAlign
• _hlineVPos :: !Double
• _hlineLineWidth :: !Double

Instances

Show LayoutDecoration

Defined in Graphics.Rendering.MiniTypeset.Layout

Methods

showsPrec :: Int -> LayoutDecoration -> ShowS

show :: LayoutDecoration -> String

showList :: [LayoutDecoration] -> ShowS

translateLayout :: Pos -> Layout ident style -> Layout ident style

reboxLayout :: Box -> Layout ident style -> Layout ident style

The box of a glyph

mfgRelBox :: MultiFontGlyph -> Box

Rendering a layout

renderLayout :: Ord ident => Layout ident style -> Pos -> IO ()

Renders the layout to the OpenGL framebuffer.

Note: you should set up the OpenGL coordinate transformation matrices so that the coordinate system is screen-space, measured in pixels. For example something like

matrixMode $= Projection
loadIdentity
ortho 0 xres yres 0 (-1) 1 
matrixMode $= Modelview 0
loadIdentity

should do.

dryrunLayout :: Ord ident => Layout ident style -> Pos -> IO (Map ident AbsBox)

Does not actually render, but computes the bounding boxes of the identified parts of the layout.

renderLayout'

Arguments

:: Ord ident

=> Bool

True = dryrun (do not render); False = do the rendering

-> Layout ident style

-> Pos

-> IO (Map ident AbsBox)

renderLayoutDecoration :: AbsBox -> LayoutDecoration -> IO ()

Creating a layouting

createLayout :: forall fontfile style ident. (Ord fontfile, Ord ident) => MultiFont fontfile style -> Height -> Document ident -> IO (Layout ident style)

Creates a layout from a document. Then you can render the resulting layout with renderLayout

data Cfg

A type used by createLayout

Constructors

Cfg

Fields

• _currentSize :: !SizeIndex
• _currentStyle :: !BasicStyle
• _currentColor :: !Col

defaultCfg :: Cfg

createLayout' :: forall fontfile style ident. (Ord fontfile, Ord ident) => MultiFont fontfile style -> Height -> Document ident -> IO (Box, Layout ident style)