paint

This module contains the main Picture type as well as the function you can use to construct, modify and combine pictures.

Types

Angle

</>

An angle in clock-wise direction. See: angle_rad and angle_deg.

pub type Angle =
  internal_implementation.Angle

A rexport of the Colour type from gleam_community/colour. Paint also includes the functions colour_hex and colour_rgb to easily construct Colours, but feel free to import the gleam_community/colour module and use the many utility that are provided from there.

pub type Colour =
  colour.Colour

Picture

</>

A 2D picture. This is the type which this entire library revolves around.

Unless you intend to author a new backend you should consider this type opaque and never use any of its constructors. Instead, make use of the many utility functions defined in this module (circle, combine, fill, etc.)

pub type Picture =
  internal_implementation.Picture

Vec2

</>

pub type Vec2 =
  #(Float, Float)

Functions

angle_deg

</>

pub fn angle_deg(degrees: Float) -> Angle

Create an angle expressed in degrees

angle_rad

</>

pub fn angle_rad(radians: Float) -> Angle

Create an angle expressed in radians

arc

</>

pub fn arc(radius: Float, start: Angle, end: Angle) -> Picture

An arc with some radius going from some starting angle to some other angle in clock-wise direction

blank

</>

pub fn blank() -> Picture

A blank image

circle

</>

pub fn circle(radius: Float) -> Picture

A circle with some given radius

colour_hex

</>

pub fn colour_hex(string: String) -> Colour

A utility around colour.from_rgb_hex_string (from gleam_community/colour) that panics on an invalid hex code.

colour_rgb

</>

pub fn colour_rgb(red: Int, green: Int, blue: Int) -> Colour

A utility around colour.from_rgb255 (from gleam_community/colour) that panics if the values are outside of the allowed range.

combine

</>

pub fn combine(pictures: List(Picture)) -> Picture

Combine multiple pictures into one

concat

</>

pub fn concat(
  picture: Picture,
  another_picture: Picture,
) -> Picture

Concatenate two pictures

fill

</>

pub fn fill(picture: Picture, colour: Colour) -> Picture

Fill a picture with some given colour, see Colour.

just

</>

pub fn just(picture: Picture) -> fn(a) -> Picture

Utility function that is useful for cases where you are no interested in the canvas configuration. For example,

canvas.display(just(circle(30.0)), "#my_canvas")
// instead of...
canvas.display(fn(_config) { circle(30.0) }, "#my_canvas")

lines

</>

pub fn lines(points: List(#(Float, Float))) -> Picture

Lines (same as a polygon but not a closed shape)

polygon

</>

pub fn polygon(points: List(#(Float, Float))) -> Picture

A polygon consisting of a list of 2d points

rectangle

</>

pub fn rectangle(width: Float, height: Float) -> Picture

A rectangle with some given width and height

rotate

</>

pub fn rotate(picture: Picture, angle: Angle) -> Picture

Rotate the picture in a clock-wise direction

scale_uniform

</>

pub fn scale_uniform(picture: Picture, factor: Float) -> Picture

Scale the picture uniformly in horizontal and vertical direction

scale_x

</>

pub fn scale_x(picture: Picture, factor: Float) -> Picture

Scale the picture in the horizontal direction

scale_y

</>

pub fn scale_y(picture: Picture, factor: Float) -> Picture

Scale the picture in the vertical direction

square

</>

pub fn square(length: Float) -> Picture

A square

stroke

</>

pub fn stroke(
  picture: Picture,
  colour: Colour,
  width width: Float,
) -> Picture

Set a solid stroke with some given colour and width

stroke_none

</>

pub fn stroke_none(picture: Picture) -> Picture

Remove the stroke of the given picture

text

</>

pub fn text(text: String, px font_size: Int) -> Picture

Text with some given font size

translate_x

</>

pub fn translate_x(picture: Picture, x: Float) -> Picture

Translate a picture in the horizontal direction

translate_xy

</>

pub fn translate_xy(
  picture: Picture,
  x: Float,
  y: Float,
) -> Picture

Translate a picture in horizontal and vertical direction

translate_y

</>

pub fn translate_y(picture: Picture, y: Float) -> Picture

Translate a picture in the vertical direction