vivid_png/README.md
james 95d4475271
All checks were successful
continuous-integration/drone/push Build is passing
chore: Modernise CI/CD and migrate. (#13)
Co-authored-by: James Harton <james@harton.nz>
Reviewed-on: https://code.harton.nz/james/vivid_png/pulls/13
2023-07-27 20:08:44 +12:00

1.3 KiB

Vivid.PNG

Build Status

Vivid.PNG adds PNG generating support to Vivid, a 2D rendering library implemented 100% in Elixir with no dependencies.

Installation

Available in Hex, the package can be installed by adding vivid_png to your list of dependencies in mix.exs:

def deps do
  [{:vivid_png, "~> 0.2.0"}]
end

License

Source code is licensed under the terms of the MIT license, the text of which is included in the LICENSE file in this distribution.

Documentation

Documentations can be found at https://hexdocs.pm/vivid_png.

Status

use Vivid
alias Vivid.PNG

frame  = Frame.init(300,200)
text   = Font.line("seems to work")
         |> Transform.fill(frame)
         |> Transform.center(frame)
         |> Transform.apply
circle = Circle.init(Point.init(100, 100), 50)
box    = Box.init(Point.init(250,150), Point.init(275, 175))

frame
|> Frame.push(text,   RGBA.black)
|> Frame.push(circle, RGBA.init(1,0,0,0.5))
|> Frame.push(box,    RGBA.init(0,0,1, 0.75))
|> PNG.to_png("example.png")

example.png