james/vivid
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Change branch references ready for merge.

Browse source
This commit is contained in:
James Harton 2017-05-09 14:56:56 +12:00
parent c5427d2fa3
commit ccd008e8c3
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
guides/getting-started.md
View file

@ -2,7 +2,7 @@
Vivid is designed to be as straightforward to use as possible whilst still providing enough features to be useful. It was originally concieved for displaying graphics and text on [Monochrome 1.3" 128x64 OLED graphic display from Adafruit](https://www.adafruit.com/products/938), which it does. Vivid is designed to be as straightforward to use as possible whilst still providing enough features to be useful. It was originally concieved for displaying graphics and text on [Monochrome 1.3" 128x64 OLED graphic display from Adafruit](https://www.adafruit.com/products/938), which it does.
![4 x OLED display clock using Hershey vector fonts](https://raw.githubusercontent.com/jamesotron/vivid.ex/add-extra-docs/guides/images/vivid_clock.jpg) ![4 x OLED display clock using Hershey vector fonts](https://raw.githubusercontent.com/jamesotron/vivid.ex/master/guides/images/vivid_clock.jpg)
The scope quickly expanded to include arbitrary transforms, basic colour compositing and alpha channels. I even added [`vivid_png`](https://github.com/jamesotron/vivid_png.ex) for writing out PNG files. The scope quickly expanded to include arbitrary transforms, basic colour compositing and alpha channels. I even added [`vivid_png`](https://github.com/jamesotron/vivid_png.ex) for writing out PNG files.
@ -36,7 +36,7 @@ The most basic type is the [`Point`](https://hexdocs.pm/vivid/Vivid.Point.html#c
iex> use Vivid iex> use Vivid
...> Point.init(13, 27) ...> Point.init(13, 27)
#Vivid.Point<{13, 27}> #Vivid.Point<{13, 27}>
![point example](https://raw.githubusercontent.com/jamesotron/vivid.ex/add-extra-docs/guides/images/point_example.png) ![point example](https://raw.githubusercontent.com/jamesotron/vivid.ex/master/guides/images/point_example.png)
### Line ### Line
@ -47,7 +47,7 @@ A [Line](https://hexdocs.pm/vivid/Vivid.Line.html#content) represents a straight
iex> use Vivid iex> use Vivid
...> Line.init(Point.init(13,27), Point.init(2,3)) ...> Line.init(Point.init(13,27), Point.init(2,3))
#Vivid.Line<[origin: #Vivid.Point<{13, 27}>, termination: #Vivid.Point<{2, 3}>]> #Vivid.Line<[origin: #Vivid.Point<{13, 27}>, termination: #Vivid.Point<{2, 3}>]>
![line example](https://raw.githubusercontent.com/jamesotron/vivid.ex/add-extra-docs/guides/images/line_example.png) ![line example](https://raw.githubusercontent.com/jamesotron/vivid.ex/master/guides/images/line_example.png)
### Path ### Path
@ -61,7 +61,7 @@ A Path must consist of at least two vertices.
...> Path.init([Point.init(13,27), Point.init(2,3), Point.init(27,13)]) ...> Path.init([Point.init(13,27), Point.init(2,3), Point.init(27,13)])
#Vivid.Path<[#Vivid.Point<{13, 27}>, #Vivid.Point<{2, 3}>, #Vivid.Point<{27, 13}>]> #Vivid.Path<[#Vivid.Point<{13, 27}>, #Vivid.Point<{2, 3}>, #Vivid.Point<{27, 13}>]>
![path example](https://raw.githubusercontent.com/jamesotron/vivid.ex/add-extra-docs/guides/images/path_example.png) ![path example](https://raw.githubusercontent.com/jamesotron/vivid.ex/master/guides/images/path_example.png)
### Polygon ### Polygon
@ -73,7 +73,7 @@ A [Polygon](https://hexdocs.pm/vivid/Vivid.Polygon.html#content) also represents
...> Polygon.init([Point.init(13,27), Point.init(2,3), Point.init(27,13)]) ...> Polygon.init([Point.init(13,27), Point.init(2,3), Point.init(27,13)])
#Vivid.Polygon<[#Vivid.Point<{13, 27}>, #Vivid.Point<{2, 3}>, #Vivid.Point<{27, 13}>]> #Vivid.Polygon<[#Vivid.Point<{13, 27}>, #Vivid.Point<{2, 3}>, #Vivid.Point<{27, 13}>]>
![polygon example](https://raw.githubusercontent.com/jamesotron/vivid.ex/add-extra-docs/guides/images/polygon_example.png) ![polygon example](https://raw.githubusercontent.com/jamesotron/vivid.ex/master/guides/images/polygon_example.png)
### Box ### Box
@ -85,7 +85,7 @@ Because of the regular nature of rectangles they can be defined with only two po
...> Box.init(Point.init(2,3), Point.init(13,27)) ...> Box.init(Point.init(2,3), Point.init(13,27))
#Vivid.Box<[bottom_left: #Vivid.Point<{2, 3}>, top_right: #Vivid.Point<{13, 27}>]> #Vivid.Box<[bottom_left: #Vivid.Point<{2, 3}>, top_right: #Vivid.Point<{13, 27}>]>
![box example](https://raw.githubusercontent.com/jamesotron/vivid.ex/add-extra-docs/guides/images/box_example.png) ![box example](https://raw.githubusercontent.com/jamesotron/vivid.ex/master/guides/images/box_example.png)
### Circle ### Circle
@ -99,7 +99,7 @@ Often it may be necessary to convert it to a polygon manually before rendering s
...> Circle.init(Point.init(15,15), 10) ...> Circle.init(Point.init(15,15), 10)
#Vivid.Circle<[center: #Vivid.Point<{15, 15}>, radius: 10]> #Vivid.Circle<[center: #Vivid.Point<{15, 15}>, radius: 10]>
![circle example](https://raw.githubusercontent.com/jamesotron/vivid.ex/add-extra-docs/guides/images/circle_example.png) ![circle example](https://raw.githubusercontent.com/jamesotron/vivid.ex/master/guides/images/circle_example.png)
### Arc ### Arc
@ -113,7 +113,7 @@ You can optionally also specify the number of steps used during path generation
...> Arc.init(Point.init(15,15), 45, 90) ...> Arc.init(Point.init(15,15), 45, 90)
#Vivid.Arc<[center: #Vivid.Point<{15, 15}>, radius: 10, start_angle: 45, range: 90, steps: 12]> #Vivid.Arc<[center: #Vivid.Point<{15, 15}>, radius: 10, start_angle: 45, range: 90, steps: 12]>
![arc example](https://raw.githubusercontent.com/jamesotron/vivid.ex/add-extra-docs/guides/images/arc_example.png) ![arc example](https://raw.githubusercontent.com/jamesotron/vivid.ex/master/guides/images/arc_example.png)
### Group ### Group
@ -127,7 +127,7 @@ A [Group](https://hexdocs.pm/vivid/Vivid.Group.html#content) allows for arbitrar
...> Group.init([box, circle]) ...> Group.init([box, circle])
#Vivid.Group<[#Vivid.Box<[bottom_left: #Vivid.Point<{2, 3}>, top_right: #Vivid.Point<{13, 27}>]>, #Vivid.Circle<[center: #Vivid.Point<{15, 15}>, radius: 10]>]> #Vivid.Group<[#Vivid.Box<[bottom_left: #Vivid.Point<{2, 3}>, top_right: #Vivid.Point<{13, 27}>]>, #Vivid.Circle<[center: #Vivid.Point<{15, 15}>, radius: 10]>]>
![group example](https://raw.githubusercontent.com/jamesotron/vivid.ex/add-extra-docs/guides/images/group_example.png) ![group example](https://raw.githubusercontent.com/jamesotron/vivid.ex/master/guides/images/group_example.png)
## Colours ## Colours
@ -137,7 +137,7 @@ Vivid (currently) defines all colours in terms of the RGBA colourspace. Create
...> RGBA.init(0.75, 0.25, 0.5, 0.8) ...> RGBA.init(0.75, 0.25, 0.5, 0.8)
#Vivid.RGBA<{0.75, 0.25, 0.5, 0.8}> #Vivid.RGBA<{0.75, 0.25, 0.5, 0.8}>
![rgba example](https://raw.githubusercontent.com/jamesotron/vivid.ex/add-extra-docs/guides/images/rgba_example.png) ![rgba example](https://raw.githubusercontent.com/jamesotron/vivid.ex/master/guides/images/rgba_example.png)
## Compositing ## Compositing