FRP.Helm.Graphics

Documentation

data Element

Constructors

CollageElement Int Int [Form]

ImageElement (Int, Int) Int Int FilePath Bool

image :: Int -> Int -> FilePath -> Element

Create an element from an image with a given width, height and image file path. If the image dimensions are not the same as given, then it will stretch/shrink to fit. Only PNG files are supported currently.

croppedImage :: (Int, Int) -> Int -> Int -> FilePath -> Element

Create an element from an image by cropping it with a certain position, width, height and image file path. This can be used to divide a single image up into smaller ones.

data Form

Constructors

Form

Fields

theta :: Double

scalar :: Double

x :: Double

y :: Double

style :: FormStyle

data FillStyle

Constructors

Solid Color

Texture String

Gradient Gradient

data LineCap

Constructors

Flat

Round

Padded

data LineJoin

Constructors

Smooth

Sharp Double

Clipped

data LineStyle

Constructors

LineStyle

Fields

color :: Color

width :: Double

cap :: LineCap

join :: LineJoin

dashing :: [Double]

dashOffset :: Double

defaultLine :: LineStyle

Creates the default line style. By default, the line is black with a width of 1, flat caps and regular sharp joints.

solid :: Color -> LineStyle

Create a solid line style with a color.

dashed :: Color -> LineStyle

Create a dashed line style with a color.

dotted :: Color -> LineStyle

Create a dotted line style with a color.

data FormStyle

Constructors

PathForm LineStyle Path

ShapeForm (Either LineStyle FillStyle) Shape

ElementForm Element

GroupForm Matrix [Form]

filled :: Color -> Shape -> Form

Creates a form from a shape by filling it with a specific color.

textured :: String -> Shape -> Form

Creates a form from a shape with a tiled texture and image file path.

gradient :: Gradient -> Shape -> Form

Creates a form from a shape filled with a gradient.

outlined :: LineStyle -> Shape -> Form

Creates a form from a shape by outlining it with a specific line style.

traced :: LineStyle -> Path -> Form

Creates a form from a path by tracing it with a specific line style.

sprite :: Int -> Int -> (Int, Int) -> FilePath -> Form

Creates a form from a image file path with additional position, width and height arguments. Allows you to splice smaller parts from a single image.

toForm :: Element -> Form

Creates a form from an element.

group :: [Form] -> Form

Groups a collection of forms into a single one.

groupTransform :: Matrix -> [Form] -> Form

Groups a collection of forms into a single one, also applying a matrix transformation.

rotate :: Double -> Form -> Form

Rotates a form by an amount (in radians).

scale :: Double -> Form -> Form

Scales a form by an amount, e.g. scaling by 2 will double the size.

move :: (Double, Double) -> Form -> Form

Moves a form relative to its current position.

moveX :: Double -> Form -> Form

Moves a form's x-coordinate relative to its current position.

moveY :: Double -> Form -> Form

Moves a form's y-coordinate relative to its current position.

collage :: Int -> Int -> [Form] -> Element

Create an element from a collection of forms. Can be used to directly render a collection of forms.

type Path = [(Double, Double)]

path :: [(Double, Double)] -> Path

Creates a path for a collection of points.

segment :: (Double, Double) -> (Double, Double) -> Path

Creates a path from a line segment, i.e. a start and end point.

type Shape = [(Double, Double)]

polygon :: [(Double, Double)] -> Shape

Creates a shape from a set of points.

rect :: Double -> Double -> Shape

Creates a rectangular shape with a specific width and height.

square :: Double -> Shape

Creates a square shape with a specific side length.

oval :: Double -> Double -> Shape

Creates an oval shape with a specific width and height.

circle :: Double -> Shape

Creates an oval shape with a specific radius.

ngon :: Int -> Double -> Shape

Creates a generic n-sided polygon (e.g. octagon) with a specific amount of sides and radius.