Idris2Doc : IdrisGL.DataType

IdrisGL.DataType

(source)
Data / Types

Definitions

record Rect : Type
  A rectangle used to determine an area.

Totality: total
Visibility: public export
Constructor: 
MkRect : Int -> Int -> Int -> Int -> Rect

Projections:
.h : Rect -> Int
  @ h The height of the rectangle area.
.w : Rect -> Int
  @ w The width of the rectangle area.
.x : Rect -> Int
  @ x X coordinate of the start point.
.y : Rect -> Int
  @ y Y coordinate of the start point.
.x : Rect -> Int
  @ x X coordinate of the start point.

Visibility: public export
x : Rect -> Int
  @ x X coordinate of the start point.

Visibility: public export
.y : Rect -> Int
  @ y Y coordinate of the start point.

Visibility: public export
y : Rect -> Int
  @ y Y coordinate of the start point.

Visibility: public export
.w : Rect -> Int
  @ w The width of the rectangle area.

Visibility: public export
w : Rect -> Int
  @ w The width of the rectangle area.

Visibility: public export
.h : Rect -> Int
  @ h The height of the rectangle area.

Visibility: public export
h : Rect -> Int
  @ h The height of the rectangle area.

Visibility: public export
record Coordinate : Type
  A coordinate used to determine the position.

Totality: total
Visibility: public export
Constructor: 
MkCoor : Int -> Int -> Coordinate

Projections:
.x : Coordinate -> Int
  @ x X coordinate of the point.
.y : Coordinate -> Int
  @ y Y coordinate of the point.
.x : Coordinate -> Int
  @ x X coordinate of the point.

Visibility: public export
x : Coordinate -> Int
  @ x X coordinate of the point.

Visibility: public export
.y : Coordinate -> Int
  @ y Y coordinate of the point.

Visibility: public export
y : Coordinate -> Int
  @ y Y coordinate of the point.

Visibility: public export
record Sur : Type
  Surface.
  A structure that contains a collection of pixels used in software blitting.

Totality: total
Visibility: public export
Constructor: 
MkSur : AnyPtr -> Sur

Projection: 
.ptr : Sur -> AnyPtr
  A wrapper of SDL_Surface pointer.
  @ ptr The C pointer of a SDL_Surface. You should not directly operate this pointer.
.ptr : Sur -> AnyPtr
  A wrapper of SDL_Surface pointer.
  @ ptr The C pointer of a SDL_Surface. You should not directly operate this pointer.

Visibility: public export
ptr : Sur -> AnyPtr
  A wrapper of SDL_Surface pointer.
  @ ptr The C pointer of a SDL_Surface. You should not directly operate this pointer.

Visibility: public export
record Win : Type
  Window.

Totality: total
Visibility: public export
Constructor: 
MkWin : AnyPtr -> Win

Projection: 
.ptr : Win -> AnyPtr
  A wrapper of SDL_Window pointer.
  @ ptr The C pointer of a SDL_Window. You should not directly operate this pointer.
.ptr : Win -> AnyPtr
  A wrapper of SDL_Window pointer.
  @ ptr The C pointer of a SDL_Window. You should not directly operate this pointer.

Visibility: public export
ptr : Win -> AnyPtr
  A wrapper of SDL_Window pointer.
  @ ptr The C pointer of a SDL_Window. You should not directly operate this pointer.

Visibility: public export
record Renderer : Type
  Renderer.
  A 2D rendering context for a window.

Totality: total
Visibility: public export
Constructor: 
MkRenderer : AnyPtr -> Renderer

Projection: 
.ptr : Renderer -> AnyPtr
  A wrapper of SDL_Renderer pointer.
  @ ptr The C pointer of a SDL_Renderer. You should not directly operate this pointer.
.ptr : Renderer -> AnyPtr
  A wrapper of SDL_Renderer pointer.
  @ ptr The C pointer of a SDL_Renderer. You should not directly operate this pointer.

Visibility: public export
ptr : Renderer -> AnyPtr
  A wrapper of SDL_Renderer pointer.
  @ ptr The C pointer of a SDL_Renderer. You should not directly operate this pointer.

Visibility: public export
record Texture : Type
  Texture.
  A structure that contains an efficient, driver-specific representation of pixel data.

Totality: total
Visibility: public export
Constructor: 
MkTexture : AnyPtr -> Texture

Projection: 
.ptr : Texture -> AnyPtr
  A wrapper of SDL_Texture pointer.
  @ ptr The C pointer of a SDL_Texture. You should not directly operate this pointer.
.ptr : Texture -> AnyPtr
  A wrapper of SDL_Texture pointer.
  @ ptr The C pointer of a SDL_Texture. You should not directly operate this pointer.

Visibility: public export
ptr : Texture -> AnyPtr
  A wrapper of SDL_Texture pointer.
  @ ptr The C pointer of a SDL_Texture. You should not directly operate this pointer.

Visibility: public export
record Event : Type
  Event.
  A union that contains structures for the different event types.

Totality: total
Visibility: public export
Constructor: 
MkEvent : AnyPtr -> Event

Projection: 
.ptr : Event -> AnyPtr
  A wrapper of SDL_Event pointer.
  @ ptr The C pointer of a SDL_Event. You should not directly operate this pointer.
.ptr : Event -> AnyPtr
  A wrapper of SDL_Event pointer.
  @ ptr The C pointer of a SDL_Event. You should not directly operate this pointer.

Visibility: public export
ptr : Event -> AnyPtr
  A wrapper of SDL_Event pointer.
  @ ptr The C pointer of a SDL_Event. You should not directly operate this pointer.

Visibility: public export
data Display : Type
  Describes how IdrisGL should display its output.

Totality: total
Visibility: public export
Constructors:
InWindow : String -> Rect -> Display
  Display in a window with the given name and area (size and position).
FullWindow : Display
  Display full screen.
data TextStyle : Type
  Font styles.

Totality: total
Visibility: public export
Constructors:
TS_NORMAL : TextStyle
TS_BOLD : TextStyle
TS_ITALIC : TextStyle
TS_UNDERLINE : TextStyle
TS_STRIKETHROUGH : TextStyle
data TextHinting : Type
  FreeType hinter settings.

Totality: total
Visibility: public export
Constructors:
TH_NORMAL : TextHinting
TH_LIGHT : TextHinting
TH_MONO : TextHinting
TH_NONE : TextHinting
data FlipSetting : Type
  Flip settings for SDL bindings.
  Instead you should avoid to use SDL bindings.

Totality: total
Visibility: public export
Constructors:
FLIP_NONE : FlipSetting
FLIP_HORIZONTAL : FlipSetting
FLIP_VERTICAL : FlipSetting
data Picture : Type
  2D Picture.

Totality: total
Visibility: public export
Constructors:
Blank : Picture
  A blank picture, with nothing in it.
Pictures : List Picture -> Picture
  A picture consisting of several others.
  @ pics    Other pictures.
Rotate : Double -> Coordinate -> Picture -> Picture
  A picture rotated clockwise by the given angle (in degrees) and given center.
  @ angle   Rotation angle.
  @ center  Rotation center.
  @ pic     The picture to be rotated.
Bitmap : String -> Rect -> Picture
  A bitmap image.
  @ path The path of the bitmap.
  @ rect The size and position of placed bitmap.
Image : String -> Rect -> Picture
  An image in other format (PNG/JPG/WEBP/TIF).
  @ path The path of the image.
  @ rect The size and position of placed image.
Pixel : Coordinate -> Color -> Picture
  A pixel at given coordinate.
  @ position The position of the pixel.
  @ color    The color of the pixel.
ThickLine : Coordinate -> Coordinate -> Color -> Int -> Picture
  A thick line with given thickness.
  @ start     The start position.
  @ end       The end position.
  @ color     The color of line.
  @ thickness The thickness of line.
Line : Coordinate -> Coordinate -> Color -> Picture
  A line.
  @ start     The start position.
  @ end       The end position.
  @ color     The color of line.
Rectangle : Rect -> Color -> Bool -> Picture
  A rectangle.
  @ rect    The size of position of the rectangle.
  @ color   The color of the rectangle.
  @ filling True if fill the rectangle.
R_Rectangle : Rect -> Color -> Bool -> Int -> Picture
  A rounded-corner rectangle.
  @ rect    The size of position of the rectangle.
  @ color   The color of the rectangle.
  @ filling True if fill the rectangle.
  @ radius  The radius of the corner arc.
Circle : Coordinate -> Color -> Bool -> Int -> Picture
  A circle.
  @ center  The center of the circle.
  @ color   The color of the circle.
  @ filling True if fill the circle.
  @ radius  The radius of the circle.
ThickCircle : Coordinate -> Color -> Int -> Int -> Picture
  A circle with given thickness.
  @ center    The center of the circle.
  @ color     The color of the circle.
  @ filling   True if fill the circle.
  @ radius    The radius of the circle.
  @ thickness The thickness of the drawing line.
Arc : Coordinate -> Color -> Int -> Int -> Int -> Picture
  A circular arc drawn counter-clockwise between two angles (in degrees).
  @ center The center of the arc.
  @ color  The color of drawing line.
  @ radius The radius of the arc.
  @ start  Starting radius in degrees of the arc. 0 degrees is down, increasing counterclockwise.
  @ end    Ending radius in degrees of the arc. 0 degrees is down, increasing counterclockwise.
Pie : Coordinate -> Color -> Int -> Int -> Int -> Bool -> Picture
  A pie (outline) drawn counter-clockwise between two angles (in degrees).
  @ center The center of the pie.
  @ color  The color of drawing line.
  @ radius The radius of the pie.
  @ start  Starting radius in degrees of the arc. 0 degrees is down, increasing counterclockwise.
  @ end    Ending radius in degrees of the arc. 0 degrees is down, increasing counterclockwise.
Ellipse : Coordinate -> Int -> Int -> Color -> Bool -> Picture
  An ellipse.
  @ center  The center of the ellipse.
  @ rx      Horizontal radius in pixels of the ellipse.
  @ ry      Vertical radius in pixels of the ellipse.
  @ color   The color of drawing line.
  @ filling True if fill the ellipse.
Trigon : Coordinate -> Coordinate -> Coordinate -> Color -> Bool -> Picture
  A trigon.
  @ point1  The first point.
  @ point2  The second point.
  @ point3  The third point.
  @ color   The color of drawing line.
  @ filling True if fill the trigon.
Polygon : List Coordinate -> Color -> Bool -> Picture
  A polygon.
  @ points  A list of points.
  @ color   The color of drawing line.
  @ filling True if fill the trigon.
Text : String -> Int -> String -> Coordinate -> Color -> Picture
  Blended text with default settings.
  @ text  Text.
  @ size  Font size.
  @ font  Path of font file.
  @ pos   Position of text.
  @ color The color of text.
SolidText : String -> Int -> String -> Coordinate -> Color -> TextStyle -> TextHinting -> Int -> Picture
  Solid text.
  @ text    Text.
  @ size    Font size.
  @ font    Path of font file.
  @ pos     Position of text.
  @ color   The color of text.
  @ style   Font style.
  @ hinting Hinting.
  @ kerning Kerning.
BlendedText : String -> Int -> String -> Coordinate -> Color -> TextStyle -> TextHinting -> Int -> Picture
  Blended text.
  @ text    Text.
  @ size    Font size.
  @ font    Path of font file.
  @ pos     Position of text.
  @ color   The color of text.
  @ style   Font style.
  @ hinting Hinting.
  @ kerning Kerning.
ShadedText : String -> Int -> String -> Coordinate -> Color -> Color -> TextStyle -> TextHinting -> Int -> Picture
  Shaded text. (Blended text with background color)
  @ text    Text.
  @ size    Font size.
  @ font    Path of font file.
  @ pos     Position of text.
  @ color   The color of text.
  @ bgColor The background color.
  @ style   Font style.
  @ hinting Hinting.
  @ kerning Kerning.