Vivid is a simple 2D rendering library written in Elixir.
Go to file
Renovate Bot 39fe2ac2d3
continuous-integration/drone/pr Build is passing Details
continuous-integration/drone/push Build is passing Details
chore(deps): update dependency erlang to v26.2.2
2024-02-09 10:47:42 +13:00
config chore: Update forgejo hostname. 2024-02-05 15:20:22 +13:00
guides chore: Update forgejo hostname. 2024-02-05 15:20:22 +13:00
lib improvement: bring code up to date and add linters, etc. 2023-07-27 18:49:47 +12:00
priv/hershey Remove unused files from the Hershey distribution. 2017-01-06 11:43:56 +13:00
test Run `mix format` 2018-01-19 09:06:04 +13:00
.check.exs improvement: bring code up to date and add linters, etc. 2023-07-27 18:49:47 +12:00
.drone.yml chore: Update forgejo hostname. 2024-02-05 15:20:22 +13:00
.formatter.exs improvement: bring code up to date and add linters, etc. 2023-07-27 18:49:47 +12:00
.gitignore Add reference implementation for people to read. 2017-03-13 19:51:09 +13:00
.tool-versions chore(deps): update dependency erlang to v26.2.2 2024-02-09 10:47:42 +13:00
.travis.yml Update dependencies and make sure everything works with Elixir 1.5 2017-09-06 09:41:30 +12:00
CHANGELOG.md chore: Update forgejo hostname. 2024-02-05 15:20:22 +13:00
LICENSE Add package information and license. 2016-12-21 13:38:08 +13:00
README.md chore: Update forgejo hostname. 2024-02-05 15:20:22 +13:00
mix.exs chore: Update forgejo hostname. 2024-02-05 15:20:22 +13:00
mix.lock improvement: bring code up to date and add linters, etc. 2023-07-27 18:49:47 +12:00
renovate.json chore: Configure Renovate (#5) 2023-07-27 20:35:21 +12:00

README.md

Vivid

Build Status

Vivid is a simple 2D rendering library.

Features

  • Supports drawing and manipulating a number of basic 2D primitives.
  • Supports filling arbitrary polygons.
  • Supports arbitrary transformations shape transformations.
  • Renders shapes onto a buffer.
  • 100% pure Elixir with no dependencies.
  • Render to PNG using vivid_png.

Demo

I implemented a simple ASCII renderer for debugging and testing purposes, so at any time you can pipe almost any Vivid struct to IO.puts and the contents of the buffer will be rendered and printed onto the screen.

Basic drawing

Frames behave as a simple collection of shapes and colours, which you can simply push on to.

use Vivid
Frame.init(10,10, RGBA.white)
|> Frame.push(Circle.init(Point.init(5,5), 4), RGBA.black)
|> IO.puts
@@@@   @@@
@@  @@@  @
@@ @@@@@ @
@ @@@@@@@
@ @@@@@@@
@ @@@@@@@
@@ @@@@@ @
@@  @@@  @
@@@@   @@@
@@@@@@@@@@

Transformations

Vivid supports a number of standards transforms which can be applied to a shape before it is added to a frame. It also makes provision for you to write your own.

use Vivid
frame = Frame.init(20, 20, RGBA.white)
shape = Box.init(Point.init(0,0), Point.init(5,5))
  |> Transform.rotate(45)
  |> Transform.fill(frame)
  |> Transform.center(frame)
  |> Transform.apply
Frame.push(frame, shape, RGBA.black)
|> IO.puts
@@@@@@@@@@ @@@@@@@@@
@@@@@@@@@ @ @@@@@@@@
@@@@@@@@ @@@ @@@@@@@
@@@@@@@ @@@@@ @@@@@@
@@@@@  @@@@@@@ @@@@@
@@@@ @@@@@@@@@@ @@@@
@@@ @@@@@@@@@@@@ @@@
@@ @@@@@@@@@@@@@@ @@
@ @@@@@@@@@@@@@@@@ @
 @@@@@@@@@@@@@@@@@@
@ @@@@@@@@@@@@@@@@ @
@@ @@@@@@@@@@@@@@ @@
@@@ @@@@@@@@@@@@ @@@
@@@@ @@@@@@@@@@ @@@@
@@@@@ @@@@@@@@@ @@@@
@@@@@@ @@@@@@@ @@@@@
@@@@@@@ @@@@@ @@@@@@
@@@@@@@@ @@@ @@@@@@@
@@@@@@@@@ @ @@@@@@@@
@@@@@@@@@@ @@@@@@@@@

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.

This distribution includes the Hershey vector font from The Hershey Fonts.

Font use restrictions:

 This distribution of the Hershey Fonts may be used by anyone for
  any purpose, commercial or otherwise, providing that:
    1. The following acknowledgements must be distributed with
      the font data:
      - The Hershey Fonts were originally created by Dr.
        A. V. Hershey while working at the U. S.
        National Bureau of Standards.
      - The format of the Font data in this distribution
        was originally created by
          James Hurt
          Cognition, Inc.
          900 Technology Park Drive
          Billerica, MA 01821
          (mit-eddie!ci-dandelion!hurt)
    2. The font data in this distribution may be converted into
      any other format *EXCEPT* the format distributed by
      the U.S. NTIS (which organization holds the rights
      to the distribution and use of the font data in that
      particular format). Not that anybody would really
      *want* to use their format... each point is described
      in eight bytes as "xxx yyy:", where xxx and yyy are
      the coordinate values as ASCII numbers.

Status

This library is now in use in several projects and seems to work well.

Future improvements include:

  • Improve Vivid.SLPFA.
  • Add transformations which can apply rotation matrices directly.
  • Add ability to composit multiple frames together.
  • Support bitmaps as a shape.