Safe Haskell	None
Language	GHC2021

Graphics.Gloss.Relative.Frame

Description

The core functionality of the gloss-relative package is exported in this module. This includes the Frame abstraction and helper functions.

Synopsis

data Frame
- = Aspect {
  - aspectRatio :: Dimension
  - aspectAlign :: Alignment
  - aspectChild :: Frame
  }
- | Zoom {
  - zoomX :: Float
  - zoomY :: Float
  - zoomAlignment :: Alignment
  - zoomChild :: Frame
  }
- | Grid [[Frame]]
- | Label {
  - labelName :: String
  - labelChild :: Frame
  }
- | Frames [Frame]
- | Stretch {
  - stretchDimension :: Maybe Dimension
  - stretchPicture :: Picture
  }
- | Sized (Dimension -> Frame)
type Dimension = (Float, Float)
renderStaticFrame :: Frame -> Dimension -> Picture
grid :: Int -> Int -> (Int -> Int -> Frame) -> Frame
fit :: Maybe Dimension -> Alignment -> Picture -> Frame
wire :: Color -> Frame
solid :: Color -> Frame
banner :: String -> Color -> Frame
shape :: [Point] -> Color -> Frame
stroke :: [Point] -> Color -> Frame
bordered :: Float -> Color -> Frame -> Frame
data Alignment = Alignment {
- alignH :: HorizontalAlignment
- alignV :: VerticalAlignment
}
data HorizontalAlignment
- = AlignLeft
- | AlignCenter
- | AlignRight
data VerticalAlignment
- = AlignTop
- | AlignMiddle
- | AlignBottom
alignTopLeft :: Alignment
alignTop :: Alignment
alignTopRight :: Alignment
alignLeft :: Alignment
alignCenter :: Alignment
alignRight :: Alignment
alignBottomLeft :: Alignment
alignBottom :: Alignment
alignBottomRight :: Alignment

Documentation

data Frame Source #

A picture frame. Much like the original Picture data type, but the purpose is to place and adjust pictures inside a frame with general dimensions.

Constructors

Aspect	Create the largest possible frame with a desired aspect ratio within the current frame.
Fields aspectRatio :: Dimension Aspect ratio dimensions. aspectAlign :: Alignment Alignment inside the parent frame. aspectChild :: Frame Child frame.
Zoom	Zoom the current frame by given factors, producing a smaller frame.
Fields zoomX :: Float Horizontal scale (percentage between 0 and 1). zoomY :: Float Vertical scale (percentage between 0 and 1). zoomAlignment :: Alignment Alignment inside the parent frame. zoomChild :: Frame Child frame.
Grid [[Frame]]	Split the current frame into a grid with the given numbers of rows and columns. Receives a matrix of frames, represented as a list of rows.
Label	Labels a frame region, to use in mouse events.
Fields labelName :: String The label for the frame region. Does not need to be unique. labelChild :: Frame Current frame.
Frames [Frame]	Overlay a sequence of frames.
Stretch	Stretch picture to fill the frame, not preserving the picture's aspect ratio. If you want to preserve the aspect ratio, consider using `fit` instead.
Fields stretchDimension :: Maybe Dimension The explicit dimension of the picture, or inferred if `Nothing`. stretchPicture :: Picture The picture to stretch to the frame's dimension.
Sized (Dimension -> Frame)	Advanced contructor. In case you need to know the exact screen size for a frame.

type Dimension = (Float, Float) Source #

A dimension is pair (width,height). When used as a screen size, the position (0,0) is considered to be at the center.

renderStaticFrame Source #

Arguments

:: Frame	The frame to render. Note: This function ignores frame labels.
-> Dimension	The dimension of the screen in which to render the frame.
-> Picture	The resulting picture.

Renders a frame into a picture.

grid :: Int -> Int -> (Int -> Int -> Frame) -> Frame Source #

Creates each cell in a grid depending on the row and column indexes.

fit Source #

Arguments

:: Maybe Dimension	The explicit dimension of the picture, or inferred if `Nothing`.
-> Alignment	The alignment of the fitted picture to the current frame.
-> Picture	The picture to stretch to the frame's dimension.
-> Frame	The resulting frame.

Fit picture to the frame, preserving the picture's aspect ratio. Receives a picture alignment inside the frame.

wire :: Color -> Frame Source #

Paints the borders of the frame with a color.

solid :: Color -> Frame Source #

Paints the frame with a solid color.

banner :: String -> Color -> Frame Source #

Draws a banner, that is, a piece of text fitted inside the frame, with a color.

shape Source #

Arguments

:: [Point]	A sequence of points that form the polygon. Differently from Gloss `polygon`, each coordinate of a point `(relx,rely)` is defined as relative screen width / height percentages between `-0.5` and `0.5`.
-> Color	The fill color.
-> Frame	The resulting frame

A convex polygon filled with a solid color.

stroke Source #

Arguments

:: [Point]	A sequence of points that form the polygon. Differently from Gloss `polygon`, each coordinate of a point `(relx,rely)` is defined as relative screen width / height percentages between `-0.5` and `0.5`.
-> Color	The fill color.
-> Frame	The resulting frame

A line connecting a sequence of points, drawn with a color.

bordered Source #

Arguments

:: Float	A fixed thickness in pixels.
-> Color	The color for the border.
-> Frame
-> Frame	The resulting frame.

Draws a border around a smaller frame.

data Alignment Source #

Alignment options for a picture or frame inside a larger frame.

Constructors

Alignment
Fields alignH :: HorizontalAlignment Horizontal alignment. alignV :: VerticalAlignment Vertical alignment.

Instances

Instances details

Show Alignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods showsPrec :: Int -> Alignment -> ShowS # show :: Alignment -> String # showList :: [Alignment] -> ShowS #
Eq Alignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods (==) :: Alignment -> Alignment -> Bool # (/=) :: Alignment -> Alignment -> Bool #
Ord Alignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods compare :: Alignment -> Alignment -> Ordering # (<) :: Alignment -> Alignment -> Bool # (<=) :: Alignment -> Alignment -> Bool # (>) :: Alignment -> Alignment -> Bool # (>=) :: Alignment -> Alignment -> Bool # max :: Alignment -> Alignment -> Alignment # min :: Alignment -> Alignment -> Alignment #

data HorizontalAlignment Source #

Horizontal alignment options for a picture or frame inside a larger frame.

Constructors

AlignLeft
AlignCenter
AlignRight

Instances

Instances details

Bounded HorizontalAlignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods minBound :: HorizontalAlignment # maxBound :: HorizontalAlignment #
Enum HorizontalAlignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods succ :: HorizontalAlignment -> HorizontalAlignment # pred :: HorizontalAlignment -> HorizontalAlignment # toEnum :: Int -> HorizontalAlignment # fromEnum :: HorizontalAlignment -> Int # enumFrom :: HorizontalAlignment -> [HorizontalAlignment] # enumFromThen :: HorizontalAlignment -> HorizontalAlignment -> [HorizontalAlignment] # enumFromTo :: HorizontalAlignment -> HorizontalAlignment -> [HorizontalAlignment] # enumFromThenTo :: HorizontalAlignment -> HorizontalAlignment -> HorizontalAlignment -> [HorizontalAlignment] #
Show HorizontalAlignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods showsPrec :: Int -> HorizontalAlignment -> ShowS # show :: HorizontalAlignment -> String # showList :: [HorizontalAlignment] -> ShowS #
Eq HorizontalAlignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods (==) :: HorizontalAlignment -> HorizontalAlignment -> Bool # (/=) :: HorizontalAlignment -> HorizontalAlignment -> Bool #
Ord HorizontalAlignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods compare :: HorizontalAlignment -> HorizontalAlignment -> Ordering # (<) :: HorizontalAlignment -> HorizontalAlignment -> Bool # (<=) :: HorizontalAlignment -> HorizontalAlignment -> Bool # (>) :: HorizontalAlignment -> HorizontalAlignment -> Bool # (>=) :: HorizontalAlignment -> HorizontalAlignment -> Bool # max :: HorizontalAlignment -> HorizontalAlignment -> HorizontalAlignment # min :: HorizontalAlignment -> HorizontalAlignment -> HorizontalAlignment #

data VerticalAlignment Source #

Vertical alignment options for a picture or frame inside a larger frame.

Constructors

AlignTop
AlignMiddle
AlignBottom

Instances

Instances details

Bounded VerticalAlignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods minBound :: VerticalAlignment # maxBound :: VerticalAlignment #
Enum VerticalAlignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods succ :: VerticalAlignment -> VerticalAlignment # pred :: VerticalAlignment -> VerticalAlignment # toEnum :: Int -> VerticalAlignment # fromEnum :: VerticalAlignment -> Int # enumFrom :: VerticalAlignment -> [VerticalAlignment] # enumFromThen :: VerticalAlignment -> VerticalAlignment -> [VerticalAlignment] # enumFromTo :: VerticalAlignment -> VerticalAlignment -> [VerticalAlignment] # enumFromThenTo :: VerticalAlignment -> VerticalAlignment -> VerticalAlignment -> [VerticalAlignment] #
Show VerticalAlignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods showsPrec :: Int -> VerticalAlignment -> ShowS # show :: VerticalAlignment -> String # showList :: [VerticalAlignment] -> ShowS #
Eq VerticalAlignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods (==) :: VerticalAlignment -> VerticalAlignment -> Bool # (/=) :: VerticalAlignment -> VerticalAlignment -> Bool #
Ord VerticalAlignment Source #
Instance details Defined in Graphics.Gloss.Relative.Internal.Window Methods compare :: VerticalAlignment -> VerticalAlignment -> Ordering # (<) :: VerticalAlignment -> VerticalAlignment -> Bool # (<=) :: VerticalAlignment -> VerticalAlignment -> Bool # (>) :: VerticalAlignment -> VerticalAlignment -> Bool # (>=) :: VerticalAlignment -> VerticalAlignment -> Bool # max :: VerticalAlignment -> VerticalAlignment -> VerticalAlignment # min :: VerticalAlignment -> VerticalAlignment -> VerticalAlignment #

alignTopLeft :: Alignment Source #

Alignment to the top-left of the frame.

alignTop :: Alignment Source #

Alignment to the top (and center) of the frame.

alignTopRight :: Alignment Source #

Alignment to the top-right of the frame.

alignLeft :: Alignment Source #

Alignment to the left (and middle) the frame.

alignCenter :: Alignment Source #

Alignment to the center (and middle) the frame.

alignRight :: Alignment Source #

Alignment to the right (and middle) the frame.

alignBottomLeft :: Alignment Source #

Alignment to the bottom-left the frame.

alignBottom :: Alignment Source #

Alignment to the bottom (and middle) the frame.

alignBottomRight :: Alignment Source #

Alignment to the bottom-right the frame.