Documentation

Fields

• _colorR :: !Int
   
• _colorG :: !Int
   
• _colorB :: !Int
   
• _colorA :: !Double
   

Fields

• _fntFontName :: !Text

  The logic name. Will be used when defining styles.

• _fntFontPath :: !Text

  The path in the filesystem.

Fields

• _fntFontName :: !Text

  The logic name. Will be used when defining styles.

• _fntFontBytes :: !ByteString

  The bytes of the loaded font.

Fields

• unFont :: Text
   

Fields

• unFontSize :: Double
   

Fields

• unFontSpace :: Double
   

Fields

• _glpGlyph :: !Char

  The represented character.

• _glpX :: !Double

  The x coordinate used for rendering.

• _glpXMin :: !Double

  The min x coordinate.

• _glpXMax :: !Double

  The max x coordinate.

• _glpYMin :: !Double

  The min x coordinate.

• _glpYMax :: !Double

  The max x coordinate.

• _glpW :: !Double

  The glyph width.

• _glpH :: !Double

  The glyph height.

Fields

• _txmAsc :: !Double

  The height above the baseline.

• _txmDesc :: !Double

  The height below the baseline.

• _txmLineH :: !Double

  The total height.

• _txmLowerX :: !Double

  The height of lowercase x.

Fields

• _tlFont :: !Font

  The font name.

• _tlFontSize :: !FontSize

  The font size.

• _tlFontSpaceH :: !FontSpace

  The font spacing.

• _tlFontSpaceV :: !FontSpace

  The vertical line spacing.

• _tlMetrics :: !TextMetrics

  The text metrics for the given font/size.

• _tlText :: !Text

  The represented text.

• _tlSize :: !Size

  The size the formatted text takes.

• _tlRect :: !Rect

  The rect the formatted text occupies.

• _tlGlyphs :: !(Seq GlyphPos)

  The glyphs for each character.

Fields

• _idfName :: Text

  The logic name of the image.

• _idfSize :: Size

  The dimensions of the image.

• _idfImgData :: ByteString

  The image data as RGBA 4-bytes blocks.

• _idfFlags :: [ImageFlag]

  The image flags.

Fields

• computeTextMetrics :: Font -> FontSize -> TextMetrics

  Returns the text metrics of a given font and size.

• computeTextMetrics_ :: Double -> Font -> FontSize -> TextMetrics

  Returns the text metrics of a given font and size, applying scale.

• computeTextSize :: Font -> FontSize -> FontSpace -> Text -> Size

  Returns the size of the line of text given font and size.

• computeTextSize_ :: Double -> Font -> FontSize -> FontSpace -> Text -> Size

  Returns the size of the line of text given font and size, applying scale.

• computeGlyphsPos :: Font -> FontSize -> FontSpace -> Text -> Seq GlyphPos

  Returns the glyphs of the line of text given font and size.

• computeGlyphsPos_ :: Double -> Font -> FontSize -> FontSpace -> Text -> Seq GlyphPos

  Returns the glyphs of the line of text given font and size, applying scale.

Fields

• beginFrame :: Double -> Double -> IO ()

  Begins a new frame.

• endFrame :: IO ()

  Finishes a frame, consolidating the drawing operations since beginFrame.

• beginPath :: IO ()

  Begins a new path

• closePath :: IO ()

  Finishes an active path by closing it with a line.

• saveContext :: IO ()

  Saves current context (scissor, offset, scale, rotation, etc).

• restoreContext :: IO ()

  Restores a previously saved context.

• createOverlay :: IO () -> IO ()

  Creates an overlay. These are rendered after the regular frame has been displayed. Useful, for instance, for a dropdown or context menu.

• renderOverlays :: IO ()

  Renders the added overlays and clears them.

• createRawTask :: IO () -> IO ()

  Creates a render task which does not rely on the abstractions provided by the Renderer. Well suited for pure OpenGLVulkanMetal.

  This runs _before_ overlays of any type, and it's useful for the content of widgets created with low level APIs.

• renderRawTasks :: IO ()

  Renders the added raw tasks and clears its queue.

• createRawOverlay :: IO () -> IO ()

  Creates an overlay which does not rely on the abstractions provided by the Renderer. Well suited for pure OpenGLVulkanMetal.

  This runs _after_ overlays based on Renderer.

• renderRawOverlays :: IO ()

  Renders the added raw overlays and clears its queue.

• intersectScissor :: Rect -> IO ()

  Sets, or intersects, a scissor which will limit the visible area.

• setTranslation :: Point -> IO ()

  Translates all further drawing operations by the given offset.

• setScale :: Point -> IO ()

  Scales all further drawing operations by the given size.

• setRotation :: Double -> IO ()

  Rotates all further drawing operations by the given angle.

• setGlobalAlpha :: Double -> IO ()

  Applies the given alpha to all further drawing operations.

• setPathWinding :: Winding -> IO ()

  Sets the winding of the shape to be drawn. Setting CCW (counter clockwise) means the shape will be solid. Setting CW (clockwise) means the shape will be a hole inside a larger solid path.

• stroke :: IO ()

  Draws an active path as a non filled stroke.

• setStrokeWidth :: Double -> IO ()

  Sets the width of the next stroke actions.

• setStrokeColor :: Color -> IO ()

  Sets the color of the next stroke actions.

• setStrokeLinearGradient :: Point -> Point -> Color -> Color -> IO ()

  Sets a linear gradient stroke from Point to Point, Color to Color.

• setStrokeRadialGradient :: Point -> Double -> Double -> Color -> Color -> IO ()

  Sets a radial gradient stroke with center point Point, inner and outer radius, inner and outer Color.

• setStrokeBoxGradient :: Rect -> Double -> Double -> Color -> Color -> IO ()

  Sets a box gradient stroke with box area, corner radius, feather, inner and outer Color

• setStrokeImagePattern :: Text -> Point -> Size -> Double -> Double -> IO ()

  Sets an image pattern stroke, with top given by Point, size of a single image given by size, rotation and alpha.

• fill :: IO ()

  Draws an active path as a filled object.

• setFillColor :: Color -> IO ()

  Sets the color of the next fill actions.

• setFillLinearGradient :: Point -> Point -> Color -> Color -> IO ()

  Sets a linear gradient fill from Point to Point, Color to Color.

• setFillRadialGradient :: Point -> Double -> Double -> Color -> Color -> IO ()

  Sets a radial gradient fill with center point Point, inner and outer radius, inner and outer Color.

• setFillBoxGradient :: Rect -> Double -> Double -> Color -> Color -> IO ()

  Sets a box gradient fill with box area, corner radius, feather, inner and outer Color

• setFillImagePattern :: Text -> Point -> Size -> Double -> Double -> IO ()

  Sets an image pattern fill, with top given by Point, size of a single image given by size, rotation and alpha.

• moveTo :: Point -> IO ()

  Moves the head to the given point. Useful for starting a set of lines.

• renderLine :: Point -> Point -> IO ()

  Renders a line between to points.

• renderLineTo :: Point -> IO ()

  Renders a line from head to a given point.

• renderRect :: Rect -> IO ()

  Renders a rectangle.

• renderRoundedRect :: Rect -> Double -> Double -> Double -> Double -> IO ()

  Renders a rectangle with rounded corners.

• renderArc :: Point -> Double -> Double -> Double -> Winding -> IO ()

  Renders an arc (center, radius, angle start, angle, end, winding).

• renderQuadTo :: Point -> Point -> IO ()

  Quadratic bezier segment from head via control point to target.

• renderBezierTo :: Point -> Point -> Point -> IO ()

  Cubic bezier segment from head via two control points to target.

• renderEllipse :: Rect -> IO ()

  Renders an ellipse.

• renderText :: Point -> Font -> FontSize -> FontSpace -> Text -> IO ()

  Renders the given text line at a specific point, with the provided font, size and horizontal spacing.

• getImage :: Text -> IO (Maybe ImageDef)

  Returns the image definition of a loaded image, if any.

• addImage :: Text -> Size -> ByteString -> [ImageFlag] -> IO ()

  Adds an image, providing name, size, image data and flags.

• updateImage :: Text -> Size -> ByteString -> IO ()

  Updates an image, providing name, size and image data (must match previous size).

• deleteImage :: Text -> IO ()

  Removes an existing image.