paint - v0.4.0

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 Angle

Colour

</>

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 Picture

Vec2

</> 
pub type Vec2 =
  #(Float, Float)

Values

angle_deg

</> 
pub fn angle_deg(degrees: Float) -> @internal Angle

Create an angle expressed in degrees

angle_rad

</> 
pub fn angle_rad(radians: Float) -> @internal Angle

Create an angle expressed in radians

arc

</> 
pub fn arc(
  radius: Float,
  start: @internal Angle,
  end: @internal Angle,
) -> @internal Picture

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

blank

</> 
pub fn blank() -> @internal Picture

A blank image

circle

</> 
pub fn circle(radius: Float) -> @internal Picture

A circle with some given radius

colour_hex

</> 
pub fn colour_hex(string: String) -> colour.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.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(@internal Picture),
) -> @internal Picture

Combine multiple pictures into one

concat

</> 
pub fn concat(
  picture: @internal Picture,
  another_picture: @internal Picture,
) -> @internal Picture

Concatenate two pictures

fill

</> 
pub fn fill(
  picture: @internal Picture,
  colour: colour.Colour,
) -> @internal Picture

Fill a picture with some given colour, see Colour.

just

</> 
pub fn just(
  picture: @internal Picture,
) -> fn(a) -> @internal 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))) -> @internal Picture

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

polygon

</> 
pub fn polygon(
  points: List(#(Float, Float)),
) -> @internal Picture

A polygon consisting of a list of 2d points

rectangle

</> 
pub fn rectangle(
  width: Float,
  height: Float,
) -> @internal Picture

A rectangle with some given width and height

rotate

</> 
pub fn rotate(
  picture: @internal Picture,
  angle: @internal Angle,
) -> @internal Picture

Rotate the picture in a clock-wise direction

scale_uniform

</> 
pub fn scale_uniform(
  picture: @internal Picture,
  factor: Float,
) -> @internal Picture

Scale the picture uniformly in horizontal and vertical direction

scale_x

</> 
pub fn scale_x(
  picture: @internal Picture,
  factor: Float,
) -> @internal Picture

Scale the picture in the horizontal direction

scale_y

</> 
pub fn scale_y(
  picture: @internal Picture,
  factor: Float,
) -> @internal Picture

Scale the picture in the vertical direction

square

</> 
pub fn square(length: Float) -> @internal Picture

A square

stroke

</> 
pub fn stroke(
  picture: @internal Picture,
  colour: colour.Colour,
  width width: Float,
) -> @internal Picture

Set a solid stroke with some given colour and width

stroke_none

</> 
pub fn stroke_none(
  picture: @internal Picture,
) -> @internal Picture

Remove the stroke of the given picture

text

</> 
pub fn text(text: String, px font_size: Int) -> @internal Picture

Text with some given font size

translate_x

</> 
pub fn translate_x(
  picture: @internal Picture,
  x: Float,
) -> @internal Picture

Translate a picture in the horizontal direction

translate_xy

</> 
pub fn translate_xy(
  picture: @internal Picture,
  x: Float,
  y: Float,
) -> @internal Picture

Translate a picture in horizontal and vertical direction

translate_y

</> 
pub fn translate_y(
  picture: @internal Picture,
  y: Float,
) -> @internal Picture

Translate a picture in the vertical direction

✨ Search Document